Sort list (sortlist)

The sort list Question is referenced by its Question type in the code, which is sortlist. This Question allows students to answer Questions by arranging entries in a list into the correct order by dragging from a source area to a target area (left-to-right, usually).

Read the authoring documentation for a description of what this Question does.
Read the developer reference documentation to see configuration options for this Question type.

Examples

{
    "response_id": "60022",
    "type": "sortlist",
    "stimulus": "sort the events, chronologically earliest to latest.",
    "list": ["Russian Revolution", "Discovery of the Americas", "Storming of the Bastille", "Battle of Plataea", "Founding of Rome", "First Crusade"],
    "instant_feedback": true,
    "feedback_attempts": 2,
    "validation": {
        "scoring_type": "partialMatch",
        "valid_response": {
            "value": [4, 3, 5, 1, 2, 0]
        },
        "penalty": 1
    }
}

Attributes

is_math boolean

Set to true to have LaTeX or MathML contents to be rendered with mathjax.

Default: false
metadata object

Object containing additional information about the question.
metadata.distractor_rationale string

Used to display individual response feedback/rationale to the student.
metadata.rubric_reference string

A unique identifier for the rubric to be used with the question - defaults to course rubric if assigned in activity
metadata.sample_answer string

A sample answer to be displayed on the Learnosity Reports API. HTML is supported.
metadata.acknowledgements string

References for any text passages, documents, images etc. used in the question.
stimulus string

The question stimulus. This can include text, tables, images, resources and LaTeX entered via the Math Editor.
stimulus_review string

HTML/Text content displayed only in review state rendered above the response area. Supports embedded Feature <span> tags. Will override stimulus in review state.
instructor_stimulus string

HTML/Text content displayed when showInstructorStimulus is set to true on the activity. Supports embedded Feature <span> tags.
type string

Type of question being asked, e.g. 'association'

Default: "sortlist"
ui_style object

Object used to control different aspects of the UI
ui_style.fontsize string

Controls the size of base font for this question. Options are among 'small', 'normal', 'large', 'xlarge' and 'xxlarge'.

Default: "normal"
ui_style.validation_stem_numeration string

Numeration character to be displayed to the left of the validation label.

Default: "number"
ui_style.show_drag_handle boolean

Determines whether to show the drag handle.

Default: "true"
feedback_attempts number

If instant_feedback is true, this field determines how many times the user can click on the 'Check Answer' button. 0 means unlimited.

Default: 0
instant_feedback boolean

Flag to determine whether to display a 'Check Answer' button to provide instant feedback to the user.

Default: false
validation object

In this section, configure the correct answer(s) for the question.
validation.allow_negative_scores boolean

Negative scores will be normalised to zero by default. Allowing negative scores, on the other hand, means that the score can drop below zero when penalties are applied.

Default: false
validation.penalty number

Value indicating the marks deducted for an incorrect response.

Default: 0
validation.min_score_if_attempted number

Positive value indicating the minimum score if a student attempted the question.

Default: 0
validation.scoring_type string

Defines the scoring approach used. Possible options:
'exactMatch': Exact Match - Entire response must match exactly
'partialMatchV2': Partial Match - A relative part of the score will be given for each correct response area
'partialMatch': Partial Match Per Response - Cumulative Score value will be given for each correct response area

Default: "exactMatch"
validation.unscored boolean

When enabled, this option will remove all scoring from the question. This is useful for creating practice questions.

Default: false
validation.valid_response object

An object containing the valid response score and value.
validation.valid_response.score number

Score awarded for the correct response(s).

Default: 1
validation.valid_response.value questionOrderlist

Array of integers indicating the correct order of indexes of the list
validation.automarkable boolean

Defines whether the question will be marked automatically, or must be marked manually.

Default: true
validation.alt_responses array

Add an alternate response if there is more than one correct overall solution to a question.
validation.alt_responses[ ].score number

Score if the alternative response is correct.

Default: 1
validation.alt_responses[ ].value questionOrderlist
validation.alt_responses[ ][ ].score number

Score if the alternative response is correct.

Default: 1
validation.alt_responses[ ][ ].value questionOrderlist
description string

Deprecated See stimulus_review.
Description of the question and its context to be displayed. It supports HTML entities.
list array

An unordered list of statements that the student must place in the correct order.
shuffle_options boolean

Use this to shuffle Sort List stimulus list options order.

Default: false

Response format

The data returned in the response format for this Question is the entries in the list, sorted into a new order by the students, who dragged the entries from a source area to a target area.

Response format examples

{
    "value": [
        3,
        4,
        5,
        0,
        1,
        2
    ],
    "source": [
        null,
        null,
        null,
        null,
        null,
        null
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 2
}

Response attributes

value array

The entries in the list, sorted into a new order by the students.
source array

An array that contains the same number of entries as the list.
type string

Informs the scoring engine about what kind of data to expect in the values entered by the student. For this Question type, you must always supply a string for this attribute with the value "array".
apiVersion string

The version of the Questions API that returned this response.
revision numeric

Keeps track of the number of Question attempt submissions, i.e. how many times the student answered the Question and submitted it.
feedbackAttemptsCount numeric

Keeps track of the number of feedback attempts.