Список геозон

Этот API возвращает список всех геозон с их характеристиками, включая координаты, тип, цвет и группу.

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

Метод

POST

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

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

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

  • cmd=geofencelist— команда для получения списка геозон
  • node — номер узла, на котором нужно выполнить команду
 

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

https://<server_address>/api/api.php?cmd=geofencelist&node=1
Ответ
{
  "code": 0,
  "msg": "OK",
  "data": [
    {
      "id": 157828,
      "zonename": "Test Magnit",
      "zonetype": 2,             
      "external_id": null,       
      "created_at": 1609780839,  
      "updated_at": 1609780839,  
      "color": "#00CC00",
      "info": "geozone text info",
      "group_name": "TEST",
      "group_id": 6531,
      "geometry": {
        "type": "Circle",
        "coordinates": [40.036497, 46.981936],
        "radius": 305
      }
    },
    {
      "id": 153244,
      "zonename": "school",
      "zonetype": 1,             
      "external_id": 1234,       
      "created_at": 1609780839,  
      "updated_at": 1609780839,  
      "color": "#FF9900",
      "info": "kml upload",
      "group_name": "TEST",
      "group_id": 6531,
      "geometry": {
        "type": "Polygon",
        "coordinates": [
          [
            [55.184334, 25.112866],
            [55.183512, 25.113472],
            [55.182154, 25.112516],
            [55.183511, 25.111016],
            [55.184923, 25.112133]
          ]
        ]
      }
    }
  ]
}
 
В ответе на API-запрос возвращается:
  • code — код результата (0 — успешная операция)
  • msg — сообщение сервера
  • data — массив объектов геозон, каждый из которых содержит:
  • id — идентификатор геозоны
  • zonename — название геозоны
  • zonetype — тип геозоны (1 — полигон, 2 — круг)
  • external_id — внешний идентификатор (если есть)
  • created_at — время создания (Unix timestamp)
  • updated_at — время обновления (Unix timestamp)
  • color — цвет геозоны в интерфейсе
  • info— дополнительная информация
  • group_name — название группы геозон
  • group_id — идентификатор группы
  • geometry — геометрия зоны:
  • type — тип (Circle или Polygon)
  • coordinates — координаты (для круга: [долгота, широта]; для полигона: массив массивов координат)
  • radius — радиус для круговой геозоны (в метрах)