Edit Driver 2

Last updated
Save as PDF

editDriver2

Given a Driver2 object, this web service allows changes to a driver's details.

void editDriver2(Driver2 driver) throws WSException

driver: A Driver2 object with the details for editing the driver.

Authorization Requirements

The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.

Required Application Licenses
- Remote Integration

Required User Permissions
- Can use QTRACS
- Can set up drivers
OR
- Can use Performance Monitoring
- Can maintain vehicles and drivers

- Can see drivers

Customer integrators are authorized to their own company's data only.

Sample XML Request

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>[US-PA]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>

<driverFirstName>Joe</driverFirstName>

<driverLastName>Bob</driverLastName>

</driver2>

</editDriver2>

</soap:Body>

Sample XML Response

An empty response conveys success. If there was an error, an exception would have been thrown.

<soapenv:Body>

<editDriver2Response/>

</soapenv:Body>

Exceptions

001 Unknown Error.
002 Required field not specified.
003 Company not authorized for integration.
004 User is not authorized.
005 Driver cannot be found.
006 Driver ID must be specified.
007 Driver name must be specified.
008 Driver name invalid.
009 Driver login password must be specified.
010 Driver login password invalid.
011 Subfleet Id is invalid.
012 Driver alias invalid.
013 Assigned vehicle not found.
014 Assigned company location not found.
015 Driver status invalid.
016 Bid number invalid.
017 Shift invalid.
018 CDL number invalid.
019 Employee type invalid.
020 Limitation errors - dynamically filled with error code:limitation name in a semi-colon delimited string
      -- an example: 020 Limitation errors - 0001:Prescription lenses needed;0001:Cannot work with others
      -- see the table below for all valid error codes and their meanings (only 0001 and 0002 apply)
021 CDL Endorsement errors - dynamically filled with error code:CDL endorsement name in a semi-colon delimited string
      -- an example: 021 CDL Endorsement errors - 0001:Q - Double/Triple Trailer;0001:M - Magic School Bus
      -- see the table below for all valid error codes and their meanings (only 0001 and 0002 apply)
022 Custom Attribute errors - dynamically filled with error code:custom attribute name in a semi-colon delimited string
      -- an example: 022 Custom Attribute errors - 0001:Shoe Size;0001:Shirt Size
      -- see the table below for all valid error codes and their meanings
023 Driver first name invalid.
024 Driver last name invalid.
025 CDL number must be unique when Omnitracs One compatible.

Error Code	Error Description
0001	Attribute name does not exist for this company
0002	Attribute name length is invalid
0003	Attribute value contains an illegal character
0004	Attribute value length is invalid