Item - Multiple Choice

Item Resource - Multiple Choice

A multiple choice question type consists of a body of text containing the question, followed by a selection of answer options for the candidate to choose from. The minimum number of options is three. Answer options have been extended to allow for media, equation and text to be supplied, this results in an answer option having two columns. Importing and extracting this information from Surpass is supported by the Item Resource in the Surpass API. This question type is also available to use as a "Survey" item type, all properties remain the same but the type is returned as part of the mutual properties.



To build a POST request to the item resource the body should include any top level property required on the item (further information about these properties can be found on the item resource help page), this would then be followed by the question type collection. The collection required for multiple choice questions, including any mandatory minimum properties is as follows:

...
"multipleChoiceQuestions": [
{
{
]
...

This collection would include all of the question specific properties required. The table below identifies all of these properties including its name, type, description, default value and if it is mandatory in a request. We have also provided sample requests for the POST and GET/{id} methods in XML and JSON format:

GET/{id} - Item MCQ - JSON Example
GET/{id} - Item MCQ - XML Example
Property Name Type Description Default Value
(POST)
Mandatory for
create (POST)
addLabelsToOptions boolean This option defines if labels will be displayed to candidates in delivery. false
markType enumeration The marking type for the multiple choice question.
Available values: "Standard", "Weighted".
standard
randomise boolean This identifies if answer options will be randomised in delivery. false
answerWidthRatio enumeration This property is used to identify the width of columns if two answer columns are defined in the option list.
Available values: "50/50" "20/80" and "80/20".
50/50
optionList / options collection This refers to the list of answer options included in the question. n/a X
optionList / options / assistiveMedia object Assistive media refers to any additional media that has been added to the answer option that is available for candidates in delivery. null
optionList / options / assistiveMedia / id int The id of the assistive media in context of the item. n/a
optionList / options / assistiveMedia / href string The request URl to return the assistive media file in base 64 encoded format. n/a
optionList / options / id int The id of the answer option component. n/a
optionList / options / contentType enumeration This identifies the media type used for the item
Available values: "RichText", "Image", "MathML".
RichText
optionList / options / text HTML The answer option text supplied in HTML format. This will only ever return the first answer option column. null
optionList / options / htmlText HTML The answer option text supplied in HTML format. This will only ever return the first answer option column. null
optionList / options / mathMl mathML The answer option equation supplied in MathML format. This will only ever return the first answer option column. null
optionList / options / mediaItem resource The media associated to the answer option. null
optionList / options / mediaItem / id int The id of the media associated to the answer option.
This relates to the media resource.
n/a
optionList / options / correct boolean Identifies if the answer option is correct. Only returned when marking type is "Standard". null
optionList / options / label string Provides the label assigned to an answer option. This can only be 3 characters. null
optionList / options / weightedMark int The weighted mark assigned to the answer option. This is only returned when the marking type is "Weighted". Can be a positive or negative integer. null
optionList / options / rationaleText string The rationale associated with an answer option to explain why it has been included. null
optionList / options / answerColumns collection If the answer option requires a combination of media, equation and/or text in one answer option then two columns need to be supplied. This collection allows you to specify this. Limited to 2 objects as part of the collection. This can be used instead of the property "text". n/a X
optionList / options / answerColumns / text HTML The text used in the answer option column using HTML format. This will be presented in the order it is passed into the request. null
optionList / options / answerColumns / mathML mathML The equation used in the answer option column using MathML format. This will be presented in the order it is passed into the request. null
optionList / options / answerColumns / media resource The media used in the answer option column. This will be presented in the order it is passed into the request. null
optionList / options / answerColumns / media / id int The id of the media used in the answer option column.
This relates to the Media resource.
n/a
tableOptionsHtml html The ability to import and export a table in HTML format that allows a candidate to select a specific row as their answer rather than an MCQ option. The correct answer is identified using the above "options > correct" property. This is only available in HTML subjects in item authoring.  n/a
rationaleEnabled boolean This identifies whether rationale is enabled for each answer option. false

Feedback and Knowledge Base