GetScheduleV42

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

This method processes a Schedule_ID and returns a list giving full details of the schedule if the schedule exists in the database, including the offline options that are set. If the schedule does not exist in the repository a SOAP fault message will be returned.

Available in:
  • Version 4.4 +
  • 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

Integer

Assessment_ID

The Assessment_ID of the assessment in this schedule

String

Session_Name

The name of the assessment

String

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

Group_Tree_ID

The ID of the parent group of the group indicated in Group_ID

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

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

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.

Appendix - Error codes