Работа с геозонами

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

Общее описание

Функция GET /v6/api/zoneManagement/zones?withCustomTemplateItems={boolean} позволяет получить список гео-зон.

Параметры вызова

В запросе используется обязательный параметр withCustomTemplateItems — нужно ли отображать дополнительные поля Сотрудника (true — нужно возвращать, false — без дополнительных полей).

Результат выполнения

Функция возвращает массив структур со следующими параметрами гео-зон:

Параметр	Описание
zoneID	ИД гео-зоны
name	Название гео-зоны
color	Цвет группы объектов
enabled	Признак активности гео-зоны: true — гео-зона включена (учитывается при определении местоположения Сотрудников, в отчетах, отображается на карте); false — гео-зона выключена.
zoneGroupID	ИД группы гео-зон
comment	Комментарий к гео-зоне
bounds (параметры границы гео-зоны)
longitude	Географическая долгота точки гео-зоны (в градусах)
latitude	Географическая широта точки гео-зоны (в градусах)
customFieldFormTemplateID	ИД шаблона дополнительных полей гео-зоны
Параметры дополнительных полей гео-зоны (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля: string – строка; text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

Формат запроса

GET /v6/api/zoneManagement/zones?withCustomTemplateItems=\{boolean} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/zoneManagement/zones?withCustomTemplateItems=true HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

[
    \{
        "zoneID": integer,
        "name": "string",
        "color": integer,
        "bounds": [
            \{
                "longitude": number,
                "latitude": number
            },
            \{
                "longitude": number,
                "latitude": number
            },
            \{
                "longitude": number,
                "latitude": number
            }
        ],
        "enabled": boolean,
        "zoneGroupID": integer,
        "comment": "string",
        "customFieldsFormTemplateID": integer,
        "customFieldFormItems": [
            \{
                "externalID": "string",
                "name": "string",
                "value": "string",
                "type": "string"
            }
        ]
    },
    \{
        "zoneID": integer,
        "name": "string",
        "color": integer,
        "bounds": [
            \{
                "longitude": number,
                "latitude": number
            },
            \{
                "longitude": number,
                "latitude": number
            },
            \{
                "longitude": number,
                "latitude": number
            }
        ],
        "enabled": boolean,
        "zoneGroupID": integer,
        "comment": "string",
        "customFieldsFormTemplateID": integer,
        "customFieldFormItems": [
            \{
                "externalID": "string",
                "name": "string",
                "value": "string",
                "type": "string"
            }
        ]
    }
]

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

[
    \{
        "zoneID": 1,
        "name": "Юг",
        "color": 0,
        "bounds": [
            \{
                "longitude": 37.76328,
                "latitude": 55.78237
            },
            \{
                "longitude": 37.7919579,
                "latitude": 55.72724
            },
            \{
                "longitude": 37.76328,
                "latitude": 55.78237
            }
        ],
        "enabled": true,
        "zoneGroupID": 1,
        "comment": "Комментарий",
        "customFieldsFormTemplateID": 1,
        "customFieldFormItems": [
            \{
                "externalID": "1",
                "name": "Настроенные события",
                "value": "вход-выход",
                "type": "string"
            }
        ]
    },
    \{
        "zoneID": 2,
        "name": "Центр",
        "color": 1,
        "bounds": [
            \{
                "longitude": 37.9249458,
                "latitude": 55.7106361
            },
            \{
                "longitude": 37.7515678,
                "latitude": 55.7094765
            },
            \{
                "longitude": 37.9249458,
                "latitude": 55.7106361
            }
        ],
        "enabled": true,
        "zoneGroupID": 1,
        "comment": "Комментарий",
        "customFieldsFormTemplateID": 1,
        "customFieldFormItems": [
            \{
                "externalID": "1",
                "name": "Настроенные события",
                "value": "вход-выход",
                "type": "string"
            }
        ]
    }
]

Получение геозоны

Общее описание

Функция GET /v6/api/zoneManagement/zones/{zoneID} позволяет получить гео-зону по ее идентификатору.

Параметры вызова

В запросе используется обязательный параметр zoneID — идентификатор гео-зоны.

Результат выполнения

Функция возвращает структуру со следующими параметрами гео-зоны:

Параметр	Описание
zoneID	ИД гео-зоны
name	Название гео-зоны
color	Цвет группы объектов
enabled	Признак активности гео-зоны: true — гео-зона включена (учитывается при определении местоположения Сотрудников, в отчетах, отображается на карте); false — гео-зона выключена.
zoneGroupID	ИД группы гео-зон
comment	Комментарий к гео-зоне
bounds (параметры границы гео-зоны)
longitude	Географическая долгота точки гео-зоны (в градусах)
latitude	Географическая широта точки гео-зоны (в градусах)
customFieldFormTemplateID	ИД шаблона дополнительных полей гео-зоны
Параметры дополнительных полей гео-зоны (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля: string – строка; text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

Формат запроса

GET /v6/api/zoneManagement/zones/\{zoneID} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/zoneManagement/zones/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

\{
    "zoneID": integer,
    "name": "string",
    "color": integer,
    "bounds": [
        \{
            "longitude": number,
            "latitude": number
        },
        \{
            "longitude": number,
            "latitude": number
        },
        \{
            "longitude": number,
            "latitude": number
        }
    ],
    "enabled": boolean,
    "zoneGroupID": integer,
    "comment": "string",
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
        \{
            "externalID": "string",
            "name": "string",
            "value": "string",
            "type": "string"
        }
    ]
}

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

\{
    "zoneID": 1,
    "name": "Юг",
    "color": 0,
    "bounds": [
        \{
            "longitude": 37.9249458,
            "latitude": 55.7106361
        },
        \{
            "longitude": 37.7515678,
            "latitude": 55.7094765
        },
        \{
            "longitude": 37.9249458,
            "latitude": 55.7106361
        }
    ],
    "enabled": true,
    "zoneGroupID": 1,
    "comment": "Комментарий",
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
        \{
            "externalID": "1",
            "name": "настроенные события",
            "value": "вход-выход",
            "type": "string"
        }
    ]
}

