Skip to main content
Omnitracs Knowledge Base

Get Next Driver - OMNXTDRV

Get Next Driver (OMNXTDRV) RI

Required Parameter Group:

1 Driver Identifier Input Char(10)
2 Return Status Output Char(1)
3 Reason Code Output Char(4)
4 Return Block Output Char(256)

API Overview:
The Get Next Driver API (OMNXTDRV) is used to retrieve the next driver (in ascending driver identifier order) from the QTRACS Driver Database. This API allows an external application to 'play through' all defined drivers.

Required Parameter Group Details:
(1) Driver Identifier
This parameter contains the identifier of the driver whose information will be returned. Valid values are:

Driver Id Returns the record for the specified driver
*FIRST Returns the first record from the driver file
*NEXT Returns the next record from the file (assumes that the file cursor has been set from a previous call which specified *FIRST or a Driver Id).

(2) Return Status
Status value returned to the caller will be set as follows:

0 Success, driver found and returned
1 Failure, no driver found
A Failure, API failed when called remotely

(3) Reason Code
This parameter contains a reason code. Possible values returned include;

0000 OK, no errors found
0001 Invalid driver identifier specified
0002 No driver record found
0003 OK, but driver not found in SensorTRACS

(4) Return Block
Fixed format data structure that returns information from the driver database to the calling program. If the 'return status' parameter is not '0', the contents of this return block are not reliable.

1-15 Company Identifier(set to blanks) Char(15)
16-25 Driver Identifier (Global Login ID) Char(10)
26-55 Driver's Full Name Char(30)
56-63 Global Login Password Char(8)
64-73 Logged-in Vehicle Identifier Char(10)
74-80 Logged-in Time Packed(13,0)
81-89 SensorTRACS MCT Account Password Char(9)
90-256 Reserved Char(167)
  • Was this article helpful?