Получает публичную зону

HTTP-запрос

GET https://courier.yandex.ru/api/v1/reference-book/public/zones/{instance_id}\
?apikey={string}

Path-параметры

instance_id *

string

ID публичной зоны в справочнике.

* Обязательный параметр

Query-параметры

apikey

string

API-ключ компании.

* Обязательный параметр

Ответы

Код 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.coordinates[] *	array
polygon.type *	string Всегда равен `Polygon`

* Обязательный параметр

Код 401

Ошибка авторизации. Убедитесь, что заголовок запроса содержит правильный OAuth-токен.

Код 403

У вас нет доступа к этому объекту.

Код 422

Неверный ввод. Операция не может быть выполнена.