POST /v1/enrolment-adjustments/delayed-start-enrolment

Delayed Start Enrolment Enrolment Adjustment

application/json

Body Required

Request for delaying an enrolment start

  • classId string Required

    Class ID

  • studentId string Required

    Student ID

  • date string(date) Required

    Date

Responses

  • 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

  • 200 application/json

    successful operation

    Hide response attributes Show response 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

POST /v1/enrolment-adjustments/delayed-start-enrolment
curl \
 --request POST 'https://api.classmanager.io/v1/enrolment-adjustments/delayed-start-enrolment' \
 --header "Content-Type: application/json" \
 --data '[{"classId":"cls_xxxxxxxxxxxxxxxxxxxxxxxxxx","studentId":"stu_xxxxxxxxxxxxxxxxxxxxxxxxxx","date":"2024-03-20"}]'
Request examples
[
  {
    "classId": "cls_xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "studentId": "stu_xxxxxxxxxxxxxxxxxxxxxxxxxx",
    "date": "2024-03-20"
  }
]
Response examples (403)
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (404)
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}
Response examples (200)
[
  {
    "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"
  }
]