Item - Either / Or

Item Resource - Either / Or

An Either/Or question type is again similar to the multiple choice question type but only provides the candidate with two options to choose from. 



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 either / or questions, including any mandatory minimum properties is as follows:

...
"eitherOrQuestions": [
{
{
]
...

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 Either / Or - JSON Example
GET/{id} - Item Either / Or - XML Example
Property Name Type Description Default Value
(POST)
Mandatory for
create (POST)
randomise boolean This flag determines if the answer options are randomised when the candidate views this in delivery. false
answerWidthRatio enumeration If multiple answer columns are defined then this property identifies the width ratio of the columns in the answer options.
Available values: "50/50", "20/80", "80/20"
null
optionList / options collection a collection of answer options that will be displayed to the candidate null
optionList / options / id int The id of the answer options. n/a
optionList / options / contentType enumeration The type of content included within the answer option.
Available values: "RichText", "Image", "MathML"
n/a
optionList / options / text HTML The text included in the answer option in HTML format. If multiple columns are used this will only display the first column. n/a
optionList / options / htmlText HTML The text included in the answer option in HTML format. Retired property. n/a
optionList / options / mathMl MathML The equation supplied in the answer option in MathML format. If multiple columns are used this will only display the first column. n/a
optionList / options / mediaItem object Any media that has been assigned to an answer option. If multiple columns are used this will only display the first column. n/a
optionList / options / mediaItem / id int The id of the media included in the answer option from the Media Library.
The ID relates to the Media resource in the Surpass API.
n/a
optionList / options / correct boolean This flag identifies if the option is correct. n/a X
(Live)
optionList / options / label string The label that has been assigned to the answer option. n/a
optionList / options / answerColumns collection A collection of content used on a particular answer option. This allows the user to define and identify if one single answer option has two types of content i.e. Text, Media, Equation. If only one is defined then only one object will be returned in this collection. n/a
optionList / options / answerColumns / text HTML The text included in the column of the answer option in HTML format. n/a X
(Live)
optionList / options / answerColumns / mathMl MathML The equation included in the column of the answer option in MathMl format. n/a
optionList / options / answerColumns / media object The media included in the column of the answer option from the Media Library. n/a
optionList / options / answerColumns / media / id int The id of the media included within the column of the answer option.
The id relates to the Media resource in the Surpass API
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

Feedback and Knowledge Base