Получение геозон по идентификатору объекта

Общее описание

Функция GET /v6/api/zoneManagement/zones/mapObjectCoordinates?mapObjectID={integer}&zoneGroupID={integer} позволяет получить список гео-зон по идентификатору объекта.

Параметры вызова

Функция имеет следующие параметры:

Параметр	Описание
mapObjectID	ИД объекта.
zoneGroupID	ИД группы гео-зон

Результат выполнения

Функция возвращает массив структур со следующими параметрами гео-зон:

Параметр	Описание
zoneID	ИД гео-зоны
name	Название гео-зоны
zoneGroupID	ИД группы гео-зон

Формат запроса

GET /v6/api/zoneManagement/zones/mapObjectCoordinates?mapObjectID=\{integer}&zoneGroupID=\{integer} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/zoneManagement/zones/mapObjectCoordinates?mapObjectID=1&zoneGroupID=1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

\{
    "zones": [
        \{
            "zoneID": integer,
            "name": "string",
            "zoneGroupID": integer
        },
        \{
            "zoneID": integer,
            "name": "string",
            "zoneGroupID": integer
        }
    ]
}

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

\{
    "zones": [
        \{
            "zoneID": 684859,
            "name": "Москва",
            "zoneGroupID": 7219
        },
        \{
            "zoneID": 684901,
            "name": "СВАО -  4 зоны",
            "zoneGroupID": 7218
        }
    ]
}

Получение геозон по координатам

Общее описание

Функция GET /v6/api/ zoneManagement/zones/mapObjectCoordinates?latitude={double}&longitude={double} позволяет получить список гео-зон по координатам.

Параметры вызова

Функция имеет следующие параметры:

Параметр	Описание
longitude	Географическая долгота точки (в градусах)
latitude	Географическая широта точки (в градусах)

Результат выполнения

Функция возвращает массив структур со следующими параметрами гео-зон:

Параметр	Описание
zoneID	ИД гео-зоны
name	Название гео-зоны
zoneGroupID	ИД группы гео-зон

