GET - История локаций

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

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

Параметр	Описание	Тип	Обязательный	Значение по умолчанию
limit	Максимальное количество элементов для возвращаемого списка.	Integer	Нет	2147483647
offset	Сдвиг, чтобы исключить первые N элементов.	Integer	Нет	0
sort	Параметр сортировки (например, id,asc).	String	Нет	id,asc
q	Быстрый поиск по текстовым полям.	String	Нет	-
name	Фильтрация по имени локации.	String	Нет	-
address	Фильтрация по адресу локации.	String	Нет	-
withGraphicPlan	Фильтрация по наличию графического плана.	Boolean	Нет	-
tags	Фильтрация по тегам, связанным с локацией.	String	Нет	-

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

Чтобы получить список локаций, в имени которых встречается "Walmart", с графическим планом, ограничив результат первыми 20 элементами:

GET /locations/history?limit=20&offset=0&sort=id,asc&q=Walmart&withGraphicPlan=true

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

Код ответа: 200 OK
Тип содержимого: application/json

Тело ответа:

{
  "data": [
    {
      "id": "638b90c5-7965-49ae-a02b-1b190cb216db",
      "name": "W001",
      "address": "Walmart 11,197",
      "latitude": 51.0966229,
      "longitude": -138.491986,
      "tags": [
        "tag1"
      ],
      "graphicPlanIds": [
        "3a1da1c9-0873-4bdc-b1f1-7343b29fdc27",
        "14b8ec6b-8ee2-4533-aedd-b82691f19af2"
      ],
      "historyId": 1
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 20,
    "count": 1000,
    "sort": [
      {
        "property": "id",
        "direction": "asc"
      }
    ],
    "filter": [
      {
        "property": "name",
        "value": "W001"
      }
    ]
  }
}

Разбор ответа:

• data: Содержит список локаций в истории. Каждая локация включает:
  • id: Уникальный идентификатор локации.
  • name: Имя локации (например, "W001").
  • address: Адрес локации (например, "Walmart 11,197").
  • latitude: Географическая широта локации.
  • longitude: Географическая долгота локации.
  • tags: Теги, связанные с локацией (например, "tag1").
  • graphicPlanIds: Список идентификаторов графических планов, связанных с локацией.
  • historyId: Идентификатор истории для локации.
• meta: Содержит метаинформацию о ответе:
  • offset: Начальная точка списка.
  • limit: Количество запрашиваемых элементов.
  • count: Общее количество доступных элементов.
  • sort: Описание порядка сортировки.
  • filter: Примененные фильтры (например, фильтрация по имени "W001").

Ошибки

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

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

Тело ответа:

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

Эта ошибка указывает на проблему на стороне сервера, которая помешала обработать запрос.

Резюме

Эндпоинт GET /locations/history предоставляет гибкий доступ к данным истории локаций с поддержкой различных фильтров (например, по имени локации, адресу и тегам) и опций сортировки. Это позволяет эффективно запрашивать данные истории локаций, включая фильтрацию по наличию графических планов. В случае возникновения ошибок возвращаются соответствующие сообщения об ошибках.