GetScheduleListByParticipant
This method processes a participant ID and returns a list giving the full details of all the schedules that are assigned to the participant if the participant ID exists and has any schedules assigned to it. If not, an empty list is returned.
The list of available schedules will only include schedules created for Web Delivery and not for Questionmark to Go or test centers. The list of schedules returned will not necessarily be the same as displayed when a participant logs in to Perception. The list of assessments scheduled differ when a participant logs in because the system also takes into account the following, which this method does not:
- Test centers assigned
- Schedule start and stop times
- Days between attempts
- Restricted attempts at an assessment
If the participant ID does not exist a SOAP fault message will be returned.
Parameter
| Input name | Description | Data type | Optional field? |
|---|---|---|---|
|
Participant_ID |
The Participant_ID of the participant whose assigned schedule details are required |
String |
N |
Response
| Output name | Description | Data type | |
|---|---|---|---|
|
Schedule (may occur several times) |
|
||
|
|
Schedule_ID |
The Schedule_ID of this schedule |
String |
|
|
Assessment_ID |
The Assessment_ID of the assessment in this schedule |
String |
|
|
Participant_ID |
If a participant is scheduled, this is their participant ID, otherwise it is zero (because a group is scheduled) |
String |
|
|
Group_ID |
If Participant_ID above is zero, a group is scheduled and this is its group ID, otherwise this is either the group ID that the participant belongs to, or is zero if the participant does not belong to a group |
String |
|
|
Schedule_Name |
A descriptive name for this schedule |
String |
|
|
Restrict_Times |
This indicates whether Schedule_Starts and Schedule_Stops below are used to restrict the period for which the assessment is available |
Boolean |
|
|
Restrict_Attempts |
This indicates whether or not Max_Attempts below is used to limit the number of attempts |
Boolean |
|
|
Max_Attempts |
This is the maximum number of times this schedule can be accessed |
Integer |
|
|
Monitored |
0 - Assessment in schedule not monitored 1 - Assessment in schedule monitored |
Integer |
|
|
Schedule_Starts |
If Restrict_Times above is set, this is the date and time at which this schedule becomes available |
String |
|
|
Schedule_Stops |
If Restrict_Times above is set, this is the date and time at which this schedule ceases to be available |
String |
Troubleshooting
Please refer to the following page for any error codes that are displayed when using this method.