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. Snapshots
  4. GetAssessmentSnapshot

GetAssessmentSnapshot

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

This method retrieves the full XML representation of a previously created delivery assessment snapshot. This allows an external system to deliver the same assessment, with the same randomization and shuffling, repeatedly over time without having to create the scoring and delivery asessment snapshots again.

This method requires a QMWISe license with snapshots enabled for it to function. If the method is used without the appropriate license an error message will be returned.

 

Available in:
  • Version 4.3 +
  • Version 5.1 +

Parameters

Input name Description Data type Optional field?

Snapshot_ID

The unique Snapshot_ID of the snapshot you to view information for

Integer

N

Response

Output name   Description Data type

Assessment_ID

  

The unique Assessment_ID for the assessment

Integer

Snapshot_ID

  

The unique Snapshot_ID

Integer

Random_Key

  

Key used for random selection, shuffling,etc.

Integer

Assessment_Type

  

The type of assessment:

0 - Quiz

1 - Test

2 - Survey

3 - Exam

Integer

Name

  

The assessment name

String

Description

  

The assessment description

String

Author

  

The name or ID of the person who created the assessment

String

Save_Answers

  

Specifies whether to save results to answer database:

0 - Do not save results

1 - Save results

Boolean

Save_Answer_Data

  

Specifies whether the full answer data is saved to the answer database:

0 - Do not save answer data

1 - Save answer data

Boolean

Number_Of_Blocks

  

The number of question blocks in the assessment

Integer

Number_Of_Questions

  

The of number of questions in the assessment

Integer

Course

  

The assessment folder name

String

Time_Limit

  

Time limit in minutes

Integer

QuestionBlock

      
 

Block_Name

The name of the block

String
 

Introduction

Introductory text

String
 

Question_List

List of questions (order shuffled if appropriate) in simplified QML

String

Troubleshooting

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

Appendix - Error codes