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

  1. HTTP-запрос
  2. Path-параметры
  3. Query-параметры
  4. Ответы
    1. Код 200
      1. Представление
      2. Поля
    2. Код 401
    3. Код 403
    4. Код 422

Получает зону компании из справочника.

HTTP-запрос

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

Path-параметры

company_id *

integer

ID компании, используемый в запросах к API Мониторинга.

instance_id *

string

ID зоны компании в справочнике.

company_id *

integer

ID компании, используемый в запросах к API Мониторинга.

instance_id *

string

ID зоны компании в справочнике.

Query-параметры

apikey

string

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

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

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

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