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.
PolicyDataBaseIds| Name | Description | Type | Additional information |
|---|---|---|---|
| PolicyDataBaseId | Collection of globally unique identifier |
None. |
Request Formats
application/json, text/json
Sample:
{
"policyDataBaseId": [
"d99c4f47-5199-42f8-a7b8-b91d661d4fdd",
"617f1e74-aae3-4f41-98ef-deb4365cb986"
]
}
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>d99c4f47-5199-42f8-a7b8-b91d661d4fdd</d2p1:guid>
<d2p1:guid>617f1e74-aae3-4f41-98ef-deb4365cb986</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.
PolicyProperty| Name | 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": "9fb4d6e3-2dd1-446d-a362-ddbb46015e92",
"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": "7e09f859-fba1-4882-bfe3-78e15a71a121",
"visible": true,
"active": true,
"lienHolders": [
{
"buildingId": "5a08ab2d-6dea-4c54-b3a4-be01364fb934",
"certificateHolderId": "ee447579-2362-4f39-858d-e1fe90719ef4",
"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",
"loanNumber": "sample string 10",
"additionalInterests": [
{
"certificateHolderId": "2287e35a-117e-4762-b6bd-c3aa87732f7e",
"truckingCompanyId": "38b16a28-0f55-4be2-b5c6-27567e7db357",
"loanNumber": "sample string 3"
},
{
"certificateHolderId": "2287e35a-117e-4762-b6bd-c3aa87732f7e",
"truckingCompanyId": "38b16a28-0f55-4be2-b5c6-27567e7db357",
"loanNumber": "sample string 3"
}
]
},
{
"buildingId": "5a08ab2d-6dea-4c54-b3a4-be01364fb934",
"certificateHolderId": "ee447579-2362-4f39-858d-e1fe90719ef4",
"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",
"loanNumber": "sample string 10",
"additionalInterests": [
{
"certificateHolderId": "2287e35a-117e-4762-b6bd-c3aa87732f7e",
"truckingCompanyId": "38b16a28-0f55-4be2-b5c6-27567e7db357",
"loanNumber": "sample string 3"
},
{
"certificateHolderId": "2287e35a-117e-4762-b6bd-c3aa87732f7e",
"truckingCompanyId": "38b16a28-0f55-4be2-b5c6-27567e7db357",
"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>9fb4d6e3-2dd1-446d-a362-ddbb46015e92</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>2287e35a-117e-4762-b6bd-c3aa87732f7e</d2p1:CertificateHolderId>
<d2p1:LoanNumber>sample string 3</d2p1:LoanNumber>
<d2p1:TruckingCompanyId>38b16a28-0f55-4be2-b5c6-27567e7db357</d2p1:TruckingCompanyId>
</d2p1:AdditionalInterest>
<d2p1:AdditionalInterest>
<d2p1:CertificateHolderId>2287e35a-117e-4762-b6bd-c3aa87732f7e</d2p1:CertificateHolderId>
<d2p1:LoanNumber>sample string 3</d2p1:LoanNumber>
<d2p1:TruckingCompanyId>38b16a28-0f55-4be2-b5c6-27567e7db357</d2p1:TruckingCompanyId>
</d2p1:AdditionalInterest>
</d2p1:AdditionalInterests>
<d2p1:AddressLine1>sample string 6</d2p1:AddressLine1>
<d2p1:BuildingId>5a08ab2d-6dea-4c54-b3a4-be01364fb934</d2p1:BuildingId>
<d2p1:CertificateHolderId>ee447579-2362-4f39-858d-e1fe90719ef4</d2p1:CertificateHolderId>
<d2p1:City>sample string 7</d2p1:City>
<d2p1:Email>sample string 4</d2p1:Email>
<d2p1:Fax>sample string 5</d2p1:Fax>
<d2p1:LoanNumber>sample string 10</d2p1:LoanNumber>
<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>2287e35a-117e-4762-b6bd-c3aa87732f7e</d2p1:CertificateHolderId>
<d2p1:LoanNumber>sample string 3</d2p1:LoanNumber>
<d2p1:TruckingCompanyId>38b16a28-0f55-4be2-b5c6-27567e7db357</d2p1:TruckingCompanyId>
</d2p1:AdditionalInterest>
<d2p1:AdditionalInterest>
<d2p1:CertificateHolderId>2287e35a-117e-4762-b6bd-c3aa87732f7e</d2p1:CertificateHolderId>
<d2p1:LoanNumber>sample string 3</d2p1:LoanNumber>
<d2p1:TruckingCompanyId>38b16a28-0f55-4be2-b5c6-27567e7db357</d2p1:TruckingCompanyId>
</d2p1:AdditionalInterest>
</d2p1:AdditionalInterests>
<d2p1:AddressLine1>sample string 6</d2p1:AddressLine1>
<d2p1:BuildingId>5a08ab2d-6dea-4c54-b3a4-be01364fb934</d2p1:BuildingId>
<d2p1:CertificateHolderId>ee447579-2362-4f39-858d-e1fe90719ef4</d2p1:CertificateHolderId>
<d2p1:City>sample string 7</d2p1:City>
<d2p1:Email>sample string 4</d2p1:Email>
<d2p1:Fax>sample string 5</d2p1:Fax>
<d2p1:LoanNumber>sample string 10</d2p1:LoanNumber>
<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>7e09f859-fba1-4882-bfe3-78e15a71a121</PolicyDatabaseId>
<State>sample string 8</State>
<Visible>true</Visible>
<Zip>sample string 9</Zip>
</PolicyProperty>