GetSchedule

Applies to the following products: 
Questionmark OnDemand
Questionmark Perception
Questionmark OnPremise
Applies to the following Perception versions: 
Perception 5.7

This method gets the schedule details based on a schedule ID. If the schedule does not exist in the repository a SOAP fault message will be returned.

Available in:
  • Version 4.1 +
  • Version 5.1 +

Parameters

Input name Description Data type Optional field?

Schedule_ID

The Schedule_ID of the schedule to you want to gather information on

String

N

Response

Output name Description Data type

Schedule_ID

The Schedule_ID of the schedule retrieved

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

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

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

Boolean

Troubleshooting

Please refer to the following page for any error codes that are displayed when using this method.

Appendix - Error codes