POST api/Policy/PolicyVehicles

Policy vehicles and respective vehicle drivers list endpoint.

Request Information

URI Parameters

None.

Body Parameters

List of policies database Ids.

Name	Description	Type	Additional information
PolicyDataBaseId		Collection of globally unique identifier	None.

Request Formats

application/json, text/json

Sample:

{
  "policyDataBaseId": [
    "1e6c6b2a-6dc1-4a5b-8434-a0ae0ca9f391",
    "8f6cbc99-32c7-42d3-9630-792e6f4b7c19"
  ]
}

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>1e6c6b2a-6dc1-4a5b-8434-a0ae0ca9f391</d2p1:guid>
    <d2p1:guid>8f6cbc99-32c7-42d3-9630-792e6f4b7c19</d2p1:guid>
  </PolicyDataBaseId>
</PolicyDataBaseIds>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

List of PolicyVehicles against given policies database Ids.

PolicyVehicles

Name	Type	Additional information
VIN	string	None.
Year	integer	None.
Model	string	None.
Make	string	None.
PolicyLevelCoveragesXML	string	None.
VehicleSpecificCoveragesXML	string	None.
Drivers	Collection of DriverBasic	None.
PolicyLevelCoverages	Collection of CoverageBasic	None.
VehicleSpecificCoverages	Collection of CoverageBasic	None.
DatabaseId	globally unique identifier	None.
Type	string	None.
TypeOfUseAsFlag	VehicleTypeOfUse	None.
PolicyDatabaseId	globally unique identifier	None.
LienHolders	Collection of VehicleLienHolder	None.
Visible	boolean	None.
Active	boolean	None.

Response Formats

application/json, text/json

Sample:

{
  "vin": "sample string 1",
  "year": 1,
  "model": "sample string 2",
  "make": "sample string 3",
  "policyLevelCoveragesXML": "sample string 4",
  "vehicleSpecificCoveragesXML": "sample string 5",
  "drivers": [
    {
      "firstName": "sample string 1",
      "lastName": "sample string 2",
      "birthday": "2024-11-21T02:53:40.7481385-06:00",
      "maritalStatusCode": 0,
      "gender": 0,
      "databaseId": "29619b9f-13c3-4f01-9d90-1cbc520ab3a9",
      "licenseNumber": "sample string 4",
      "licenseState": "sample string 5",
      "licenseYear": 1
    },
    {
      "firstName": "sample string 1",
      "lastName": "sample string 2",
      "birthday": "2024-11-21T02:53:40.7481385-06:00",
      "maritalStatusCode": 0,
      "gender": 0,
      "databaseId": "29619b9f-13c3-4f01-9d90-1cbc520ab3a9",
      "licenseNumber": "sample string 4",
      "licenseState": "sample string 5",
      "licenseYear": 1
    }
  ],
  "policyLevelCoverages": [
    {
      "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
    }
  ],
  "vehicleSpecificCoverages": [
    {
      "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
    }
  ],
  "databaseId": "a3a88a3a-a685-4972-ad6b-a20c19489398",
  "type": "sample string 7",
  "typeOfUseAsFlag": 1,
  "policyDatabaseId": "69878dda-f873-461a-8c4f-453f3248d017",
  "lienHolders": [
    {
      "vehicleId": "5c85888a-f305-443c-8c7f-761caa4d7829",
      "certificateHolderId": "4d9980ab-68c0-4713-9cfa-f2b935dd41d1",
      "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": "d59e40e9-1580-40e7-9f54-fc47d592911d",
          "truckingCompanyId": "bb16c59f-cd2c-4c42-ae8f-6d74545aeaa6",
          "loanNumber": "sample string 3"
        },
        {
          "certificateHolderId": "d59e40e9-1580-40e7-9f54-fc47d592911d",
          "truckingCompanyId": "bb16c59f-cd2c-4c42-ae8f-6d74545aeaa6",
          "loanNumber": "sample string 3"
        }
      ]
    },
    {
      "vehicleId": "5c85888a-f305-443c-8c7f-761caa4d7829",
      "certificateHolderId": "4d9980ab-68c0-4713-9cfa-f2b935dd41d1",
      "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": "d59e40e9-1580-40e7-9f54-fc47d592911d",
          "truckingCompanyId": "bb16c59f-cd2c-4c42-ae8f-6d74545aeaa6",
          "loanNumber": "sample string 3"
        },
        {
          "certificateHolderId": "d59e40e9-1580-40e7-9f54-fc47d592911d",
          "truckingCompanyId": "bb16c59f-cd2c-4c42-ae8f-6d74545aeaa6",
          "loanNumber": "sample string 3"
        }
      ]
    }
  ],
  "visible": true,
  "active": true
}

application/xml, text/xml

Sample:

