Get Global Group Members API
Available in PIT v2.3
This ILE API wraps the Get Global Group Members web service. See its documentation for a further explanation of the input and output parameters, as well as the possible error conditions.
API Name: QTGETDGGM
Parameter Interface:
|
Parameter
|
Direction
|
Type
|
Length
|
Precision
|
Description
|
|---|---|---|---|---|---|
|
Global Group ID |
Input |
Character |
25 |
n/a |
Identifier for the global group |
|
Member Type Filter |
Input |
Character |
1 |
n/a |
Global group member type. See the Global Group Member Object for the correct type code for each entity. |
|
Global Group Member Anchor |
Input |
Character |
26 |
n/a |
An optionally specified (i.e. non-blank) member ID anchor value allowing requests to be positioned alphabetically in the member list. The member anchor value consists of 26 characters where the first 25 characters specify the member ID and the next 1 character specifies its member type. |
|
Request Positioning Operation |
Input |
Character |
2 |
n/a |
An operation code specifying which portion of the alphabetical member list will be returned in relation to the optionally specified member anchor. Valid codes are: '>', '<', '>=', '<='. |
|
Number of Members Requested |
Input |
Decimal |
5 |
0 |
The number of members requested. Note that up to a maximum of 1000 members can be requested and returned per call |
|
Member List |
Output |
Character Array (1000) |
26 |
n/a |
An output array of up to 1000 global group members matching the request and selection criteria. Each member is 26 characters where the first 25 characters specify the member ID and the next 1 character specifies its member type. See the Global Group Member Object for the correct type code for each entity. |
|
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.