Get Vehicle Information

Last updated
Save as PDF

getVehicleInformation

Given a vehicle identifier, return select status-related attributes of the vehicle in a VehicleInfo object. The purpose of this method is to return information about the specified vehicle including current location, connected trailers (if TrailerTRACS is licensed and enabled), drivers, message statistics, coverage and group assignments, etc. Most of the information returned by this method is information that may change over time. It represents the current status of the vehicle.

VehicleInfo getVehicleInformation(AssetIdentifier vehicle) throws WSException

vehicle: A QTWebServices AssetIdentifier that contains the identifier of the vehicle whose status information will be retrieved.

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

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>

<getVehicleInformation>

<vehicle xmlns="">

<id>A26984</id>

<scac> </scac>

</vehicle>

</getVehicleInformation>

</soap:Body>

Sample XML Response

<soapenv:Body>

<getVehicleInformationResponse>

<getVehicleInformationReturn>

<auxiliaryAccount />

<auxVehicle>0</auxVehicle>

<coverage>PINELIST</coverage>

<customerAccount>0022641664</customerAccount>

<customerReference />

<driver1 />

<driver2 />

<firmwareVersion>23.02</firmwareVersion>

<ignitionStatus>1</ignitionStatus>

<JTRACSEnabled>0</JTRACSEnabled>

<latitude>40.15611111111111</latitude>

<longitude>-75.8275</longitude>

<messageGroup1 />

<messageGroup2 />

<messageGroup3 />

<messageGroup4 />

<name>AUTO-CREATED</name>

<NCharacters>8465</NCharacters>

<NDrivers>0</NDrivers>

<newVehicle>1</newVehicle>

<NMessageGroups>0</NMessageGroups>

<NMessages>201</NMessages>

<NTrailers>0</NTrailers>

<positionHardware>GPS</positionHardware>

<STRACSEnabled>0</STRACSEnabled>

<timeLastModified>2006-04-12T18:54:09Z</timeLastModified>

<timePositionReport>2006-05-10T20:26:14Z</timePositionReport>

<timeStatisticsReset>2006-03-06T21:42:21Z</timeStatisticsReset>

<trailer1>

<id />

<scac />

</trailer1>

<trailer2>

<id />

<scac />

</trailer2>

<tripStatus>2</tripStatus>

<TTRACSEnabled>1</TTRACSEnabled>

<unitAddress>0049726984</unitAddress>

<userLastModified>LBLANK</userLastModified>

<proximityCity>

<city>Reading</city>

<country>US</country>

<direction>SSE</direction>

<distance>13.76</distance>

<placeName xsi:nil="true" />

<placeType>CITY</placeType>

<state>PA</state>

<zip>19601</zip>

</proximityCity>

<proximityTown>

<city>Elverson</city>

<country>US</country>

<direction>AT</direction>

<distance>0.0</distance>

<placeName xsi:nil="true" />

<placeType>TOWN</placeType>

<state>PA</state>

<zip>19520</zip>

</proximityTown>

<vehicle>

<id>A26984</id>

<scac />

</vehicle>

</getVehicleInformationReturn>

</p861:getVehicleInformationResponse>

</soapenv:Body>

Exceptions

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