Skip to main content

GET - Список точек для локации

Эндпоинт GET /locations/{id}/points используется для получения пагинированного списка точек, связанных с конкретной локацией.

Детали запроса​

HTTP метод: GET
Эндпоинт: /locations/{id}/points
Content-Type: Отсутствует

Параметры запроса:​

ИмяОписаниеТипОбязательныйЗначение по умолчанию
limitКоличество элементов для возврата.integerНет2147483647
offsetКоличество элементов, которые следует пропустить.integerНет0
idУникальный идентификатор локации.string($uuid)Да—

Пример запроса:​

URL:

GET /locations/12a8af51-52f6-409b-82c2-08bbd5df18c2/points?limit=20&offset=0

Успешный ответ​

Код ответа: 200 OK
Тело ответа:

{
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "locationId": "12a8af51-52f6-409b-82c2-08bbd5df18c2",
      "name": "P001",
      "type": "VIRTUAL",
      "latitude": null,
      "longitude": null,
      "graphicPlans": [],
      "rfidCode": null,
      "qrCode": null,
      "tags": ["tag1"]
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 20,
    "count": 15,
    "sort": [
      {
        "property": "id",
        "direction": "asc"
      }
    ]
  }
}

Описание полей:​

  • data: Массив объектов точек.
    • id: Уникальный идентификатор точки.
    • locationId: Идентификатор связанной локации.
    • name: Имя точки.
    • type: Тип точки (например, "VIRTUAL").
    • latitude/longitude: Географические координаты, если применимо.
    • graphicPlans: Связанные графические планы.
    • rfidCode/qrCode: RFID или QR код точки, если применимо.
    • tags: Теги, связанные с точкой.
  • meta: Метаданные ответа.
    • offset: Количество пропущенных элементов.
    • limit: Максимальное количество возвращаемых элементов.
    • count: Общее количество элементов в коллекции.
    • sort: Детали сортировки.

Возможные ошибки​

400 Неверный запрос - Неверные данные ввода​

Происходит, когда запрос содержит некорректные данные, такие как неверно отформатированный id.

Пример ответа:

{
  "message": "invalid input data",
  "code": "input.data.invalid",
  "timestamp": "2023-03-07T05:57:59.315Z",
  "details": [
    {
      "message": "invalid data type",
      "code": "data.type.invalid",
      "identifier": "id",
      "args": ["[UUID]"]
    }
  ]
}

500 Внутренняя ошибка сервера - Неожиданная проблема на сервере​

Происходит, когда на сервере возникает внутренняя ошибка.

Пример ответа:

{
  "message": "internal server error",
  "code": "internal.server.error",
  "timestamp": "2023-03-07T05:57:59.315Z"
}

Резюме​

Эндпоинт GET /locations/{id}/points возвращает пагинированный список точек для конкретной локации. Используйте параметры запроса limit и offset для управления количеством результатов и пагинацией. Убедитесь, что id действителен, чтобы избежать ошибок.