PPEAM

Get All

GET /api/locations/shifts/reports
Http bearer

Fetch all shift reports

Query parameters

  • page integer

    Default value is 1.

  • perPage integer

    Maximum value is 250. Default value is 100.

  • locationId string | null
  • sortBy string | null

    Default value is -date.

  • since string | string(date) | null
  • until string | string(date) | null
  • format string

    Values are json or excel. Default value is json.

Responses

  • 200 application/json

    Successful Response

    Hide response attributes Show response attributes object
    • items array[object] Required
      Hide items attributes Show items attributes object
      • id string Required
      • shift object Required
        Hide shift attributes Show shift attributes object
        • startTime string(time) Required
        • endTime string(time) Required
        • dayOfWeek integer | null Required

          Minimum value is 0.0, maximum value is 6.0.

        • seatsCount integer Required

          Minimum value is 1.0, maximum value is 20.0.

        • isEnabled boolean Required
        • id string Required
        • location object Required
          Hide location attributes Show location attributes object
          • id string Required

            Minimum length is 26, maximum length is 26.

          • name string Required

      • date string | string(date) Required

        Any of:
        string-1 string string-2 string(date)
      • submitter object Required
        Hide submitter attributes Show submitter attributes object
        • id string Required

          Minimum length is 26, maximum length is 26.

        • name string Required
        • username string Required
    • total integer Required
    • page integer Required
    • perPage integer Required
    • totalPages integer Required
    • hasNextPage boolean Required
  • 422 application/json

    Validation Error

    Hide response attribute Show response attribute object
    • detail array[object]
      Hide detail attributes Show detail attributes object
      • loc array[string | integer] Required
      • msg string Required
      • type string Required
GET /api/locations/shifts/reports 
curl \
 -X GET https://metropolitanabogota.org/api/locations/shifts/reports \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "items": [
    {
      "id": "string",
      "shift": {
        "startTime": "09:42:00+00:00",
        "endTime": "09:42:00+00:00",
        "dayOfWeek": 42,
        "seatsCount": 42,
        "isEnabled": true,
        "id": "string",
        "location": {
          "id": "string",
          "name": "string"
        }
      },
      "date": "string",
      "submitter": {
        "id": "string",
        "name": "string",
        "username": "string"
      }
    }
  ],
  "total": 42,
  "page": 42,
  "perPage": 42,
  "totalPages": 42,
  "hasNextPage": true
}
Response examples (422) 
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}