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": [
    "b68e8a13-a444-4ef5-8b56-419788b8f825",
    "c0283ab8-801d-454a-aca9-e1b8566607de"
  ]
}

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>b68e8a13-a444-4ef5-8b56-419788b8f825</d2p1:guid>
    <d2p1:guid>c0283ab8-801d-454a-aca9-e1b8566607de</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	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": "6defa0f4-d68d-4029-93bf-482f28c59faf",
  "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": "28ef7173-bbfb-42f4-ad60-9da3a44e5724",
  "visible": true,
  "active": true,
  "lienHolders": [
    {
      "buildingId": "5c3e4f61-8739-470e-b6ac-0f8b11442423",
      "certificateHolderId": "9723a111-fe92-4a6d-b887-6eea31768cfc",
      "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": "f493a3f2-51a7-47e2-ba6d-6223b2ee7fdc",
          "truckingCompanyId": "e5291a7c-019b-420b-b3ad-b0db460e62ef",
          "loanNumber": "sample string 3"
        },
        {
          "certificateHolderId": "f493a3f2-51a7-47e2-ba6d-6223b2ee7fdc",
          "truckingCompanyId": "e5291a7c-019b-420b-b3ad-b0db460e62ef",
          "loanNumber": "sample string 3"
        }
      ]
    },
    {
      "buildingId": "5c3e4f61-8739-470e-b6ac-0f8b11442423",
      "certificateHolderId": "9723a111-fe92-4a6d-b887-6eea31768cfc",
      "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": "f493a3f2-51a7-47e2-ba6d-6223b2ee7fdc",
          "truckingCompanyId": "e5291a7c-019b-420b-b3ad-b0db460e62ef",
          "loanNumber": "sample string 3"
        },
        {
          "certificateHolderId": "f493a3f2-51a7-47e2-ba6d-6223b2ee7fdc",
          "truckingCompanyId": "e5291a7c-019b-420b-b3ad-b0db460e62ef",
          "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>6defa0f4-d68d-4029-93bf-482f28c59faf</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>f493a3f2-51a7-47e2-ba6d-6223b2ee7fdc</d2p1:CertificateHolderId>
          <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber>
          <d2p1:TruckingCompanyId>e5291a7c-019b-420b-b3ad-b0db460e62ef</d2p1:TruckingCompanyId>
        </d2p1:AdditionalInterest>
        <d2p1:AdditionalInterest>
          <d2p1:CertificateHolderId>f493a3f2-51a7-47e2-ba6d-6223b2ee7fdc</d2p1:CertificateHolderId>
          <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber>
          <d2p1:TruckingCompanyId>e5291a7c-019b-420b-b3ad-b0db460e62ef</d2p1:TruckingCompanyId>
        </d2p1:AdditionalInterest>
      </d2p1:AdditionalInterests>
      <d2p1:AddressLine1>sample string 6</d2p1:AddressLine1>
      <d2p1:BuildingId>5c3e4f61-8739-470e-b6ac-0f8b11442423</d2p1:BuildingId>
      <d2p1:CertificateHolderId>9723a111-fe92-4a6d-b887-6eea31768cfc</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>f493a3f2-51a7-47e2-ba6d-6223b2ee7fdc</d2p1:CertificateHolderId>
          <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber>
          <d2p1:TruckingCompanyId>e5291a7c-019b-420b-b3ad-b0db460e62ef</d2p1:TruckingCompanyId>
        </d2p1:AdditionalInterest>
        <d2p1:AdditionalInterest>
          <d2p1:CertificateHolderId>f493a3f2-51a7-47e2-ba6d-6223b2ee7fdc</d2p1:CertificateHolderId>
          <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber>
          <d2p1:TruckingCompanyId>e5291a7c-019b-420b-b3ad-b0db460e62ef</d2p1:TruckingCompanyId>
        </d2p1:AdditionalInterest>
      </d2p1:AdditionalInterests>
      <d2p1:AddressLine1>sample string 6</d2p1:AddressLine1>
      <d2p1:BuildingId>5c3e4f61-8739-470e-b6ac-0f8b11442423</d2p1:BuildingId>
      <d2p1:CertificateHolderId>9723a111-fe92-4a6d-b887-6eea31768cfc</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>28ef7173-bbfb-42f4-ad60-9da3a44e5724</PolicyDatabaseId>
  <State>sample string 8</State>
  <Visible>true</Visible>
  <Zip>sample string 9</Zip>
</PolicyProperty>