Supplemental information for API call POST ⧸learn⧸v1⧸lo⧸﹛id﹜⧸track

Values

id (integer, optional)
The internal ID of the submitted item. Returned only when type is submission.

Structure

{
  acknowledge: {
    id: (integer, optional)
  }
}

Values

url (string, required)
The URL of the S3 file to download

Structure

{
  acknowledge: {
    url: (string, required)
  }
}

Values

url (string, required)
The URL of the Google Drive file to play

Structure

{
    acknowledge: {
        url: (string, required)
    }
}

Values

content (string, required)
The HTML content to display

Structure

{
  acknowledge: {
    content: (string, required)
  }
}

Values

questions (array, required)
An array of questions for the requested page

question (string, required)
The ID of the question

question_index (integer, required)
The position of the question in the page

type (string, required)
The type of question. Possible values are:

• associate

• choice

• choice_multiple

• extended_text

• fill_in_the_blank

• inline_choice

• text_entry

• title

• upload

title (string, optional)
The question title to display

category (string, optional)
The question category

time_limit (integer, optional)
The time limit per question. Used only if time options for the test is per_question.

additional_info (object, optional)
Additional information used by specific question types

answers (array, optional)
Possible answers to the given question. Used only for questions where type is:

• choice

• choice_multiple

• inline_choice

• associate

id_answer (number, required)
The answer ID

text (string, required)
The answer title

associations (array, optional)
Possible association answers. Used only for questions where type is associate.

id (number, required)
The ID of the associated answer

title (string, required)
The title of the associated answer

user_status (object, optional)
An object containing the answers provided by the user so far

answer (string, optional)
The answer to this question. Required only for questions where type is:

• choice

• extended_text

• text_entry

• upload

• inline_choice

answers (object, optional)
An object containing the answers to this question. Required only for questions where type is:

• choice_multiple

• fill_in_the_blank

• associate

[id: (string)] (boolean | string | number, required - the ID itself is a string of the answer ID)
The selected answers to this question, indexed by answer ID. Returns a boolean value when the question type is choice_multiple. Returns a string when the question type is fill_in_the_blank. Returns a number when the question type is associate.

page_number (integer, optional)
The page number, returned only if there is a previous or next page.

user_status (object, optional)
The user status information for the current test

status (string, required)
The current quiz status for this user. Possible values are:

• not_submitted

• submitted

score (decimal, optional)
The current calculated score for the user

evaluation_status (string, optional)
If status is submitted, this contains the evaluation status. Possible values are:

• waiting_evaluation

• evaluated

completion_status (string, required)
The completion status. Possible values are:

• completed

• passed

• failed

• attempted

suspension_time (integer, optional)
This property sets how many minutes the user should wait before the test is unsuspended. If this value is set, the test is currently suspended.

time_consumed (string, optional)
Tracks the amount of time consumed by the user. Only used if time_option is per_test.

attempts_consumed (integer, optional)
Tracks the number of attempts consumed by the user. Only used if max_attempts is not 0.

feedback_message (string, optional)
An optional message that depends on the actual user score. Can be displayed if the quiz is in the status:

• suspended

• retakable

• max_attempts_reached

score_per_category (array, optional)
An optional array containing the calculated scores divided by category

category_name (string, required)
The name of the category

questions_count (integer, required)
The number of questions inside this category

score (decimal, required)
The calculated score for this category

total_score (decimal, required)
The total score

questions_id (string[], required)
An array of question IDs for this category

average_user_score (decimal, optional)
The average score of other users who have already completed the test

show_results (boolean, required)
Returns TRUE if the results should be displayed, otherwise returns FALSE

Structure

{
  acknowledge: {
    questions: [{
      question: (string, required),
      question_index: (integer, required),
      type: (string, required),
      title: (string, optional),
      category: (string, optional),
      time_limit: (integer, optional),
      additional_info: (object, optional) {
        answers: (array, optional) [{
          id_answer: (number, required),
          text: (string, required)
        }],
        associations: (array, optional) [{
          id: (number, required),
          title: (string, required)
        }],
      },
      user_status: (object, optional) {
        answer: (string, optional)
        answers: (object, optional) {
          [id: (string, required)]: (boolean / string / number, required)
        }
      }
    }],
    page_number: (integer, optional),
    user_status: (object, optional) {
      status: (string, required),
      score: (decimal, required),
      evaluation_status: (string, optional),
      completion_status: (string, required),
      suspension_time: (integer, optional),
      time_consumed: (string, optional),
      attempts_consumed: (integer, optional),
      feedback_message: (string, optional),
      score_per_category: (array, optional) [{
        category_name: (string, required),
        questions_count: (integer, required),
        score: (decimal, required),
        total_score: (decimal, required),
        questions_id: (string[], required)
      }],
      average_user_score: (decimal, optional),
      show_results: (boolean, required)
    }
  }
}

None

Values

is_completed (boolean, required)
Returns TRUE if the question is completed, otherwise returns FALSE

Structure

{
  acknowledge: {
    is_completed: (boolean, required)
  }
}

None