Get All

GET /api/locations

Fetch all locations

Query parameters

  • page integer

    Default value is 1.

  • perPage integer

    Maximum value is 250. Default value is 100.

  • sortBy string | null

    Default value is name.

  • isEnabled boolean | null

    Default value is true.

  • circuitId string | null

Responses

  • 200 application/json

    Successful Response

    Hide response attributes Show response attributes object
    • items array[object] Required
      Hide items attributes Show items attributes object
      • name string Required

        Minimum length is 4, maximum length is 100.

      • description string | null Required

        Maximum length is 150.

      • coordinates string | null
      • isEnabled boolean Required
      • id string Required
      • shiftsCount integer Required
      • shifts array[object] Required
        Hide shifts attributes Show shifts 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
      • remarksSummary string | null
      • labels array[object] Required
        Hide labels attributes Show labels attributes object
        • name string Required

          Minimum length is 1, maximum length is 50.

        • bgColor string Required

          Maximum length is 20.

        • id string Required
      • circuit object | null
        Hide circuit attributes Show circuit attributes object | null
        • name string Required

          Minimum length is 3, maximum length is 100.

        • id string Required

          Maximum length is 26.

      • createdAt string(date-time) Required
      • updatedAt string(date-time) | null
    • 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
curl \
 -X GET https://metropolitanabogota.org/api/locations \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200)
{
  "items": [
    {
      "name": "string",
      "description": "string",
      "coordinates": "string",
      "isEnabled": true,
      "id": "string",
      "shiftsCount": 42,
      "shifts": [
        {
          "startTime": "09:42:00+00:00",
          "endTime": "09:42:00+00:00",
          "dayOfWeek": 42,
          "seatsCount": 42,
          "isEnabled": true,
          "id": "string"
        }
      ],
      "remarksSummary": "string",
      "labels": [
        {
          "name": "string",
          "bgColor": "string",
          "id": "string"
        }
      ],
      "circuit": {
        "name": "string",
        "id": "string"
      },
      "createdAt": "2024-05-04T09:42:00+00:00",
      "updatedAt": "2024-05-04T09:42:00+00:00"
    }
  ],
  "total": 42,
  "page": 42,
  "perPage": 42,
  "totalPages": 42,
  "hasNextPage": true
}
Response examples (422)
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}