313 lines
17 KiB
Markdown
313 lines
17 KiB
Markdown
Синтаксис запроса
|
||
|
||
# Информация о перевозчике
|
||
|
||
- [Синтаксис запроса](https://yandex.ru/dev/rasp/doc/ru/reference/query-carrier#query)
|
||
- [Структура ответа](https://yandex.ru/dev/rasp/doc/ru/reference/query-carrier#emails-detailed)
|
||
|
||
Запрос позволяет получить информацию о [перевозчике](https://yandex.ru/dev/rasp/doc/ru/concepts/termin#carrier) по указанному коду перевозчика.
|
||
|
||
Коды перевозчиков можно получить в публичных справочниках кодов, а также в ответах на запросы: [Расписание рейсов между станциями](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-point-point), [Расписание рейсов по станции](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-on-station), [Список станций следования](https://yandex.ru/dev/rasp/doc/ru/reference/list-stations-route).
|
||
|
||
## Синтаксис запроса
|
||
|
||
```
|
||
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` | [Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.<br>Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:<br>```<br>Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab<br>``` |
|
||
| `code` | Код перевозчика. По умолчанию в системе кодирования Яндекс Расписаний. Чтобы отправить код в другой системе кодирования, укажите параметр `system`.<br>Если код указан в системе кодирования IATA, в ответе могут быть описаны несколько перевозчиков. |
|
||
|
||
**Необязательные параметры**
|
||
|
||
| | |
|
||
| --- | --- |
|
||
| **Параметр** | **Описание** |
|
||
| `system` | [Система кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system), в которой указывается код перевозчика (параметр `code`) в запросе. Возможные значения:<br>- `yandex` (значение по умолчанию) — система кодирования Яндекс Расписаний;<br>- `iata` — [коды Международной ассоциации воздушного транспорта](https://ru.wikipedia.org/wiki/%D0%9A%D0%BE%D0%B4_%D0%98%D0%90%D0%A2%D0%90);<br>- `sirena` — коды в системах, построенных на базе [сетей «Сирена»](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C));<br>- `express` — коды железнодорожных станций СНГ и стран Балтии из базы [Экспресс-3](http://www.express-3.ru/);<br>- `esr` — коды железнодорожных станций СНГ и стран Балтии из базы [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0).<br>Параметр обязателен, если используется система кодирования, отличная от системы кодирования Яндекс Расписаний. |
|
||
| `lang` | Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [ISO 639](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), коды стран — стандартом [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).<br>По умолчанию ответ возвращается для значения `ru_RU`.<br>Поддерживаемые коды языков:<br>- `ru` — русский;<br>- `uk` — украинский.<br>Поддерживаемые коды стран:<br>- `RU` — Россия;<br>- `UA` — Украина. |
|
||
| `format` | Формат ответа. Поддерживаемые значения:<br>- `json` (по умолчанию);<br>- `xml`. |
|
||
|
||
## Структура ответа
|
||
|
||
Ответ содержит информацию об указанном в запросе перевозчике. Если код перевозчика в запросе указан в системе кодирования [IATA](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%B0%D1%81%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D0%BE%D0%B3%D0%BE_%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%B0) ответ содержит данные по нескольким перевозчикам (вместо одного элемента `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` | Массив | Список перевозчиков.<br>Может быть включен в ответ, если код перевозчика был указан в системе IATA. |
|
||
|
||
**Элементыобъекта**`carriers`
|
||
|
||
| | | |
|
||
| --- | --- | --- |
|
||
| **Элемент JSON** | **Тип** | **Описание** |
|
||
| `code` | Число | Код перевозчика в указанной системе кодирования (по умолчанию — в системе Яндекс Расписаний.) |
|
||
| `contacts` | Строка | Контактная информация, в свободной форме. |
|
||
| `url` | Строка | Ссылка на сайт перевозчика. |
|
||
| `title` | Строка | Название перевозчика. |
|
||
| `phone` | Строка | Контактный номер телефона перевозчика. |
|
||
| `codes` | Объект | Список кодов перевозчика в других системах кодирования, поддерживаемых Яндекс Расписаниями. |
|
||
| `address` | Строка | Юридический адрес перевозчика. |
|
||
| `logo` | Строка | Ссылка на используемый Яндексом логотип перевозчика в растровом формате. |
|
||
| `email` | Строка | Электронный почтовый адрес перевозчика. |
|
||
|
||
**Элементыобъекта**`codes`
|
||
|
||
| | | |
|
||
| --- | --- | --- |
|
||
| **Элемент JSON** | **Тип** | **Описание** |
|
||
| `icao` | Строка | Код перевозчика в системе кодирования [ICAO](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B3%D1%80%D0%B0%D0%B6%D0%B4%D0%B0%D0%BD%D1%81%D0%BA%D0%BE%D0%B9_%D0%B0%D0%B2%D0%B8%D0%B0%D1%86%D0%B8%D0%B8). |
|
||
| `sirena` | Строка | Код перевозчика в системе кодирования [Sirena](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C)). |
|
||
| `iata` | Строка | Код перевозчика в системе кодирования [IATA](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%B0%D1%81%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D0%BE%D0%B3%D0%BE_%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%B0). |
|
||
|
||
```
|
||
<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](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B3%D1%80%D0%B0%D0%B6%D0%B4%D0%B0%D0%BD%D1%81%D0%BA%D0%BE%D0%B9_%D0%B0%D0%B2%D0%B8%D0%B0%D1%86%D0%B8%D0%B8). |
|
||
| `sirena` | Строка | Код перевозчика в системе кодирования [Sirena](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C)). |
|
||
| `iata` | Строка | Код перевозчика в системе кодирования [IATA](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%B0%D1%81%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D0%BE%D0%B3%D0%BE_%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%B0). |
|
||
|
||
[Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.
|
||
|
||
Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:
|
||
|
||
```
|
||
Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab
|
||
```
|
||
|
||
Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [ISO 639](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2), коды стран — стандартом [ISO 3166](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
|
||
|
||
По умолчанию ответ возвращается для значения `ru_RU`.
|
||
|
||
Поддерживаемые коды языков:
|
||
|
||
- `ru` — русский;
|
||
- `uk` — украинский.
|
||
|
||
|
||
|
||
|
||
Поддерживаемые коды стран:
|
||
- `RU` — Россия;
|
||
- `UA` — Украина.
|
||
|
||
Формат ответа. Поддерживаемые значения:
|
||
|
||
- `json` (по умолчанию);
|
||
- `xml`.
|
||
|
||
Код перевозчика. По умолчанию в системе кодирования Яндекс Расписаний. Чтобы отправить код в другой системе кодирования, укажите параметр `system`.
|
||
|
||
Если код указан в системе кодирования IATA, в ответе могут быть описаны несколько перевозчиков.
|
||
|
||
[Система кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system), в которой указывается код перевозчика (параметр `code`) в запросе. Возможные значения:
|
||
|
||
- `yandex` (значение по умолчанию) — система кодирования Яндекс Расписаний;
|
||
- `iata` — [коды Международной ассоциации воздушного транспорта](https://ru.wikipedia.org/wiki/%D0%9A%D0%BE%D0%B4_%D0%98%D0%90%D0%A2%D0%90);
|
||
- `sirena` — коды в системах, построенных на базе [сетей «Сирена»](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C));
|
||
- `express` — коды железнодорожных станций СНГ и стран Балтии из базы [Экспресс-3](http://www.express-3.ru/);
|
||
- `esr` — коды железнодорожных станций СНГ и стран Балтии из базы [ЕСР](https://ru.wikipedia.org/wiki/%D0%95%D0%B4%D0%B8%D0%BD%D0%B0%D1%8F_%D1%81%D0%B5%D1%82%D0%B5%D0%B2%D0%B0%D1%8F_%D1%80%D0%B0%D0%B7%D0%BC%D0%B5%D1%82%D0%BA%D0%B0).
|
||
|
||
|
||
|
||
|
||
Параметр обязателен, если используется система кодирования, отличная от системы кодирования Яндекс Расписаний.
|
||
|
||
**Тип**
|
||
|
||
Число
|
||
|
||
**Описание**
|
||
|
||
Код перевозчика в указанной системе кодирования (по умолчанию — в системе Яндекс Расписаний.)
|
||
|
||
**Тип**
|
||
|
||
**Описание**
|
||
|
||
Элемент, содержащий контактные данные перевозчика.
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Название перевозчика.
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Ссылка на сайт перевозчика.
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Контактная информация, в свободной форме.
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Контактный номер телефона перевозчика.
|
||
|
||
**Тип**
|
||
|
||
Объект
|
||
|
||
**Описание**
|
||
|
||
Список кодов перевозчика в других системах кодирования, поддерживаемых Яндекс Расписаниями.
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Код перевозчика в системе кодирования [ICAO](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%BE%D1%80%D0%B3%D0%B0%D0%BD%D0%B8%D0%B7%D0%B0%D1%86%D0%B8%D1%8F_%D0%B3%D1%80%D0%B0%D0%B6%D0%B4%D0%B0%D0%BD%D1%81%D0%BA%D0%BE%D0%B9_%D0%B0%D0%B2%D0%B8%D0%B0%D1%86%D0%B8%D0%B8).
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Код перевозчика в системе кодирования [Sirena](http://ru.wikipedia.org/wiki/%D0%A1%D0%B8%D1%80%D0%B5%D0%BD%D0%B0_(%D1%81%D0%B5%D1%82%D1%8C)).
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Код перевозчика в системе кодирования [IATA](https://ru.wikipedia.org/wiki/%D0%9C%D0%B5%D0%B6%D0%B4%D1%83%D0%BD%D0%B0%D1%80%D0%BE%D0%B4%D0%BD%D0%B0%D1%8F_%D0%B0%D1%81%D1%81%D0%BE%D1%86%D0%B8%D0%B0%D1%86%D0%B8%D1%8F_%D0%B2%D0%BE%D0%B7%D0%B4%D1%83%D1%88%D0%BD%D0%BE%D0%B3%D0%BE_%D1%82%D1%80%D0%B0%D0%BD%D1%81%D0%BF%D0%BE%D1%80%D1%82%D0%B0).
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Юридический адрес перевозчика.
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Ссылка на используемый Яндексом логотип перевозчика в растровом формате.
|
||
|
||
**Тип**
|
||
|
||
Строка
|
||
|
||
**Описание**
|
||
|
||
Электронный почтовый адрес перевозчика.
|