GET - История точек

Метод GET /locations/points/history позволяет получить историю точек, связанных с местоположениями, с возможностью фильтрации, сортировки и пагинации.

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

Параметр	Тип	Описание	Значение по умолчанию
limit	integer	Количество элементов в ответе.	`2147483647` (макс.)
offset	number	Количество элементов, исключаемых с начала ответа.	`0`
sort	string	Сортировка элементов (например, `id,asc` или `name,desc`).	`id,asc`
q	string	Быстрый поиск по текстовым полям.	—
id	string	Фильтр по идентификатору точки (UUID). Для нескольких значений используйте `in:`.	—
name	string	Фильтр по имени точки.	—
type	string	Фильтр по типу точки (например, `QR`, `VIRTUAL`). Для нескольких значений используйте `in:`.	—
locationId	string	Фильтр по идентификатору местоположения.	—
tags	string	Фильтр по тегам. Для нескольких значений используйте `in:`.	—

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

GET /locations/points/history?limit=20&offset=0&sort=id,asc&name=P001

Пример успешного ответа

Код ответа: 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"
      ],
      "historyId": 1
    }
  ],
  "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: Теги, связанные с точкой.
- historyId: Идентификатор записи в истории.
meta: Метаданные ответа.
- offset: Количество пропущенных элементов.
- limit: Максимальное количество возвращаемых элементов.
- count: Общее количество элементов.
- sort: Детали сортировки.

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

500 Внутренняя ошибка сервера

Код ответа: 500 Internal Server Error
Тело ответа:

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

Описание: Эта ошибка указывает на непредвиденную проблему на стороне сервера. Повторите запрос позже или свяжитесь с поддержкой.

Заключение

Метод GET /locations/points/history позволяет гибко фильтровать, сортировать и использовать пагинацию при получении истории точек. Убедитесь, что параметры запроса указаны корректно, чтобы избежать ошибок и максимально эффективно использовать возможности фильтрации и сортировки.

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

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

Пример успешного ответа​

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

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

500 Внутренняя ошибка сервера​

Заключение​