Long text (essay) (Deprecated)

Examples

{
    "response_id": "60004",
    "type": "longtext",
    "stimulus": "write about their hobbies in no more than 400 words",
    "max_length": 400,
    "character_map": 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.

• 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: "longtext"

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

  The minimum height of the text entry area. Input as units. Example: "100px"

• ui_style.max_height stringUnits

  The max height of the text input including units. Example: "100px"

• validation object

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

• validation.max_score number

  The highest score a marker can award to this question response.

• validation.min_score_if_attempted number

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

  Default: 0

• validation.unscored boolean

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

  Default: false

• description string

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

• formatting_options array

  An array containing strings of text formatting options to make available.

  Default: ["bold","italic","underline","unorderedList"]

• max_length number

  Maximum number of words that can be entered in the field. Maximum: 100,000 chars ~ 10,000 words

  Default: 10000

• character_map boolean / array [characters]

  If true, the character map button will display in the long text editor toolbar. The character map will display the default set of special characters.
  If an Array, the character map button will show and display only the array of characters.
  IMPORTANTThe HTML document will require a charset of utf-8: <meta charset="utf-8">

  Default: false

• spellcheck boolean

  Control the input/textarea attributes spellcheck, autocapitalize, autocomplete and autocorrect. See "Spell check MDN". "Autocapitalize MDN". "Autocomplete MDN" " Autocorrect ". Note these are browser features and may not always be available.

  Default: true

• disable_auto_link boolean

  Sets whether urls, entered by the user should automatically become clickable-links.

  Default: false

• submit_over_limit boolean

  Determines if the user is able to save/submit when the word limit has been exceeded.

  Default: false

• placeholder string

  Placeholder text that can be added into the response entry area, which disappears when user starts typing.

• show_word_limit string

  Determines how the word limit UI will display. Options are the following strings:
  "always": Word limit is always shown and updated as the user types
  "on-limit": Word limit is only displayed when the word limit is exceeded
  "off": No word limit it shown.

  Default: "always"