Mrixs/trip-planner

Fork 0

Files

Vladimir Zagainov c78bf00f7a Initial docs

2026-08-13 18:26:15 +03:00

17 KiB

Raw Blame History

Синтаксис запроса

Информация о перевозчике

Запрос позволяет получить информацию о перевозчике по указанному коду перевозчика.

Коды перевозчиков можно получить в публичных справочниках кодов, а также в ответах на запросы: Расписание рейсов между станциями, Расписание рейсов по станции, Список станций следования.

Синтаксис запроса

https://api.rasp.yandex-net.ru/v3.0/carrier/ ?
  apikey=<ключ>
 & code=<код перевозчика>
[& format=<формат>]
[& lang=<язык>]
[& system=<текущая система кодирования>]

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

https://api.rasp.yandex-net.ru/v3.0/carrier/?format=json&apikey={ключ}&lang=ru_RU&code=TK&system=iata

Входные параметры:

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


Параметр	Описание
`apikey`	Ключ доступа к API. Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например: `<br>Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab<br>`
`code`	Код перевозчика. По умолчанию в системе кодирования Яндекс Расписаний. Чтобы отправить код в другой системе кодирования, укажите параметр `system`. Если код указан в системе кодирования IATA, в ответе могут быть описаны несколько перевозчиков.

Необязательные параметры


Параметр	Описание
`system`	Система кодирования, в которой указывается код перевозчика (параметр `code`) в запросе. Возможные значения: - `yandex` (значение по умолчанию) — система кодирования Яндекс Расписаний; - `iata` — коды Международной ассоциации воздушного транспорта; - `sirena` — коды в системах, построенных на базе сетей «Сирена»; - `express` — коды железнодорожных станций СНГ и стран Балтии из базы Экспресс-3; - `esr` — коды железнодорожных станций СНГ и стран Балтии из базы ЕСР. Параметр обязателен, если используется система кодирования, отличная от системы кодирования Яндекс Расписаний.
`lang`	Язык возвращаемой информации, в формате <код языка>_<код страны>. Поддерживаемые коды языка описаны стандартом ISO 639, коды стран — стандартом ISO 3166. По умолчанию ответ возвращается для значения `ru_RU`. Поддерживаемые коды языков: - `ru` — русский; - `uk` — украинский. Поддерживаемые коды стран: - `RU` — Россия; - `UA` — Украина.
`format`	Формат ответа. Поддерживаемые значения: - `json` (по умолчанию); - `xml`.

Структура ответа

Ответ содержит информацию об указанном в запросе перевозчике. Если код перевозчика в запросе указан в системе кодирования IATA ответ содержит данные по нескольким перевозчикам (вместо одного элемента carrier возвращается массив carriers).

Структура ответа в различных форматах показана в примерах.

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

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

{
  "carriers":
  [\
    {\
      "code": 680,\
      "contacts": "Телефон: +7 (1234) 123456",\
      "url": "http://www.example.com/",\
      "title": "Россия",\
      "phone": "",\
      "codes":\
      {\
        "icao": null,\
        "sirena": null,\
        "iata": "SU"\
      },\
      "address": "Санкт-Петербург, ул. Строителей, д. 18",\
      "logo": "//yastatic.net/rasp/media/data/company/logo/logo_1.jpg",\
      "email": ""\
    }\
    ...\
  ]
}

Описание элементов JSON


Элемент JSON	Тип	Описание
`carriers`	Массив	Список перевозчиков. Может быть включен в ответ, если код перевозчика был указан в системе IATA.

Элементыобъектаcarriers


Элемент JSON	Тип	Описание
`code`	Число	Код перевозчика в указанной системе кодирования (по умолчанию — в системе Яндекс Расписаний.)
`contacts`	Строка	Контактная информация, в свободной форме.
`url`	Строка	Ссылка на сайт перевозчика.
`title`	Строка	Название перевозчика.
`phone`	Строка	Контактный номер телефона перевозчика.
`codes`	Объект	Список кодов перевозчика в других системах кодирования, поддерживаемых Яндекс Расписаниями.
`address`	Строка	Юридический адрес перевозчика.
`logo`	Строка	Ссылка на используемый Яндексом логотип перевозчика в растровом формате.
`email`	Строка	Электронный почтовый адрес перевозчика.

Элементыобъектаcodes


Элемент JSON	Тип	Описание
`icao`	Строка	Код перевозчика в системе кодирования ICAO.
`sirena`	Строка	Код перевозчика в системе кодирования Sirena.
`iata`	Строка	Код перевозчика в системе кодирования IATA.

