GET - Список точек

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

---

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

HTTP метод: GET
Эндпоинт: /locations/points
Content-Type: Нет

---

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

Имя	Описание	Тип	Обязательный	Значение по умолчанию	Пример
limit	Количество элементов, которые нужно вернуть.	integer	Нет	2147483647	20
offset	Количество элементов, которые нужно пропустить.	integer	Нет	0	0
sort	Сортировка элементов в коллекции.	string	Нет	id,asc	id,asc
q	Быстрый поиск по текстовым полям.	string	Нет	—	"Point 1"
id	Фильтрация по конкретным идентификаторам точек.	string	Нет	—	in:f7d8347f-b19a-44d5-84c9-24d5a8a0b8a0
name	Фильтрация по имени точки.	string	Нет	—	"Point 1"
type	Фильтрация по типу точки.	string	Нет	—	in:QR,VIRTUAL
locationId	Фильтрация по идентификатору локации.	string	Нет	—	in:22220000-0000-0000-0000-000000000000
tags	Фильтрация по тегам, связанным с точкой.	string	Нет	—	"tag1,tag2"

---

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

URL:

GET /locations/points?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"
      ]
    }
  ],
  "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: Информация о сортировке ответа.

---

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

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

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

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

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

---

Резюме

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