GetParticipantGroupList
This method processes a Participant ID and returns a list all groups in the repository that the participant is a member of if the Participant ID exists in the repository. If there are none, an empty list is returned.
If the participant does not exist in the repository a SOAP fault message will be returned.
- Version 4.1 +
- Version 5.1 +
Parameters
| Input name | Description | Data type | Optional field? |
|---|---|---|---|
|
Participant_ID |
The Participant ID of the participant for whom the details of groups they are members of are required |
String |
N |
Responses
| Output name | Description | Data type |
|---|---|---|
|
Group_ID |
The Group ID of the group whose details follow |
String |
|
Parent_ID |
Must be set to 0 Reserved for future use (envisaged as the Group ID of the "parent" group in a hierarchical group structure, or 0 if there is no parent group) |
String |
|
Group_Name |
The display name of this group |
String |
|
Description |
A short description of this group |
String |
|
Account_Internal_Ref |
No longer used |
String |
|
Account_Admin_Email |
No longer used |
String |
|
Directory_Name |
No longer used |
String |
|
Account_Status |
No longer used |
Integer |
|
Special_1 to Special_10 |
No longer used |
String |
|
Max_Participants |
No longer used |
Integer |
|
Max_Sessions_Attempt |
No longer used |
Integer |
|
Session_Taken |
No longer used |
Integer |
|
Account_Password |
No longer used |
String |
|
Account_Type |
No longer used |
Integer |
|
Account_Finish |
No longer used |
String |
|
Use_Emailing |
No longer used |
Integer |
|
Email_Domains |
No longer used
|
String |
Troubleshooting
Please refer to the following page for any error codes that are displayed when using this method.