Class Manager
GET /v1/drop-ins

List Drop In

Query parameters

  • page number

    Current page

  • pageSize number

    Number of items per page

  • selectAll boolean

    Determines if all items are selected

  • where object

    App\Classes\DropIns\Core\Models\DropIn Filters: 0, 1, 2, 3, 4

    Hide where attributes Show where attributes object
  • sort object

    App\Classes\DropIns\Core\Models\DropIn Sorting by dropInDate, dropInTime

    Hide sort attributes Show sort attributes object
    • dropInDate string

      Values are asc or desc.

    • dropInTime string

      Values are asc or desc.

  • onlyArchived boolean

    Determines whether to return only archived records in the response.

  • includeArchived boolean

    Determines whether to return with archived records in the response.

Responses

  • 200 application/json

    Paginated response

    Hide response attributes Show response attributes object
    • data array[object] Required

      Drop-in with course data

      Hide data attributes Show data attributes object
      • id string Required

        Drop in ID

      • companyId string Required

        Company ID

      • courseId string Required

        Class ID

      • studentId string Required

        Student ID

      • dropInDate string(date) Required

        Drop-in date

      • dropInTime string(time) Required

        Drop-in time

      • courseName string Required

        Course name

      • courseDayOfWeek string Required

        Course day of week

        Values are monday, tuesday, wednesday, thursday, friday, saturday, or sunday.

      • courseTime string(time) Required

        Course time

      • courseDuration integer Required

        Course duration in minutes

      • status string Required

        Status

        Values are cancelled-lesson, cancelled-class, changed-date, additional-lesson, or delayed-start-class.

    • 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/drop-ins 
curl \
 --request GET 'https://classmanager.test/v1/drop-ins'
Response examples (200) 
{
  "data": [
    {
      "id": "dpi_xxxxxxxxxxxxxxxxxxxxxxxxxx",
      "companyId": "co_xxxxxxxxxxxxxxxxxxxxxxxxxx",
      "courseId": "cls_xxxxxxxxxxxxxxxxxxxxxxxxxx",
      "studentId": "stu_xxxxxxxxxxxxxxxxxxxxxxxxxx",
      "dropInDate": "2023-12-05",
      "dropInTime": "23:15",
      "courseName": "Ballet",
      "courseDayOfWeek": "monday",
      "courseTime": "23:15",
      "courseDuration": 100,
      "status": "cancelled-lesson"
    }
  ],
  "pagination": {
    "total": 15,
    "count": 10,
    "perPage": 10,
    "currentPage": 1,
    "totalPages": 2
  }
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}