GetGroupByName
This method processes a group name and returns a list giving the full details of the group if it exists in the repository. If not, a SOAP fault message is returned.
Parameter
| Input name | Description | Data type | Optional field? |
|---|---|---|---|
|
Group_Name |
The group name of the group whose details are required (not case sensitive) |
String |
N |
Response
| Output name | Description | Data type |
|---|---|---|
|
Group_ID |
The Group_ID of the group |
String |
|
Parent_ID |
The group's parent ID |
String |
|
Group_Name |
The display name of the group |
String |
|
Description |
A short description of the 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 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 |
|
Use_Emailing |
No longer used |
Integer |
|
Email_Domains |
No longer used |
String |
|
Account_Finish |
No longer used |
String |
Troubleshooting
Please refer to the following page for any error codes that are displayed when using this method.