Геолокация объекта

Объекту можно указать координаты.

API

POST /api/v1/object/geolocation

Получить или установить координаты геолокации для объекта.

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

Имя	Тип	Значение	Описание
id	UUID		Обязательный. Идентификатор объекта.
coordinates	JSON array	null OR json	Вариативный. Массив JSON объектов с координатами.

Формат coordinates:

Ключ	Тип	Описание
code	STRING	Необязательный. Код. По умолчанию default. Может использоваться в качестве идентификатора места положения (home, work)
latitude	NUMERIC	Обязательный. Широта.
longitude	NUMERIC	Обязательный. Долгота.
accuracy	NUMERIC	Необязательный. Точность (высота над уровнем моря).
label	STRING	Необязательный. Метка.
description	STRING	Необязательный. Описание.
data	JSON	Необязательный. Данные в произвольном формате.

ВНИМАНИЕ: Если значение coordinates не указано или равно null, то метод работает как Получить иначе как Установить.

Установить

POST /api/v1/object/geolocation/set

Установить координаты геолокации для объекта.

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

Имя	Тип	Значение	Описание
id	UUID		Обязательный. Идентификатор объекта.
coordinates	JSON array		Обязательный. Массив JSON объектов с координатами.

ВНИМАНИЕ: Координаты геолокации для объекта хранятся в виде истории по дате и времени добавления.

Получить

POST /api/v1/object/geolocation/get

Получить последние координаты геолокации для объекта.

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

Имя	Тип	Значение	Описание
id	UUID		Обязательный. Идентификатор объекта.
code	STRING		Необязательный. Код. По умолчанию default. Может использоваться в качестве идентификатора места положения (home, work)
fields	JSON array		Необязательный. Массив JSON string полей в таблице, если не указано то запрос вернет все поля.

ВНИМАНИЕ: На период может повлиять значение oper_date (дата операционного дня) см. Текущие значения.

Формат ответа:

Ключ	Тип	Описание
id	UUID	Идентификатор записи.
object	UUID	Идентификатор объекта.
code	STRING	Код. По умолчанию default. Может использоваться в качестве идентификатора места положения (home, work)
latitude	NUMERIC	Широта.
longitude	NUMERIC	Долгота.
accuracy	NUMERIC	Точность (высота над уровнем моря).
label	STRING	Метка.
description	STRING	Описание.
data	JSON	Данные в произвольном формате.
validfromdate	TIMESTAMP	Дата начала периода действия.
validtodate	TIMESTAMP	Дата окончания периода действия.

Формат data произвольный. Если данные передавались чезер потоковый сервер, то в data в поле device будут содержаться данные GPS устройства.

Формат data:

{
  "device": {
    "id": uuid,
    "identity": string,
    "serial": string,
    "battery": numeric
  }
}

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

{
  "id": "1a445b54-b28c-4b7b-b8de-3b19b380131a",
  "object": "697c3dfe-5d1f-4a68-8463-f7ebe1ea415f",
  "code": "default",
  "latitude": 54.7119513000032,
  "longitude": 20.5316411000007,
  "accuracy": 0,
  "label": "ANDROID-test",
  "description": null,
  "validfromdate": "2020-12-27T16:36:03.5391+03:00",
  "validtodate": "2020-12-27T17:08:05.090964+03:00",
  "data": {
    "device": {
      "id": "697c3dfe-5d1f-4a68-8463-f7ebe1ea415f",
      "serial": "test",
      "battery": 37,
      "identity": "ANDROID-test"
    }
  }
}

Список

POST /api/v1/object/geolocation/list

Получить координаты геолокации в виде списка.

Параметры запроса: Общие параметры запроса для списка