Match list (association)

This Question allows learners to pair associated options, presented as two columns with the prompt on one side and the learner response area on the other.

The match list Question is referenced by its type in the code, which is "association".

• Read the authoring documentation for instructions on how to author content for this Question type.

Examples

{
    "type": "association",
    "stimulus": "Match the cities to the parent nation.",
    "possible_responses": ["United States", "Australia", "France", "Ireland", "England"],
    "response_id": "60005",
    "stimulus_list": ["London", "Dublin", "Paris", "Boston", "Sydney"],
    "validation": {
        "scoring_type": "partialMatch",
        "valid_response": {
            "value": ["England", "Ireland", "France", "United States", "Australia"]
        }
    },
    "instant_feedback": true
}

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.

• metadata.distractor_rationale_response_level array

  Enter Distractor value for each response.

• 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

  Defines the Question type to be rendered.

  Must be set to "association" in this case.

• ui_style object

  Configuration to control different aspects of the Question type UI.

  See below for configurable attributes.

• ui_style.fontsize string

  Controls the size of the font for this Question.

  See Controlling Font Size in Learnosity Questions for more information.

  Default: "normal"

  Possible values

  • "small"
  • "normal"
  • "large"
  • "xlarge"
  • "xxlarge"

• ui_style.validation_stem_numeration string

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

  Default: "number"

  Possible values

  • "number" - Numbered starting from "1".
  • "upper-alpha" - Uppercase letters starting from "A".
  • "lower-alpha" - Lowercase letters starting from "a".

• ui_style.possibility_list_position string

  Defines where the possible options list is positioned relative to the response area.

  Default: "bottom"

  Possible values

  • "top"
  • "bottom"
  • "left"
  • "right"

• ui_style.show_drag_handle boolean

  Controls whether the drag indicator is shown on each of the possible options.

  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 array[string]

  The list of valid responses for each prompt in the stimulus_list in the corresponding array index order.

• 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 array

  Alternate response.

• validation.alt_responses[ ][ ].score number

  Score if the alternative response is correct.

  Default: 1

• validation.alt_responses[ ][ ].value array

  Alternate response.

• group_possible_responses boolean

  Allows you to sort the possible responses into different groups, with each group having its own heading.

  Default: false

• description string

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

• shuffle_options boolean

  Randomly shuffle the order of the prompts presented to the learner.

  Default: false

• duplicate_responses boolean

  Allows the learner to re-use any possible responses any number of times.

  Default: false

• stimulus_list array[string]

  The list of values to be shown for each prompt.

Response format

The data returned in the response format for this Question are the ordered possible responses that the the learner matched, when answering the Question.

Response format examples

{
    "value": [
        "France",
        "England",
        "United States",
        "Australia",
        "Ireland"
    ],
    "type": "array",
    "updatedFormat": true,
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 1
}

Response attributes

• value array

  The possible responses that the learner matched, when answering the Question.

• 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".

• updatedFormat boolean

  Indicates whether or not this is in the updated format for scoring.

• 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.