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": [ "6db6dbf7-25ce-4405-a1a5-2a7b89ad93b7", "7f92c256-981e-4c65-ae97-be7602d2dad7" ] }
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>6db6dbf7-25ce-4405-a1a5-2a7b89ad93b7</d2p1:guid> <d2p1:guid>7f92c256-981e-4c65-ae97-be7602d2dad7</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. |
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": "2023-06-04T09:12:37.1234708-05:00", "maritalStatusCode": 0, "gender": 0, "databaseId": "75c021cd-2357-4f73-92e0-c7a66fea0a3a", "licenseNumber": "sample string 4", "licenseState": "sample string 5", "licenseYear": 1 }, { "firstName": "sample string 1", "lastName": "sample string 2", "birthday": "2023-06-04T09:12:37.1234708-05:00", "maritalStatusCode": 0, "gender": 0, "databaseId": "75c021cd-2357-4f73-92e0-c7a66fea0a3a", "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": "182260ae-513d-4a99-af99-f6a0468f1d01", "type": "sample string 7", "typeOfUseAsFlag": 1, "policyDatabaseId": "f8b95883-471e-46b3-af8f-427f6b5d8e58", "lienHolders": [ { "vehicleId": "e489a469-6b5d-4ce3-9a0f-3f3cb4ad1f0e", "certificateHolderId": "1c989a86-70b0-41ab-a90f-32abc56d8fec", "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": "7e5c2370-2130-4302-b536-e575be38bb49", "truckingCompanyId": "5c57b51d-3490-4c84-afee-2b7ed8dc6e4d", "loanNumber": "sample string 3" }, { "certificateHolderId": "7e5c2370-2130-4302-b536-e575be38bb49", "truckingCompanyId": "5c57b51d-3490-4c84-afee-2b7ed8dc6e4d", "loanNumber": "sample string 3" } ] }, { "vehicleId": "e489a469-6b5d-4ce3-9a0f-3f3cb4ad1f0e", "certificateHolderId": "1c989a86-70b0-41ab-a90f-32abc56d8fec", "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": "7e5c2370-2130-4302-b536-e575be38bb49", "truckingCompanyId": "5c57b51d-3490-4c84-afee-2b7ed8dc6e4d", "loanNumber": "sample string 3" }, { "certificateHolderId": "7e5c2370-2130-4302-b536-e575be38bb49", "truckingCompanyId": "5c57b51d-3490-4c84-afee-2b7ed8dc6e4d", "loanNumber": "sample string 3" } ] } ] }
application/xml, text/xml
Sample:
<PolicyVehicles xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BusinessEntities.NowCertsFulcrum"> <DatabaseId>182260ae-513d-4a99-af99-f6a0468f1d01</DatabaseId> <Drivers> <DriverBasic> <Birthday>2023-06-04T09:12:37.1234708-05:00</Birthday> <DatabaseId>75c021cd-2357-4f73-92e0-c7a66fea0a3a</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>2023-06-04T09:12:37.1234708-05:00</Birthday> <DatabaseId>75c021cd-2357-4f73-92e0-c7a66fea0a3a</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>7e5c2370-2130-4302-b536-e575be38bb49</d2p1:CertificateHolderId> <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber> <d2p1:TruckingCompanyId>5c57b51d-3490-4c84-afee-2b7ed8dc6e4d</d2p1:TruckingCompanyId> </d2p1:AdditionalInterest> <d2p1:AdditionalInterest> <d2p1:CertificateHolderId>7e5c2370-2130-4302-b536-e575be38bb49</d2p1:CertificateHolderId> <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber> <d2p1:TruckingCompanyId>5c57b51d-3490-4c84-afee-2b7ed8dc6e4d</d2p1:TruckingCompanyId> </d2p1:AdditionalInterest> </d2p1:AdditionalInterests> <d2p1:AddressLine1>sample string 6</d2p1:AddressLine1> <d2p1:CertificateHolderId>1c989a86-70b0-41ab-a90f-32abc56d8fec</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>e489a469-6b5d-4ce3-9a0f-3f3cb4ad1f0e</d2p1:VehicleId> </d2p1:VehicleLienHolder> <d2p1:VehicleLienHolder> <d2p1:AdditionalInterests> <d2p1:AdditionalInterest> <d2p1:CertificateHolderId>7e5c2370-2130-4302-b536-e575be38bb49</d2p1:CertificateHolderId> <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber> <d2p1:TruckingCompanyId>5c57b51d-3490-4c84-afee-2b7ed8dc6e4d</d2p1:TruckingCompanyId> </d2p1:AdditionalInterest> <d2p1:AdditionalInterest> <d2p1:CertificateHolderId>7e5c2370-2130-4302-b536-e575be38bb49</d2p1:CertificateHolderId> <d2p1:LoanNumber>sample string 3</d2p1:LoanNumber> <d2p1:TruckingCompanyId>5c57b51d-3490-4c84-afee-2b7ed8dc6e4d</d2p1:TruckingCompanyId> </d2p1:AdditionalInterest> </d2p1:AdditionalInterests> <d2p1:AddressLine1>sample string 6</d2p1:AddressLine1> <d2p1:CertificateHolderId>1c989a86-70b0-41ab-a90f-32abc56d8fec</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>e489a469-6b5d-4ce3-9a0f-3f3cb4ad1f0e</d2p1:VehicleId> </d2p1:VehicleLienHolder> </LienHolders> <Make>sample string 3</Make> <Model>sample string 2</Model> <PolicyDatabaseId>f8b95883-471e-46b3-af8f-427f6b5d8e58</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> <Year>1</Year> </PolicyVehicles>