List

GET /v1/enrolment-adjustments/

List Enrolment Adjustment

Query parameters

search string

Global search
page number

Current page
pageSize number

Number of items per page
selectAll boolean

Determines if all items are selected
where object

App\Classes\EnrolmentAdjustments\Models\EnrolmentAdjustment Filters: 0, 1, 2, 3, 4, 5, 6
Hide where attributes Show where attributes object
- id object
  
  Filter by id field
  
  One of:
  DateFilterSchema object TextFilterSchema object NumberFilterSchema object DecimalFilterSchema object SelectFilterSchema object MultiSelectFilterSchema object BooleanFilterSchema object
  
  Hide attributes Show attributes
  
  equals string
  
  notEquals string
  
  greaterThan string
  
  lessThan string
  
  greaterThanOrEqual string
  
  lessThanOrEqual string
  
  isNotNull string
  
  month string
  
  year string
  
  Hide attributes Show attributes
  
  equals integer
  
  notEquals integer
  
  greaterThan integer
  
  lessThan integer
  
  greaterThanOrEqual integer
  
  lessThanOrEqual integer
  
  isNotNull integer
  
  month integer
  
  year integer
  
  Hide attributes Show attributes
  
  equals number
  
  notEquals number
  
  greaterThan number
  
  lessThan number
  
  greaterThanOrEqual number
  
  lessThanOrEqual number
  
  isNotNull number
  
  month number
  
  year number
- classId object
  
  Filter by classId field
  
  One of:
  DateFilterSchema object TextFilterSchema object NumberFilterSchema object DecimalFilterSchema object SelectFilterSchema object MultiSelectFilterSchema object BooleanFilterSchema object
  
  Hide attributes Show attributes
  
  equals string
  
  notEquals string
  
  greaterThan string
  
  lessThan string
  
  greaterThanOrEqual string
  
  lessThanOrEqual string
  
  isNotNull string
  
  month string
  
  year string
  
  Hide attributes Show attributes
  
  equals integer
  
  notEquals integer
  
  greaterThan integer
  
  lessThan integer
  
  greaterThanOrEqual integer
  
  lessThanOrEqual integer
  
  isNotNull integer
  
  month integer
  
  year integer
  
  Hide attributes Show attributes
  
  equals number
  
  notEquals number
  
  greaterThan number
  
  lessThan number
  
  greaterThanOrEqual number
  
  lessThanOrEqual number
  
  isNotNull number
  
  month number
  
  year number
- studentId object
  
  Filter by studentId field
  
  One of:
  DateFilterSchema object TextFilterSchema object NumberFilterSchema object DecimalFilterSchema object SelectFilterSchema object MultiSelectFilterSchema object BooleanFilterSchema object
  
  Hide attributes Show attributes
  
  equals string
  
  notEquals string
  
  greaterThan string
  
  lessThan string
  
  greaterThanOrEqual string
  
  lessThanOrEqual string
  
  isNotNull string
  
  month string
  
  year string
  
  Hide attributes Show attributes
  
  equals integer
  
  notEquals integer
  
  greaterThan integer
  
  lessThan integer
  
  greaterThanOrEqual integer
  
  lessThanOrEqual integer
  
  isNotNull integer
  
  month integer
  
  year integer
  
  Hide attributes Show attributes
  
  equals number
  
  notEquals number
  
  greaterThan number
  
  lessThan number
  
  greaterThanOrEqual number
  
  lessThanOrEqual number
  
  isNotNull number
  
  month number
  
  year number
- startAt object
  
  Filter by startAt field
  
  One of:
  DateFilterSchema object TextFilterSchema object NumberFilterSchema object DecimalFilterSchema object SelectFilterSchema object MultiSelectFilterSchema object BooleanFilterSchema object
  
  Hide attributes Show attributes
  
  equals string
  
  notEquals string
  
  greaterThan string
  
  lessThan string
  
  greaterThanOrEqual string
  
  lessThanOrEqual string
  
  isNotNull string
  
  month string
  
  year string
  
  Hide attributes Show attributes
  
  equals integer
  
  notEquals integer
  
  greaterThan integer
  
  lessThan integer
  
  greaterThanOrEqual integer
  
  lessThanOrEqual integer
  
  isNotNull integer
  
  month integer
  
  year integer
  
  Hide attributes Show attributes
  
  equals number
  
  notEquals number
  
  greaterThan number
  
  lessThan number
  
  greaterThanOrEqual number
  
  lessThanOrEqual number
  
  isNotNull number
  
  month number
  
  year number
