Справочный центр Wialon
Wialon для разработчиков Руководство пользователя Документация API resource get_zones_by_unit

get_zones_by_unit

Метод get_zones_by_unit проверяет, находятся ли указанные объекты в пределах указанных геозон.

Конечная точка

Copied!
svc=resource/get_zones_by_unit&params={
  "spec": {
    "zoneId": {
      "<long>": [<long>, ...],
      ...
    },
    "units": [<long>],
    "time": <long>
  }
}

Параметры

Запрос должен содержать следующий параметр:

Название Тип Описание
spec object Содержит информацию о геозонах (zoneId), объектах (units) и времени (time), для которых проверяется нахождение объектов в пределах геозон. Описание этих параметров см. ниже.

Параметры spec

Обязательные параметры spec:

Название Тип Описание
zoneId object JSON-объект, который сопоставляет ID ресурсов с массивами ID геозон.
Каждый ключ — это ID ресурса, а значение — массив ID соответствующих геозон этого ресурса.

Пример
"zoneId": {
"912": [4, 5, 6, 7, 8, 9],
"913": [1, 2, 3, 4, 5, 76]

В этом примере:
  • ресурс с ID 912 содержит геозоны с ID 4, 5, 6, 7, 8, 9;
  • ресурс с ID 913 содержит геозоны с ID 1, 2, 3, 4, 5, 76.
units array of integers Список ID объектов, для которых проверяется нахождение в геозонах.

Пример
"units": [917]

В этом примере проверяется объект с ID 917.
time integer Задает время, для которого проверяется нахождение объектов в пределах геозон:
  • если указана временная метка в формате Unix, проверяется местоположение объекта в указанное время;
  • если указан 0, проверяется последнее известное местоположение объекта.

Пример
"time": 0

В этом примере проверяется последнее местоположение объекта.

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

Copied!
https://hst-api.wialon.com/wialon/ajax.html?svc=resource/get_zones_by_unit&sid=SESSION_IDENTIFIER&params={"spec":{"zoneId":{"912":[4,5,6,7,8,9],"913":[1,2,3,4,5,76]},"units":[917],"time":0}}

В этом примере:

  • запрос проверяет, находится ли объект с ID 917 в пределах указанных геозон двух ресурсов с ID 912 и 913;
  • time=0 означает, что проверяется последнее местоположение объекта 917.

Ответ

Ответ показывает, находились ли указанные объекты в пределах указанных геозон в запрошенное время.

Copied!
{
  "<text>": {     /* ID ресурса */
    "<text>": [   /* ID геозоны */
      <long>,     /* ID объектов */
      ...
    ]
  },
  ...
}

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

Copied!
{"912": {"4": [917]}}

В этом примере объект с ID 917 находится в пределах геозоны с ID 4. Геозона принадлежит ресурсу с ID 912.

Пустой ответ

Если в указанное время в геозонах не найдено ни одного объекта, возвращается пустой JSON.

Copied!
{}

Коды ошибок

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

Код ошибки Описание
4 Неверные входные параметры.
6 Неизвестная ошибка.

Если вы заметили ошибку в тексте, пожалуйста, выделите её и нажмите Ctrl+Enter.