Class Manager
GET /v1/enrolments/{id}

Get Enrolment

Path parameters

  • id string Required

    Enrolment id

Responses

  • 200 application/json

    successful operation

    Hide response attributes Show response attributes object
    • id string Required

      Enrolment ID

    • companyId string Required

      Company ID

    • classId string Required

      Class ID

    • studentId string Required

      Student ID

    • startAt string(date) | null Required

      Start At

    • endAt string(date) | null Required

      End 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
  • 404 application/json

    Not found

    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/enrolments/{id} 
curl \
 --request GET 'https://localhost/v1/enrolments/enr_xxxxxxxx'
Response examples (200) 
{
  "id": "enr_xxxxxxxxxxxxxxxxxxxxxxxxxx",
  "companyId": "co_xxxxxxxxxxxxxxxxxxxxxxxxxx",
  "classId": "cls_xxxxxxxxxxxxxxxxxxxxxxxxxx",
  "studentId": "stu_xxxxxxxxxxxxxxxxxxxxxxxxxx",
  "startAt": "2023-12-05",
  "endAt": "2023-12-05"
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (404) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}