DeleteScheduleList
This method when used will delete all the schedules listed by ID. It then returns a list of schedule records (as per existing GetScheduleList method) for each schedule deleted. Any schedule that does not exist will be ignored and not included in the list of schedules returned.
- Version 4.3 + To use this method you must purchase an additional license for the SAP Connector.
- Version 5.1 +
Parameters
| Input name | Description | Data type | Optional field? |
|---|---|---|---|
|
Schedule_ID |
The Schedule_ID of the schedule to be deleted |
Integer |
N |
Response
| Output name | Description | Data type |
|---|---|---|
|
Schedule_ID |
The Schedule_ID of this schedule |
Integer |
|
Assessment_ID |
The Assessment_ID of the assessment in this schedule |
Integer |
|
Participant_ID |
If a participant is scheduled, this is their Participant_ID, otherwise it is zero (because a group is scheduled) |
Integer |
|
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 |
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 |
|
Schedule_Starts |
If Restrict_Times above is set, this is the date and time at which this schedule becomes available |
Date/Time |
|
Schedule_Stops |
If Restrict_Times above is set, this is the date and time at which this schedule ceases to be available |
Date/Time |
|
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 |
Boolean |
Troubleshooting
Please refer to the following page for any error codes that are displayed when using this method.