Get Vehicle ID List
getVehicleIDList
Given a vehicle identifier (optional) and a number of vehicles to return, this web service returns a list of Equipment objects in alphabetical order by the Vehicle ID.
Equipment[] getVehicleIDList(AssetIdentifier vehicle, int numOfVehicles) throws WSException
- vehicle: A QTWebServices AssetIdentifier containing the SCAC and ID. The returned list will begin after (alphabetically) the vehicle that is specified on the call. When the SCAC and ID inside the AssetIdentier are blank, the list will begin with the first vehicle in alphabetical order by the Vehicle ID.
- numOfVehicles: The number of vehicles to return in the list. The allowed range is 1 to 32766.
Returns a null string on exceptions; otherwise returns an array of Equipment objects.
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.
|
|
Sample XML Response
|
|
Exceptions
002 Required field not specified.
003 Authenticated company not specified.
004 Authenticated user not specified.
005 User is not authorized.
006 SCAC is required.
007 SCAC is invalid.
008 Vehicle ID is invalid.
009 No vehicles found.
010 Invalid number of records specified.