GetAdministratorGroupList
This method processes an administrator ID and returns a list all groups in the repository who are owned by the administrator if the administrator ID exists in the database. If there are none, an empty list is returned. If the administrator doesn't exist in the repository, a SOAP fault message will be returned.
Note: The GetAdministratorGroupList method doesn't return any roles assigned to an administrator.
Parameters
| Input name | Description | Data type | Optional field? |
|---|---|---|---|
|
Administrator_ID |
The Administrator_ID of the administrator for whom the details of groups they own are required |
String |
N |
Response
| Output name | Description | Data type |
|---|---|---|
|
Group_ID |
The Group ID of the group whose details follow |
String |
|
Parent_ID |
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
For information about any error codes returned when using this method, see Error codes.