Skip to main content
Omnitracs Knowledge Base

Get Next User - OMNXTUSR

Get Next User (OMNXTUSR) RI

Required Parameter Group:

1 User Identifier Input Char(10)
2 Format Name Input Char(6)
3 Return Status Output Char(1)
4 Reason Code Output Char(4)
5 Return Block Output Char(512)

API Overview:
The Get Next User API (OMNXTUSR) is used to retrieve user information from the QTRACS User Database. This API allows user information to be retrieved in several ways. User information may be retrieved by explicitly specifying the user to be returned. Alternately, this API allows an external application to 'play through' all defined users. By specifying *FIRST and *NEXT, the API can be used to return the entire user database in ascending user identifier order.

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

User Id Returns the record for the specified user
*FIRST Returns the first record from the user 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 User Id).

(2) Format Name
The format of the information to be returned. Valid values are:

USR100 User characteristics

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

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

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

0000 User found and information returned
0001 Invalid user identifier specified
0002 No user record found
0003 Invalid format name specified

(5) Return Block
Variable format data structure that returns information to the calling program based on the 'format name' parameter. If the 'return status' parameter is not '0', the contents of this return block are not reliable.

The supported data formats are shown in the shaded tables below.
USR100 Data Format ( User characteristics )

1-10 User Identifier Char(10)
11-34 User Name Char(24)
35-37 User Time Zone
Blanks are returned if user's time zone is set to system default.
38-40 Vehicles in Coverage Packed(5,0)
41-45 Number of Transmitted Characters Packed(9,0)
46-50 Number of Transmitted Messages Packed(9,0)
51-57 Time of last reset Packed(13,0)
  • Was this article helpful?