POST v1/Policies/SearchByPolicyNumbers

Search for Policies based on a list of Policy Numbers

Request Information

URI Parameters

None.

Body Parameters

Policy numbers

Collection of string

Request Formats

application/json, text/json

Sample:

[
  "sample string 1",
  "sample string 2"
]

application/xml, text/xml

Sample:

<ArrayOfstring xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
  <string>sample string 1</string>
  <string>sample string 2</string>
</ArrayOfstring>

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 'List`1'.

Response Information

Resource Description

Search result

MultiplePolicyNumbersSearchResult

Name	Type	Additional information
SearchSucceeded	boolean	None.
Message	string	None.
ResultType	MultiplePolicyNumberSearchResultType	None.
PoliciesFound	Collection of PolicySearchDTO	None.
Count	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "SearchSucceeded": true,
  "Message": "sample string 2",
  "ResultType": 0,
  "PoliciesFound": [
    {
      "AgentName": "sample string 1",
      "MGA": "sample string 2",
      "WritingCarrier": "sample string 3",
      "LOB": "sample string 4",
      "CustomerName": "sample string 5",
      "PolicyId": 1,
      "CustomerId": 6,
      "PolicyNumber": "sample string 7",
      "EffectiveDate": "sample string 8",
      "ExpirationDate": "sample string 9",
      "Status": "sample string 10",
      "TotalPremium": 11.0,
      "Description": "sample string 12",
      "LOBId": 13,
      "MGAId": 1,
      "CarrierId": 1
    },
    {
      "AgentName": "sample string 1",
      "MGA": "sample string 2",
      "WritingCarrier": "sample string 3",
      "LOB": "sample string 4",
      "CustomerName": "sample string 5",
      "PolicyId": 1,
      "CustomerId": 6,
      "PolicyNumber": "sample string 7",
      "EffectiveDate": "sample string 8",
      "ExpirationDate": "sample string 9",
      "Status": "sample string 10",
      "TotalPremium": 11.0,
      "Description": "sample string 12",
      "LOBId": 13,
      "MGAId": 1,
      "CarrierId": 1
    }
  ],
  "Count": 3
}

application/xml, text/xml

Sample:

<MultiplePolicyNumbersSearchResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/QQSolutions.NextGen.ModelLibrary.DataTransferObjects.Policies">
  <Count>3</Count>
  <Message>sample string 2</Message>
  <PoliciesFound>
    <PolicySearchDTO>
      <CarrierId>1</CarrierId>
      <CustomerId>6</CustomerId>
      <Description>sample string 12</Description>
      <EffectiveDate>sample string 8</EffectiveDate>
      <ExpirationDate>sample string 9</ExpirationDate>
      <LOBId>13</LOBId>
      <MGAId>1</MGAId>
      <PolicyId>1</PolicyId>
      <PolicyNumber>sample string 7</PolicyNumber>
      <Status>sample string 10</Status>
      <TotalPremium>11</TotalPremium>
      <AgentName>sample string 1</AgentName>
      <CustomerName>sample string 5</CustomerName>
      <LOB>sample string 4</LOB>
      <MGA>sample string 2</MGA>
      <WritingCarrier>sample string 3</WritingCarrier>
    </PolicySearchDTO>
    <PolicySearchDTO>
      <CarrierId>1</CarrierId>
      <CustomerId>6</CustomerId>
      <Description>sample string 12</Description>
      <EffectiveDate>sample string 8</EffectiveDate>
      <ExpirationDate>sample string 9</ExpirationDate>
      <LOBId>13</LOBId>
      <MGAId>1</MGAId>
      <PolicyId>1</PolicyId>
      <PolicyNumber>sample string 7</PolicyNumber>
      <Status>sample string 10</Status>
      <TotalPremium>11</TotalPremium>
      <AgentName>sample string 1</AgentName>
      <CustomerName>sample string 5</CustomerName>
      <LOB>sample string 4</LOB>
      <MGA>sample string 2</MGA>
      <WritingCarrier>sample string 3</WritingCarrier>
    </PolicySearchDTO>
  </PoliciesFound>
  <ResultType>None</ResultType>
  <SearchSucceeded>true</SearchSucceeded>
</MultiplePolicyNumbersSearchResult>