- endAt object
  
  Filter by endAt field
  
  One of:
  DateFilterSchema object TextFilterSchema object NumberFilterSchema object DecimalFilterSchema object SelectFilterSchema object MultiSelectFilterSchema object BooleanFilterSchema object
  
  Hide attributes Show attributes
  
  equals string
  
  notEquals string
  
  greaterThan string
  
  lessThan string
  
  greaterThanOrEqual string
  
  lessThanOrEqual string
  
  isNotNull string
  
  month string
  
  year string
  
  Hide attributes Show attributes
  
  equals integer
  
  notEquals integer
  
  greaterThan integer
  
  lessThan integer
  
  greaterThanOrEqual integer
  
  lessThanOrEqual integer
  
  isNotNull integer
  
  month integer
  
  year integer
  
  Hide attributes Show attributes
  
  equals number
  
  notEquals number
  
  greaterThan number
  
  lessThan number
  
  greaterThanOrEqual number
  
  lessThanOrEqual number
  
  isNotNull number
  
  month number
  
  year number
- type object
  
  Filter by type field
  
  One of:
  DateFilterSchema object TextFilterSchema object NumberFilterSchema object DecimalFilterSchema object SelectFilterSchema object MultiSelectFilterSchema object BooleanFilterSchema object
  
  Hide attributes Show attributes
  
  equals string
  
  notEquals string
  
  greaterThan string
  
  lessThan string
  
  greaterThanOrEqual string
  
  lessThanOrEqual string
  
  isNotNull string
  
  month string
  
  year string
  
  Hide attributes Show attributes
  
  equals integer
  
  notEquals integer
  
  greaterThan integer
  
  lessThan integer
  
  greaterThanOrEqual integer
  
  lessThanOrEqual integer
  
  isNotNull integer
  
  month integer
  
  year integer
  
  Hide attributes Show attributes
  
  equals number
  
  notEquals number
  
  greaterThan number
  
  lessThan number
  
  greaterThanOrEqual number
  
  lessThanOrEqual number
  
  isNotNull number
  
  month number
  
  year number
- reason object
  
  Filter by reason field
  
  One of:
  DateFilterSchema object TextFilterSchema object NumberFilterSchema object DecimalFilterSchema object SelectFilterSchema object MultiSelectFilterSchema object BooleanFilterSchema object
  
  Hide attributes Show attributes
  
  equals string
  
  notEquals string
  
  greaterThan string
  
  lessThan string
  
  greaterThanOrEqual string
  
  lessThanOrEqual string
  
  isNotNull string
  
  month string
  
  year string
  
  Hide attributes Show attributes
  
  equals integer
  
  notEquals integer
  
  greaterThan integer
  
  lessThan integer
  
  greaterThanOrEqual integer
  
  lessThanOrEqual integer
  
  isNotNull integer
  
  month integer
  
  year integer
  
  Hide attributes Show attributes
  
  equals number
  
  notEquals number
  
  greaterThan number
  
  lessThan number
  
  greaterThanOrEqual number
  
  lessThanOrEqual number
  
  isNotNull number
  
  month number
  
  year number
sort object

App\Classes\EnrolmentAdjustments\Models\EnrolmentAdjustment Sorting by

Responses

200 application/json

Paginated response
Hide response attributes Show response attributes object
- data array[object] Required
  
  Enrolment Adjustment schema
  
  Hide data attributes Show data 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
- pagination object Required
  
  Pagination schema
  
  Hide pagination attributes Show pagination attributes object
  
  total integer Required
  
  Total number of items
  
  count integer Required
  
  Number of items on this page
  
  perPage integer
  
  Number of items per page
  
  currentPage integer
  
  Current page number
  
  totalPages integer
  
  Total number of pages
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/enrolment-adjustments/

curl \
 --request GET 'https://api-dev.classmanager.io/v1/enrolment-adjustments/'

Response examples (200)

{
  "data": [
    {
      "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"
    }
  ],
  "pagination": {
    "total": 15,
    "count": 10,
    "perPage": 10,
    "currentPage": 1,
    "totalPages": 2
  }
}

Response examples (403)

{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}

List

Query parameters

id object

classId object

studentId object

startAt object

endAt object

type object

reason object

Responses