Формат запроса

GET /v6/api/zoneManagement/zones/mapObjectCoordinates?latitude=\{double}&longitude=\{double}  HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/zoneManagement/zones/mapObjectCoordinates?latitude=55.751538&longitude=37.652173  HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

\{
    "zones": [
        \{
            "zoneID": integer,
            "name": "string",
            "zoneGroupID": integer
        },
        \{
            "zoneID": integer,
            "name": "string",
            "zoneGroupID": integer
        }
    ]
}

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

\{
    "zones": [
        \{
            "zoneID": 684859,
            "name": "Москва",
            "zoneGroupID": 7219
        },
        \{
            "zoneID": 684901,
            "name": "СВАО -  4 зоны",
            "zoneGroupID": 7218
        }

Создание геозоны

Общее описание

Функция POST /v6/api/zoneManagement/zones позволяет создать гео-зону.

Параметры вызова

Функция имеет следующие параметры:

Параметр	Описание
name	Название гео-зоны (обязательный параметр)
color	Цвет группы объектов
enabled	Признак активности гео-зоны. Существуют следующие значения: true — гео-зона включена (учитывается при определении местоположения Сотрудников, в отчетах, отображается на карте); false — гео-зона выключена.
zoneGroupID	ИД группы гео-зон
comment	Комментарий к гео-зоне
customFieldFormTemplateID	ИД шаблона дополнительных полей гео-зоны
bounds (параметры границы гео-зоны)
longitude	Географическая долгота точки гео-зоны (в градусах)
latitude	Географическая широта точки гео-зоны (в градусах)
Параметры дополнительных полей гео-зоны (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля. Существуют следующие типы: string – строка; text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

Результат выполнения

При успешном выполнении возвращается статус 201.

Параметр	Описание
zoneID	ИД гео-зоны
name	Название гео-зоны
color	Цвет группы объектов
enabled	Признак активности гео-зоны: true — гео-зона включена (учитывается при определении местоположения Сотрудников, в отчетах, отображается на карте); false — гео-зона выключена.
zoneGroupID	ИД группы гео-зон
comment	Комментарий к гео-зоне
bounds (параметры границы гео-зоны)
longitude	Географическая долгота точки гео-зоны (в градусах)
latitude	Географическая широта точки гео-зоны (в градусах)
customFieldFormTemplateID	ИД шаблона дополнительных полей гео-зоны
Параметры дополнительных полей гео-зоны (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля: string – строка; text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

Формат запроса

POST /v6/api/zoneManagement/zones HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "name": "string",
    "color": integer,
    "bounds": [
        \{
            "longitude": number,
            "latitude": number
        },
        \{
            "longitude": number,
            "latitude": number
        },
        \{
            "longitude": number,
            "latitude": number
        }
    ],
    "enabled": boolean,
    "zoneGroupID": integer,
    "comment": "string",
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
        \{
            "externalID": "string",
            "name": "string",
            "value": "string",
            "type": "string"
        }
    ]
}

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

POST /v6/api/zoneManagement/zones HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "name": "Юг",
    "color": 0,
    "bounds": [
        \{
            "longitude": 37.9249458,
            "latitude": 55.7106361
        },
        \{
            "longitude": 37.7515678,
            "latitude": 55.7094765
        },
        \{
            "longitude": 37.9249458,
            "latitude": 55.7106361
        }
    ],
    "enabled": true,
    "zoneGroupID": 1,
    "comment": "Комментарий",
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
        \{
            "externalID": "1",
            "name": "настроенные события",
            "value": "вход-выход",
            "type": "string"
        }
    ]
}

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

\{
    "zoneID": integer,
    "name": "string",
    "color": integer,
    "bounds": [
        \{
            "longitude": number,
            "latitude": number
        },
        \{
            "longitude": number,
            "latitude": number
        },
        \{
            "longitude": number,
            "latitude": number
        }
    ],
    "enabled": boolean,
    "zoneGroupID": integer,
    "comment": "string",
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
        \{
            "externalID": "string",
            "name": "string",
            "value": "string",
            "type": "string"
        }
    ]
}

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

