POST api/Insured/InsuredPolicies

Insured policies list endpoint.

Request Information

URI Parameters

None.

Body Parameters

List of insured database Ids.

InsuredDataBaseIds
NameDescriptionTypeAdditional information
InsuredDataBaseId

Collection of globally unique identifier

None.

Request Formats

application/json, text/json

Sample:
{
  "insuredDataBaseId": [
    "cae972df-9bbc-4b62-849a-f97399bb0aec",
    "fac980b9-2a48-44af-a314-fc2eb6f1f409"
  ]
}

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>cae972df-9bbc-4b62-849a-f97399bb0aec</d2p1:guid>
    <d2p1:guid>fac980b9-2a48-44af-a314-fc2eb6f1f409</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
NameDescriptionTypeAdditional 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.

CancellationDate

date

None.

ReinstatementDate

date

None.

Active

boolean

None.

RenewedPolicyId

globally unique identifier

None.

RenewedPolicyNumber

string

None.

InsuredDatabaseId

globally unique identifier

None.

Response Formats

application/json, text/json

Sample:
{
  "databaseId": "41bebab1-3128-4e15-9f8d-28c9925beba5",
  "number": "sample string 2",
  "isQuote": true,
  "effectiveDate": "2021-08-03T06:06:12.729957-05:00",
  "expirationDate": "2021-08-03T06:06:12.729957-05:00",
  "bindDate": "2021-08-03T06:06:12.729957-05: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": "2021-08-03T06:06:12.7455423-05:00",
  "cancellationDate": "2021-08-03T06:06:12.7455423-05:00",
  "reinstatementDate": "2021-08-03T06:06:12.7455423-05:00",
  "active": true,
  "renewedPolicyId": "d6f9bc9b-7d36-4981-be9c-49575ff5ccca",
  "renewedPolicyNumber": "sample string 9",
  "insuredDatabaseId": "0ab462fe-b088-41bd-b9e9-b914a08703a1"
}

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>
  <BillingType>Direct_Bill_100</BillingType>
  <BindDate>2021-08-03T06:06:12.729957-05:00</BindDate>
  <BusinessSubType>AgentOfRecord</BusinessSubType>
  <BusinessType>New_Business</BusinessType>
  <CancellationDate>2021-08-03T06:06:12.7455423-05:00</CancellationDate>
  <CarrierName>sample string 5</CarrierName>
  <ChangeDate>2021-08-03T06:06:12.7455423-05:00</ChangeDate>
  <DatabaseId>41bebab1-3128-4e15-9f8d-28c9925beba5</DatabaseId>
  <Description>sample string 4</Description>
  <EffectiveDate>2021-08-03T06:06:12.729957-05:00</EffectiveDate>
  <ExpirationDate>2021-08-03T06:06:12.729957-05:00</ExpirationDate>
  <InsuredDatabaseId>0ab462fe-b088-41bd-b9e9-b914a08703a1</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>
  <ReinstatementDate>2021-08-03T06:06:12.7455423-05:00</ReinstatementDate>
  <RenewedPolicyId>d6f9bc9b-7d36-4981-be9c-49575ff5ccca</RenewedPolicyId>
  <RenewedPolicyNumber>sample string 9</RenewedPolicyNumber>
  <TotalAgencyCommission>1</TotalAgencyCommission>
  <TotalNonPremium>1</TotalNonPremium>
  <TotalPremium>1</TotalPremium>
</InsuredPolicies>