Геозоны

Основные запросы

Получить список геозон

Запрос:

GET /api/v1/geofences 

Ответ: 

Массив всех геозон проекта

Получить информацию об одной геозоне

Запрос:

GET /api/v1/geofences/:id

Ответ: 

Представление геозоны в формате JSON

Создать новую геозону

В теле запроса на создание новой геозоны укажите ее представление в формате JSON.

Обязательные поля:

  • name — имя новой геозоны.
Изменить геозону

В теле запроса на изменение существующей геозоны укажите поля, которые нужно обновить.

Запрос:

PATCH /api/v1/geofences/:id

{

  "color": "#fc0fc0"

}

Ответ:

Представление геозоны в формате JSON с учетом измененных полей

Удалить геозону

Запрос:

DELETE /api/v1/geofences/:id

Ответ: 

Представление удаленной геозоны в формате JSON

Добавление геозон на объект

Важно: В запросах :id — идентификатор объекта, на который нужно добавить геозону, :geofence — идентификатор добавляемой геозоны.

Добавить геозону на объект

Запрос:

POST /api/v1/objects/:id/geofences/:geofence/start

Ответ:

Информация о статусе выполнения запроса

Удалить геозону с объекта

Запрос:

POST /api/v1/objects/:id/geofences/:geofence/stop

Ответ:

Информация о статусе выполнения запроса