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. Assessments
  4. GetAssessmentDefinition

GetAssessmentDefinition

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

Warning: There's a known issue with the GetAssessmentDefinition method where the Shuffle_Questions, Use_Template_File, Save_Answers, and Save_Answer_Database fields are returned incorrectly.

This method processes an Assessment_ID and returns a list giving the full details of the assessment definition if the assessment definition exists in the repository. These details do not include:

  • Jump blocks
  • Topic reporting information
  • Prerequisite topic information
  • Topic scoreband overrides
  • Special field information for single questions in blocks

If using this method in Perception 5, the language is also returned as part of the response. The language identifies what language the assessment has been assigned. If the language is not defined or you're using Perception 4, it's assumed that the language of the assessment is in the base language of your Perception installation.

If the assessment definition doesn't exist in the database a SOAP fault message will be returned.

Parameters

Input name Description Data type Optional field?

Assessment_ID

The Assessment_ID of the assessment for which you want to get the details

String

N

Note: The Assessment_ID is the full 16 digits made up from the fields Session_MID and Session_LID in the S_Header table of the database.

Response

Output name         Description Data type

Assessment

        

 

 
 

Assessment_ID

      

The Assessment_ID for this definition

Integer
 

Revision

      

The new assessment definition's current revision

Integer
 

Session_Name

      

The new assessment definition's name or title

String
 

Author

      

The name of the new assessment definition's creator

String
 

Save_Answers

      

This indicates whether to save the answers in the answer tables.

Warning: There's a known issue with the GetAssessmentDefinition method where the Shuffle_Questions, Use_Template_File, Save_Answers, and Save_Answer_Database fields are returned incorrectly.

Boolean
 

Save_Answer_Database

      

This indicates whether to save the data to all answer tables, or only to the results and assessment tables.

Warning: There's a known issue with the GetAssessmentDefinition method where the Shuffle_Questions, Use_Template_File, Save_Answers, and Save_Answer_Database fields are returned incorrectly.

Boolean
 

Open_Session

      

This indicates whether the assessment can be presented with open.dll or open.php.

Boolean
 

Session_Password

      

The assessment's password (blank if no password is set)

String
 

Session_Timed

      

This indicates whether the assessment has a time limit (if so, the value is contained in the field Time_Limit below).

Boolean
 

Time_Limit

      

The number of minutes for which the assessment is available (used if Session_Timed above is set)

Integer
 

Template_Name

      

The default template file for the assessment (each assessment block can be set to use its own template file)

String
 

When_Feedback

      

0 - No Feedback at all

1 - Feedback shown after each block

3 - Feedback shown at the end of the assessment

Integer
 

End_Feedback

      

If When_Feedback above is zero:

0 - All questions get feedback

1 - Only wrong or unanswered questions get feedback

2 - Only wrong questions get feedback

3 - All answered questions get feedback

Integer
 

Exclude_Unscored

      

If When_Feedback above is not zero, this indicates whether questions with a maximum score of zero should show feedback.

Boolean
 

Folder_ID

      

The assessment folder  in which the assessment is stored

Integer
 

Lang

      

The language associated with the assessment

String
 

Description

      

This is a short comment for the assessment definition.

String
 

Monitored

      

0 - Assessment not monitored

1 - Assessment monitored

Boolean
 

Editor

      

The last user who modified the new assessment definition

String
 

Version

      

The version of Assessment Manager last used to modify the new assessment

String
 

Permit_External_Call

      

This is placed in the database field S_Header.Permit_External_Call.

Boolean
 

Created_Date

      

The date on which the new assessment definition was created

Date
 

Modified_Date

      

The last date on which the new assessment definition was modified

Date

AssessmentBlockList

          

 
 

AssessmentBlock

(zero or more repetitions)

        

 
   

Block_Name

    

The name of this assessment block

String
   

Feedback

    

This indicates whether feedback is enabled or disabled for this block.

Boolean
   

Shuffle_Questions

    

This indicates whether questions are shuffled or not within this block.

Warning: There's a known issue with the GetAssessmentDefinition method where this field is returned incorrectly.

Boolean
   

Suspend_Time_Limit

    

If a Time_Limit is set for the assessment, this indicates whether this block is excluded from it.

Boolean
   

Use_Template_File

    

This indicates whether this block uses its own template independently of the template used for the assessment.

Warning: There's a known issue with the GetAssessmentDefinition method where this field is returned incorrectly.

Boolean
   

Template_Name

    

This is the template used for this block.

String
   

Introduction_Text

    

This is the introductory text used for this block.

String
   

ItemList

        
     

Item

(zero or more repetitions)

  

This parameter (if used) is in the form of sets of item (question) information, as detailed.

  
       

Method

0 - If this item (question) was selected randomly

1 - If all items (questions) in a topic were selected

2 - If this item (question) was selected as a single question

Integer
       

Include_Sub_Topics

If the method is 0 or 1, this indicates whether subtopics were included in the item (question) selection.

Boolean
       

Topic_ID

If the method is 0 or 1, this is the topic ID of the topic from which this item (question) was selected.

Boolean
       

Number_Of_Questions

If the method is 0, this is the number of items (questions) selected.

Integer
       

Question_ID

If the method is 0 or 2, this is the question ID of the selected item (question).

Integer

AssessmentOutcomeList

            
 

AssessmentOutcome

(zero or more repetitions)

          
   

Outcome_Name

    

The name of this assessment outcome

String
   

Session_Score

    

This indicates whether to show the total topic score.

Integer
   

Topic_Scores

    

This indicates whether to show the topic scoring.

Integer
   

Topic_Feedback

    

This indicates whether to show the topic feedback.

Boolean
   

Branch

    

0 - Do not branch after this assessment outcome 1 - Branch to another assessment after this assessment outcome 2 - Branch to a URL after this assessment outcome

Integer
   

Assessment_ID

    

If branch is 1, this is the assessment ID of the assessment to branch to.

Integer
   

Destination

    

If branch is 2, this is the URL to branch to.

String
   

Message

    

This is the message given as feedback with this assessment outcome.

String
   

Min_Percent

    

This is the lowest percentage score that will activate this assessment outcome.

Real
   

Max_Percent

    

This is the highest percentage score that will activate this assessment outcome.

Real

Troubleshooting

For information about any error codes displayed when using this method, see Error codes.