GET api/PolicyDetailList?key={key}&isActive={isActive}
Use this endpoint to get only policy related information.
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| key |
Policy database id to get a particular record base on id. |
globally unique identifier |
None. |
| isActive |
By default both active/inactive. If Active is true then only active policies, else inactive policies are returned. |
boolean |
None. |
Body Parameters
None.
Response Information
Resource Description
PolicyDetailList class.
Collection of PolicyDetailList| Name | 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 | string |
None. |
|
| BusinessSubType | string |
None. |
|
| Description | string |
None. |
|
| BillingType | PolicyBillingType |
None. |
|
| InsuredDatabaseId | globally unique identifier |
None. |
|
| InsuredEmail | string |
None. |
|
| InsuredFirstName | string |
None. |
|
| InsuredLastName | string |
None. |
|
| InsuredCommercialName | string |
None. |
|
| CarrierName | string |
None. |
|
| CarrierNAIC | string |
None. |
|
| CarrierFinanceSearchCoCode | string |
None. |
|
| MgaName | string |
None. |
|
| MgaFinanceSearchCoCode | 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. |
|
| Status | string |
None. |
|
| InceptionDate | date |
None. |
|
| CreateDate | date |
None. |
|
| PolicyTerm | integer |
None. |
|
| PolicyTermFormatted | string |
None. |
|
| BinderId | string |
None. |
|
| InsuredType | string |
None. |
|
| LineOfBusinesses | Collection of PolicyLineOfBusiness |
None. |
|
| AdditionalPolicyStatus | string |
None. |
|
| PercentageChange | decimal number |
None. |
|
| ProductName | string |
None. |
|
| LastChangeUserId | globally unique identifier |
None. |
|
| LastChangeUserName | string |
None. |
|
| PrimaryOfficeDatabaseId | globally unique identifier |
None. |
|
| ReferralSourceDatabaseId | globally unique identifier |
None. |
|
| ReferralSourceName | string |
None. |
|
| LeadSources | Collection of InsuredBasic |
None. |
|
| Origin | string |
None. |
|
| FinanceCompany | InsuredBasic |
None. |
|
| AlternativePolicyNumber | string |
None. |
|
| ApprovedForCommissions | boolean |
None. |
|
| ApprovedForCommissionsDate | date |
None. |