Class Manager
GET /v1/attendees

List Attendee

Query parameters

  • where array[object] Required

    Filter conditions

    Hide where attributes Show where attributes object
    • classId object Required

      Filter by Class ID

      Hide classId attribute Show classId attribute object
      • equals string

        Filter by exact ID

    • date object Required

      Filter by date

      Hide date attribute Show date attribute object
      • equals string(date)

        Filter by exact date

    • time object Required

      Filter by time

      Hide time attribute Show time attribute object
      • equals string

        Filter by exact time

Responses

  • 422 application/json

    Validation error

    Hide response attributes Show response attributes object
    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
  • 200 application/json

    List collection response

    Hide response attributes Show response attributes object
    • companyId string Required

      Company ID

    • classId string Required

      Class ID

    • studentId string Required

      Student ID

    • date string(date) Required
    • time string Required
    • status string Required

      Values are expected-to-attend or not-expected-to-attend.

    • adjustments array[object] Required

      Enrolment Adjustment schema

      Hide adjustments attributes Show adjustments attributes object
      • id string Required

        Enrolment adjustment ID

      • classId string Required

        Class ID

      • studentId string Required

        Student ID

      • companyId string Required

        Company ID

      • reason string Required

        Values are make-up-lesson, delayed-start-enrolment, or cancelled-enrolment.

      • type string Required

        Values are addition or deduction.

      • startAt string(date) Required

        Start date

      • endAt string(date) Required

        End date

      • time string(time) | null Required

        Time

    • makeUpLessons array[object] Required

      Make Up Lesson schema

      Hide makeUpLessons attributes Show makeUpLessons attributes object
      • id string Required

        Make up lesson ID

      • companyId string Required

        Company ID

      • courseId string Required

        Class ID

      • studentId string Required

        Student ID

      • date string(date) Required

        Lesson date

      • time string(time) Required

        Lesson time

    • trials array[object] Required

      Trial schema

      Hide trials attributes Show trials attributes object
      • id string Required

        id

      • companyId string Required

        Company ID

      • classId string Required

        Class ID

      • studentId string Required

        Student ID

      • trialAt string(date) Required

        Date of trial

      • time string(time) Required

        Time of trial

      • archivedAt string(date-time) | null Required

        Archived at
  • 403 application/json

    Not authorized

    Hide response attributes Show response attributes object

    Error schema

    • statusCode number Required

      Status Code

    • messages array[string] Required

      List of error messages

    • exception object

      Exception
GET /v1/attendees 
curl \
 --request GET 'https://api-dev.classmanager.io/v1/attendees?where=%7B%7D'
Response examples (422) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (200) 
[
  {
    "companyId": "co_xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "classId": "cls_xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "studentId": "stu_xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "date": "2022-01-01",
    "time": "13:30",
    "status": "expected-to-attend",
    "adjustments": [
      {
        "id": "enad_xxxxxxxxxxxxxxxxxxxxxxxxxx",
        "classId": "cls_xxxxxxxxxxxxxxxxxxxxxxxxxx",
        "studentId": "stu_xxxxxxxxxxxxxxxxxxxxxxxxxx",
        "companyId": "co_xxxxxxxxxxxxxxxxxxxxxxxxxx",
        "reason": "make-up-lesson",
        "type": "addition",
        "startAt": "2023-12-05",
        "endAt": "2023-12-05",
        "time": "23:15"
      }
    ],
    "makeUpLessons": [
      {
        "id": "mkpl_xxxxxxxxxxxxxxxxxxxxxxxxxx",
        "companyId": "co_xxxxxxxxxxxxxxxxxxxxxxxxxx",
        "courseId": "cls_xxxxxxxxxxxxxxxxxxxxxxxxxx",
        "studentId": "stu_xxxxxxxxxxxxxxxxxxxxxxxxxx",
        "date": "2023-12-05",
        "time": "23:15"
      }
    ],
    "trials": [
      {
        "id": "trl_xxxxxxxxxxx",
        "companyId": "co_123123123123",
        "classId": "cls_123123123123",
        "studentId": "stu_123123123123",
        "trialAt": "2023-12-05",
        "time": "23:15",
        "archivedAt": "2024-06-12T09:39:49.000000Z"
      }
    ]
  }
]
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}