POST api/Insured/InsuredPolicies

Insured policies list endpoint.

Request Information

URI Parameters

None.

Body Parameters

List of insured database Ids.

Name	Description	Type	Additional information
InsuredDataBaseId		Collection of globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "insuredDataBaseId": [
    "c0f4be76-0bdf-4d8b-b19f-293905d3f453",
    "622c8a23-dd4a-451d-b2dd-8f22beb97eae"
  ]
}

application/xml, text/xml

Sample:

<InsuredDataBaseIds xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.OData">
  <InsuredDataBaseId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:guid>c0f4be76-0bdf-4d8b-b19f-293905d3f453</d2p1:guid>
    <d2p1:guid>622c8a23-dd4a-451d-b2dd-8f22beb97eae</d2p1:guid>
  </InsuredDataBaseId>
</InsuredDataBaseIds>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of InsuredPolicies against given insured database Ids.

InsuredPolicies

Name	Type	Additional information
DatabaseId	globally unique identifier	None.
Number	string	None.
IsQuote	boolean	None.
EffectiveDate	date	None.
ExpirationDate	date	None.
BindDate	date	None.
BusinessType	PolicyBusinessType	None.
BusinessSubType	PolicyBusinessSubType	None.
Description	string	None.
BillingType	PolicyBillingType	None.
LinesOfBusiness	Collection of string	None.
CarrierName	string	None.
MgaName	string	None.
TotalPremium	decimal number	None.
TotalNonPremium	decimal number	None.
TotalAgencyCommission	decimal number	None.
ChangeDate	date	None.
CreateDate	date	None.
CancellationDate	date	None.
ReinstatementDate	date	None.
Active	boolean	None.
RenewedPolicyId	globally unique identifier	None.
RenewedPolicyNumber	string	None.
InsuredDatabaseId	globally unique identifier	None.
Status	string	None.
PolicyTermInMonths	integer	None.
BillingCompanyId	globally unique identifier	None.
BillingCompanyName	string	None.

Response Formats

application/json, text/json

Sample:

{
  "databaseId": "637beacb-42fd-49d9-8ecd-f7daa27256e4",
  "number": "sample string 2",
  "isQuote": true,
  "effectiveDate": "2024-11-21T03:28:49.0478678-06:00",
  "expirationDate": "2024-11-21T03:28:49.0478678-06:00",
  "bindDate": "2024-11-21T03:28:49.0478678-06:00",
  "businessType": 0,
  "businessSubType": 0,
  "description": "sample string 4",
  "billingType": 0,
  "linesOfBusiness": [
    "sample string 1",
    "sample string 2"
  ],
  "carrierName": "sample string 5",
  "mgaName": "sample string 6",
  "totalPremium": 1.0,
  "totalNonPremium": 1.0,
  "totalAgencyCommission": 1.0,
  "changeDate": "2024-11-21T03:28:49.0478678-06:00",
  "createDate": "2024-11-21T03:28:49.0478678-06:00",
  "cancellationDate": "2024-11-21T03:28:49.0478678-06:00",
  "reinstatementDate": "2024-11-21T03:28:49.0478678-06:00",
  "active": true,
  "renewedPolicyId": "40976a3a-ea28-49c5-a031-a970448bed4a",
  "renewedPolicyNumber": "sample string 10",
  "insuredDatabaseId": "17ef25f3-be07-4279-b244-da577b914965",
  "status": "sample string 12",
  "policyTermInMonths": 13,
  "billingCompanyId": "6ff1fa87-535c-46ef-bd2b-616aa5385c9a",
  "billingCompanyName": "sample string 14"
}

application/xml, text/xml

Sample:

<InsuredPolicies xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum">
  <Active>true</Active>
  <BillingCompanyId>6ff1fa87-535c-46ef-bd2b-616aa5385c9a</BillingCompanyId>
  <BillingCompanyName>sample string 14</BillingCompanyName>
  <BillingType>Direct_Bill_100</BillingType>
  <BindDate>2024-11-21T03:28:49.0478678-06:00</BindDate>
  <BusinessSubType>AgentOfRecord</BusinessSubType>
  <BusinessType>New_Business</BusinessType>
  <CancellationDate>2024-11-21T03:28:49.0478678-06:00</CancellationDate>
  <CarrierName>sample string 5</CarrierName>
  <ChangeDate>2024-11-21T03:28:49.0478678-06:00</ChangeDate>
  <CreateDate>2024-11-21T03:28:49.0478678-06:00</CreateDate>
  <DatabaseId>637beacb-42fd-49d9-8ecd-f7daa27256e4</DatabaseId>
  <Description>sample string 4</Description>
  <EffectiveDate>2024-11-21T03:28:49.0478678-06:00</EffectiveDate>
  <ExpirationDate>2024-11-21T03:28:49.0478678-06:00</ExpirationDate>
  <InsuredDatabaseId>17ef25f3-be07-4279-b244-da577b914965</InsuredDatabaseId>
  <IsQuote>true</IsQuote>
  <LinesOfBusiness xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </LinesOfBusiness>
  <MgaName>sample string 6</MgaName>
  <Number>sample string 2</Number>
  <PolicyTermInMonths>13</PolicyTermInMonths>
  <ReinstatementDate>2024-11-21T03:28:49.0478678-06:00</ReinstatementDate>
  <RenewedPolicyId>40976a3a-ea28-49c5-a031-a970448bed4a</RenewedPolicyId>
  <RenewedPolicyNumber>sample string 10</RenewedPolicyNumber>
  <Status>sample string 12</Status>
  <TotalAgencyCommission>1</TotalAgencyCommission>
  <TotalNonPremium>1</TotalNonPremium>
  <TotalPremium>1</TotalPremium>
</InsuredPolicies>