GetScheduleListByAssessmentV42
This method processes an assessment ID and returns a list giving the full details of all the schedules that are assigned to this assessment if the assessment ID exists and has schedules assigned to it. This method will return information about schedules that were generated by:
If the assessment does not exist in the repository a SOAP fault message will be returned.
Parameter
Input name | Description | Data type | Optional field? |
---|---|---|---|
Assessment_ID |
The Assessment_ID of the group 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 |
Group_Tree_ID |
The parent group the Group_ID belongs to |
Integer |
|
|
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 |
Test_Center_ID |
The Test_Center_ID of the test center where this schedule had to be taken |
Integer |
|
Min_Days_Between_Attempts |
The minimum number of days that need to elapse before a participant can take the assessment again |
Integer |
|
Time_Limit_Override |
Determines if the time limit set in the assessment should be overridden |
Boolean |
|
Time_Limit |
If Time_Limit_Override is enabled this is the number of minutes in total that the participant now has to take the assessment |
Integer |
|
Participant_Name |
The name of the participant |
String |
|
Group_Name |
The name of the group that the participant is apart of |
String |
|
Test_Center_Name |
The name of the Test_Center identified in Test_Center_ID |
String |
|
Web_Delivery |
Determines if the participant can access the assessment from perception.dll or perception.php |
Boolean |
|
Offline_Delivery |
Determines if the assessment is available for download |
Boolean |
|
APack4URL |
The URL of the assessment download |
String |
Troubleshooting
Please refer to the following page for any error codes that are displayed when using this method.