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. URLs
  4. GetAccessScheduleNotify

GetAccessScheduleNotify

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, a Participant_Name (who must exist already in the Questionmark database) and a Notify URL. It also returns a URL that will start the assessment with given schedule ID for a participant with the name participant name. The notify URL will notify when the assessment finishes using the PIP file name specified in the PIP parameter.

If the schedule does not exist, a SOAP fault message will be returned.

To use this method you must purchase an additional license for the SAP Connector.

Parameters

Input name   Description Data type Optional field?

Schedule_ID

  

This is the ID number of the schedule of the assessment that will be taken.

Integer

N

Participant_Name

  

This is the name of the participant who will take the assessment; it must exist in the database.

String

N

Notify

  

This is the URL that is notified when the participant has finished the scheduled assessment

String

Y

PIP

  

This parameter specifies the name of the PIP file that will be used when the URL is generated. If no value is supplied, it defaults to QMWISE.

String

Y

Parameter

        
 

Name

This is the name of a parameter that's recognized by the calling system (see note below). This enables the calling system to receive the parameter in the notification, e.g., a unique identifier may be used by to track the assessment.

String

N
 

Value

This is the value to be assigned to the parameter with the Name above.

String

Y

Parameters with the following names cannot be used:

  • CALL
  • SESSION
  • NAME
  • NOTIFY
  • EXPIRES
  • ACCESS

Response

Output name Description Data type

URL

This is the URL that will run the assessment using perception.dll or perception.php. A notification will also be sent to the URL in the Notify parameter when the assessment finishes.

String

Troubleshooting

Please refer to the Appendix - Error codes section for information about any error codes that are displayed when using this method.

Please note that the errors reported by this method aren't always correct.

Error 2040 ("Error occured while trying to get access schedule notify") could be caused by one of the following problems:

  • The schedule has limited attempts and no attempts remain (i.e., caused when attempts are already finished).
  • The schedule has restricted times and has not yet started or has stopped (i.e., when start/end period don't match).
  • The participant has taken the assessment with in minimum days between attempts (i.e., when next possible start date don't match).