Skip to main content
Omnitracs Knowledge Base

Get Driver ID List

getDriverIDList

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

string[] getDriverIDList(string driverId,int numOfDrivers) throws WSException

  • 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.
  • numberOfDrivers: The number of drivers to return in the list.  The value must be between 1 and 32,766.

Returns a null string on exceptions; otherwise returns an array of string 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

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>

   <getDriverIDList>

        <driverId>ABCD123456</driverId>

    <numOfDrivers>2</numOfDrivers>

      </getDriverIDList>

</soap:Body>

Sample XML Response

<soapenv:Body>

      <getDriverIDListResponse>

         <getDriverIDListReturn>

            <string>AAAA123B</string>

            <string>AAAA123C</string>

         </getDriverIDListReturn>

      </getDriverIDListResponse>

   </soapenv:Body>

Exceptions

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

  • Was this article helpful?