Driver->AddEx
AddEx (Driver Function)
This function adds one or more driver records. Includes all the possible parameters for the driver.
XML Request
For multiple driver records, each driver must have its own <DriverData> tag. The Add function takes the following input parameters:
| Parameter | Type | Optional | Description | Must be unique? |
|---|---|---|---|---|
| DriverID | String | No | The driver ID for the new driver. Must be unique. Must be at least 4 characters. | Yes |
| DriverPortalPin | String | Yes | The Driver Protal PIN. Applies to customers that use enhanced Drivers Portal security | No |
| UpdateDriverId | String | No | If updating an existing driver ID, the new driver ID. Must be unique. | Yes |
| Password | String | No | The driver's password | No |
| LastName | String | No | The driver's last name. Must be at least 2 characters. | No |
| FirstName | String | No | The driver's first name. Must be at least 2 characters. | No |
| DepotId | Short | Yes | The ID of the depot to which the driver belongs. If the depot does not exist, the Add operation will fail. | No |
| DefaultRuleSet | Enum | Yes | The default driving rule set for this driver; possible values are USA, CANMain, CANNorth, USACalifornia, USAFlorida, USATexas, USAAlaska | No |
| DriverGroup | String | Yes | The group driver belongs to. If more than one, provide each string on a new line within the <DriverGroup> tag |
No |
| InOffDutyDrvPolicy | Enum | Yes | Specifies if the driver is allowed to drive off duty or not. Enable/disable driver's use of Personal Conveyance. Possible values check Feature Enum table. | No |
| WaitingInOilWell | Enum | Yes | Flag that determines if a driver can wait in oil well or not. Possible values check Feature Enum table | No |
| TwentyFourHrReset | Enum | Yes | Flag that determines if a driver can take 24 hour reset or not. Possible values check Feature Enum table | No |
| HazmatLoadHauler | Enum | Yes | Flag that determines if a driver can take a rest break while on duty and carrying hazardous loads. Possible values check Feature Enum table. This setting can be specified at any time and will take effect only when driver is under a rule-set that complies with the US rest break rules | No |
| EnableCanadianRules | Enum | Yes | Flag that determines if a driver is permitted to enable Canadian rules. Default is true | No |
| EnableRestBreakExemption | Enum | Yes | Flag that determines if a driver is permitted to enable the rest break exemption | No |
| USDefaultDutyCycle | Enum | Yes | The driver's default duty cycle for a U.S. rule set; possible values are None (if a Canadian rule set is used), SevenDay, EightDay | No |
| CANDefaultDutyCycle | Enum | Yes | The driver's default duty cycle for a Canadian rule set; possible values are None (if a U.S. rule set is used), SevenDay, FourteenDay | No |
| EnableSixteenHourExemption | Enum | Yes | Flag that determines if a driver is enabled for 16-hour exemption. Default is false | No |
| ELDExempt | Boolean | Yes | Flag indicating driver is exempt from ELD requirements | No |
| ELDExemptReason | String | Yes | Up to 60 characters describing the reason, if driver is exempt. Mandatory if driver is exempt; not used otherwise | No |
| CDL | String | Yes | Commercial driver's license number (up to 20 chars). Must be unique for each account. Attempting to add a new DriverID or FirstName/LastName with a CDL that already belongs to another driver in your account will result in a failure to add the driver. Adding a driver without a CDL is allowed. | Yes |
| CDLState | Enum | Yes | Issuing authority for commercial driver's license | No |
| EnableYardMove | Enum | Yes | Enable/disable driver's use of Yard Move | No |
Feature Enum Table - CDLState
| Enum Value |
|---|
| None |
| Alabama |
| Alaska |
| Arkansas |
| Arizona |
| California |
| Colorado |
| Connecticut |
| DistrictOfColumbia |
| Delaware |
| Florida |
| Georgia |
| Hawaii |
| Iowa |
| Idaho |
| Illinois |
| Indiana |
| Kansas |
| Kentucky |
| Louisiana |
| Massachusetts |
| Maryland |
| Maine |
| Michigan |
| Minnesota |
| Missouri |
| Mississippi |
| Montana |
| NorthCarolina |
| NorthDakota |
| Nebraska |
| NewHampshire |
| NewJersey |
| NewMexico |
| Nevada |
| NewYork |
| Ohio |
| Oklahoma |
| Oregon |
| Pennsylvania |
| RhodeIsland |
| SouthCarolina |
| SouthDakota |
| Tennessee |
| Texas |
| Utah |
| Virginia |
| Vermont |
| Washington |
| Wisconsin |
| WestVirginia |
| Wyoming |
| AmericanSamoa |
| Guam |
| NorthernMarianas |
| PuertoRico |
| VirginIslands |
| Alberta |
| BritishColumbia |
| Manitoba |
| NewBrunswick |
| Newfoundland |
| NovaScotia |
| NorthwestTerritories |
| Ontario |
| PrinceEdwardIsland |
| Quebec |
| Saskatchewan |
| YukonTerritory |
| Aguascalientes |
| BajaCaliforniaNorte |
| BajaCaliforniaSur |
| Coahuila |
| Chihuahua |
| Colima |
| Campeche |
| Chiapas |
| DistritoFederal |
| Durango |
| Guerrero |
| Guanajuato |
| Hidalgo |
| Jalisco |
| Michoacan |
| Morelos |
| Mexico |
| Nayarit |
| NuevoLeon |
| Oaxaca |
| Puebla |
| Queretaro |
| QuintanaRoo |
| Sinaloa |
| SanLuisPotosi |
| Sonora |
| Tamaulipas |
| Tabasco |
| Tlaxcala |
| Veracruz |
| Yucatan |
| Zacatecas |
| Other |
Feature Enum Table - InOffDutyDrvPolicy
| Enum Value | Comment |
|---|---|
| None | Same as not allowed |
| Allowed | Feature allowed |
| NotAllowed | Feature not allowed |
XML Response
The return result contains the Boolean parameter <AddResult>, which indicates whether the addition was successful (true) or not (false), followed by the same data given as input.