Student

Reminder: if you are using an app/client ID in sandbox, you must use sandbox.motar.io as the endpoint for your requests. Requests to api.motar.io with a sandbox client ID will fail!

These routes all require the "training" scope to be registered for the app you are making requests from. This scope requires special permission from MOTAR administrators.

Add a Comment

POST https://api.motar.io/edu/v1/student/comment

Adds a comment about a student.

Headers

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

Request Body

Name	Type	Description
studentId	string	ID of the student to which this comment pertains.
classId	string	ID of the class to which this comment pertains.
text	string	Text of the comment.
lessonId	string	If the comment pertains to a specific lesson, specify it here.

200 Comment added successfully.

{ commentId: '3a02cbb9ae4c2e167927d3259159bfa80793ecfebebd2fb989d4db65def37778dc592a8e0bee5b7b39608f5609446cf5f8832576d6a2b992d4919a42acc7e194e81ede86ea2aa670a1436be0678f2fa1ce$366b5c2e7cf20c2aaa6ad8f2bc4fef3d',
  student: 
   { handle: '@testerson2',
     firstName: 'Tabitha',
     lastName: 'Testerson',
     userType: 'adult',
     accountType: 'Adult',
     country: 'US',
     profilePic: '5dd55951a63523e850e3f788',
     coverPhoto: '5dd55951a63523e850e3f789',
     userId: '3a02cbb9ae4c2e157927d3259159bfa80793ecfebebd74ef89d4db65def37778dc592a8e0bee5b7b39608f5609446cf5f8832576d6a2b992d4919a42acc7e194e81ede86ea2aa670a1436be0678f2fa1ce$366b5c2e7cf20c2aaa6ad8f2bc4fef3d',
     anonymous: false,
  author: 
   { handle: '@testadult',
     firstName: 'Penny',
     lastName: 'Testman',
     userType: 'adult',
     accountType: 'Adult',
     country: 'US',
     profilePic: '5dd55952a63523e850e3f7ae',
     coverPhoto: '5dd55952a63523e850e3f7af',
     userId: '3a02cbb9ae4c2e167927d3259159bfa80793ecfebebd2ebc89d4db65def37778dc592a8e0bee5b7b39608f5609446cf5f8832576d6a2b992d4919a42acc7e194e81ede86ea2aa670a1436be0678f2fa1ce$366b5c2e7cf20c2aaa6ad8f2bc4fef3d',
     anonymous: false },
  course: '3a02cbb9ae4c2e167927d3259159bfa80793ecfebebd2eea89d4db65def37778dc592a8e0bee5b7b39608f5609446cf5f8832576d6a2b992d4919a42acc7e194e81ede86ea2aa670a1436be0678f2fa1ce$366b5c2e7cf20c2aaa6ad8f2bc4fef3d',
  lesson: '3a02cbb9ae4c2e167927d3259159bfa80793ecfebebd2fbc89d4db65def37778dc592a8e0bee5b7b39608f5609446cf5f8832576d6a2b992d4919a42acc7e194e81ede86ea2aa670a1436be0678f2fa1ce$366b5c2e7cf20c2aaa6ad8f2bc4fef3d',
  class: '3a02cbb9ae4c2e167927d3259159bfa80793ecfebebd2fbd89d4db65def37778dc592a8e0bee5b7b39608f5609446cf5f8832576d6a2b992d4919a42acc7e194e81ede86ea2aa670a1436be0678f2fa1ce$366b5c2e7cf20c2aaa6ad8f2bc4fef3d',
  text: 'Awesome student!' }

Read Comments

GET https://api.motar.io/edu/v1/student/comment

Retrieves comments about students based on the query provided.

Query Parameters

Name	Type	Description
studentId	string	ID of the student whose comments you would like to retrieve.
classId	string	ID of the class to retrieve comments for.
courseId	string	ID of the course to retrieve comments for.
lessonId	string	ID of the lesson to retrieve comments for.

Headers

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

200 A list of pertinent comments.

[ { commentId: '9cdad03cbe91c0a292121150a7b8b1df2785c71e8fe52371c9ee7eae1761c265f7c90bdf4ec314937d2555e6d89fc3e2303b16fd6f34e84d41b855098571b4cfa2de635b99ad76fed38c086ae32fbe8488$eba00573f78a7705d3092a552e9024e8',
    student: 
     { handle: '@testerson2',
       firstName: 'Getrude',
       lastName: 'Testerson',
       userType: 'adult',
       accountType: 'Adult',
       country: 'US',
       profilePic: '5dd55a1e22b467e85c53ee2d',
       coverPhoto: '5dd55a1e22b467e85c53ee2e',
       userId: '9cdad03cbe91c0a292121150a7b8b1df2785c71e8fe52678c9ee7eae1761c265f7c90bdf4ec314937d2555e6d89fc3e2303b16fd6f34e84d41b855098571b4cfa2de635b99ad76fed38c086ae32fbe8488$eba00573f78a7705d3092a552e9024e8',
       anonymous: false },
    author: 
     { handle: '@testadult-testman',
       firstName: 'Abby',
       lastName: 'Testman',
       userType: 'adult',
       accountType: 'Adult',
       country: 'US',
       profilePic: '5dd55a1f22b467e85c53ee53',
       coverPhoto: '5dd55a1f22b467e85c53ee54',
       userId: '9cdad03cbe91c0a292121150a7b8b1df2785c71e8fe5207cc9ee7eae1761c265f7c90bdf4ec314937d2555e6d89fc3e2303b16fd6f34e84d41b855098571b4cfa2de635b99ad76fed38c086ae32fbe8488$eba00573f78a7705d3092a552e9024e8',
       anonymous: false },
    course: '9cdad03cbe91c0a292121150a7b8b1df2785c71e8fe5237dc9ee7eae1761c265f7c90bdf4ec314937d2555e6d89fc3e2303b16fd6f34e84d41b855098571b4cfa2de635b99ad76fed38c086ae32fbe8488$eba00573f78a7705d3092a552e9024e8',
    lesson: '9cdad03cbe91c0a292121150a7b8b1df2785c71e8fe5237cc9ee7eae1761c265f7c90bdf4ec314937d2555e6d89fc3e2303b16fd6f34e84d41b855098571b4cfa2de635b99ad76fed38c086ae32fbe8488$eba00573f78a7705d3092a552e9024e8',
    class: '9cdad03cbe91c0a292121150a7b8b1df2785c71e8fe5237fc9ee7eae1761c265f7c90bdf4ec314937d2555e6d89fc3e2303b16fd6f34e84d41b855098571b4cfa2de635b99ad76fed38c086ae32fbe8488$eba00573f78a7705d3092a552e9024e8',
    text: 'Bad student!' } ]

400 Returned if the query does not contain one or more of studentId, classId, lessonId, and/or courseId.

{ error_code: 4005,
  error_description: 'You must specify a student, class, course, and/or lesson.' }