Class Manager
GET /v1/reporting/staff/export

Export Staff

Query parameters

  • page number

    Current page

  • pageSize number

    Number of items per page

  • selectAll boolean

    Determines if all items are selected

  • where object

    App\Staff\Core\Models\Staff Filters: 0, 2, 3

    Hide where attributes Show where attributes object
  • sort object

    App\Staff\Core\Models\Staff Sorting by firstname, lastname, createdAt

    Hide sort attributes Show sort attributes object
    • firstname string

      Values are asc or desc.

    • lastname string

      Values are asc or desc.

    • createdAt 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

    successful operation

    Hide response attribute Show response attribute object
    • url string Required

      Report URL
  • 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/reporting/staff/export 
curl \
 --request GET 'https://classmanager.test/v1/reporting/staff/export'
Response examples (200) 
{
  "url": "https://www.example.com/report/my-report.csv"
}
Response examples (403) 
{
  "statusCode": 42.0,
  "messages": [
    "string"
  ],
  "exception": {}
}