POST v1/Search/PoliciesWithDates

An advanced version of search that allows searching by effective and exipration date ranges

Request Information

URI Parameters

None.

Body Parameters

Defines the search criteria

AdvancedSearchPolicyInputDTO
NameDescriptionTypeAdditional information
PolicyNumber

string

None.

LOBFilterID

integer

None.

LocationFilterID

integer

None.

EffectiveFromDateTime

date

None.

EffectiveToDateTime

date

None.

ExpiredFromDateTime

date

None.

ExpiredToDateTime

date

None.

PageNumber

integer

None.

PageSize

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "PolicyNumber": "sample string 1",
  "LOBFilterID": 2,
  "LocationFilterID": 3,
  "EffectiveFromDateTime": "2024-11-21T06:31:24.1361769+00:00",
  "EffectiveToDateTime": "2024-11-21T06:31:24.1361769+00:00",
  "ExpiredFromDateTime": "2024-11-21T06:31:24.1361769+00:00",
  "ExpiredToDateTime": "2024-11-21T06:31:24.1361769+00:00",
  "PageNumber": 8,
  "PageSize": 9
}

application/xml, text/xml

Sample:
<AdvancedSearchPolicyInputDTO xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
  <EffectiveFromDateTime>2024-11-21T06:31:24.1361769+00:00</EffectiveFromDateTime>
  <EffectiveToDateTime>2024-11-21T06:31:24.1361769+00:00</EffectiveToDateTime>
  <ExpiredFromDateTime>2024-11-21T06:31:24.1361769+00:00</ExpiredFromDateTime>
  <ExpiredToDateTime>2024-11-21T06:31:24.1361769+00:00</ExpiredToDateTime>
  <LOBFilterID>2</LOBFilterID>
  <LocationFilterID>3</LocationFilterID>
  <PageNumber>8</PageNumber>
  <PageSize>9</PageSize>
  <PolicyNumber>sample string 1</PolicyNumber>
</AdvancedSearchPolicyInputDTO>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'AdvancedSearchPolicyInputDTO'.

Response Information

Resource Description

Policies search result

PageOfOfAdvancedSearchPolicyDTO
NameDescriptionTypeAdditional information
Data

Collection of AdvancedSearchPolicyDTO

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, text/json

Sample:
{
  "Data": [
    {
      "PolicyID": 1,
      "CustomerID": 2,
      "PolicyNo": "sample string 3",
      "EffectiveDate": "2024-11-21T06:31:24.151881+00:00",
      "ExpirationDate": "2024-11-21T06:31:24.151881+00:00",
      "Status": "sample string 6",
      "AgentName": "sample string 7",
      "TotalPremium": 1.0,
      "Description": "sample string 8",
      "LOBID": 9,
      "LOB": "sample string 10",
      "MGAID": 1,
      "MGA": "sample string 11",
      "CarrierID": 12,
      "WritingCarrier": "sample string 13",
      "WritingCarrierNAIC": "sample string 14",
      "CustomerName": "sample string 15",
      "PolicyClass": "sample string 16",
      "PackageType": "sample string 17",
      "CustomerType": "sample string 18",
      "EffectiveDateString": "sample string 19",
      "ExpirationDateString": "sample string 20",
      "ClickLinkUrl": "sample string 21",
      "TypeDisplay": "sample string 22",
      "TotalPremiumString": "sample string 23",
      "PolicyStatusCaption": "sample string 24",
      "CustomerClickLinkUrl": "sample string 25",
      "CarrierClickLinkUrl": "sample string 26",
      "LOBString": "sample string 27"
    },
    {
      "PolicyID": 1,
      "CustomerID": 2,
      "PolicyNo": "sample string 3",
      "EffectiveDate": "2024-11-21T06:31:24.151881+00:00",
      "ExpirationDate": "2024-11-21T06:31:24.151881+00:00",
      "Status": "sample string 6",
      "AgentName": "sample string 7",
      "TotalPremium": 1.0,
      "Description": "sample string 8",
      "LOBID": 9,
      "LOB": "sample string 10",
      "MGAID": 1,
      "MGA": "sample string 11",
      "CarrierID": 12,
      "WritingCarrier": "sample string 13",
      "WritingCarrierNAIC": "sample string 14",
      "CustomerName": "sample string 15",
      "PolicyClass": "sample string 16",
      "PackageType": "sample string 17",
      "CustomerType": "sample string 18",
      "EffectiveDateString": "sample string 19",
      "ExpirationDateString": "sample string 20",
      "ClickLinkUrl": "sample string 21",
      "TypeDisplay": "sample string 22",
      "TotalPremiumString": "sample string 23",
      "PolicyStatusCaption": "sample string 24",
      "CustomerClickLinkUrl": "sample string 25",
      "CarrierClickLinkUrl": "sample string 26",
      "LOBString": "sample string 27"
    }
  ],
  "PageNumber": 1,
  "PagesTotal": 2,
  "TotalItems": 3,
  "IsSuccess": true,
  "ErrorCode": "sample string 5",
  "ErrorMessage": "sample string 6",
  "DisplayMessage": "sample string 7",
  "Links": [
    {
      "Rel": "sample string 1",
      "Href": "sample string 2"
    },
    {
      "Rel": "sample string 1",
      "Href": "sample string 2"
    }
  ],
  "Href": "sample string 8"
}

