HOS Add Driver (Extended)
Available in PIT v2.3
This ILE API wraps the HOS Add Driver Extended web service. See its documentation for a further explanation of the input and output parameters, as well as the possible error conditions.
API Name: HSDRVAX
Parameter Interface:
| Parameter | Direction | Type | Length | Precision | Description |
|---|---|---|---|---|---|
| Driver Add/Update Extended | Input | DS | n/a | n/a | See the Driver Add/Update Extended structure below |
| 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 Add/Update Extended Structure (HSDRVUXDS):
This DS is used by the caller of the HOS Add Driver Extended web service wrapper to optionally specify one or more fields to be updated.
The caller MUST initialize (clear) the DS prior to use. This will zero the lengths of each field. Fields with zero lengths are considered null and will not be included in the update request sent to the web service.
The caller MUST assign values to each of the fields being updated. Note that it is up to the caller to ensure the validity of the field values and field combinations. Fields that are NOT being updated MUST be left in their initialized states i.e. zero lengths.
The caller MUST always specify the DriverID field - null or blank values are not valid.
| Field | Type | Length | Precision | Description |
|---|---|---|---|---|
| DriverId | Character Varying | 100 | n/a | Always required |
| DrvPortalPin | Character Varying | 100 | n/a | Optional portal PIN |
| UpdDriverId | Character Varying | 100 | n/a | Optional new driver ID |
| Password | Character Varying | 100 | n/a | Optional password |
| LastName | Character Varying | 100 | n/a | Optional last name |
| FirstName | Character Varying | 100 | n/a | Optional first name |
| DepotId | Character Varying | 100 | n/a | Optional depot id |
| DriverGroup | Character Varying Dim(20) | 100 | n/a | Optional driver groups up to 20 |
| InOffDutyPol | Character Varying | 100 | n/a | Optional off duty policy |
| EnaCanRules | Character Varying | 100 | n/a | Optional enable Canadian rules |
| DefRuleSet | Character Varying | 100 | n/a | Optional default rule set |
| USDefDutyCy | Character Varying | 100 | n/a | Optional US default duty cycle |
| CANDefDutyCy | Character Varying | 100 | n/a | Optional Canadian default duty cycle |
| WaitInOilWell | Character Varying | 100 | n/a | Optional driver can wait in oil well |
| Reset24Hr | Character Varying | 100 | n/a | Optional 24 hour reset |
| HazmatLdHaul | Character Varying | 100 | n/a | Optional hazmat load haul |
| EnaRestBrkEx | Character Varying | 100 | n/a | Optional enable rest break exemption |
| ELDExempt | Character Varying | 100 | n/a | Optional ELD exemption "1' = True, "0" = False |
| ELDExemptRea | Character Varying | 100 | n/a | Optional ELD exemption reason |
| CDL | Character Varying | 100 | n/a | Optional Commercial driver license number |
| CDLState | Character Varying | 100 | n/a | Optional CDL issuing authority |