GetScheduleListByAssessment

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

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 any schedules assigned to it. If not, an empty list is returned. If the assessment does not exist in the repository a SOAP fault message will be returned.

Available in:
  • Version 4.1 +
  • Version 5.1 +

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

 

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.

Appendix - Error codes