Driver Limitations, CDL Endorsements & Custom Driver Attributes Integration Tips

Last updated
Save as PDF

If you're interested in modifying a driver's limitations, CDL endorsements, or custom attributes read the following paragraphs. Otherwise, set limitations[], endorsements[], and customAttributes[] in the Driver2 to null and these values will not be changed for the driver being modified.

(warning) Note: Changing or deleting existing limitations, cdl endorsements, and custom driver attributes on the QTRACS company settings page will likely require changes to integration code to avoid web service exceptions.

Driver Limitations

A driver's limitations are selected from a company defined list of possible driver limitations; e.g. Cannot drive at night or Prescription Eye wear. The list of possible driver limitations is maintained on the QTRACS company settings page. There are three locations to retrieve the list of possible driver limitation names:

QTRACS Company Settings Page
Driver page in edit mode
getDriverLimitationNames web service

When calling createDriver2 or editDriver2 , fill the limitations[] array in the Driver2 object with the names of the limitations you want assigned to the driver. The order of the limitation names does not matter. The limitations names must be in the list of possible driver limitations. To delete all the driver's limitations set the limitations[] array to blank. Otherwise, set limitations[] to null and the driver's limitations will not be changed.

(warning) Driver limitation names are case-sensitive.

CDL Endorsements

A driver's CDL endorsements are selected from a company defined list of possible cdl endorsements; e.g. T - Double/Triple Trailers, S - School Bus. The list of possible CDL endorsements is maintained on the QTRACS company settings page. There are three locations to retrieve the list of possible CDL endorsement names:

QTRACS Company Settings Page
Driver page in edit mode
getCdlEndorsementNames web service.

When calling createDriver2 or editDriver2 , fill the cdlEndorsements[] array in the Driver2 object with the names of the CDL endorsements you want assigned to the driver. The order of the CDL endorsement names does not matter. The CDL endorsement names must be in list of possible CDL endorsements. To delete all the driver's cdl endorsements set the cdlEndorsements[] array to blank. Otherwise, set cdlEndorsements[] to null and the driver's CDL endorsements will not be changed.

(warning) CDL endorsement names are case-sensitive.

Custom Driver Attributes

Custom driver attributes allow customers to define additional driver attributes specific to their company/operation. These attributes may be created/edited by a properly authorized user on the QTRACS company settings page. There are three locations to retrieve the list custom driver attribute names:

QTRACS Company Settings Page
Driver page
Calling the getCustomDriverAttributeNamess web service.

Every driver within a company has all of the custom driver attributes defined for the company; however, the values of the custom driver attributes differ from driver to driver. For example: Let's say a company has defined a custom driver attribute named "Shoe size" and has two drivers defined, Joe and Bob. Then both Joe and Bob have a custom driver attribute named "Shoe size"; however, Joe's "Shoe size" attribute has an associated value of 9.5 and Bob's "Shoe size" attribute has an associated value of 10. Custom driver attributes are permitted to have a value of blank.

When calling createDriver2 or editDriver2 , fill the customDriverAttributes[] array within the Driver2 object with CustomDriverAttribute objects. Each CustomDriverAttribute object should contain a custom driver attribute name and the associated attribute value for the driver being created/modified. The custom driver attribute names must be in list of company defined custom driver attributes. Include all of the custom driver attributes you want the driver to have an associated value for. The order of the CustomDriverAttribute objects does not matter. Otherwise, set customDriverAttributes[] to null and the driver's custom driver attribute values will not be changed.

(warning) When customDriverAttributes[] is not set to null, custom driver attributes that are not included in the customDriverAttributes[] array will have their associated values set to blank for the driver being created/modified.

Sample XML Request

This sample shows how to edit a driver with the following details:

CDL endorsements
1. T - Double/Triple Trailers
2. S - School Bus
Limitations: No change
Custom driver attributes
1. Name: Shoe size Value: 9.5
2. Name: Shirt size Value: blank

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, click here.

<soap:Body>

<editDriver2>

<driver2>

<driverId>JOE</driverId>

<driverName>Joe Bob</driverName>

<driverLogin>11111</driverLogin>

<prefMonPassword></prefMonPassword>

<fleetId></fleetId>

<subfleetId>Milk Men</subfleetId>

<loggedOnTime></loggedOnTime>

<loggedOntoVehicle></loggedOntoVehicle>

<connectedTrailers></connectedTrailers>

<alias>Big Joe</alias>

<assignedVehicle></assignedVehicle>

<cdl>54654564</cdl>

<cdlEndorsements>

<string>T - Double/Triple Trailers</string>

<string>S - School Bus</string>

</cdlEndorsements>

<status>O</status>

<shift>first</shift>

<employeeType>P</employeeType>

<limitations xsi:nil="true"/>

<bidNumber>A1</bidNumber>

<assignedCompanyLocation></assignedCompanyLocation>

<customDriverAttributes>

<CustomDriverAttribute>

<name>Shoe size</name>

<value>9.5</value>

</CustomDriverAttribute>

<CustomDriverAttribute>

<name>Shirt size</name>

<value></value>

</CustomDriverAttribute>

</customDriverAttributes>

</driver2>

</editDriver2>

</soap:Body>