POST api/Insured/InsuredPolicies
Insured policies list endpoint.
Request Information
URI Parameters
None.
Body Parameters
List of insured database Ids.
InsuredDataBaseIdsName | Description | Type | Additional information |
---|---|---|---|
InsuredDataBaseId | Collection of globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "insuredDataBaseId": [ "e5d5d81a-b3ec-4ea9-9268-4e9d7642f6a7", "014b1fb9-1e07-4a13-aecb-f00905962ad9" ] }
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>e5d5d81a-b3ec-4ea9-9268-4e9d7642f6a7</d2p1:guid> <d2p1:guid>014b1fb9-1e07-4a13-aecb-f00905962ad9</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.
InsuredPoliciesName | Description | 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": "158e9ef8-e3a1-41e4-a9bc-ec13d676ada6", "number": "sample string 2", "isQuote": true, "effectiveDate": "2024-03-28T09:22:18.2968712-05:00", "expirationDate": "2024-03-28T09:22:18.2968712-05:00", "bindDate": "2024-03-28T09:22:18.2968712-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": "2024-03-28T09:22:18.2968712-05:00", "createDate": "2024-03-28T09:22:18.2968712-05:00", "cancellationDate": "2024-03-28T09:22:18.2968712-05:00", "reinstatementDate": "2024-03-28T09:22:18.2968712-05:00", "active": true, "renewedPolicyId": "12ae18af-81b2-4c0c-83e1-1f78b643dbb3", "renewedPolicyNumber": "sample string 10", "insuredDatabaseId": "fe623036-ad1b-434b-8b3b-fed557f6feae", "status": "sample string 12", "policyTermInMonths": 13, "billingCompanyId": "cb2c5638-b8f4-4cef-8332-cf892ae1d6fa", "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>cb2c5638-b8f4-4cef-8332-cf892ae1d6fa</BillingCompanyId> <BillingCompanyName>sample string 14</BillingCompanyName> <BillingType>Direct_Bill_100</BillingType> <BindDate>2024-03-28T09:22:18.2968712-05:00</BindDate> <BusinessSubType>AgentOfRecord</BusinessSubType> <BusinessType>New_Business</BusinessType> <CancellationDate>2024-03-28T09:22:18.2968712-05:00</CancellationDate> <CarrierName>sample string 5</CarrierName> <ChangeDate>2024-03-28T09:22:18.2968712-05:00</ChangeDate> <CreateDate>2024-03-28T09:22:18.2968712-05:00</CreateDate> <DatabaseId>158e9ef8-e3a1-41e4-a9bc-ec13d676ada6</DatabaseId> <Description>sample string 4</Description> <EffectiveDate>2024-03-28T09:22:18.2968712-05:00</EffectiveDate> <ExpirationDate>2024-03-28T09:22:18.2968712-05:00</ExpirationDate> <InsuredDatabaseId>fe623036-ad1b-434b-8b3b-fed557f6feae</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-03-28T09:22:18.2968712-05:00</ReinstatementDate> <RenewedPolicyId>12ae18af-81b2-4c0c-83e1-1f78b643dbb3</RenewedPolicyId> <RenewedPolicyNumber>sample string 10</RenewedPolicyNumber> <Status>sample string 12</Status> <TotalAgencyCommission>1</TotalAgencyCommission> <TotalNonPremium>1</TotalNonPremium> <TotalPremium>1</TotalPremium> </InsuredPolicies>