POST v1/Search/Policies
An Advanced search against policies
Request Information
URI Parameters
None.
Body Parameters
Defines the search criteria
FilterSearchPoliciesDTOName | Description | Type | Additional information |
---|---|---|---|
CustomerID | integer |
None. |
|
SearchValue | string |
None. |
|
IncludeActive | boolean |
None. |
|
IncludePending | boolean |
None. |
|
IncludeCancelled | boolean |
None. |
|
IncludeExpired | boolean |
None. |
|
IncludeVoided | boolean |
None. |
|
CarrierID | integer |
None. |
|
OfficeID | integer |
None. |
|
LOBID | integer |
None. |
|
PageNumber | integer |
None. |
|
PageSize | integer |
None. |
|
OrderBy | string |
None. |
|
SortDirection | SortOrder |
None. |
|
AgentID | integer |
None. |
|
FilterPolicyID | integer |
None. |
|
Language | string |
None. |
Request Formats
application/json, text/json
Sample:
{ "CustomerID": 1, "SearchValue": "sample string 2", "IncludeActive": true, "IncludePending": true, "IncludeCancelled": true, "IncludeExpired": true, "IncludeVoided": true, "CarrierID": 8, "OfficeID": 9, "LOBID": 10, "PageNumber": 11, "PageSize": 12, "OrderBy": "sample string 13", "SortDirection": 0, "AgentID": 14, "FilterPolicyID": 15, "Language": "sample string 16" }
application/xml, text/xml
Sample:
<FilterSearchPoliciesDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Contacts"> <AgentID>14</AgentID> <CarrierID>8</CarrierID> <CustomerID>1</CustomerID> <FilterPolicyID>15</FilterPolicyID> <IncludeActive>true</IncludeActive> <IncludeCancelled>true</IncludeCancelled> <IncludeExpired>true</IncludeExpired> <IncludePending>true</IncludePending> <IncludeVoided>true</IncludeVoided> <LOBID>10</LOBID> <Language>sample string 16</Language> <OfficeID>9</OfficeID> <OrderBy>sample string 13</OrderBy> <PageNumber>11</PageNumber> <PageSize>12</PageSize> <SearchValue>sample string 2</SearchValue> <SortDirection>Ascending</SortDirection> </FilterSearchPoliciesDTO>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
Complex policies search result
PageOfOfComplexPoliciesSearchResultDTOName | Description | Type | Additional information |
---|---|---|---|
Data | Collection of ComplexPoliciesSearchResultDTO |
None. |
|
PageNumber | integer |
None. |
|
PagesTotal | integer |
None. |
|
TotalItems | integer |
None. |
|
IsSuccess | boolean |
None. |
|
ErrorCode | string |
None. |
|
ErrorMessage | string |
None. |
|
DisplayMessage | string |
None. |
|
Links | Collection of PageLink |
None. |
|
Href | string |
None. |
Response Formats
application/json
Sample:
text/json
Sample:
application/xml, text/xml
Sample:
<PageOfComplexPoliciesSearchResultDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects"> <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies"> <d2p1:ComplexPoliciesSearchResultDTO> <d2p1:AgentName>sample string 13</d2p1:AgentName> <d2p1:CSRName>sample string 14</d2p1:CSRName> <d2p1:CarrierID>19</d2p1:CarrierID> <d2p1:ClickLinkUrl>sample string 3</d2p1:ClickLinkUrl> <d2p1:CustomerID>8</d2p1:CustomerID> <d2p1:CustomerName>sample string 24</d2p1:CustomerName> <d2p1:Description>sample string 16</d2p1:Description> <d2p1:EffectiveDate>2024-12-11T06:47:33.3600644+00:00</d2p1:EffectiveDate> <d2p1:EffectiveDateString>12/11/2024</d2p1:EffectiveDateString> <d2p1:ExpirationDate>2024-12-11T06:47:33.3600644+00:00</d2p1:ExpirationDate> <d2p1:ExpirationDateString>12/11/2024</d2p1:ExpirationDateString> <d2p1:FuturePolicyBusinessType>sample string 30</d2p1:FuturePolicyBusinessType> <d2p1:FuturePolicyID>1</d2p1:FuturePolicyID> <d2p1:GetQuotesUrl>sample string 1</d2p1:GetQuotesUrl> <d2p1:HasIntentToCancel>28</d2p1:HasIntentToCancel> <d2p1:IntentReasonID>1</d2p1:IntentReasonID> <d2p1:IntentReasonName>sample string 29</d2p1:IntentReasonName> <d2p1:IntentToCancelDate>2024-12-11T06:47:33.3600644+00:00</d2p1:IntentToCancelDate> <d2p1:LOB>sample string 17</d2p1:LOB> <d2p1:LOBID>1</d2p1:LOBID> <d2p1:MGA>sample string 18</d2p1:MGA> <d2p1:MGAID>1</d2p1:MGAID> <d2p1:NonRenewal>true</d2p1:NonRenewal> <d2p1:ParentCarrier>sample string 22</d2p1:ParentCarrier> <d2p1:ParentCarrierNAIC>sample string 23</d2p1:ParentCarrierNAIC> <d2p1:Period>sample string 27</d2p1:Period> <d2p1:PolicyID>7</d2p1:PolicyID> <d2p1:PolicyNo>sample string 9</d2p1:PolicyNo> <d2p1:PolicyStatusCaption>sample string 4</d2p1:PolicyStatusCaption> <d2p1:PriorPolicyID>1</d2p1:PriorPolicyID> <d2p1:PriorPolicyNo>sample string 26</d2p1:PriorPolicyNo> <d2p1:PriorPolicyURL>sample string 2</d2p1:PriorPolicyURL> <d2p1:Status>sample string 12</d2p1:Status> <d2p1:TotalPremium>15</d2p1:TotalPremium> <d2p1:WritingCarrier>sample string 20</d2p1:WritingCarrier> <d2p1:WritingCarrierNAIC>sample string 21</d2p1:WritingCarrierNAIC> <d2p1:rowNumber>1</d2p1:rowNumber> <d2p1:totalPages>1</d2p1:totalPages> <d2p1:totalRows>1</d2p1:totalRows> </d2p1:ComplexPoliciesSearchResultDTO> <d2p1:ComplexPoliciesSearchResultDTO> <d2p1:AgentName>sample string 13</d2p1:AgentName> <d2p1:CSRName>sample string 14</d2p1:CSRName> <d2p1:CarrierID>19</d2p1:CarrierID> <d2p1:ClickLinkUrl>sample string 3</d2p1:ClickLinkUrl> <d2p1:CustomerID>8</d2p1:CustomerID> <d2p1:CustomerName>sample string 24</d2p1:CustomerName> <d2p1:Description>sample string 16</d2p1:Description> <d2p1:EffectiveDate>2024-12-11T06:47:33.3600644+00:00</d2p1:EffectiveDate> <d2p1:EffectiveDateString>12/11/2024</d2p1:EffectiveDateString> <d2p1:ExpirationDate>2024-12-11T06:47:33.3600644+00:00</d2p1:ExpirationDate> <d2p1:ExpirationDateString>12/11/2024</d2p1:ExpirationDateString> <d2p1:FuturePolicyBusinessType>sample string 30</d2p1:FuturePolicyBusinessType> <d2p1:FuturePolicyID>1</d2p1:FuturePolicyID> <d2p1:GetQuotesUrl>sample string 1</d2p1:GetQuotesUrl> <d2p1:HasIntentToCancel>28</d2p1:HasIntentToCancel> <d2p1:IntentReasonID>1</d2p1:IntentReasonID> <d2p1:IntentReasonName>sample string 29</d2p1:IntentReasonName> <d2p1:IntentToCancelDate>2024-12-11T06:47:33.3600644+00:00</d2p1:IntentToCancelDate> <d2p1:LOB>sample string 17</d2p1:LOB> <d2p1:LOBID>1</d2p1:LOBID> <d2p1:MGA>sample string 18</d2p1:MGA> <d2p1:MGAID>1</d2p1:MGAID> <d2p1:NonRenewal>true</d2p1:NonRenewal> <d2p1:ParentCarrier>sample string 22</d2p1:ParentCarrier> <d2p1:ParentCarrierNAIC>sample string 23</d2p1:ParentCarrierNAIC> <d2p1:Period>sample string 27</d2p1:Period> <d2p1:PolicyID>7</d2p1:PolicyID> <d2p1:PolicyNo>sample string 9</d2p1:PolicyNo> <d2p1:PolicyStatusCaption>sample string 4</d2p1:PolicyStatusCaption> <d2p1:PriorPolicyID>1</d2p1:PriorPolicyID> <d2p1:PriorPolicyNo>sample string 26</d2p1:PriorPolicyNo> <d2p1:PriorPolicyURL>sample string 2</d2p1:PriorPolicyURL> <d2p1:Status>sample string 12</d2p1:Status> <d2p1:TotalPremium>15</d2p1:TotalPremium> <d2p1:WritingCarrier>sample string 20</d2p1:WritingCarrier> <d2p1:WritingCarrierNAIC>sample string 21</d2p1:WritingCarrierNAIC> <d2p1:rowNumber>1</d2p1:rowNumber> <d2p1:totalPages>1</d2p1:totalPages> <d2p1:totalRows>1</d2p1:totalRows> </d2p1:ComplexPoliciesSearchResultDTO> </Data> <DisplayMessage>sample string 7</DisplayMessage> <ErrorCode>sample string 5</ErrorCode> <ErrorMessage>sample string 6</ErrorMessage> <Href>sample string 8</Href> <IsSuccess>true</IsSuccess> <Links> <PageLink> <Href>sample string 2</Href> <Rel>sample string 1</Rel> </PageLink> <PageLink> <Href>sample string 2</Href> <Rel>sample string 1</Rel> </PageLink> </Links> <PageNumber>1</PageNumber> <PagesTotal>2</PagesTotal> <TotalItems>3</TotalItems> </PageOfComplexPoliciesSearchResultDTO>