application/xml, text/xml

Sample:
<PageOfAdvancedSearchPolicyDTO 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:AdvancedSearchPolicyDTO>
      <d2p1:AgentName>sample string 7</d2p1:AgentName>
      <d2p1:CarrierClickLinkUrl>sample string 26</d2p1:CarrierClickLinkUrl>
      <d2p1:CarrierID>12</d2p1:CarrierID>
      <d2p1:ClickLinkUrl>sample string 21</d2p1:ClickLinkUrl>
      <d2p1:CustomerClickLinkUrl>sample string 25</d2p1:CustomerClickLinkUrl>
      <d2p1:CustomerID>2</d2p1:CustomerID>
      <d2p1:CustomerName>sample string 15</d2p1:CustomerName>
      <d2p1:CustomerType>sample string 18</d2p1:CustomerType>
      <d2p1:Description>sample string 8</d2p1:Description>
      <d2p1:EffectiveDate>2024-11-21T06:31:24.151881+00:00</d2p1:EffectiveDate>
      <d2p1:EffectiveDateString>sample string 19</d2p1:EffectiveDateString>
      <d2p1:ExpirationDate>2024-11-21T06:31:24.151881+00:00</d2p1:ExpirationDate>
      <d2p1:ExpirationDateString>sample string 20</d2p1:ExpirationDateString>
      <d2p1:LOB>sample string 10</d2p1:LOB>
      <d2p1:LOBID>9</d2p1:LOBID>
      <d2p1:LOBString>sample string 27</d2p1:LOBString>
      <d2p1:MGA>sample string 11</d2p1:MGA>
      <d2p1:MGAID>1</d2p1:MGAID>
      <d2p1:PackageType>sample string 17</d2p1:PackageType>
      <d2p1:PolicyClass>sample string 16</d2p1:PolicyClass>
      <d2p1:PolicyID>1</d2p1:PolicyID>
      <d2p1:PolicyNo>sample string 3</d2p1:PolicyNo>
      <d2p1:PolicyStatusCaption>sample string 24</d2p1:PolicyStatusCaption>
      <d2p1:Status>sample string 6</d2p1:Status>
      <d2p1:TotalPremium>1</d2p1:TotalPremium>
      <d2p1:TotalPremiumString>sample string 23</d2p1:TotalPremiumString>
      <d2p1:TypeDisplay>sample string 22</d2p1:TypeDisplay>
      <d2p1:WritingCarrier>sample string 13</d2p1:WritingCarrier>
      <d2p1:WritingCarrierNAIC>sample string 14</d2p1:WritingCarrierNAIC>
    </d2p1:AdvancedSearchPolicyDTO>
    <d2p1:AdvancedSearchPolicyDTO>
      <d2p1:AgentName>sample string 7</d2p1:AgentName>
      <d2p1:CarrierClickLinkUrl>sample string 26</d2p1:CarrierClickLinkUrl>
      <d2p1:CarrierID>12</d2p1:CarrierID>
      <d2p1:ClickLinkUrl>sample string 21</d2p1:ClickLinkUrl>
      <d2p1:CustomerClickLinkUrl>sample string 25</d2p1:CustomerClickLinkUrl>
      <d2p1:CustomerID>2</d2p1:CustomerID>
      <d2p1:CustomerName>sample string 15</d2p1:CustomerName>
      <d2p1:CustomerType>sample string 18</d2p1:CustomerType>
      <d2p1:Description>sample string 8</d2p1:Description>
      <d2p1:EffectiveDate>2024-11-21T06:31:24.151881+00:00</d2p1:EffectiveDate>
      <d2p1:EffectiveDateString>sample string 19</d2p1:EffectiveDateString>
      <d2p1:ExpirationDate>2024-11-21T06:31:24.151881+00:00</d2p1:ExpirationDate>
      <d2p1:ExpirationDateString>sample string 20</d2p1:ExpirationDateString>
      <d2p1:LOB>sample string 10</d2p1:LOB>
      <d2p1:LOBID>9</d2p1:LOBID>
      <d2p1:LOBString>sample string 27</d2p1:LOBString>
      <d2p1:MGA>sample string 11</d2p1:MGA>
      <d2p1:MGAID>1</d2p1:MGAID>
      <d2p1:PackageType>sample string 17</d2p1:PackageType>
      <d2p1:PolicyClass>sample string 16</d2p1:PolicyClass>
      <d2p1:PolicyID>1</d2p1:PolicyID>
      <d2p1:PolicyNo>sample string 3</d2p1:PolicyNo>
      <d2p1:PolicyStatusCaption>sample string 24</d2p1:PolicyStatusCaption>
      <d2p1:Status>sample string 6</d2p1:Status>
      <d2p1:TotalPremium>1</d2p1:TotalPremium>
      <d2p1:TotalPremiumString>sample string 23</d2p1:TotalPremiumString>
      <d2p1:TypeDisplay>sample string 22</d2p1:TypeDisplay>
      <d2p1:WritingCarrier>sample string 13</d2p1:WritingCarrier>
      <d2p1:WritingCarrierNAIC>sample string 14</d2p1:WritingCarrierNAIC>
    </d2p1:AdvancedSearchPolicyDTO>
  </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>
</PageOfAdvancedSearchPolicyDTO>