Assessment

An assessment is a series of questions or tasks that a student must complete to finish a course.

Read an Assessment

GET https://api.motar.io/edu/v1/assessment

Retrieves a single assessment by ID to be displayed to a user.

Query Parameters

Name
Type
Description

assessmentId

string

The ID of an assessment or the ID of the assessment's lesson. An assessment's ID can be found in the "media" attribute of an assessment lesson.

Headers

Name
Type
Description

Authorization

string

Auth token generated by user login.

[ { answers: null,
    questionType: 'short-answer',
    question: 'What is the secret identity of the Batman?',
    correctAnswerIndex: null },
  { answers: [ 'Yes', 'No' ],
    questionType: 'multiple-choice',
    question: 'Is Batman cool?',
    correctAnswerIndex: 0 } ]

Update Student Assessment Answers

POST https://api.motar.io/edu/v1/assessment/progress

Updates a student's answer for an assessment question.

Headers

Name
Type
Description

Authorization

string

Auth token generated by user login.

Request Body

Name
Type
Description

correct

boolean

Whether or not a student's short answer is correct. If the question is multiple choice this parameter is not required (and is ignored).

answer

string

Text of student's answer picked from the array of answers in the question object if question is multiple choice, or free text if the question is short answer.

questionText

string

The text of the question the student is answering, taken from the Get Assessment route above. One of "questionIndex" or "questionText" is required.

questionIndex

number

Integer index of the question in the assessment. This should match the index of the question returned in the assessment's array above. One of "questionIndex" or "questionText" is required.

classId

string

Assessments are graded on a class-by-class basis. Indicate which class you are reporting student answers on with this ID.

lessonId

string

ID of the assessment lesson.

studentId

string

Student who is being assessed. If omitted, defaults to the logged-in user.

{ studentId:
   '20130abb95ff8f5786e39bf4d087b52c2246b63900ffa929cecc3f540a51dde4e3ede60d0166e10f4e31f87ece1fe67b6074e839a5f6fd1aa6f6bdfbb47c917098c80d46b005b9660cb90b49f350dc2448$5867a08016ad0378a5d33c2c919a10f7',
  lessonId:
   '20130abb95ff8f5886e39bf4d087b52c2246b63900ffac24cecc3f540a51dde4e3ede60d0166e10f4e31f87ece1fe67b6074e839a5f6fd1aa6f6bdfbb47c917098c80d46b005b9660cb90b49f350dc2448$5867a08016ad0378a5d33c2c919a10f7',
  pass: false,
  score: null,
  answers:
   [ { question: 'What is the secret identity of the Batman?',
       answer: 'Bruce Wayne',
       correct: true },
     { question: 'Is Batman cool?',
       answer: null,
       correct: null } ],
  started: '2019-12-30T21:07:20.325Z',
  completed: null }

Last updated