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. SetScheduleV42

SetScheduleV42

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 method can only be used to modify schedules created by:

If the schedule adds offline delivery an APack4 file is created and if offline Ddelivery is removed the APack4 file is deleted. 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.4 +
  • Version 5.1 +

Parameters

Input name Description Data type Optional field?

Schedule_ID

Unique identifier for this particular schedule.

Integer

N

Assessment_ID

The Assessment_ID of the assessment in the new schedule

String

N

Session_Name

The name of the assessment being scheduled.

String

N

Participant_ID

This is the Participant_ID of the participant in the new schedule

Integer

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)

Integer

N

Group_Tree_ID

The lowest level Group_ID that the participant being scheduled is associated with

Integer

N

Schedule_Name

The new schedule's name

String

N

Restrict_Times

This indicates whether or not to use Schedule_Starts and Schedule_Stops below to restrict the period for which the assessment is available

Boolean

Y

Schedule_Starts

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

Date/Time

N

Schedule_Stops

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

Date/Time

N

Restrict_Attempts

This indicates whether or not to use Max_Attempts

Boolean

Y

Max_Attempts

This is the maximum number of times the new schedule can be accessed

Integer

Y

Monitored

0 - Assessment in schedule not monitored

1 - Assessment in schedule monitored

Integer

Y

Test_Center_ID

If using a test center to deliver this assessment the relevant ID is required

Integer

Y

Min_Days_Between_Attempts

The number of days that must have elapsed before a participant can retake an assessment. If left blank the default of 0 used.

Integer

Y

Time_Limit_Override

If using a test center to deliver this assessment the relevant ID is required

Boolean

Y

Time_Limit

If the time limit of the assessment is being overridden, this specifies the new time limit in minutes.

Integer

Y

Participant_Name

The name of the participant

String

N

Group_Name

The group name that the participant belongs to if one is assigned

String

Y

Test_Center_Name

The name of the test center that has been assigned to deliver the assessment

String

N

Web_Delivery

0 - Assessment in not schedule for web delivery

1 - Assessment is scheduled for web delivery

Boolean

N

Offline_Delivery

0 - Assessment in not schedule for offline delivery

1 - Assessment is scheduled for offline delivery

Boolean

N

APack4Url

The URL for the Apack if offline delivery is set to 1

String

Y

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