POST api/Policy/PolicyVehicles
Policy vehicles and respective vehicle drivers list endpoint.
Request Information
URI Parameters
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": [ "5e9b0b72-e92e-43a4-b1e0-e7ee20912e40", "f06244be-c9c5-464b-8342-7ed75f5b76cc" ] }
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>5e9b0b72-e92e-43a4-b1e0-e7ee20912e40</d2p1:guid> <d2p1:guid>f06244be-c9c5-464b-8342-7ed75f5b76cc</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.
PolicyVehiclesName | Description | 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": "2025-05-08T19:14:36.7801166-05:00", "maritalStatusCode": 0, "gender": 0, "databaseId": "931a863a-8cc1-4484-b035-190c08e4aaa6", "licenseNumber": "sample string 4", "licenseState": "sample string 5", "licenseYear": 1 }, { "firstName": "sample string 1", "lastName": "sample string 2", "birthday": "2025-05-08T19:14:36.7801166-05:00", "maritalStatusCode": 0, "gender": 0, "databaseId": "931a863a-8cc1-4484-b035-190c08e4aaa6", "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": "a91a9ef4-eb39-4671-a2df-2f7dfd349fb8", "type": "sample string 7", "typeOfUseAsFlag": 1, "policyDatabaseId": "ed9df1af-7ca2-405a-95dc-78536e154681", "lienHolders": [ { "vehicleId": "95f0c0da-6108-46eb-b13f-69d3a7a2c891", "certificateHolderId": "b98e5687-9c0c-454b-a56a-3a400f9d97d6", "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": "71260eda-bfa6-42c1-9e9a-986459e229ab", "truckingCompanyId": "ac915f52-4b22-405e-ab47-0b481bc3a7bd", "loanNumber": "sample string 3" }, { "certificateHolderId": "71260eda-bfa6-42c1-9e9a-986459e229ab", "truckingCompanyId": "ac915f52-4b22-405e-ab47-0b481bc3a7bd", "loanNumber": "sample string 3" } ] }, { "vehicleId": "95f0c0da-6108-46eb-b13f-69d3a7a2c891", "certificateHolderId": "b98e5687-9c0c-454b-a56a-3a400f9d97d6", "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": "71260eda-bfa6-42c1-9e9a-986459e229ab", "truckingCompanyId": "ac915f52-4b22-405e-ab47-0b481bc3a7bd", "loanNumber": "sample string 3" }, { "certificateHolderId": "71260eda-bfa6-42c1-9e9a-986459e229ab", "truckingCompanyId": "ac915f52-4b22-405e-ab47-0b481bc3a7bd", "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>a91a9ef4-eb39-4671-a2df-2f7dfd349fb8</DatabaseId> <Drivers> <DriverBasic> <Birthday>2025-05-08T19:14:36.7801166-05:00</Birthday> <DatabaseId>931a863a-8cc1-4484-b035-190c08e4aaa6</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>2025-05-08T19:14:36.7801166-05:00</Birthday> <DatabaseId>931a863a-8cc1-4484-b035-190c08e4aaa6</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>71260eda-bfa6-42c1-9e9a-986459e229ab</d2p1:CertificateHolderId> <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber> <d2p1:TruckingCompanyId>ac915f52-4b22-405e-ab47-0b481bc3a7bd</d2p1:TruckingCompanyId> </d2p1:AdditionalInterest> <d2p1:AdditionalInterest> <d2p1:CertificateHolderId>71260eda-bfa6-42c1-9e9a-986459e229ab</d2p1:CertificateHolderId> <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber> <d2p1:TruckingCompanyId>ac915f52-4b22-405e-ab47-0b481bc3a7bd</d2p1:TruckingCompanyId> </d2p1:AdditionalInterest> </d2p1:AdditionalInterests> <d2p1:AddressLine1>sample string 6</d2p1:AddressLine1> <d2p1:CertificateHolderId>b98e5687-9c0c-454b-a56a-3a400f9d97d6</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>95f0c0da-6108-46eb-b13f-69d3a7a2c891</d2p1:VehicleId> </d2p1:VehicleLienHolder> <d2p1:VehicleLienHolder> <d2p1:AdditionalInterests> <d2p1:AdditionalInterest> <d2p1:CertificateHolderId>71260eda-bfa6-42c1-9e9a-986459e229ab</d2p1:CertificateHolderId> <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber> <d2p1:TruckingCompanyId>ac915f52-4b22-405e-ab47-0b481bc3a7bd</d2p1:TruckingCompanyId> </d2p1:AdditionalInterest> <d2p1:AdditionalInterest> <d2p1:CertificateHolderId>71260eda-bfa6-42c1-9e9a-986459e229ab</d2p1:CertificateHolderId> <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber> <d2p1:TruckingCompanyId>ac915f52-4b22-405e-ab47-0b481bc3a7bd</d2p1:TruckingCompanyId> </d2p1:AdditionalInterest> </d2p1:AdditionalInterests> <d2p1:AddressLine1>sample string 6</d2p1:AddressLine1> <d2p1:CertificateHolderId>b98e5687-9c0c-454b-a56a-3a400f9d97d6</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>95f0c0da-6108-46eb-b13f-69d3a7a2c891</d2p1:VehicleId> </d2p1:VehicleLienHolder> </LienHolders> <Make>sample string 3</Make> <Model>sample string 2</Model> <PolicyDatabaseId>ed9df1af-7ca2-405a-95dc-78536e154681</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>