HOS Get Vehicles
Available in PIT v2.3
This ILE API wraps the HOS Get Vehicles web service. See its documentation for a further explanation of the input and output parameters, as well as the possible error conditions.
API Name: HSVEHLS
Parameter Interface:
| Parameter | Direction | Type | Length | Precision | Description |
|---|---|---|---|---|---|
| Vehicle array | Output | Character | n/a | n/a | An array of 50,000 vehicle structures as shown below. The number of non-null array entries is returned in a separate output parameter. Fields with zero length values are considered null and represent optional values that weren't returned in the web service response or entire vehicle array entries which weren't returned. See the HSVEHLIST external structure defined in the HSVEHLSDS copy file which further describes the output parameter data. |
| Vehicle array element count | Output | Decimal | 5 | 0 | Number of non-null elements in the vehicle output array |
| 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 a list of vehicles were returned successfully.
Driver Roll Off Time Export Structure (hsVehList DS defined in HSVEHLSDS copy file):
This data structure may be mapped over each of the 50,000 elements of the vehicle array output parameter. The array contains a fixed number of elements (50,000). The number of non-null array entries is returned in a separate output parameter. Fields with zero length values are considered null and represent optional values that weren't returned in the web service response or entire vehicle entries which weren't returned.:
| Field | Type | Length | Precision | Description |
|---|---|---|---|---|
| vid | Character | 50 | varying | Vehicle Id |
| ua | Integer | 10 | 0 | Unified address (aka. the device serial number) |