This is a lower-level API. Lower-level APIs are not recommended for most projects, and may not be available on all plans. See our page on recommended deployment patterns for more information.

Response Formats

This article outlines the data structure of the different response formats that all the types of Learnosity Questions will return when submitting responses to the Questions API, with examples of their usage.

Warning: response formats are subject to change

Response formats are not guaranteed to remain static over time, as they represent "under the hood" functionality of Learnosity. However, we provide examples of the formats and an explanation of how they work in order to give client developers as much information as possible. We recommend that you do not write tightly integrated code that relies on the response formats remaining the same over time.

On this page

Generic attributes (available in all Question types)

Overview

The following attributes are available in all Question types.

Response format example: generic attributes (available in all Question types)

{
    "apiVersion": "v2.173.0",
    "revision": 1,
    "resetState": "reset"
}

Attributes: generic attributes (available in all Question types)

Key Type Description
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.
resetState string [reset, attemptedAfterReset] Indicate the reset status of a Question response. This flag will not appear in the response object until the response of a Question has been reset through the public method resetResponse(). The resetState will be set to 'reset' when the response has been reset. If the Question will be attempted again after reset, the flag resetState will change from 'reset' to 'attemptedAfterReset'

Audio recorder (audio)

Overview

The audio recorder Question is referenced by its Question type in the code, which is audio. This Question allows students to record an answer in audio form, using their device microphone.

Data summary: audio recorder

The data returned in the response format for this Question has information about the recorded audio file, which the student has recorded in response to the Question.

Response format example: audio recorder

{
    "location": "0034/questionresponse/2019/265/0034_testing_user_01__4cbd3128-e3ab-412a-ab8f-aaf2ef96ed0d.v0",
    "type": "audio+png",
    "length": 3065,
    "created": "2019-09-23T04:12:35.678Z",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "uris": {
        "mp3": "https://.../....mp3",
        "png": "https://.../....png"
    }
}

Attributes: audio recorder

Key Type Description
location string The location of the recorded audio file.
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 "audio+png".
length numeric The length (in bytes) of the recorded audio file.
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.
uris object Universal Resource Indicators (links) for the recorded MP3 audio file and PNG graphic file of the waveform.

Chart (simplechart)

Overview

The chart Question is referenced by its Question type in the code, which is simplechart. The chart Question allows students to create or modify charts, including bar charts, line charts, histograms, dot plots and line plots.

Data summary: chart

The data returned in the response format for this Question is the information for the chart data, which are the data points that the student added to the chart or moved on the chart display.

Note: the different types of chart will return different data formats.

Response format example: chart

            {
                "value": {
                    "data": [
                        {
                            "x": "A",
                            "y": 10
                        },
                        {
                            "x": "B",
                            "y": 20
                        },
                        {
                            "x": "C",
                            "y": 40,
                            "interactive": true
                        },
                        {
                            "x": "D",
                            "y": 40
                        },
                        {
                            "x": "E",
                            "y": 50
                        },
                        {
                            "x": "F",
                            "y": 60
                        },
                        {
                            "x": "G",
                            "y": 70
                        },
                        {
                            "x": "H",
                            "y": 80
                        }
                    ],
                    "name": "Bar chart"
                },
                "type": "object",
                "apiVersion": "v2.173.0",
                "revision": 1,
                "feedbackAttemptsCount": 1
            }
            {
                "value": {
                    "data": [
                        {
                            "x": "A",
                            "y": 10
                        },
                        {
                            "x": "B",
                            "y": 15
                        },
                        {
                            "x": "C",
                            "y": 30
                        }
                    ],
                    "name": "Line chart"
                },
                "type": "object",
                "apiVersion": "v2.173.0",
                "revision": 1,
                "feedbackAttemptsCount": 1
            }

Attributes: chart

Key Type Description
value object The information in the chart entered or changed by students.
value.data object The data points within the chart.
value.name string The type of chart being displayed. This will be one of the following: "Bar chart", "Line chart", "Histogram", "Dot plot", or "Line plot".
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 "object".
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.

Chemistry essay with rich text (chemistryessayV2)

Overview

