HOS Export Driver Clock by Depot ID
Available in PIT v2.3
This ILE API wraps the HOS Export Driver Clock by Depot ID web service. See its documentation for a further explanation of the input and output parameters, as well as the possible error conditions.
API Name: HSDRVCD
Parameter Interface:
| Parameter | Direction | Type | Length | Precision | Description |
|---|---|---|---|---|---|
| Driver ID | Input | Character | 50 | n/a | Identifier for the driver |
| Depot ID | Input | Character | 50 | n/a | Depot ID |
| Time Resolution | Input | Character | 1 | n/a | This parameter specifies whether certain values in the response are returned in seconds or minutes, where '1' = Values are returned in seconds, and '0' = values are returned in minutes. |
| Clock array | Output | Character | n/a | n/a | An array of 20,000 driver clock 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 clock array entries which weren't returned. See the HSDRVCLKARR and HSCLKEXPORT external structures defined in the HSDRVCDDS copy file which further describes the output parameter data. |
| Clock array element count | Output | Decimal | 5 | 0 | Number of non-null elements in the clock output array |
| Output Depot ID | Output | Character | 50 | n/a | Output depot 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 driver's details were returned successfully.
Driver Clock Export Structure (hsClkExport DS defined in HSDRVCDDS copy file):
This data structure may be mapped over each of the 20,000 elements of the driver export clock array output parameter. The array contains a fixed number of elements (20,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 clock array entries which weren't returned.:
| Field | Type | Length | Precision | Description |
|---|---|---|---|---|
| expDRIVR | Character | 50 | varying | Driver Id |
| expRESTBR | Character | 50 | varying | Day Rest Break |
| expDAYDR | Character | 50 | varying | Day Drive |
| expDAYDUT | Character | 50 | varying | Day Duty |
| expWEEKDU | Character | 50 | varying | Week Duty |
| expDAYOFF | Character | 50 | varying | Day Off |
| expSHIFT | Character | 50 | varying | Shift |
| expWRKLFT | Character | 50 | varying | Work Left |
| exp24R | Character | 1 | n/a | 24hr Reset Enabled (0=disable, 1=enabled) |
| expOIL | Character | 1 | n/a | Wait In Oil Well Enabled (0=disable, 1=enabled) |
| expHAZ | Character | 1 | n/a | Hazmat Load Enabled (0=disable, 1=enabled) |
| expLASTA | Character | 19 | varying | Last Avail Hours Recalc (YYYY-MM-DDTHH:MM:SS) |
| expUSD | Character | 50 | varying | US Duty Cycle |
| expCAND | Character | 50 | varying | CAN Duty Cycle |
| expRULE | Character | 50 | varying | Current Rule Set |
| expCRT | Character | 19 | varying | Cycle Reset Time (YYYY-MM-DDTHH:MM:SS) |
| expNQC | Character | 19 | varying | Next Qual Us Cycle Reset (YYYY-MM-DDTHH:MM:SS) |
| expCAD | Character | 50 | varying | Contig Activ Duration |
| expCND | Character | 50 | varying | Contig Nonworking Duration |
| expRSTEXP | Character | 1 | n/a | Rest Break Exemp Enabled (0=disable, 1=enabled) |
| expRSTCUR | Character | 1 | n/a | Curr Using Rest Break Exemp (0=disable, 1=enabled) |