GetParticipantListByGroup
This method processes a Group ID and returns a list giving the full details of all the participants that are members of that group if the Group ID exists and has any participants belonging to it. If not, an empty list is returned.
If a participant details list is returned, it will include a list of all the groups (specified by Group ID) of which the participant is a member. This group list will be empty if the participant does not belong to any groups.
Parameters
| Input name | Description | Data type | Optional field? |
|---|---|---|---|
|
Group_ID |
The Group ID of the group whose member participant details are required |
String |
N |
Responses
| Output name | Description | Data type | |
|---|---|---|---|
|
Participant_ID |
|
The participant ID of the participant whose details are to be retrieved |
String |
|
Participant_Name |
|
The login name of the participant |
String |
|
Password |
|
The login password of the participant |
String |
|
Authenticate_Ext |
|
This indicates whether the participant must be authenticated externally |
Integer |
|
First_Name |
|
The participant's forename |
String |
|
Last_Name |
|
The participant's surname |
String |
|
Middle_Name |
|
The participant's middle name(s) |
String |
|
Use_Correspondence |
|
This indicates how email correspondence will be used |
Integer |
|
Primary_Address_1 |
|
The first line of the participant's primary address |
String |
|
Primary_Address_2 |
|
The second line of the primary address |
String |
|
Primary_City |
|
The city or town in the primary address |
String |
|
Primary_State |
|
The state or county in the primary address |
String |
|
Primary_ZIP_Code |
|
The ZIP or postal code in the primary address |
String |
|
Primary_Country |
|
The country in the primary address |
String |
|
Primary_Phone |
|
The participant's primary telephone number |
String |
|
Primary_Fax |
|
The participant's primary fax number |
String |
|
Primary_Email |
|
The participant's primary email address |
String |
|
Secondary_Address_1 |
|
|
String |
|
Secondary_Address_2 |
|
String |
|
|
Secondary_City |
|
String |
|
|
Secondary_State |
|
|
|
|
Secondary_ZIP_Code |
|
String |
|
|
Secondary_Country |
|
String |
|
|
Secondary_Phone |
|
String |
|
|
Secondary_Fax |
|
String |
|
|
Secondary_Email |
|
String |
|
|
Salutation |
|
How to address the participant |
String |
|
Organization_Name |
|
The name of the participant's organization |
String |
|
Department |
|
The participant's department within their organization |
String |
|
Title |
|
The participant's title |
String |
|
Assistant_Name |
|
The name of the participant's assistant |
String |
|
Manager_Name |
|
The name of the participant's manager |
String |
|
Gender |
|
The participant's gender |
String |
|
URL |
|
A URL for the participant (such as that of a homepage or picture) |
String |
|
Date_Registration |
|
The date the participant was registered in the system |
String |
|
Details |
|
The participant's general details |
String |
|
Details_1 to Details_20 |
|
These contain specific details about the participant |
String |
|
GroupIDList |
|
|
|
|
|
Group_ID (may occur several times) |
NOT USED |
String |
Troubleshooting
Please refer to the following page for any error codes that are displayed when using this method.