Course

In MOTAR, a "course" is a data structure that a teacher can create. A course can contain any number of lessons.

Read a Course

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

Retrieves a single course by ID.

Query Parameters

Name	Type	Description
courseId	string	The ID of the requested course.

Headers

Name	Type	Description
Authorization	string	Auth token generated by user login.

200 Returns the course.

{ courseId: 'b1161645be4d7dafb73c5ba2a9be745c14a3b06c89ffa4e1de2b136125badcf6d853cccf49f5fed916b3bdbcd99d2dee04481ddcfec1a3295abf663405fc6dd6c25e2b33c23cc2177a9c117f7b4ed40a07$cb50983fb276183150f3bed45aa31bf8',
  name: 'Cool Course for Cool Kids',
  description: 'A cool course that teaches kids to be cool.',
  profilePic: '5d691b8707d0161062eb8801',
  coverPhoto: null }

Lists All Courses

GET https://api.motar.io/edu/v1/course/list

Lists all courses.

Query Parameters

Name	Type	Description
limit	number	Page size, defaults to 10.
page	number	Results page to return, defaults to 1.

Headers

Name	Type	Description
Authorization	string	Auth token generated by user login.

200 List of courses, along with the page, limit, total results, and number of pages.

{ docs: 
   [ { courseId: 'a1ebfdc5328f33116dbfdc175239f1c5ed7c82f8dd7f7ba153b1b7f9ee8d914b0e3d86f88214ef7ea681d90633b5891e0f4f11aa3489da86d8204809dc0ad1ba15cfb2513747479f456953cc24536ef59e$8778901d1b182ffd2096a4dac481ab91',
       name: 'Test Course',
       description: 'A test course',
       profilePic: '5d691e1677fde4106be829fe',
       coverPhoto: '5d691e1677fde4106be829ff' } ],
  total: 1,
  limit: 10,
  page: 1,
  pages: 1 }

Read Course Objectives

GET https://api.motar.io/edu/v1/course/objectives

Retrieves a courses objectives.

Query Parameters

Name	Type	Description
courseId	string	The ID of the requested course.

Headers

Name	Type	Description
Authorization	string	Auth token generated by user login.

200 A list of course objectives.

[{
    "objectiveId": "a1ebfdc5328f33116dbfdc175239f1c5ed7c82f8dd7f7ba153b1b7f9ee8d914b0e3d86f88214ef7ea681d90633b5891e0f4f11aa3489da86d8204809dc0ad1ba15cfb2513747479f456953cc24536ef59e",
    "name": "2.1.1 Progression in the Crew Chief Career Ladder",
    "lessonIds": ["ac5f1ba630fe00c29a1c938a22e80a8ba402e1e98b675c7c7d4b66a670c51007566eed9855d125cb270a6b5e963e447688da39561ab4bd3d200c903e3b67fb00afa8dd5a10569c490ab387b75f04c9b217"]
}]

Read Course Objective Performance

GET https://api.motar.io/edu/v1/course/objectives/performance

Retrieves a courses objectives along with a student's performance on the objectives.

Query Parameters

Name	Type	Description
courseId	string	The ID of the requested course.

Headers

Name	Type	Description
Authorization	string	Auth token generated by user login.

