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

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

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

Примечание.

Запрос следует отправлять по протоколу HTTPS.

  1. Синтаксис запроса
  2. Структура ответа

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

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

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

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

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

Параметр Описание
Обязательные параметры
apikey

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

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

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

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

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

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

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

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

lang

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

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

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

  • ru — русский;

  • uk — украинский.

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

  • RU — Россия;

  • UA — Украина.

format

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

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

  • xml.

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

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

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

{
  "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
code Число

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

contacts Строка

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

url Строка

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

title Строка

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

phone Строка

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

codes Объект

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

address Строка

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

logo Строка

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

email Строка

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

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

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

sirena Строка

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

iata Строка

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