The chemistry essay with rich text Question is referenced by its Question type in the code, which is chemistryessayV2. This Question allows students to input text and chemistry formula within the same response.

Data summary: chemistry essay with rich text

The data returned in the response format for this Question is the text and chemistry formula(s) that the student entered.

Response format example: chemistry essay with rich text

{
    "value": [
        {
            "id": "chemistryessay_2296",
            "type": "math",
            "content": "The\\ formula\\ for\\ water\\ is\\ H^2O\\ .\\"
        }
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1
}

Attributes: chemistry essay with rich text

Key Type Description
value array Contains the id, type and content of the student response.
value.id string A unique id to identify each math/chemistry expression entered.
value.type string A type indicator for this expression.
value.content string The text and chemistry formula(s) that the student entered.
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 reponse.
revision numeric Keeps track of the number of Question attempt submissions, i.e. how many times the student answered the Question and submitted it.

Chemistry formula (chemistry)

Overview

The chemistry formula Question is referenced by its Question type in the code, which is chemistry. This Question allows students to input full or partial chemical formulas into empty response boxes.

Data summary: chemistry formula

The data returned in the response format for this Question is a string, which is the chemistry formula that the student entered.

Response format example: chemistry formula

        {
            "value": "H^2\ O",
            "type": "string",
            "responses": [],
            "apiVersion": "v2.173.0",
            "revision": 1,
            "feedbackAttemptsCount": 1
        }

Attributes: chemistry formula

Key Type Description
value string All the chemistry formula content that the student entered.
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 "string".
responses array Contains the content that the student entered into each individual response box when multiple response boxes are contained in the content. These response boxes are the scoreable answers.
apiVersion string The version of the Questions API that returned this reponse.
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.

Cloze math (clozeformula)

Overview

The cloze math Question is referenced by its Question type in the code, which is clozeformula. This Question allows students to enter a math response into one or more response boxes, set by the author. These response boxes can be placed on more than one line, as part of an equation or inline with text.

Data summary: cloze math

The data returned in the response format for this Question is the math response(s) entered by the student into one or more response boxes, set by the author.

Response format example: cloze math

            {
                "value": [
                    "1",
                    "2"
                ],
                "responses": [
                    [1+2=3],
                ],
                "type": "array",
                "apiVersion": "v2.173.0",
                "revision": 1,
                "feedbackAttemptsCount": 1
            }

Attributes: cloze math

Key Type Description
value array The full math formula(s) built based on the student's responses. These formulas are the scoreable answers.
responses array The responses that the student entered into each individual response box, if complex formulas with multiple response boxes are used.
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.

Cloze math with image (imageclozeformula)

Overview

The cloze math with image Question is referenced by its Question type in the code, which is imageclozeformula. This Question allows students to easily enter complex math formula as a response on top of an image, with advanced validation capabilities using math specific scoring methods.

Data summary: cloze math with image

The data returned in the response format for this Question is the math formulas which students have added on top of an image.

Response format example: cloze math with image

{
    "value": [
        null,
        "\frac{o}{a}"
    ],
    "responses": [
        null,
        []
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 1
}

Attributes: cloze math with image

Key Type Description
value array The math formulas entered by the student on the image.
responses array Contains the content that the student entered into each individual response box when multiple response boxes are contained in the content. These response boxes are the scoreable answers.
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.

Choice matrix (choicematrix)

Overview

The choice matrix Question is referenced by its Question type in the code, which is choicematrix. This Question requires students to evaluate one or more row items using a set of column options.

Data summary: choice matrix

The data returned in the response format for this Question is an array of integers, which represent the choices that the student made.

Response format example: choice matrix

{
    "value": [
        [1],
        [0],
        [1]
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 2
}

Attributes: choice matrix

Key Type Description
value array Contains the choices that the student made.
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 reponse.
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.

Classification (classification)

Overview

The classification Question is referenced by its Question type in the code, which is classification. This Question allows students to categorize a list of possible responses, in the form of words or images, into a table.

Data summary: classification

The data returned in the response format for this Question is an array of arrays, each containing indexes, which are the responses that the student dragged into the drop zones in the table.

Response format example: classification

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

Attributes: classification

Key Type Description
value array The responses that were dragged into the drop zones in the table.
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 reponse.
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.

Cloze text (clozetext)

Overview

The cloze text Question is referenced by its Question type in the code, which is clozetext. This Question allows students to type their responses into empty response boxes that have been inserted by the author into a passage of text.

Data summary: cloze text

The data returned in the response format for this Question is an array containing indexes, which are the responses that the student typed into the blank spaces in the passage.

Response format example: cloze text

{
    "value": [
        "1",
        "4",
        "9",
        "16",
        "25"
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1
}

Attributes: cloze text

Key Type Description
value array The responses that were typed into the blank spaces in the passage.
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 reponse.
revision numeric Keeps track of the number of Question attempt submissions, i.e. how many times the student answered the Question and submitted it.

Cloze chemistry (clozechemistry)

Overview

The cloze chemistry Question is referenced by its Question type in the code, which is clozechemistry. This Question allows students to enter chemical formulas into empty response boxes, which may form part of an equation, or appear in the middle of the text.

Data summary: cloze chemistry

The data returned in the response format for this Question is the chemical formulas that the the student entered into the empty response boxes.

Response format example: cloze chemistry

{
    "value": [
        "C^{60}"
    ],
    "responses": [
        []
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 1
}

Attributes: Cloze chemistry

Key Type Description
value array All the chemical formulas that the student entered.
responses array Contains the content that student entered into each individual response box when multiple response boxes are contained in the content. These response boxes are the scoreable answers.
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 reponse.
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.

Cloze chemistry with image (imageclozechemistry)

Overview

The cloze chemistry with image Question is referenced by its Question type in the code, which is imageclozechemistry. This Question allows students to input complex chemistry formulas on an image, using response boxes.

Data summary: cloze chemistry with image

The data returned in the response format for this Question is the complex chemistry formulas that the student added onto an image, using response boxes.

Response format example: cloze chemistry with image

{
    "value": [
        "Carbon"
    ],
    "responses": [
        []
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 2
}

Attributes: cloze chemistry with image

Key Type Description
value array All the complex chemistry formulas that the student added onto an image.
responses array Contains the content that the student entered into each individual response box when multiple response boxes are contained in the content. These response boxes are the scoreable answers.
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.

Cloze with drag & drop (clozeassociation)

Overview

The cloze with drag & drop Question is referenced by its Question type in the code, which is clozeassociation. This Question allows students to drag their responses from a list of options set by the author, into empty response boxes.

Data summary: cloze with drag & drop

The data returned in the response format for this Question is an array containing strings, which are the responses that the student dragged into the empty response boxes.

Response format example: cloze with drag & drop

{
    "value": [
        "whispered",
        "intruder",
        "acquaintance",
        "burning",
        "revolver",
        "spilt"
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 1
}

Attributes: cloze with drag & drop

Key Type Description
value array The responses that the student dragged into the empty response boxes.
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 reponse.
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.

Drawing (drawing)

Overview

The drawing Question is referenced by its Question type in the code, which is drawing. This Question allows freeform drawing, where students draw directly into the screen viewport with lines, arcs, gestures, or text.

Data summary: drawing

The data returned in the response format for this Question is an array of objects, each of which holds the data for one visual element that the student has drawn on the page. These can be lines, arcs, gestures, or text.

Response format example: drawing

            {
                "value": [
                    {
                        "type": "gesture",
                        "line_color": "rgba(255, 0, 0, 0.8)",
                        "line_width": 5,
                        "id": "4fabab13-4a13-4395-a190-4333d7f611d2",
                        "points": [
                            [
                                238,
                                167
                            ],
                            [
                                232,
                                168
                            ],
                            [
                                230,
                                169
                            ],
                            [
                                228,
                                170
                            ],
                                ...
                ]
            },
                    {
                        "type": "line",
                        "line_color": "rgba(255, 0, 0, 0.8)",
                        "line_width": 5,
                        "id": "65a3e41d-b8b8-4117-94d0-63d20734daee",
                        "points": "M112.44979858398438,226.02911376953125L415.6666564941406,167.80020141601562"
                    },
                    {
                        "type": "text",
                        "action": "modify",
                        "textValue": "Something",
                        "id": "f01053a3-6546-41c9-9790-d99797421693",
                        "x": 141,
                        "y": 71,
                        "fontSize": 14,
                        "color": "rgba(0, 116, 217, 1)",
                        "textAnchor": "left"
                    }
            ],
            "type": "array",
                    "apiVersion": "v2.153.0",
                    "revision": 1
            }

Attributes: drawing

Key Type Description
value array The configuration and coordinates of each element drawn onto the page. Within the array held in value, there are a number of properties:
value.type string Shows the type of visual element that has been drawn. This can be one of the following:
  • gesture - a freehand drawing.
  • line - a straight line.
  • arc - a curving arc made with the compass tool.
  • text - a text annotation.
value.line_color string Shows the line color of the element that has been drawn, as an RGBA value.
value.line_width numeric Shows the line width of the element that has been drawn, in pixels.
value.id string Shows the unique of the element that has been drawn.
value.points string Shows the pixel coordinates of the recorded points in the element that has been drawn. The format for each point is:
[x_coordinate, y_coordinate].
value.action string Shows the action that was performed, altering the status of the element. This can be one of the following:
  • modify - for text annotations, indicates that the text content or position was changed.
  • remove - indicates that the element was deleted.
value.textValue string For a text annotation, shows the text content that was displayed.
value.x numeric For a text annotation, shows the horizontal pixel coordinate value.
value.y numeric For a text annotation, shows the vertical pixel coordinate value.
value.fontSize numeric For a text annotation, shows the size setting for the text that was displayed.
value.color string For a text annotation, shows the text color of the element that was drawn, as an RGBA value.
value.textAnchor string For a text annotation, shows the alignment setting of the text, which will always be set to left. At the present time, only left alignment is supported.
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.

Essay with rich text (longtextV2)

Overview

The essay with rich text Question is referenced by its Question type in the code, which is longtextV2. This Question allows students to submit an essay response to a Question, of up to 10,000 words.

Data summary: essay with rich text

The data returned in the response format for this Question is the essay text, the response that the student entered (with text formatting), and a word count that gives an idea of how much text was written (often, a minimum or maximum number of words is required).

Response format example: essay with rich text

{
    "value": "<p>Shall I compare thee to a summer's day?
    Thou art more lovely and more temperate:
    Rough winds do shake the darling buds of May,
    And summer's lease hath all too short a date;
    Sometime too hot the eye of heaven shines,
    And often is his gold complexion dimm'd;
    And every fair from fair sometime declines,
    By chance or nature's changing course untrimm'd;
    But thy eternal summer shall not fade,
    Nor lose possession of that fair thou ow'st;
    Nor shall death brag thou wander'st in his shade,
    When in eternal lines to time thou grow'st:
    So long as men can breathe or eyes can see,
    So long lives this, and this gives life to thee.</p>",
"wordCount": 122,
"type": "string",
"apiVersion": "v2.173.0",
"revision": 1
}

Attributes: essay with rich text

Key Type Description
value string The essay text, the response that the student entered, with information for text formatting.
wordcount numeric A value indicating how much text was written in the student response.
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 "string".
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.

Essay with plain text (plaintext)

Overview

The essay with plain text Question is referenced by its Question type in the code, which is plaintext. This Question allows students to give long, detailed answers to Questions (up to a maximum of 10,000 words). As the grading of an essay is subjective, the Question cannot be auto scored.

Data summary: essay with plain text

The data returned in the response format for this Question is the text content that the student entered, and the wordcount that gives an idea of how much text was written (often, a minimum or maximum number of words is required).

Response format example: essay with plain text

{
    "value": "The quick, brown fox jumps over the lazy dog.",
    "wordCount": 9,
    "type": "string",
    "apiVersion": "v2.173.0",
    "revision": 1
}

Attributes: essay with plain text

Key Type Description
value string The text content entered by the student.
wordCount numeric A value indicating how much text was written in the student response.
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 "string".
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.

File upload (fileupload)

Overview

The file upload Question is referenced by its Question type in the code, which is fileupload. This Question allows students to upload a file to Learnosity, for review by the teacher.

Data summary: file upload

The data returned in the response format for this Question is the name, size, file type and location of the file(s) that the student uploaded.

Response format example: file upload

{
    "value": [
        {
            "name": "YN City 6.png",
            "originalName": "YN City 6.png",
            "extension": "png",
            "size": 6225609,
            "assetPath": "userupload/0034/questionresponse/2019/265/0034_testing_user_0034_testing_user_44__4cbd3128-e3ab-412a-ab8f-aaf2ef96ed0d/244afd18-79c9-4db0-921c-dd937447fff5.png"
        }
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1
}

Attributes: file upload

Key Type Description
value array name, size, file type and location of the file(s) that the student uploaded.
value.name string The file name the student chose.
value.originalName string The original file name from disk.
value.extension string The three letter file extension from the uploaded file, indicating the type of data contained within.
value.size numeric The size (in bytes) of the uploaded file.
value.assetPath numeric A path pointing to the storage location of the file.
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.

Graph plotting (graphplotting)

Overview

The graph plotting Question is referenced by its Question type in the code, which is graphplotting. This Question allows students to to plot points, lines, and shapes on a coordinate grid.

Data summary: graph plotting

The data returned in the response format for this Question is the plot points, lines, or shapes that the student plotted on the coordinate grid.

Response format example: graph plotting

{
    "value": {
        "actions": [
            "point(-2,7) << id: 'lrn_1', showinfobox: true, snaptogrid: true, snapsizex: 1, snapsizey: 1 >>;",
            "point(-4,3) << id: 'lrn_3', showinfobox: true, snaptogrid: true, snapsizex: 1, snapsizey: 1 >>;point(3,4) << id: 'lrn_2', showinfobox: true, snaptogrid: true, snapsizex: 1, snapsizey: 1 >>;circle(lrn_3,lrn_2) << id: 'lrn_4' >>;",
            "lrn_2.move([0,4]);",
            "lrn_3.move([0,3]);"
        ],
        "undo": [
            "remove(lrn_1);",
            "remove(lrn_3);remove(lrn_2);remove(lrn_4);",
            "lrn_2.move([3,4]);",
            "lrn_3.move([-4,3]);"
        ],
        "composition": [
            {
                "id": "lrn_1",
                "type": "point",
                "coords": {
                    "x": -2,
                    "y": 7
                }
            },
            {
                "id": "lrn_3",
                "type": "point",
                "coords": {
                    "x": 0,
                    "y": 3
                },
                "subElement": true
            },
            {
                "id": "lrn_2",
                "type": "point",
                "coords": {
                    "x": 0,
                    "y": 4
                },
                "subElement": true
            },
            {
                "id": "lrn_4",
                "type": "circle",
                "subElementsIds": {
                    "centrePoint": "lrn_3",
                    "radiusPoint": "lrn_2"
                }
            }
        ]
    },
    "type": "object",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 1
}

Attributes: graph plotting

Key Type Description
value object The points, lines, and/or shapes that the student plotted onto the coordinate grid.
value.actions array of strings Contains the steps that the student took to draw each shape onto the graph.
value.undo array of strings Contains the undo history for actions the student took on the graph.
value.composition array of objects Contains all of the shapes and related points drawn on the graph.
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 "object".
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.

Gridded (gridded)

Overview

The gridded Question is referenced by its Question type in the code, which is gridded. This Question allows students to answer Questions by shading in an option from a grid presented as a vertical column of "bubbles", showing numbers 0 to 9. Students can also type directly inside the input field and the Question will automatically shade the corresponding bubble in the column underneath.

Data summary: gridded

The data returned in the response format for this Question is the answers that the student selected from the columns of number options shown in the grid.

Response format example: gridded

{
    "value": [
        null,
        "2",
        "0",
        "0",
        "0",
        "1",
        "0",
        "0"
    ],
    "characterCount": 14,
    "type": "string",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 2
}

Attributes: gridded

Key Type Description
value array of strings A list of the answers from the grid columns, selected by the student.
characterCount numeric The number of characters entered by the student.
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 "string".
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.

Hotspot (hotspot)

Overview

The hotspot Question is referenced by its Question type in the code, which is hotspot. This Question allows students to answer Questions by clicking on target region(s) defined within the boundaries of an image.

Data summary: hotspot

The data returned in the response format for this Question is the region(s) inside the image where the student clicked to answer the Question.

Response format example: hotspot

{
    "value": [
        "2"
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 1
}

Attributes: hotspot

Key Type Description
value array The region(s) inside the image where the student clicked to answer 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".
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.

Image annotation upload (imageupload)

Overview

The image annotation upload Question is referenced by its Question type in the code, which is imageupload. This Question allows students to upload and annotate an image. The Question can be used in two ways. One way is using the annotation tool to add response boxes and label an image that has been uploaded by the author. This can be auto-scored. Another way is asking the students to upload an image themselves, directly from their machine and then use the annotation tool to place and label the response areas. In this case, the Question cannot be auto scored.

Data summary: image annotation upload

The data returned in the response format for this Question describes the annotations, which are the text entries that the student added on top of the image.

Response format example: image annotation upload

{
    "value": {
        "annotations": [
            {
                "id": "2224",
                "content": "Annotation on uploaded image.",
                "offset": {
                    "top": 46.15384615384615,
                    "left": 27.09030100334448,
                    "leftOffsetRatio": 0.25418060200668896,
                    "topOffsetRatio": 0.4280936454849498
                }
            }
        ]
    },
    "type": "object",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 2
}

Attributes: image annotation upload

Key Type Description
value object The content from the student response.
value.annotations array The information about annotations created by the student.
value.annotations.id string A unique id used to identify each annotation.
value.annotations.content string The text content entered by the student.
value.annotations.offset object Contains coordinates and offset information used to place the annotation on the image.
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 "object".
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.

Label image with drag & drop (imageclozeassociationV2)

Overview

The label image with drag & drop Question is referenced by its Question type in the code, which is imageclozeassociationV2. This Question allows students to select from a list of potential answers and drag them to the correct response box on the image. There is the option of allowing more than one correct response per container.

Data summary: label image with drag & drop

The data returned in the response format for this Question is the answers, which the student dragged onto the correct response box(es) on the image.

Response format example: label image with drag & drop

{
    "value": [
        [
            "Belfast"
        ],
        [
            "Galway"
        ],
        [
            "Athlone"
        ],
        [
            "Dublin"
        ],
        [
            "Cork"
        ]
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 1
}

Attributes: label image with drag & drop

Key Type Description
value array The answers, which the student dragged onto the correct response box(es) on the image.
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.

Label image with drop-down (imageclozedropdown)

Overview

The label image with drop-down Question is referenced by its Question type in the code, which is imageclozedropdown. This is a fill in the blanks Question type, where students fill in the blanks on images, via drop-down menus.

Data summary: label image with drop-down

The data returned in the response format for this Question is the text labels that the student added to the image using drop down menus.

Response format example: label image with drop-down

            {
                "value": [
                    "Belfast",
                    "Galway",
                    "Athlone",
                    "Dublin",
                    "Cork"
                ],
                "type": "array",
                "apiVersion": "v2.173.0",
                "revision": 1,
                "feedbackAttemptsCount": 1
            }

Attributes: label image with drop-down

Key Type Description
value array The text values added to the image.
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.

Label image with math (imageclozeformulaV2)

Overview

The label image with math Question is referenced by its Question type in the code, which is imageclozeformulaV2. This Question allows students to easily enter complex math formula as a response on top of an image, with advanced validation capabilities using math specific scoring methods.

Data summary: label image with math

The data returned in the response format for this Question is the math formulas which students have added on top of an image.

Response format example: label image with math

{
    "value": [
        null,
        "\frac{o}{a}"
    ],
    "responses": [
        null,
        []
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 1
}

Attributes: label image with math

Key Type Description
value array The math formulas entered by the student on the image.
responses array Contains the content that the student entered into each individual response box when multiple response boxes are contained in the content. These response boxes are the scoreable answers.
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.

Label image with text (imageclozetext)

Overview

The 'label image with text' Question is referenced by its Question type in the code, which is imageclozetext. This is a fill in the blanks Question type, where students fill in text boxes on images.

Response format summary

The data returned in the response format for this Question type is the text labels that the student added to the image.

Response format example: label image with text

{
    "value": [
        "Belfast",
        "Galway",
        "Athlone",
        "Dublin",
        "Cork"
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 1
}

Attributes: label image with text

Key Type Description
value array The text labels added to the image.
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.

Match list (association)

Overview

The match list Question is referenced by its Question type in the code, which is association. This Question allows students to pair associated items, using one static list and one dynamic list.

Data summary: match list

The data returned in the response format for this Question is the pairs of list items that the the student matched, when answering the Question.

Response format example: match list

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

Attributes: match list

Key Type Description
value array The list items that the student 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.
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.

Math (clozeformulaV2)

Overview

The math Question is referenced by its Question type in the code, which is clozeformulaV2. This Question allows students to enter a math response into one or more response boxes, set by the author. These response boxes can be placed on more than one line, as part of an equation or inline with text.

Data summary: math

The data returned in the response format for this Question is the math response(s) entered by the student into one or more response boxes, set by the author.

Response format example: math

{
    "value": [
        "1",
        "2"
    ],
    "responses": [
        [1+2=3]
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 1
}

Attributes: math

Key Type Description
value array The full math formula(s) built based on the student's responses. These formulas are the scoreable answers.
responses array The responses that the student entered into each individual response box, if complex formulas with multiple response boxes are used.
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.

Math essay with rich text (formulaessayV2)

Overview

The Math essay with rich text Question is referenced by its Question type in the code, which is formulaessayV2. This Question allows students to input text and math formula within the same response, usually when a response needs further explanation or math is required to be entered within the text of a written document. This Question is manually scored.

Data summary: math essay with rich text

The data returned in the response format for this Question is the text and math formula, which together comprise the answer the student submitted.

Response format example: math essay with rich text

{
    "value": "<p>The radius of the Earth is \(0.91\%\) of the radius of the Sun.</p>",
    "wordCount": 13,
    "type": "string",
    "apiVersion": "v2.172.0-rc.17",
    "revision": 1
}

Attributes: math essay with rich text

Key Type Description
value string The information in the chart entered or changed by students.
wordcount numeric A value indicating how much text was written in the student response.
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 "string".
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.

Multiple choice (mcq)

Overview

The multiple choice Question is referenced by its Question type in the code, which is mcq. This type of Question allows the student to select one or more correct answers from a number of potential answers.

Data summary: multiple choice

The data returned in the response format for this Question is the answer options a student has selected in order to answer the Question.

Note: the number of returned strings in the value array will depend on whether the Question variation chosen in the Question Editor interface accepts one or multiple answers per Question.

Response format example: multiple choice

{
    "value": [
        "2",
        "0"
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 1
}

Attributes: multiple choice

Key Type Description
value array The answer choice(s) selected by the student.
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.

Number line plot (numberlineplot)

Overview

The number line plot Question is referenced by its Question type in the code, which is numberlineplot. This Question allows students to plot points on a line, or stack points above a line.

Data summary: number line plot

The data returned in the response format for this Question is the points that the student plotted on a line, or points that were stacked above a line.

Response format example: number line plot

{
    "value": [
        {
            "type": "point",
            "point1": -6
        }
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 1
}

Attributes: number line plot

Key Type Description
value array The the points that the student plotted on a line, or points that were stacked above a line.
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.

Order list (orderlist)

Overview

The order list Question is referenced by its Question type in the code, which is orderlist. This Question allows students to organize a list of responses into a specified order. This Question can be used to reorder words, paragraphs of text, or sentences within a paragraph.

Data summary: order list

The data returned in the response format for this Question is the list of responses, as sorted by the student.

Response format example: order list

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

Attributes: order list

Key Type Description
value array The list of responses, as sorted by the student.
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.

Rating (rating)

Overview

The rating Question is referenced by its Question type in the code, which is rating. This Question allows students to select a rating by clicking on a bar of buttons showing a range of ratings, for example 25%, 50%, 75%, and 100%. The rating Question is useful for obtaining student feedback, or as a rubric for use by the teacher when providing feedback to the student. This is a non-auto-scored Question.

Data summary: rating

The data returned in the response format for this Question is the rating selected by the student.

Response format example: rating

{
    "value": "2",
    "type": "numeric",
    "apiVersion": "v2.173.0",
    "revision": 1
}

Attributes: rating

Key Type Description
value string The rating selected by the student.
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 "numeric".
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.

Shading (simpleshading)

Overview

The shading Question is referenced by its Question type in the code, which is simpleshading. This Question allows students to click on square "cells", which become shaded when clicked as their response. This Question is used to show a visual representation of functions and calculations, including fractions and ratios. Authors are able to format a set of cells, which are shaded by the student.

Data summary: shading

The data returned in the response format for this Question is the square "cells", which become shaded when clicked by the student as their response.

Response format example: shading

{
    "value": [
        [
            1,
            1
        ],
        [
            2,
            2
        ],
        [
            3,
            3
        ]
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 1
}

Attributes: shading

Key Type Description
value array The data about the square "cells", which become shaded when clicked by the student as their response.
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.

Short text (shorttext)

Overview

The short text Question is referenced by its Question type in the code, which is shorttext. This Question allows students to respond to Questions that have short, definite answers, for example, 1-2 words, or a number.

Data summary: short text

The data returned in the response format for this Question is the short text response, entered by the student.

Response format example: short text

{
    "value": "New Jersey",
    "characterCount": 10,
    "type": "string",
    "apiVersion": "v2.173.0",
    "revision": 2,
    "feedbackAttemptsCount": 1
}

Attributes: short text

Key Type Description
value string The short text response, entered by the student.
characterCount numeric The number of characters entered by the student.
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 "string".
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.

Sort list (sortlist)

Overview

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

Data summary: sort list

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 example: sort list

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

Attributes: sort list

Key Type Description
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.

Token highlight (tokenhighlight)

Overview

The token highlight Question is referenced by its Question type in the code, which is tokenhighlight. This Question allows students to highlight certain words, sentences, or paragraphs in a text passage by clicking on the text.

Data summary: token highlight

The data returned in the response format for this Question is the words, sentences, or paragraphs in a text passage, that the student highlighted.

Response format example: token highlight

{
    "value": [
        3
    ],
    "type": "array",
    "apiVersion": "v2.173.0",
    "revision": 1,
    "feedbackAttemptsCount": 1
}

Attributes: token highlight

Key Type Description
value array The words, sentences, or paragraphs in the text passage, that the student highlighted.
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.

Video recorder (video)

Overview

The video recorder Question is referenced by its Question type in the code, which is video. This Question allows students to record a video response.
Note: this Question type is not enabled by default - you will need to contact Learnosity Support to enable this.

Data summary: video recorder

The data returned in the response format for this Question is references to the video file that the student recorded as a response to a Question.

Response format example: video recorder

{
    "value": {
        "name": "0034_testing_user_46__4cbd3128-e3ab-412a-ab8f-aaf2ef96ed0d_1.mp4",
        "originalName": "0034_testing_user_46__4cbd3128-e3ab-412a-ab8f-aaf2ef96ed0d_1.webm",
        "extension": "mp4",
        "size": 254049,
        "assetPath": "userupload/0034/questionresponse/2019/265/0034_testing_user_0034_testing_user_46__4cbd3128-e3ab-412a-ab8f-aaf2ef96ed0d/2e1cbd29-b9c3-4c66-aa4b-271508f9c872.webm",
        "assetProcessedPath": "userupload/0034/questionresponse/2019/265/0034_testing_user_0034_testing_user_46__4cbd3128-e3ab-412a-ab8f-aaf2ef96ed0d/2e1cbd29-b9c3-4c66-aa4b-271508f9c872.mp4",
        "duration": 3,
        "srcType": "video/webm"
    },
    "type": "video",
    "created": "2019-09-24T01:46:22.409Z",
    "apiVersion": "v2.173.0",
    "revision": 1
}

Attributes: video recorder

Key Type Description
value object The references to the video file that the student recorded as a response to a Question. This includes the filename, file extension or type, file size, paths to the original and compressed files, and duration of the video (in seconds).
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 "video".
created string The time and date stamp of the video file's creation.
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.