Добавление геозоны

Этот API создаёт новую геозону, указав её название, тип, цвет, группу и геометрию.

Как получить данные

Метод

GET

Адрес запроса

Для выполнения запроса используйте адрес: https://<server_address>/api/api.php?

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

  • cmd=geofenceadd — команда для добавления геозоны
  • zonename — название геозоны
  • zonetype — тип зоны (1 — многоугольник, 2 — круг)
  • color — цвет зоны в формате HEX (например, #FFFFFF)
  • info — текстовая информация о геозоне
  • group_name — название группы геозон (создаётся, если не существует, опционально)
  • group_id — ID существующей группы (если указан, group_name игнорируется, опционально)
  • geometry — GEOJson с описанием многоугольника или круга
  • external_id — внешний идентификатор геозоны (опционально)
  • node — номер узла, на котором нужно выполнить команду
 

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

 
Полигон:
http://<server_address>/api/api.php?cmd=geofenceadd&zonetype=1&zonename=test_api_polygon&external_id=12354&info=blabla&color=%23FF3300&group_name=TEST_API&geometry={"type":"Polygon","coordinates":[[[55.184334,25.112866],[55.183512,25.113472],[55.182154,25.112516],[55.183511,25.111016],[55.184923,25.112133]]]}&node=1
Круг:
http://<server_address>/api/api.php?cmd=geofenceadd&zonetype=2&zonename=test_api_circle&external_id=12345&info=circle_info&color=%23FF3300&group_name=TEST_API&geometry={"type":"Circle","coordinates":[55.184334,25.112866],"radius":150}&node=1
Ответ
{
  "code": 0,
  "msg": "OK",
  "data": {
    "id": 158412,
    "zonename": "test_api_polygon",
    "zonetype": 1,
    "external_id": "12354",
    "created_at": 1610536445,
    "updated_at": 1610536445,
    "color": "#FF3300",
    "info": "blabla",
    "group_id": 6984
  }
}
В ответе на API-запрос возвращается:
  • code — код результата (0 — успешная операция)
  • msg — сообщение сервера
  • data — объект с информацией о созданной геозоне:
  • id — идентификатор геозоны
  • zonename — название геозоны
  • zonetype — тип зоны (1 — многоугольник, 2 — круг)
  • external_id — внешний идентификатор
  • created_at — время создания (Unix timestamp)
  • updated_at — время обновления (Unix timestamp)
  • color — цвет геозоны
  • info — текстовая информация
  • group_id— идентификатор группы геозон