IMPORTANT: Questionmark recommendeds using the Delivery Odata API (click here for documentation) for new integrations, not the QMWISe API. Although we currently continue to issue maintenance updates to this API to support customers with current QMWISe-based integrations, we are no longer adding new methods/functionality to QMWISe. 
  1. Questionmark QMWISe API Guide
  2. Web service methods
  3. Schedule
  4. SetSchedule

SetSchedule

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 updates the details of an existing schedule from the schedule information supplied. The only information that must be provided is:

  • The schedule's name
  • The assessment ID of the assessment to be scheduled
  • The date and time at which the schedule becomes available
  • The date and time at which the schedule ceases to be available

If the schedule ID does not already exist in the database, 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 as indicated in the input parameters

String

N

Assessment_ID

The assessment ID of the assessment in the modified schedule

String

N

Participant_ID

This is the participant ID of the participant in the modified schedule

String

N

Group_ID

This is either the group ID that the participant belongs to, or is zero if the participant does not belong to a group (and will be scheduled as a member of No Groups)

String

N

Schedule_Name

The modified schedule's name

String

N

Restrict_Times

This indicates Schedule_Starts and Schedule_Stops below are used to restrict the period for which the assessment is available

Boolean

Y

Restrict_Attempts

This indicates whether or not to use Max_Attempts

Boolean

Y

Max_Attempts

This is the maximum number of times the modified schedule can be accessed and must be set if Restrict_Attempts is enabled

String

Y

Monitored

0 - Assessment in schedule not monitored

1 - Assessment in schedule monitored

Integer

Y

Schedule_Starts

If Restrict_Times above is set, this is the date and time at which the modified schedule becomes available

String

N

Schedule_Stops

If Restrict_Times above is set, this is the date and time at which the modified schedule ceases to be available

String

N

Response

Output name Description Data type

NONE

Troubleshooting

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

Appendix - Error codes