Get User List API
Available in PIT v2.3
This ILE API wraps the Get Users web service. See its documentation for a further explanation of the input and output parameters, as well as the possible error conditions.
API Name: OMUSRLST
Parameter Interface:
|
Parameter
|
Direction
|
Type
|
Length
|
Precision
|
Description
|
|---|---|---|---|---|---|
|
Filter Type |
Input |
Character |
1 |
n/a |
Optional (i.e. non-blank) filter type where: 'A' = application family e.g. QTRACS, TTRACS, etc. 'R' = role name e.g. Admin, User, etc. 'U' = User name i.e. get single user. |
|
Filter ID |
Input |
Character |
25 |
n/a |
Optional (i.e. non-blank) filter ID associated with the specified non-blank filter type parameter value. |
|
User Count |
Output |
Decimal |
5 |
0 |
The number of users returned in the output response, up to a maximum of 10,000. |
|
User List |
Output |
Character Array (10000) |
397 |
n/a |
An output array of up to 10,000 user information structures (see below). |
|
Output |
Decimal |
3 |
0 |
Error Category, if any |
|
|
Output |
Decimal |
5 |
0 |
Error Code, if any |
|
|
Output |
Character |
150 varying |
n/a |
Error description, if any |
An error category of 0 means that the request was successful.
User Information Structure:
|
Field
|
Type
|
Length
|
Description
|
|---|---|---|---|
|
Field
|
Type
|
Length
|
Description
|
|
usUserId |
Character |
10 |
user id |
|
usCompId |
Character |
10 |
company id |
|
usFName |
Character |
30 |
first name |
|
usLName |
Character |
30 |
last name |
|
usEmail |
Character |
50 |
email address |
|
usPagerEmail |
Character |
50 |
pager email address |
|
usPwdReset |
Character |
1 |
force PWD rest (T/F) |
|
usLockedOut |
Character |
1 |
locked out (T/F) |
|
usObeyDst |
Character |
1 |
obey DST (T/F) |
|
usRoleName |
Character |
25 |
role name |
|
usRoleDesc |
Character |
50 |
role description |
|
usTzName |
Character |
50 |
timezone name |
|
usTzGmtOffset |
Character |
9 |
gmt offset e.g. GMT-08:00 |
|
usTzStdShort |
Character |
10 |
standard short name |
|
usTzStdLong |
Character |
30 |
standard long name |
|
usTzDstShort |
Character |
10 |
DST short name |
|
usTzDstLong |
Character |
30 |
DST long name |