HOS Get Roll Off Time by Depot ID
Available in PIT v2.3
This ILE API wraps the HOS Get Roll Off Time 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: HSDRVRO
Parameter Interface:
|
Parameter |
Direction |
Type |
Length |
Precision |
Description |
|---|---|---|---|---|---|
|
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. |
|
Roll Off Time array |
Output |
Character |
n/a |
n/a |
An array of 20,000 driver roll off time 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 roll off time array entries which weren't returned. See the HSROLLOFFLIST external structure defined in the HSDRVRODS copy file which further describes the output parameter data. |
|
Roll Off Time array element count |
Output |
Decimal |
5 |
0 |
Number of non-null elements in the roll off time output array |
|
Output |
Decimal |
3 |
0 |
Error Category, if any |
|
|
Output |
Decimal |
5 |
0 |
Error Code, if any |
|
|
Output |
Character |
150 varying |
n/a |
Error description, if any |
An error category of 0 means that the roll off times were returned successfully.
Driver Roll Off Time Export Structure (hsRollOffList DS defined in HSDRVRODS copy file):
This data structure may be mapped over each of the 20,000 elements of the driver roll off time 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 |
|---|---|---|---|---|
|
roDriverID |
Character |
50 |
varying |
Driver Id |
|
roToday |
Integer |
10 |
0 |
Time (in mins or secs) that will be gained at the end of current day. |
|
roToday |
Integer |
10 |
0 |
Time (in mins or secs) that will be gained at the end of the next day. |