Skip to main content
Omnitracs Knowledge Base

Get Vehicle List API

(plus) Available in PIT v2.3

This ILE API wraps the Get Vehicle ID List web service. See its documentation for a further explanation of the input and output parameters, as well as the possible error conditions.

API Name:  QTVEHLST

Parameter Interface:

 

Parameter

 

 

Direction

 

 

Type

 

 

Length

 

 

Precision

 

 

Description

 

Vehicle SCAC

Input

Character

4

n/a

Optional (i.e. non-blank) vehicle SCAC anchor value, used along with a vehicle ID, allowing requests to be positioned alphabetically in the vehicle list.

Vehicle ID

Input

Character

10

n/a

Optional (i.e. non-blank) vehicle ID anchor value, used along with a vehicle SCAC, allowing requests to be positioned alphabetically in the vehicle list.

Number of Vehicles Requested

Input

Decimal

5

0

The number of vehicles requested up to a maximum of 1000. Subsequent anchored calls are required to return customer vehicle lists exceeding 1000 in number.

Number of Vehicles Returned

Output

Decimal

5

0

The number of vehicles returned in the vehicle output arrays. The number may be 0 up to the number of vehicles requested, with a maximum of 1000.

Vehicle SCAC List

Output

Character Array (1000)

4

n/a

An output array of up to 1000 vehicle SCACs

Vehicle ID List

Output

Character Array (1000)

10

n/a

An output array of up to 1000 vehicle IDs. The actual number of non-blank vehicle IDs returned will be indicated by the "Number of Vehicle Returned" output parameter

Vehicle Type List

Output

Character Array (1000)

1

n/a

An output array of up to 1000 vehicle types. See Equipment object documentation for valid type codes.

Vehicle UA List

Output

Character Array (1000)

10

n/a

An output array of up to 1000 vehicle UAs

Error Category

Output

Decimal

3

0

Error Category, if any

Error Code

Output

Decimal

5

0

Error Code, if any

Error Description

Output

Character

150 varying

n/a

Error description, if any

An error category of 0 means that the request was successful.

  • Was this article helpful?