\{
    "zoneID": 1,
    "name": "Юг",
    "color": 0,
    "bounds": [
        \{
            "longitude": 37.9249458,
            "latitude": 55.7106361
        },
        \{
            "longitude": 37.7515678,
            "latitude": 55.7094765
        },
        \{
            "longitude": 37.9249458,
            "latitude": 55.7106361
        }
    ],
    "enabled": true,
    "zoneGroupID": 1,
    "comment": "Комментарий",
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
        \{
            "externalID": "1",
            "name": "настроенные события",
            "value": "вход-выход",
            "type": "string"
        }
    ]
}

Обновление геозоны

Общее описание

Функция PUT /v6/api/zoneManagement/zones/{zoneID} позволяет обновить гео-зону (должны быть переданы все атрибуты гео-зоны для обновления, т.е. гео-зона обновляется полностью).

Параметры вызова

Функция имеет следующие параметры:

Параметр	Описание
zoneID	ИД гео-зоны
name	Название гео-зоны
color	Цвет группы объектов
enabled	Признак активности гео-зоны. Существуют следующие значения: true — гео-зона включена (учитывается при определении местоположения Сотрудников, в отчетах, отображается на карте); false — гео-зона выключена.
zoneGroupID	ИД группы гео-зон
comment	Комментарий к гео-зоне
customFieldFormTemplateID	ИД шаблона дополнительных полей гео-зоны
bounds (параметры границы гео-зоны)
longitude	Географическая долгота точки гео-зоны (в градусах)
latitude	Географическая широта точки гео-зоны (в градусах)
Параметры дополнительных полей гео-зоны (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля. Существуют следующие типы: string – строка; text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

Результат выполнения

При успешном выполнении возвращается статус 204.

Формат запроса

PUT /v6/api/zoneManagement/zones/\{zoneID} HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "name": "string",
    "color": integer,
    "bounds": [
        \{
            "longitude": number,
            "latitude": number
        },
        \{
            "longitude": number,
            "latitude": number
        },
        \{
            "longitude": number,
            "latitude": number
        }
    ],
    "enabled": boolean,
    "zoneGroupID": integer,
    "comment": "string",
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
        \{
            "externalID": "string",
            "name": "string",
            "value": "string",
            "type": "string"
        }
    ]
}

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

PUT /v6/api/zoneManagement/zones/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "name": "Юг",
    "color": 0,
    "bounds": [
        \{	
            "longitude": 37.9249458,
            "latitude": 55.7106361
        },
        \{
            "longitude": 37.7515678,
            "latitude": 55.7094765
        },
        \{
            "longitude": 37.9249458,
            "latitude": 55.7106361
        }
    ],
    "enabled": true,
    "zoneGroupID": 1,
    "comment": "Комментарий",
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
        \{
            "externalID": "1",
            "name": "настроенные события",
            "value": "вход-выход",
            "type": "string"
        }
    ]
}

Редактирование геозоны

Общее описание

Функция PATCH /v6/api/zoneManagement/zones/{zoneID} позволяет изменить только часть параметров гео-зоны.

Параметры вызова

Функция имеет следующие параметры (если параметр не передан при вызове функции, то его значение не меняется):

Параметр	Описание
zoneID	ИД гео-зоны (обязательный параметр)
name	Название гео-зоны
color	Цвет группы объектов
enabled	Признак активности гео-зоны. Существуют следующие значения: true — гео-зона включена (учитывается при определении местоположения Сотрудников, в отчетах, отображается на карте); false — гео-зона выключена.
zoneGroupID	ИД группы гео-зон
comment	Комментарий к гео-зоне
customFieldFormTemplateID	ИД шаблона дополнительных полей гео-зоны
bounds (параметры границы гео-зоны)
longitude	Географическая долгота точки гео-зоны (в градусах)
latitude	Географическая широта точки гео-зоны (в градусах)
Параметры дополнительных полей гео-зоны (массив структур customFieldFormItems)
externalID	ИД дополнительного поля
name	Название дополнительного поля
value	Значение дополнительного поля
type	Тип дополнительного поля. Существуют следующие типы: string – строка; text – текст; date – дата; time – время; integer – целое число; double – вещественное число; boolean – галочка; select – список; picture – изображение; file – файл.

