Export Driver Names

Last updated
Save as PDF

exportDriverNames

Given a driver identifier (optional) and a number of drivers to return, this web service returns a list of DriverIdentifier objects in alphabetical order by the Driver ID.

DriverIdentifier[] exportDriverNames (string companyId, string driverId, int numOfDrivers) throws WSException

companyId: (optional) A string, maximum length 10, specifying the unique company identifier.
NOTE: If no companyId is specified, the company of the authorized user making the call will be used.
driverId:(optional) A string containing a unique driver identifier. The returned list will begin after the driver that is specified on the call. When driverId is blank, the list will begin with the first driver sorted in ascending order by Driver ID.
numOfDrivers: The number of drivers to return in the list. The allowed range is 1 to 32766.

Returns a null string on exceptions; otherwise returns an array of DriverIdentifier objects.

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 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>

<exportDriverNames>

<driverId>ABCD123456</driverId>

<numOfDrivers>2</numOfDrivers>

</exportDriverNames>

</soap:Body>

Sample XML Response

<soapenv:Body>

<exportDriverNamesResponse>

<exportDriverNamesReturn>

<DriverIdentifier>

<id>JANED</id>

<loginName>Jane Doe</loginName>

<firstName>Jane</firstName>

<lastName>Doe</lastName>

<alias>Janey</alias>

</DriverIdentifier>

<DriverIdentifier>

<id>JOHND</id>

<loginName>John Doe</loginName>

<firstName>John</firstName>

<lastName>Doe</lastName>

<alias>Johnny</alias>

</DriverIdentifier>

</exportDriverNamesReturn>

</exportDriverNamesResponse>

</soapenv:Body>

Exceptions

001 Unknown Error.
002 Required field not specified.
003 Company not authorized for integration.
004 User is not authorized.
005 Invalid company id.
006 No drivers found.
007 Invalid number of records specified.
008 Invalid driver id.