<PolicyVehicles xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum">
  <Active>true</Active>
  <DatabaseId>a3a88a3a-a685-4972-ad6b-a20c19489398</DatabaseId>
  <Drivers>
    <DriverBasic>
      <Birthday>2024-11-21T02:53:40.7481385-06:00</Birthday>
      <DatabaseId>29619b9f-13c3-4f01-9d90-1cbc520ab3a9</DatabaseId>
      <FirstName>sample string 1</FirstName>
      <Gender>M</Gender>
      <LastName>sample string 2</LastName>
      <LicenseNumber>sample string 4</LicenseNumber>
      <LicenseState>sample string 5</LicenseState>
      <LicenseYear>1</LicenseYear>
      <MaritalStatusCode>S</MaritalStatusCode>
    </DriverBasic>
    <DriverBasic>
      <Birthday>2024-11-21T02:53:40.7481385-06:00</Birthday>
      <DatabaseId>29619b9f-13c3-4f01-9d90-1cbc520ab3a9</DatabaseId>
      <FirstName>sample string 1</FirstName>
      <Gender>M</Gender>
      <LastName>sample string 2</LastName>
      <LicenseNumber>sample string 4</LicenseNumber>
      <LicenseState>sample string 5</LicenseState>
      <LicenseYear>1</LicenseYear>
      <MaritalStatusCode>S</MaritalStatusCode>
    </DriverBasic>
  </Drivers>
  <LienHolders xmlns:d2p1="http://schemas.datacontract.org/2004/07/BusinessEntities.OData">
    <d2p1:VehicleLienHolder>
      <d2p1:AdditionalInterests>
        <d2p1:AdditionalInterest>
          <d2p1:CertificateHolderId>d59e40e9-1580-40e7-9f54-fc47d592911d</d2p1:CertificateHolderId>
          <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber>
          <d2p1:TruckingCompanyId>bb16c59f-cd2c-4c42-ae8f-6d74545aeaa6</d2p1:TruckingCompanyId>
        </d2p1:AdditionalInterest>
        <d2p1:AdditionalInterest>
          <d2p1:CertificateHolderId>d59e40e9-1580-40e7-9f54-fc47d592911d</d2p1:CertificateHolderId>
          <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber>
          <d2p1:TruckingCompanyId>bb16c59f-cd2c-4c42-ae8f-6d74545aeaa6</d2p1:TruckingCompanyId>
        </d2p1:AdditionalInterest>
      </d2p1:AdditionalInterests>
      <d2p1:AddressLine1>sample string 6</d2p1:AddressLine1>
      <d2p1:CertificateHolderId>4d9980ab-68c0-4713-9cfa-f2b935dd41d1</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:VehicleId>5c85888a-f305-443c-8c7f-761caa4d7829</d2p1:VehicleId>
    </d2p1:VehicleLienHolder>
    <d2p1:VehicleLienHolder>
      <d2p1:AdditionalInterests>
        <d2p1:AdditionalInterest>
          <d2p1:CertificateHolderId>d59e40e9-1580-40e7-9f54-fc47d592911d</d2p1:CertificateHolderId>
          <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber>
          <d2p1:TruckingCompanyId>bb16c59f-cd2c-4c42-ae8f-6d74545aeaa6</d2p1:TruckingCompanyId>
        </d2p1:AdditionalInterest>
        <d2p1:AdditionalInterest>
          <d2p1:CertificateHolderId>d59e40e9-1580-40e7-9f54-fc47d592911d</d2p1:CertificateHolderId>
          <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber>
          <d2p1:TruckingCompanyId>bb16c59f-cd2c-4c42-ae8f-6d74545aeaa6</d2p1:TruckingCompanyId>
        </d2p1:AdditionalInterest>
      </d2p1:AdditionalInterests>
      <d2p1:AddressLine1>sample string 6</d2p1:AddressLine1>
      <d2p1:CertificateHolderId>4d9980ab-68c0-4713-9cfa-f2b935dd41d1</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:VehicleId>5c85888a-f305-443c-8c7f-761caa4d7829</d2p1:VehicleId>
    </d2p1:VehicleLienHolder>
  </LienHolders>
  <Make>sample string 3</Make>
  <Model>sample string 2</Model>
  <PolicyDatabaseId>69878dda-f873-461a-8c4f-453f3248d017</PolicyDatabaseId>
  <PolicyLevelCoverages 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>
  </PolicyLevelCoverages>
  <PolicyLevelCoveragesXML>sample string 4</PolicyLevelCoveragesXML>
  <Type>sample string 7</Type>
  <TypeOfUseAsFlag>Commercial</TypeOfUseAsFlag>
  <VIN>sample string 1</VIN>
  <VehicleSpecificCoverages 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>
  </VehicleSpecificCoverages>
  <VehicleSpecificCoveragesXML>sample string 5</VehicleSpecificCoveragesXML>
  <Visible>true</Visible>
  <Year>1</Year>
</PolicyVehicles>