CreateAssessmentSnapshot
This method returns a full XML representation of an assessment specified by ID, with questions picked and shuffled at random according to selection methods in the assessment definition, using the random key if defined. Using the same random key will always result in the same selection and shuffling.
The assessment representation does not include jump blocks, topic reporting information, topic prerequisites, or topic scoreband overrides. Each question is represented in simplified QML, with all scoring information removed.
|
Assessment snapshots will only work if you use compatible question types. Questions types that are compatible are listed below:
If you use a question type that is incompatible you will receive a SOAP error message. 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. |
Parameters
| Input name | Description | Data type | Optional field? |
|---|---|---|---|
|
Assessment_ID |
The unique Assessment_ID for the assessment |
String |
N |
|
Random_Key |
Key used for random selection, shuffling,etc. |
String |
Y |
|
Save_Snapshot |
Whether to save snapshot data on the server: 0 - Do not save snapshot data 1 - Save snapshot data If set to 0, return the XML representation of the assessment and set Snapshot_ID to 0. This means the snapshot is for information only and cannot be scored later. |
Boolean |
Y |
|
Expiry |
When the snapshot may be deleted: 0 - Never deleted (default is omitted) 1 - Deleted after expiration date has passed 2 - Delete after the snapshot has been scored once by a call to ScoreAssessmentSnapshot |
Integer |
Y |
|
Expiry_Date |
The date after which the snapshot may be deleted. If Expiry is set to 1 this defines a date after which the snapshot may be deleted |
Date |
Y |
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.