Class

A class is a group of users belonging to an instructor or student. Optionally, classes can be assigned a specific course.

Get Classes

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

Returns a student class list.

Query Parameters

Name	Type	Description
page	string	Results page to retrieve.
limit	string	Page size. Defaults to 10.

Headers

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

200 A list of classes, including courses if available. If a class is not associated with a course, the course attribute will be null.

{ docs: 
   [ { groupId: '484b2ccaa12326182d1294e033a105994c4efbf8fd13038912fc0afd96b1bd936fb96b5516d6e31cdbcac0e2b40bab5a1ed12c2bd3ac1587a00d44ef81cf19b0f15167d921d5db781763cdc34537ddf50e$98760d68bfcea5269e44347f3760c124',
       name: 'Cool Class for Cool Kids',
       joinCode: '3d09a351a3ca',
       studentId: '7f5d55a96c496150044ce6cab67171af7aa3e2367a79ff3c3ad3b0a51f6dc8c7c8067988e65569d1cbdc7c0e81da6ffa6da5eb831aed038f9973b9b7a74d753e9be04401e3f52b90203a7fecc99fd2a974$2fb47452b1b4d16bab8e98532f7e7cc3',
       course: 
        { courseId: '484b2ccaa12326182d1294e033a105994c4efbf8fd1304dc12fc0afd96b1bd936fb96b5516d6e31cdbcac0e2b40bab5a1ed12c2bd3ac1587a00d44ef81cf19b0f15167d921d5db781763cdc34537ddf50e$98760d68bfcea5269e44347f3760c124',
          name: 'Test Course',
          description: 'A test course',
          profilePic: '5d69318ab26d2810d4b5c9a0',
          coverPhoto: '5d69318cb26d2810d4b5c9a1' } } ],
  total: 1,
  limit: 10,
  page: 1,
  pages: 1 }

Get class structure

GET https://api.motar.io/edu/v1/class/structure

Query Parameters

Name	Type	Description
classId*	string	A class ID.

Headers

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

200: OK Class structure.

{
  "groupId": "62971a3f15603fef85e68899156991313a6f6931c406a10e27346956817e5f3c49b6634fec58eca47393a1eeae9460e71668ec772f8d10ad6c02e374d00ec1f2729fc4af5d88f5f2c46a91c2918be08af3$77daf4008e4ef1529fd88fa04fc681ec",
  "name": "Test Class",
  "course": {
    "courseId": "62971a3f15603fef85e68899156991313a6f6931c406a60a27346956817e5f3c49b6634fec58eca47393a1eeae9460e71668ec772f8d10ad6c02e374d00ec1f2729fc4af5d88f5f2c46a91c2918be08af3$77daf4008e4ef1529fd88fa04fc681ec",
    "name": "Test Course",
    "description": "A test course",
    "profilePic": "63d94b49a8a4dc3144a5e937",
    "coverPhoto": "63d94b49a8a4dc3144a5e939"
  },
  "instructors": [
    {
      "instructorId": "62971a3f15603fef85e68899156991313a6f6931c406a10827346956817e5f3c49b6634fec58eca47393a1eeae9460e71668ec772f8d10ad6c02e374d00ec1f2729fc4af5d88f5f2c46a91c2918be08af3$77daf4008e4ef1529fd88fa04fc681ec",
      "user": {
        "handle": "@testadult-testerson",
        "firstName": "Hannah",
        "lastName": "Testerson",
        "userType": "adult",
        "accountType": "Adult",
        "country": "US",
        "profilePic": "63d94b49a8a4dc3144a5e8f8",
        "coverPhoto": "63d94b49a8a4dc3144a5e8fa",
        "userId": "62971a3f15603fef85e68899156991313a6f6931c406a55c27346956817e5f3c49b6634fec58eca47393a1eeae9460e71668ec772f8d10ad6c02e374d00ec1f2729fc4af5d88f5f2c46a91c2918be08af3$77daf4008e4ef1529fd88fa04fc681ec",
        "anonymous": false,
        "position": null,
        "role": null,
        "organizationRoles": {},
        "gender": "female"
      }
    }
  ],
  "students": [
    {
      "studentId": "62971a3f15603fef85e68899156991313a6f6931c406a05f27346956817e5f3c49b6634fec58eca47393a1eeae9460e71668ec772f8d10ad6c02e374d00ec1f2729fc4af5d88f5f2c46a91c2918be08af3$77daf4008e4ef1529fd88fa04fc681ec",
      "user": {
        "handle": "@testadult-testerby",
        "firstName": "Vivian",
        "lastName": "Testerby",
        "userType": "adult",
        "accountType": "Adult",
        "country": "US",
        "profilePic": "63d94b49a8a4dc3144a5e902",
        "coverPhoto": "63d94b49a8a4dc3144a5e904",
        "userId": "62971a3f15603fef85e68899156991313a6f6931c406a50d27346956817e5f3c49b6634fec58eca47393a1eeae9460e71668ec772f8d10ad6c02e374d00ec1f2729fc4af5d88f5f2c46a91c2918be08af3$77daf4008e4ef1529fd88fa04fc681ec",
        "anonymous": false,
        "position": null,
        "role": null,
        "organizationRoles": {},
        "gender": "female"
      }
    }
  ],
  "observers": [
    {
      "observerId": "62971a3f15603fef85e68899156991313a6f6931c406a00827346956817e5f3c49b6634fec58eca47393a1eeae9460e71668ec772f8d10ad6c02e374d00ec1f2729fc4af5d88f5f2c46a91c2918be08af3$77daf4008e4ef1529fd88fa04fc681ec",
      "user": {
        "handle": "@testadult-testazowski",
        "firstName": "Abby",
        "lastName": "Testazowski",
        "userType": "adult",
        "accountType": "Adult",
        "country": "US",
        "profilePic": "63d94b49a8a4dc3144a5e90c",
        "coverPhoto": "63d94b49a8a4dc3144a5e90e",
        "userId": "62971a3f15603fef85e68899156991313a6f6931c406a45827346956817e5f3c49b6634fec58eca47393a1eeae9460e71668ec772f8d10ad6c02e374d00ec1f2729fc4af5d88f5f2c46a91c2918be08af3$77daf4008e4ef1529fd88fa04fc681ec",
        "anonymous": false,
        "position": null,
        "role": null,
        "organizationRoles": {},
        "gender": "female"
      }
    }
  ]
}