HOS Get Violation Events
Available in PIT v2.3
This ILE API wraps the HOS Get Violation Events web service. See its documentation for a further explanation of the input and output parameters, as well as the possible error conditions.
API Name: HSDRVVE
Parameter Interface:
| Parameter | Direction | Type | Length | Precision | Description |
|---|---|---|---|---|---|
| Event ID | Input | Character | 50 | n/a | Violation event ID or zero value if fetching by start timestamp only |
| Start timestamp | Input | Character | 19 | n/a | Start timestamp value (YYY-MM-DD-HH.MM.SS). Blank value defaults to 24 hours prior to now |
| Violation Event array | Output | Character | n/a | n/a | An array of 1,000 driver violation event 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 violation event array entries which weren't returned. See the HSDRVVIOARR and HSVIOEXPORT external structures defined in the HSDRVVEDS copy file which further describes the output parameter data. |
| Violation event array element count | Output | Decimal | 5 | 0 | Number of non-null elements in the violation event output array |
| Output Next Event ID | Output | Character | 50 | n/a | Output next violation event ID which may be used in subsequent calls |
| 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 call completed successfully.
Driver Violation Event Export Structure (hsVioExport DS defined in HSDRVVEDS copy file):
This data structure may be mapped over each of the 1,000 elements of the driver violation event array output parameter. The array contains a fixed number of elements (1,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 violation event array entries which weren't returned.:
| Field | Type | Length | Precision | Description |
|---|---|---|---|---|
| DriverID | Character | 50 | varying | Driver ID |
| DepotId | Character | 50 | varying | Depot ID (int) |
| EventType | Character | 50 | varying | Event Type (enum) |
| Clock | Character | 50 | varying | Clock (int) |
| EventTime | Character | 19 | varying | Event TS |
| CalcTime | Character | 19 | varying | Calculation TS |
| MinLeftDrive | Character | 50 | varying | Min left to drive (int) |