<response>
  <carrier>
    <code>680</code>
    <title>Turkish Airlines</title>
    <url>http://www.thy.com/</url>
    <contacts/>
    <phone></phone>
    <codes>
      <icao>xsi:nil="true"</icao>
      <sirena>xsi:nil="true"</sirena>
      <iata>SU</iata>
    </codes>
    <address>Москва, Ленинградский пр., д.37, корп.9 </address>
    <logo>//yastatic.net/rasp/media/data/company/logo/logo_ru.gif</logo>
    <email/>
  </carrier>
  ...
</response>

Описание элементов XML


Элемент JSON	Тип	Описание
`carrier`		Элемент, содержащий контактные данные перевозчика.

Элементы, вложенные вcarriers


Элемент JSON	Тип	Описание
`code`	Число	Код перевозчика в указанной системе кодирования (по умолчанию — в системе Яндекс Расписаний.)
`title`	Строка	Название перевозчика.
`url`	Строка	Ссылка на сайт перевозчика.
`contacts`	Строка	Контактная информация, в свободной форме.
`phone`	Строка	Контактный номер телефона перевозчика.
`codes`		Список кодов перевозчика в других системах кодирования, поддерживаемых Яндекс Расписаниями.
`address`	Строка	Юридический адрес перевозчика.
`logo`	Строка	Ссылка на используемый Яндексом логотип перевозчика в растровом формате.
`email`	Строка	Электронный почтовый адрес перевозчика.

Элементы, вложенные вcodes


Элемент JSON	Тип	Описание
`icao`	Строка	Код перевозчика в системе кодирования ICAO.
`sirena`	Строка	Код перевозчика в системе кодирования Sirena.
`iata`	Строка	Код перевозчика в системе кодирования IATA.

Ключ доступа к API.

Параметр можно не передавать, если ключ доступа указан в заголовке Authorization, например:

Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab

Язык возвращаемой информации, в формате <код языка>_<код страны>. Поддерживаемые коды языка описаны стандартом ISO 639, коды стран — стандартом ISO 3166.

По умолчанию ответ возвращается для значения ru_RU.

Поддерживаемые коды языков:

ru — русский;
uk — украинский.

Поддерживаемые коды стран:

RU — Россия;
UA — Украина.

Формат ответа. Поддерживаемые значения:

json (по умолчанию);
xml.

Код перевозчика. По умолчанию в системе кодирования Яндекс Расписаний. Чтобы отправить код в другой системе кодирования, укажите параметр system.

Если код указан в системе кодирования IATA, в ответе могут быть описаны несколько перевозчиков.

Система кодирования, в которой указывается код перевозчика (параметр code) в запросе. Возможные значения:

yandex (значение по умолчанию) — система кодирования Яндекс Расписаний;
iata — коды Международной ассоциации воздушного транспорта;
sirena — коды в системах, построенных на базе сетей «Сирена»;
express — коды железнодорожных станций СНГ и стран Балтии из базы Экспресс-3;
esr — коды железнодорожных станций СНГ и стран Балтии из базы ЕСР.

Параметр обязателен, если используется система кодирования, отличная от системы кодирования Яндекс Расписаний.

Тип

Число

Описание

Код перевозчика в указанной системе кодирования (по умолчанию — в системе Яндекс Расписаний.)

Тип

Описание

Элемент, содержащий контактные данные перевозчика.

Тип

Строка

Описание

Название перевозчика.

Тип

Строка

Описание

Ссылка на сайт перевозчика.

Тип

Строка

Описание

Контактная информация, в свободной форме.

Тип

Строка

Описание

Контактный номер телефона перевозчика.

Тип

Объект

Описание

Список кодов перевозчика в других системах кодирования, поддерживаемых Яндекс Расписаниями.

Тип

Строка

Описание

Код перевозчика в системе кодирования ICAO.

Тип

Строка

Описание

Код перевозчика в системе кодирования Sirena.

Тип

Строка

Описание

Код перевозчика в системе кодирования IATA.

Тип

Строка

Описание

Юридический адрес перевозчика.

Тип

Строка

Описание

Ссылка на используемый Яндексом логотип перевозчика в растровом формате.

Тип

Строка

Описание

Электронный почтовый адрес перевозчика.

17 KiB Raw Blame History Unescape Escape

Информация о перевозчике

Синтаксис запроса

Структура ответа

Описание элементов JSON

Описание элементов XML

17 KiB

Raw Blame History