Результат выполнения

При успешном выполнении возвращается статус 204.

Формат запроса

PATCH /v6/api/zoneManagement/zones/\{zoneID} HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "name": "string",
    "color": integer,
    "bounds": [
        \{
            "longitude": number,
            "latitude": number
        },
        \{
            "longitude": number,
            "latitude": number
        },
        \{
            "longitude": number,
            "latitude": number
        }
    ],
    "enabled": boolean,
    "zoneGroupID": integer,
    "comment": "string",
    "customFieldsFormTemplateID": integer,
    "customFieldFormItems": [
        \{
            "externalID": "string",
            "name": "string",
            "value": "string",
            "type": "string"
        }
    ]
}

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

PATCH /v6/api/zoneManagement/zones/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "name": "Юг",
    "color": 1,
    "bounds": [
        \{
            "longitude": 37.9249458,
            "latitude": 55.7106361
        },
        \{
            "longitude": 37.7515678,
            "latitude": 55.7094765
        },
        \{
            "longitude": 37.9249458,
            "latitude": 55.7106361
        }
    ],
    "enabled": false,
    "zoneGroupID": 1,
    "comment": "Комментарий",
    "customFieldsFormTemplateID": 1,
    "customFieldFormItems": [
        \{
            "externalID": "1",
            "name": "настроенные события",
            "value": "вход-выход",
            "type": "string"
        }
    ]
}

Удаление геозоны

Общее описание

Функция DELETE /v6/api/zoneManagement/zones/{zoneID} позволяет удалить гео-зону по ее идентификатору.

Параметры вызова

В запросе используется обязательный параметр zoneID — идентификатор гео-зоны.

Результат выполнения

При успешном выполнении возвращается статус 204.

Формат запроса

DELETE /v6/api/zoneManagement/zones/\{zoneID} HTTP/1.1
Host: host
Authorization: Bearer token

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

DELETE /v6/api/zoneManagement/zones/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Получение списка групп геозон

Общее описание

Функция GET /v6/api/zoneManagement/zoneGroups позволяет получить список групп гео-зон.

Параметры вызова

Функция не имеет дополнительных параметров.

Результат выполнения

Функция возвращает массив структур со следующими параметрами групп гео-зон:

Параметр	Описание
zoneGroupID	ИД группы гео-зон
name	Название группы гео-зон
parentID	ИД родительской группы гео-зон
regionID	ИД региона

Формат запроса

GET /v6/api/zoneManagement/zoneGroups HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/zoneManagement/zoneGroups HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

[
    \{
        "zoneGroupID": integer,
        "name": "string",
        "parentID": integer,
        "regionID": integer
    },
    \{
        "zoneGroupID": integer,
        "name": "string",
        "parentID": integer,
        "regionID": integer
    }
]

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

[
    \{
        "zoneGroupID": 2,
        "name": "Москва",
        "parentID": 1,
        "regionID": 1
    },
    \{
        "zoneGroupID": 3,
        "name": "Санкт-Петербург",
        "parentID": 1,
        "regionID": 3
    }
]

Получение группы геозон

Общее описание

Функция GET /v6/api/zoneManagement/zoneGroups/{zoneGroupID} позволяет получить группу гео-зон.

Параметры вызова

В запросе используется обязательный параметр zoneGroupID — идентификатор группы гео-зон.

Результат выполнения

Функция возвращает структуру со следующими параметрами группы гео-зон:

Параметр	Описание
zoneGroupID	ИД группы гео-зон
name	Название группы гео-зон
parentID	ИД родительской группы гео-зон
regionID	ИД региона

Формат запроса

GET /v6/api/zoneManagement/zoneGroups/\{zoneGroupID} HTTP/1.1
Host: host
Authorization: Bearer token

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

