CreateScheduleGroupV42
This method creates schedule(s) for a group in the database. It now includes the creation of offline schedules. If the schedule includes offline delivery an APack4 file is created. If wanted, a schedule is created individually on each participant. The response is the Schedule_ID of the new schedules.
- The schedule's name
- The Assessment_ID of the assessment to be scheduled
- The Group_ID of group the participant belongs to
- The date and time at which the schedule becomes available
- The date and time at which the schedule ceases to be available
Parameters
Input name | Description | Data type | Optional field? |
---|---|---|---|
Schedule_ID |
The ID of the schedule |
Integer |
N |
Assessment_ID |
The Assessment_ID of the assessment in the new schedule |
String |
N |
Session_Name |
The name of the assessment being scheduled. |
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 |
Group_Tree_ID |
The lowest level Group ID that the group being scheduled is associated with |
Integer |
Y |
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 Must be: 1 = true 0 = false |
Boolean |
N |
Schedule_Starts |
If Restrict_Times above is set, this is the date and time at which the new schedule becomes available |
Date/Time |
N |
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 |
N |
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 |
Test_Center_ID |
Used when scheduling by participant for a test center |
Integer |
Y |
Min_Days_Between_Attempts |
The number of days that must have elapsed before a participant can retake an assessment. If left blank the default of 0 used |
Integer |
Y |
Time_Limit_Override |
Whether the time limit for the assessment can be overridden 0 - The time limit can not be overridden 1 - The time limit can be overridden |
Boolean |
Y |
Time_Limit |
If the time limit of the assessment is being overridden, this specifies the new time limit in minutes. |
Integer |
Y |
Participant_Name |
The name of the participant |
String |
N |
Group_Name |
The group name that the participant belongs to if one is assigned |
String |
Y |
Test_Center_Name |
The name of the test center that has been assigned to deliver the assessment |
String |
Y |
Web_Delivery |
Must be: 0 - Assessment in not schedule for web delivery 1 - Assessment is scheduled for web delivery |
Boolean |
N |
Offline_Delivery |
Must be: 0 - Assessment in not schedule for offline delivery 1 - Assessment is scheduled for offline delivery |
Boolean |
N |
APack4Url |
The URL for the Apack if offline delivery is set to 1 |
String |
Y |
ScheduleEachMember |
Whether a new schedule should be created for each participant in the group (as defined by the group ID) . Must be: 0 - Do not create separate schedules 1 - Create separate schedule |
Boolean |
N |
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.