CreateParticipant
This method creates a participant from the participant information supplied and returns the Participant ID of the participant. The only information that must be provided is:
- the participant's name,
- a password for the participant,
- and an email address for the participant.
If the Participant Name does not already exist in the repository, the participant is created. If a participant with the Participant Name given already exists, a SOAP fault message will be returned. Any group specified will have the participant as a member if the group exists in the repository. Otherwise the group will be ignored.
Parameters
Parameters left blank will cause the corresponding fields in the repository database to be updated with a null entry.
Input name | Description | Data type | Optional field? | |
---|---|---|---|---|
Participant_ID |
|
The participant ID of the participant whose details are to be created |
String |
Y |
Participant_Name |
|
The login name of the participant |
String |
N |
Password |
|
The login password of the participant |
String |
N
|
Authenticate_Ext |
|
This indicates whether the participant must be authenticated externally |
Integer |
Y |
First_Name |
|
The participant's forename |
String |
Y |
Last_Name |
|
The participant's surname |
String |
Y |
Middle_Name |
|
The participant's middle name(s) |
String |
Y |
Use_Correspondence |
|
This indicates how email correspondence will be used |
Integer |
Y |
Primary_Address_1 |
|
The first line of the participant's primary address |
String |
Y |
Primary_Address_2 |
|
The second line of the primary address |
String |
Y |
Primary_City |
|
The city or town in the primary address |
String |
Y |
Primary_State |
|
The state or county in the primary address |
String |
Y |
Primary_ZIP_Code |
|
The ZIP or postal code in the primary address |
String |
Y |
Primary_Country |
|
The country in the primary address |
String |
Y |
Primary_Phone |
|
The participant's primary telephone number |
String |
Y |
Primary_Fax |
|
The participant's primary fax number |
String |
Y |
Primary_Email |
|
The participant's primary email address |
String |
N |
Secondary_Address_1 |
|
|
String |
Y |
Secondary_Address_2 |
|
String |
Y | |
Secondary_City |
|
String |
Y | |
Secondary_State |
|
|
Y | |
Secondary_ZIP_Code |
|
String |
Y | |
Secondary_Country |
|
String |
Y | |
Secondary_Phone |
|
String |
Y | |
Secondary_Fax |
|
String |
Y | |
Secondary_Email |
|
String |
Y | |
Salutation |
|
How to address the participant |
String |
Y |
Organization_Name |
|
The name of the participant's organization |
String |
Y |
Department |
|
The participant's department within their organization |
String |
Y |
Title |
|
The participant's title |
String |
Y |
Assistant_Name |
|
The name of the participant's assistant |
String |
Y |
Manager_Name |
|
The name of the participant's manager |
String |
Y |
Gender |
|
The participant's gender |
String |
Y |
URL |
|
A URL for the participant (such as that of a homepage or picture) |
String |
Y |
Date_Registration |
|
The date the participant was registered in the system |
String |
Y |
Details |
|
The participant's general details |
String |
Y |
Details_1 to Details_20 |
|
These contain specific details about the participant |
String |
Y |
GroupIDList |
|
NOT USED |
|
Y
|
|
Group_ID (may occur several times) |
NOT USED |
String |
Y
|
Response
Output name | Description | Data type |
---|---|---|
Participant_ID |
The Participant ID of the participant |
String |
Troubleshooting
Please refer to the following page for any error codes that are displayed when using this method.