GET /v6/api/zoneManagement/zoneGroups/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

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

\{
    "zoneGroupID": integer,
    "name": "string",
    "parentID": integer,
    "regionID": integer
}

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

\{
    "zoneGroupID": 4,
    "name": "Запад Москвы",
    "parentID": 1,
    "regionID": 1
}

Создание группы геозон

Общее описание

Функция POST /v6/api/zoneManagement/zoneGroups позволяет создать группу гео-зон.

Параметры вызова

Функция имеет следующие параметры:

Параметр	Описание
name	Название группы гео-зон (обязательный параметр)
parentID	ИД родительской группы гео-зон
regionID	ИД региона

Результат выполнения

При успешном выполнении возвращается статус 201.

Функция возвращает структуру со следующими параметрами группы гео-зон:

Параметр	Описание
zoneGroupID	ИД группы гео-зон
name	Название группы гео-зон
parentID	ИД родительской группы гео-зон
regionID	ИД региона

Формат запроса

POST /v6/api/zoneManagement/zoneGroups HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "name": "string",
    "parentID": integer,
    "regionID": integer
}

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

POST /v6/api/zoneManagement/zoneGroups HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "name": "Запад Москвы",
    "parentID": 1,
    "regionID": 1
}

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

\{
    "zoneGroupID": integer,
    "name": "string",
    "parentID": integer,
    "regionID": integer
}

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

\{
    "zoneGroupID": 4,
    "name": "Запад Москвы",
    "parentID": 1
    "regionID": 1
}

Обновление группы геозон

Общее описание

Функция PUT /v6/api/zoneManagement/zoneGroups/{zoneGroupID} позволяет обновить группу гео-зон. Для обновления должны быть переданы все атрибуты группы, то есть обновление выполняется полностью.

Параметры вызова

Функция имеет следующие параметры:

Параметр	Описание
zoneGroupID	ИД группы гео-зон
name	Название группы гео-зон
parentID	ИД родительской группы гео-зон
regionID	ИД региона

Результат выполнения

При успешном выполнении возвращается статус 204.

Формат запроса

PUT /v6/api/zoneManagement/zoneGroups/\{zoneGroupID} HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "name": "string",
    "parentID": integer,
    "regionID": integer
}

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

PUT /v6/api/zoneManagement/zoneGroups/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "name": "Запад Москвы",
    "parentID": 2,
    "regionID": 2
}

Изменение группы геозон

Общее описание

Функция PATCH /v6/api/zoneManagement/zoneGroups/{zoneGroupID} позволяет изменить только часть параметров группы гео-зон.

Параметры вызова

Функция имеет следующие параметры (если параметр не передан при вызове функции, то его значение не меняется):

Параметр	Описание
zoneGroupID	ИД группы гео-зон (обязательный параметр)
name	Название группы гео-зон
parentID	ИД родительской группы гео-зон
regionID	ИД региона

Результат выполнения

При успешном выполнении возвращается статус 204.

Формат запроса

PATCH /v6/api/zoneManagement/zoneGroups/\{zoneGroupID} HTTP/1.1
Host: host
Authorization: Bearer token

\{
    "name": "string",
    "parentID": integer,
    "regionID": integer
}

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

PATCH /v6/api/zoneManagement/zoneGroups/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

\{
    "name": "Запад Москвы",
    "parentID": 2,
    "regionID": 2
}

Удаление группы геозон

Общее описание

Функция DELETE /v6/api/zoneManagement/zoneGroups/{zoneGroupID} позволяет удалить группу гео-зон по ее идентификатору.

Параметры вызова

В запросе используется обязательный параметр zoneGroupID — идентификатор группы гео-зон.

Результат выполнения

При успешном выполнении возвращается статус 204.

Формат запроса

DELETE /v6/api/zoneManagement/zoneGroups/\{zoneGroupID} HTTP/1.1
Host: host
Authorization: Bearer token

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

DELETE /v6/api/zoneManagement/zoneGroups/1 HTTP/1.1
Host: api.mpoisk.ru
Authorization: Bearer token

Работа с геозонами

Содержание