200 A list of course objectives with the requested student's skill level and the scores that were used to calculate it. Skill level ranks can be 0 ("Basic"), 1 ("Advanced"), or 2 ("Expert"). In the "lessonScores" array, the score is either the score of the student's latest completed attempt at the lesson, or an objective score sent in via the API (see Update Student's Objective Score), indicated by the "scoreType" attribute. If a student has no recorded progress on the Objective's linked lessons, "skill" will be 0, and "skillDescription" and "score" will both be null.

[{
  "objectiveId": "2d23d1c8d02046b50e908bcc380f42d0e712b4cc3c9defc0e338be2b0ec89e74afdc19c7d30a3692deae2418499b6dfa7fa6e174e36d74fba8cce032a939ccd331f623a4e268a6b8a090d3d086dd37043a$2b32458e5aac5fc060a7e98b01dd5765",
  "name": "Test Objective 1",
  "skill": 3,
  "skillDescription": "Expert",
  "score": 100,
  "lessonScores": [{
    "lessonId": "2d23d1c8d02046b50e908bcc380f42d0e712b4cc3c9def9ce338be2b0ec89e74afdc19c7d30a3692deae2418499b6dfa7fa6e174e36d74fba8cce032a939ccd331f623a4e268a6b8a090d3d086dd37043a$2b32458e5aac5fc060a7e98b01dd5765",
    "score": 100,
    "scoreType": "objective"
  }]
 },{
  "objectiveId": "2d23d1c8d02046b50e908bcc380f42d0e712b4cc3c9defc1e338be2b0ec89e74afdc19c7d30a3692deae2418499b6dfa7fa6e174e36d74fba8cce032a939ccd331f623a4e268a6b8a090d3d086dd37043a$2b32458e5aac5fc060a7e98b01dd5765",
  "name": "Test Objective 2",
  "skill": 1,
  "skillDescription": "Basic",
  "score": 50,
  "lessonScores": [{
    "lessonId": "2d23d1c8d02046b50e908bcc380f42d0e712b4cc3c9def9ce338be2b0ec89e74afdc19c7d30a3692deae2418499b6dfa7fa6e174e36d74fba8cce032a939ccd331f623a4e268a6b8a090d3d086dd37043a$2b32458e5aac5fc060a7e98b01dd5765",
    "score": 50,
    "scoreType": "lesson"
   },{
    "lessonId": "2d23d1c8d02046b50e908bcc380f42d0e712b4cc3c9def9de338be2b0ec89e74afdc19c7d30a3692deae2418499b6dfa7fa6e174e36d74fba8cce032a939ccd331f623a4e268a6b8a090d3d086dd37043a$2b32458e5aac5fc060a7e98b01dd5765",
    "score": 50,
    "scoreType": "lesson"
  }]
 },{
  "objectiveId": "2d23d1c8d02046b50e908bcc380f42d0e712b4cc3c9defc2e338be2b0ec89e74afdc19c7d30a3692deae2418499b6dfa7fa6e174e36d74fba8cce032a939ccd331f623a4e268a6b8a090d3d086dd37043a$2b32458e5aac5fc060a7e98b01dd5765",
  "name": "Test Objective 3",
  "skill": 0,
  "skillDescription": null,
  "score": null,
  "lessonScores": [{
    "lessonId": "2d23d1c8d02046b50e908bcc380f42d0e712b4cc3c9defc5e338be2b0ec89e74afdc19c7d30a3692deae2418499b6dfa7fa6e174e36d74fba8cce032a939ccd331f623a4e268a6b8a090d3d086dd37043a$2b32458e5aac5fc060a7e98b01dd5765",
    "score": null,
    "scoreType": null
  }]
}]

Read Course Levels

GET https://api.motar.io/edu/v1/course/levels

Retrieves a courses and populates the course's levels, along with all lessons and child lessons in order. If no student ID is provided in the query string, all lessons will show as unlocked. If a student ID is provided, the lock status of each lesson will be determined by the student's progress in the course against the lesson and/or level's prerequisites.

Query Parameters

Name	Type	Description
classId	string	An education class ID. A course ID OR class ID is required. If both are provided, class ID is ignored.
studentId	string	Optional ID of the student to check lock status for.
courseId	string	The ID of the requested course. A course ID OR class ID is required. If both are provided, class ID is ignored.

Headers

Name	Type	Description
Authorization	string	Auth token generated by user login.

200 A course document tree.

{
  "courseId": "102698673a90adcd2c360217c02d08679636a71d63c6fe98eb5febdd832188de2c42dd3dc19bbeb63bde7412f54daea2945c222be1e873f389a6238d5e69540652af652e62d4966c8033576491f433599b$2dec6ad7b5437aafdddd36c1eeaa5ce6",
  "name": "Test Course",
  "description": "A test course",
  "profilePic": "5f3bc933c33f0b4804800e2a",
  "coverPhoto": "5f3bc933c33f0b4804800e2c",
  "levels": [
    {
      "levelId": "102698673a90adcd2c360217c02d08679636a71d63c5abcdeb5febdd832188de2c42dd3dc19bbeb63bde7412f54daea2945c222be1e873f389a6238d5e69540652af652e62d4966c8033576491f433599b$2dec6ad7b5437aafdddd36c1eeaa5ce6",
      "name": "Level 1",
      "lessons": [
        {
          "lessonId": "102698673a90adcd2c360217c02d08679636a71d63c6fe99eb5febdd832188de2c42dd3dc19bbeb63bde7412f54daea2945c222be1e873f389a6238d5e69540652af652e62d4966c8033576491f433599b$2dec6ad7b5437aafdddd36c1eeaa5ce6",
          "courseId": "102698673a90adcd2c360217c02d08679636a71d63c6fe98eb5febdd832188de2c42dd3dc19bbeb63bde7412f54daea2945c222be1e873f389a6238d5e69540652af652e62d4966c8033576491f433599b$2dec6ad7b5437aafdddd36c1eeaa5ce6",
          "name": "Test Lesson 1",
          "description": "A test lesson",
          "profilePic": "5f3bc933c33f0b4804800e2a",
          "coverPhoto": "5f3bc933c33f0b4804800e2c",
          "media": "http://www.google.com",
          "isAssessment": false,
          "expectedCompletionTime": 120,
          "instructorGraded": false,
          "public": true,
          "childLessons": [],
          "launchParameters": [
            "extId=abc123"
          ],
          "locked": true
        }
      ]
    }
  ]
}