POST api/Policy/PolicyProperties?Active={Active}
Policy properties list endpoint.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
Active |
By default both active/inactive. If Active is true then only active properties, else inactive properties are returned. |
boolean |
None. |
Body Parameters
List of policies database Ids.
PolicyDataBaseIdsName | Description | Type | Additional information |
---|---|---|---|
PolicyDataBaseId | Collection of globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{ "policyDataBaseId": [ "c3f32bc6-3c8c-475d-9378-2fb02703ad71", "de9046bd-8e93-44ad-9c85-c6f11cbb0d9e" ] }
application/xml, text/xml
Sample:
<PolicyDataBaseIds xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.OData"> <PolicyDataBaseId xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d2p1:guid>c3f32bc6-3c8c-475d-9378-2fb02703ad71</d2p1:guid> <d2p1:guid>de9046bd-8e93-44ad-9c85-c6f11cbb0d9e</d2p1:guid> </PolicyDataBaseId> </PolicyDataBaseIds>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
List of PolicyProperty against given policies database Ids.
PolicyPropertyName | Description | Type | Additional information |
---|---|---|---|
DatabaseId | globally unique identifier |
None. |
|
AddressLine1 | string |
None. |
|
AddressLine2 | string |
None. |
|
BuildingNumber | string |
None. |
|
City | string |
None. |
|
County | string |
None. |
|
Description | string |
None. |
|
State | string |
None. |
|
Zip | string |
None. |
|
CoveragesXML | string |
None. |
|
Coverages | Collection of CoverageBasic |
None. |
|
PolicyDatabaseId | globally unique identifier |
None. |
|
Visible | boolean |
None. |
|
Active | boolean |
None. |
|
LienHolders | Collection of PropertyLienHolder |
None. |
Response Formats
application/json, text/json
Sample:
{ "databaseId": "3bb043bf-251d-49a7-971e-76868afbab5f", "addressLine1": "sample string 2", "addressLine2": "sample string 3", "buildingNumber": "sample string 4", "city": "sample string 5", "county": "sample string 6", "description": "sample string 7", "state": "sample string 8", "zip": "sample string 9", "coveragesXML": "sample string 10", "coverages": [ { "name": "sample string 1", "typeCode": "sample string 2", "limits": [ 1.0, 2.0 ], "limitFormatted": "sample string 3", "deductibles": [ 1.0, 2.0 ], "deductiblesFormatted": "sample string 4", "premium": 5.0 }, { "name": "sample string 1", "typeCode": "sample string 2", "limits": [ 1.0, 2.0 ], "limitFormatted": "sample string 3", "deductibles": [ 1.0, 2.0 ], "deductiblesFormatted": "sample string 4", "premium": 5.0 } ], "policyDatabaseId": "37a47b0d-2389-42cc-8df0-241b0494a964", "visible": true, "active": true, "lienHolders": [ { "buildingId": "d95a90cd-35e7-4973-99d6-ef17af31d6bb", "certificateHolderId": "8bcb8bda-159e-46f4-b779-23e0242b1ac5", "name": "sample string 3", "email": "sample string 4", "fax": "sample string 5", "addressLine1": "sample string 6", "city": "sample string 7", "state": "sample string 8", "natureOfInterestEnumValue": 1, "natureOfInterestDescriptionValue": "sample string 9", "additionalInterests": [ { "certificateHolderId": "ea50a222-2333-44bc-9e11-36272f8059b4", "truckingCompanyId": "df3eff38-775f-4c2f-8870-731c977e1d72", "loanNumber": "sample string 3" }, { "certificateHolderId": "ea50a222-2333-44bc-9e11-36272f8059b4", "truckingCompanyId": "df3eff38-775f-4c2f-8870-731c977e1d72", "loanNumber": "sample string 3" } ] }, { "buildingId": "d95a90cd-35e7-4973-99d6-ef17af31d6bb", "certificateHolderId": "8bcb8bda-159e-46f4-b779-23e0242b1ac5", "name": "sample string 3", "email": "sample string 4", "fax": "sample string 5", "addressLine1": "sample string 6", "city": "sample string 7", "state": "sample string 8", "natureOfInterestEnumValue": 1, "natureOfInterestDescriptionValue": "sample string 9", "additionalInterests": [ { "certificateHolderId": "ea50a222-2333-44bc-9e11-36272f8059b4", "truckingCompanyId": "df3eff38-775f-4c2f-8870-731c977e1d72", "loanNumber": "sample string 3" }, { "certificateHolderId": "ea50a222-2333-44bc-9e11-36272f8059b4", "truckingCompanyId": "df3eff38-775f-4c2f-8870-731c977e1d72", "loanNumber": "sample string 3" } ] } ] }
application/xml, text/xml
Sample:
<PolicyProperty xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum"> <Active>true</Active> <AddressLine1>sample string 2</AddressLine1> <AddressLine2>sample string 3</AddressLine2> <BuildingNumber>sample string 4</BuildingNumber> <City>sample string 5</City> <County>sample string 6</County> <Coverages xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum.Coverage"> <d2p1:CoverageBasic> <d2p1:Deductibles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:decimal>1</d4p1:decimal> <d4p1:decimal>2</d4p1:decimal> </d2p1:Deductibles> <d2p1:DeductiblesFormatted>sample string 4</d2p1:DeductiblesFormatted> <d2p1:LimitFormatted>sample string 3</d2p1:LimitFormatted> <d2p1:Limits xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:decimal>1</d4p1:decimal> <d4p1:decimal>2</d4p1:decimal> </d2p1:Limits> <d2p1:Name>sample string 1</d2p1:Name> <d2p1:Premium>5</d2p1:Premium> <d2p1:TypeCode>sample string 2</d2p1:TypeCode> </d2p1:CoverageBasic> <d2p1:CoverageBasic> <d2p1:Deductibles xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:decimal>1</d4p1:decimal> <d4p1:decimal>2</d4p1:decimal> </d2p1:Deductibles> <d2p1:DeductiblesFormatted>sample string 4</d2p1:DeductiblesFormatted> <d2p1:LimitFormatted>sample string 3</d2p1:LimitFormatted> <d2p1:Limits xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays"> <d4p1:decimal>1</d4p1:decimal> <d4p1:decimal>2</d4p1:decimal> </d2p1:Limits> <d2p1:Name>sample string 1</d2p1:Name> <d2p1:Premium>5</d2p1:Premium> <d2p1:TypeCode>sample string 2</d2p1:TypeCode> </d2p1:CoverageBasic> </Coverages> <CoveragesXML>sample string 10</CoveragesXML> <DatabaseId>3bb043bf-251d-49a7-971e-76868afbab5f</DatabaseId> <Description>sample string 7</Description> <LienHolders xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessEntities.OData"> <d2p1:PropertyLienHolder> <d2p1:AdditionalInterests> <d2p1:AdditionalInterest> <d2p1:CertificateHolderId>ea50a222-2333-44bc-9e11-36272f8059b4</d2p1:CertificateHolderId> <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber> <d2p1:TruckingCompanyId>df3eff38-775f-4c2f-8870-731c977e1d72</d2p1:TruckingCompanyId> </d2p1:AdditionalInterest> <d2p1:AdditionalInterest> <d2p1:CertificateHolderId>ea50a222-2333-44bc-9e11-36272f8059b4</d2p1:CertificateHolderId> <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber> <d2p1:TruckingCompanyId>df3eff38-775f-4c2f-8870-731c977e1d72</d2p1:TruckingCompanyId> </d2p1:AdditionalInterest> </d2p1:AdditionalInterests> <d2p1:AddressLine1>sample string 6</d2p1:AddressLine1> <d2p1:BuildingId>d95a90cd-35e7-4973-99d6-ef17af31d6bb</d2p1:BuildingId> <d2p1:CertificateHolderId>8bcb8bda-159e-46f4-b779-23e0242b1ac5</d2p1:CertificateHolderId> <d2p1:City>sample string 7</d2p1:City> <d2p1:Email>sample string 4</d2p1:Email> <d2p1:Fax>sample string 5</d2p1:Fax> <d2p1:Name>sample string 3</d2p1:Name> <d2p1:NatureOfInterestDescriptionValue>sample string 9</d2p1:NatureOfInterestDescriptionValue> <d2p1:NatureOfInterestEnumValue>1</d2p1:NatureOfInterestEnumValue> <d2p1:State>sample string 8</d2p1:State> </d2p1:PropertyLienHolder> <d2p1:PropertyLienHolder> <d2p1:AdditionalInterests> <d2p1:AdditionalInterest> <d2p1:CertificateHolderId>ea50a222-2333-44bc-9e11-36272f8059b4</d2p1:CertificateHolderId> <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber> <d2p1:TruckingCompanyId>df3eff38-775f-4c2f-8870-731c977e1d72</d2p1:TruckingCompanyId> </d2p1:AdditionalInterest> <d2p1:AdditionalInterest> <d2p1:CertificateHolderId>ea50a222-2333-44bc-9e11-36272f8059b4</d2p1:CertificateHolderId> <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber> <d2p1:TruckingCompanyId>df3eff38-775f-4c2f-8870-731c977e1d72</d2p1:TruckingCompanyId> </d2p1:AdditionalInterest> </d2p1:AdditionalInterests> <d2p1:AddressLine1>sample string 6</d2p1:AddressLine1> <d2p1:BuildingId>d95a90cd-35e7-4973-99d6-ef17af31d6bb</d2p1:BuildingId> <d2p1:CertificateHolderId>8bcb8bda-159e-46f4-b779-23e0242b1ac5</d2p1:CertificateHolderId> <d2p1:City>sample string 7</d2p1:City> <d2p1:Email>sample string 4</d2p1:Email> <d2p1:Fax>sample string 5</d2p1:Fax> <d2p1:Name>sample string 3</d2p1:Name> <d2p1:NatureOfInterestDescriptionValue>sample string 9</d2p1:NatureOfInterestDescriptionValue> <d2p1:NatureOfInterestEnumValue>1</d2p1:NatureOfInterestEnumValue> <d2p1:State>sample string 8</d2p1:State> </d2p1:PropertyLienHolder> </LienHolders> <PolicyDatabaseId>37a47b0d-2389-42cc-8df0-241b0494a964</PolicyDatabaseId> <State>sample string 8</State> <Visible>true</Visible> <Zip>sample string 9</Zip> </PolicyProperty>