CreateScheduleParticipant
This method creates a schedule for a participant (specified by their Participant_ID) from the schedule information supplied and returns the Schedule_ID of the new schedule. The information that must be provided is:
- The schedule's name
- The Assessment_ID of the assessment to be scheduled
- The Participant_ID of the participant
- The date and time at which the schedule becomes available
- The date and time at which the schedule ceases to be available
If the new schedule cannot be created a SOAP fault message will be returned.
Parameters
| Input name | Description | Data type | Optional field? |
|---|---|---|---|
| Schedule_ID | The ID of the schedule | String |
N |
|
Assessment_ID |
The Assessment_ID of the assessment in the new schedule |
String |
N |
|
Participant_ID |
Must be 0 |
Integer |
N |
|
Group_ID |
This is the Group_ID of the group in the new schedule |
Integer |
N |
|
Schedule_Name |
The new schedule's name |
String |
N |
|
Restrict_Times |
This indicates whether or not to use Schedule_Starts and Schedule_Stops below to restrict the period for which the assessment is available |
Boolean |
Y |
|
Schedule_Starts |
If Restrict_Times above is set, this is the date and time at which the new schedule becomes available |
Date/Time |
Y |
|
Schedule_Stops |
If Restrict_Times above is set, this is the date and time at which the new schedule ceases to be available |
Date/Time |
Y |
|
Restrict_Attempts |
This indicates whether or not to use Max_Attempts |
Boolean |
Y |
|
Max_Attempts |
This is the maximum number of times the new schedule can be accessed |
Integer |
Y |
|
Monitored |
0 - Assessment in schedule not monitored 1 - Assessment in schedule monitored |
Boolean |
Y |
Response
| Output name | Description | Data type |
|---|---|---|
|
Schedule_ID (may occur several times) |
The Schedule_ID of each new schedule |
Integer |
Troubleshooting
Please refer to the following page for any error codes that are displayed when using this method.