Получает справочник зон компании
Получает справочник зон компании.
HTTP-запрос
GET https://courier.yandex.ru/api/v1/reference-book/companies/{company_id}/zones\
?apikey={string}\
&page={integer}\
&per_page={integer}
Path-параметры
company_id * | integer ID компании, используемый в запросах к API Мониторинга. |
company_id * | integer ID компании, используемый в запросах к API Мониторинга. |
* Обязательный параметр
Query-параметры
apikey | string API-ключ компании. |
page | integer Номер страницы в базе данных. Каждая страница содержит per_page зон компании, упорядоченных по возрастанию ID курьера. Минимальное значение: |
per_page | integer Количество зон компании на страницу. Минимальное значение: |
apikey | string API-ключ компании. |
page | integer Номер страницы в базе данных. Каждая страница содержит per_page зон компании, упорядоченных по возрастанию ID курьера. Минимальное значение: |
per_page | integer Количество зон компании на страницу. Минимальное значение: |
* Обязательный параметр
Ответы
Код 200
Справочник зон компании получен.
[ { "color_edge": string, "color_fill": string, "id": string, "number": string, "polygon": { "coordinates": [ "array" ], "type": string } } ]
Скопировано
Представление
Поля
color_edge | string Цвет края зоны. Возможные форматы: #000000, rgb (0,0,0), black. |
color_fill | string Цвет заливки зоны. Возможные форматы: #000000, rgb (0,0,0), black. |
id | string ID зоны в справочнике. |
number | string Номер зоны. |
polygon | object Полигон зоны. Форматы: Geojson в соответствии со спецификацией RFC7946. Пример: {"type":"Polygon","coordinates":[[[0.0,0.0],[2.2,2.2],[-1.1,1.1],[0.0,0.0]]]} |
polygon. | array |
polygon. | string Всегда равен |
color_edge | string Цвет края зоны. Возможные форматы: #000000, rgb (0,0,0), black. |
color_fill | string Цвет заливки зоны. Возможные форматы: #000000, rgb (0,0,0), black. |
id | string ID зоны в справочнике. |
number | string Номер зоны. |
polygon | object Полигон зоны. Форматы: Geojson в соответствии со спецификацией RFC7946. Пример: {"type":"Polygon","coordinates":[[[0.0,0.0],[2.2,2.2],[-1.1,1.1],[0.0,0.0]]]} |
polygon. | array |
polygon. | string Всегда равен |
* Обязательный параметр
Код 401
Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.
Код 403
У вас нет доступа к этому объекту.
Код 422
Неверный ввод. Операция не может быть выполнена.