Информация о перевозчике
Запрос позволяет получить информацию о перевозчике по указанному коду перевозчика.
Коды перевозчиков можно получить в публичных справочниках кодов, а также в ответах на запросы: Расписание рейсов между станциями, Расписание рейсов по станции, Список станций следования.
Примечание
Запрос следует отправлять по протоколу HTTPS.
Синтаксис запроса
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
Входные параметры:
Обязательные параметры
Параметр |
Описание |
|
Ключ доступа к API. Параметр можно не передавать, если ключ доступа указан в заголовке
|
|
Код перевозчика. По умолчанию в системе кодирования Яндекс Расписаний. Чтобы отправить код в другой системе кодирования, укажите параметр Если код указан в системе кодирования IATA, в ответе могут быть описаны несколько перевозчиков. |
Необязательные параметры
Параметр |
Описание |
|
Система кодирования, в которой указывается код перевозчика (параметр
Параметр обязателен, если используется система кодирования, отличная от системы кодирования Яндекс Расписаний. |
|
Язык возвращаемой информации, в формате <код языка>_<код страны>. Поддерживаемые коды языка описаны стандартом ISO 639, коды стран — стандартом ISO 3166. По умолчанию ответ возвращается для значения Поддерживаемые коды языков:
Поддерживаемые коды стран:
|
|
Формат ответа. Поддерживаемые значения:
|
Структура ответа
Ответ содержит информацию об указанном в запросе перевозчике. Если код перевозчика в запросе указан в системе кодирования 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 |
Тип |
Описание |
|
Массив |
Список перевозчиков. Может быть включен в ответ, если код перевозчика был указан в системе IATA. |
Элементыобъекта carriers
Элемент JSON |
Тип |
Описание |
|
Число |
Код перевозчика в указанной системе кодирования (по умолчанию — в системе Яндекс Расписаний.) |
|
Строка |
Контактная информация, в свободной форме. |
|
Строка |
Ссылка на сайт перевозчика. |
|
Строка |
Название перевозчика. |
|
Строка |
Контактный номер телефона перевозчика. |
|
Объект |
Список кодов перевозчика в других системах кодирования, поддерживаемых Яндекс Расписаниями. |
|
Строка |
Юридический адрес перевозчика. |
|
Строка |
Ссылка на используемый Яндексом логотип перевозчика в растровом формате. |
|
Строка |
Электронный почтовый адрес перевозчика. |
Элементыобъекта codes
Элемент JSON |
Тип |
Описание |
|
Строка |
Код перевозчика в системе кодирования ICAO. |
|
Строка |
Код перевозчика в системе кодирования Sirena. |
|
Строка |
Код перевозчика в системе кодирования 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 |
Тип |
Описание |
|
Элемент, содержащий контактные данные перевозчика. |
Элементы, вложенные в carriers
Элемент JSON |
Тип |
Описание |
|
Число |
Код перевозчика в указанной системе кодирования (по умолчанию — в системе Яндекс Расписаний.) |
|
Строка |
Название перевозчика. |
|
Строка |
Ссылка на сайт перевозчика. |
|
Строка |
Контактная информация, в свободной форме. |
|
Строка |
Контактный номер телефона перевозчика. |
|
Список кодов перевозчика в других системах кодирования, поддерживаемых Яндекс Расписаниями. |
|
|
Строка |
Юридический адрес перевозчика. |
|
Строка |
Ссылка на используемый Яндексом логотип перевозчика в растровом формате. |
|
Строка |
Электронный почтовый адрес перевозчика. |
Элементы, вложенные в codes
Элемент JSON |
Тип |
Описание |
|
Строка |
Код перевозчика в системе кодирования ICAO. |
|
Строка |
Код перевозчика в системе кодирования Sirena. |
|
Строка |
Код перевозчика в системе кодирования 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.
Тип
Строка
Описание
Юридический адрес перевозчика.
Тип
Строка
Описание
Ссылка на используемый Яндексом логотип перевозчика в растровом формате.
Тип
Строка
Описание
Электронный почтовый адрес перевозчика.