Get Vehicle Identification

Last updated
Save as PDF

getVehicleIdentification

Given a vehicle identifier, returns information used to identify the vehicle, including the SCAC, ID, name, VIN, and license plate of the vehicle.

AssetIdentification getVehicleIdentification(String companyId, AssetIdentifier vehicle) throws WSException

companyId: A string of maximum length 10 that specifies the unique company identifier.
vehicle: An AssetIdentifier object containing the SCAC and ID of the vehicle whose identification information is to be returned.

Returns an AssetIdentification object containing the SCAC, ID, name, VIN, and license plate of the vehicle.

Authorization Requirements

The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.

Required Application Licenses
- Remote Integration

Required User Permissions
- Can use QTRACS
- Can see data for all assets OR the vehicle must be in the user's coverage or global group

Customer integrators are authorized to their own company's data only.

Sample XML Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

<soap:Body>

<getVehicleIdentification>

<companyId>MYCOMPANY</companyId>

<vehicle>

<id>OAKSTMCT</id>

<scac></scac>

</vehicle>

</getVehicleIdentification>

</soap:Body>

Sample XML Response

<soapenv:Body>

<getVehicleIdentificationResponse>

<getVehicleIdentificationReturn>

<scac></scac>

<id>ATOM92426</id>

<name>A vehicle name</name>

<vin>1G6CD5183H4333111</vin>

<licensePlate>

<number>FHN3423</number>

<jurisdiction>US-PA</jurisdiction>

</licensePlate>

</getVehicleIdentificationReturn>

</getVehicleIdentificationResponse>

</soapenv:Body>

Exceptions

002 Required field not specified.
003 Company not authorized for integration.
004 User is not authorized.
005 Invalid company id.
006 SCAC is required.
007 SCAC is invalid.
008 Vehicle ID is required.
009 Vehicle not found.