Initial docs
This commit is contained in:
783
docs/yandex-api-docs/list-stations-route.md
Normal file
783
docs/yandex-api-docs/list-stations-route.md
Normal file
@@ -0,0 +1,783 @@
|
||||
Список станций следования
|
||||
|
||||
# Список станций следования
|
||||
|
||||
- [Синтаксис запроса](https://yandex.ru/dev/rasp/doc/ru/reference/list-stations-route#format)
|
||||
- [Структура ответа](https://yandex.ru/dev/rasp/doc/ru/reference/list-stations-route#emails-detailed)
|
||||
- [Станция](https://yandex.ru/dev/rasp/doc/ru/reference/list-stations-route#stanciya)
|
||||
- [Нитка](https://yandex.ru/dev/rasp/doc/ru/reference/list-stations-route#nitka)
|
||||
- [Интервальная нитка](https://yandex.ru/dev/rasp/doc/ru/reference/list-stations-route#intervalnaya-nitka)
|
||||
|
||||
Запрос позволяет получить список _станций_ следования _нитки_ по указанному идентификатору нитки, информацию о каждой нитке и о промежуточных станциях нитки.
|
||||
|
||||
Идентификатор нитки можно получить в ответах на запросы: [Расписание рейсов между станциями](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-point-point), [Расписание рейсов по станции](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-on-station).
|
||||
|
||||
## Синтаксис запроса
|
||||
|
||||
```
|
||||
https://api.rasp.yandex-net.ru/v3.0/thread/ ?
|
||||
apikey=<ключ>
|
||||
& uid=<идентификатор нитки>
|
||||
& [from=<код станции отправления>]
|
||||
& [to=<код станции прибытия>]
|
||||
& [format=<формат>]
|
||||
& [lang=<язык>]
|
||||
& [date=<дата>]
|
||||
& [show_systems=<коды в ответе>]
|
||||
```
|
||||
|
||||
Пример запроса:
|
||||
|
||||
```
|
||||
https://api.rasp.yandex-net.ru/v3.0/thread/?apikey={ключ}&format=json&uid=038AA_tis&lang=ru_RU&show_systems=all
|
||||
```
|
||||
|
||||
Входные параметры:
|
||||
|
||||
**Обязательные параметры**
|
||||
|
||||
| | |
|
||||
| --- | --- |
|
||||
| **Параметр** | **Описание** |
|
||||
| `apikey` | [Ключ доступа](https://yandex.ru/dev/rasp/doc/ru/concepts/access) к API.<br>Параметр можно не передавать, если ключ доступа указан в заголовке `Authorization`, например:<br>```<br>Authorization: 1eb31582-941a-3ac8-a61f-041c344495ab<br>``` |
|
||||
| `uid` | Идентификатор нитки в Яндекс Расписаниях.<br>Идентификатор нитки может меняться со временем. Поэтому перед каждым запросом станций нитки необходимо получать актуальный идентификатор запросом [расписания рейсов между станциями](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-point-point) или [расписания рейсов по станции](https://yandex.ru/dev/rasp/doc/ru/reference/schedule-on-station). |
|
||||
|
||||
**Необязательные параметры**
|
||||
|
||||
| | |
|
||||
| --- | --- |
|
||||
| **Параметр** | **Описание** |
|
||||
| `from` | Код станции отправления. Должен быть указан в [системе кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system).<br>При использовании системы кодирования Яндекс Расписаний в данном параметре также можно указать код населенного пункта.<br>Код населенного пункта или код станции можно получить из адресной строки, пользуясь Яндекс Расписаниями. Например, из адресной строки:<br>- «http://rasp.yandex.ru/station/9600213» — код станции «s9600213» (к числовому значению кода добавляется латинская буква «s»);<br>- «http://rasp.yandex.ru/city/146» — код населенного пункта «c146» (к числовому значению кода добавляется латинская буква «c»). |
|
||||
| `to` | Код станции прибытия. Должен быть указан в [системе кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system).<br>При использовании системы кодирования Яндекс Расписаний в данном параметре также можно указать код населенного пункта.<br>Код населенного пункта или код станции можно получить из адресной строки, пользуясь Яндекс Расписаниями. Например, из адресной строки:<br>- «https://rasp.yandex.ru/station/9600213» — код станции «s9600213» («s» от сокращенного «station»).<br>- «https://rasp.yandex.ru/city/146» — код населенного пункта «c146» («c» от сокращенного «city»). |
|
||||
| `format` | Формат ответа. Поддерживаемые значения:<br>- `json` (по умолчанию);<br>- `xml`. |
|
||||
| `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` — Украина. |
|
||||
| `date` | Дата, на которую необходимо получить список станций следования. Должна быть указана в формате, соответствующем стандарту [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601). Например, YYYY-MM-DD.<br>По умолчанию возвращается список станций следования на первую дату хождения нитки. |
|
||||
| `show_systems` | [Cистеме кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system), в которой необходимо получить коды станций (в элементе ответа `codes`, вложенном в элемент `station`).<br>Возможные значения:<br>- `yandex` — система кодирования Яндекс Расписаний;<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>- `all` — коды всех поддерживаемых систем кодирования.<br>По умолчанию элемент `station` не содержит элемента `codes`. |
|
||||
|
||||
## Структура ответа
|
||||
|
||||
Ответ представляет собой список станций следования нитки. Содержит подробную информацию о нитке, о всех промежуточных станциях нитки.
|
||||
|
||||
Возможные форматы ответа: JSON, XML.
|
||||
|
||||
Пример ответа в формате JSON
|
||||
|
||||
Пример ответа в формате XML
|
||||
|
||||
```
|
||||
{
|
||||
"except_days": "",
|
||||
"arrival_date": null,
|
||||
"from": null,
|
||||
"uid":"038AA_tis",
|
||||
"title": "Москва - Санкт-Петербург",
|
||||
"interval":
|
||||
{
|
||||
"density": "автобус раз в 10-15 минут",
|
||||
"end_time": "2017-06-10T22:30:00",
|
||||
"begin_time": "2017-06-10T06:00:00"
|
||||
},
|
||||
"departure_date": null,
|
||||
"start_time": "00:44",
|
||||
"number": "038А",
|
||||
"short_title": "Москва - Санкт-Петербург",
|
||||
"days": "ежедневно, кроме вс",
|
||||
"to": null,
|
||||
"carrier":
|
||||
{ /* hide:carrier */
|
||||
"code": 112,
|
||||
"offices": [],
|
||||
"codes":
|
||||
{
|
||||
"icao": null,
|
||||
"sirena": null,
|
||||
"iata": null
|
||||
},
|
||||
"title": "РЖД/ФПК",
|
||||
},
|
||||
"transport_type": "train",
|
||||
"stops":
|
||||
[\
|
||||
{\
|
||||
"arrival": null,\
|
||||
"departure": "2017-02-20T00:44:00+03:00",\
|
||||
"terminal": null,\
|
||||
"platform": "",\
|
||||
"station":\
|
||||
{ /* hide:station */\
|
||||
"codes":\
|
||||
{\
|
||||
"express": "2006004",\
|
||||
"yandex": "s2006004",\
|
||||
"esr": "060073 "\
|
||||
},\
|
||||
"title": "Москва (Ленинградский вокзал)",\
|
||||
"popular_title": "Ленинградский вокзал",\
|
||||
"short_title": "М-Ленинградск",\
|
||||
"code": "s2006004",\
|
||||
"type": "station"\
|
||||
},\
|
||||
"stop_time": null,\
|
||||
"duration": 0.0\
|
||||
},\
|
||||
{\
|
||||
"arrival": "2017-02-20T02:34:00",\
|
||||
...\
|
||||
}\
|
||||
]
|
||||
"vehicle": null,
|
||||
"start_date": "2017-03-22",
|
||||
"transport_subtype":
|
||||
{ /* hide:transport_subtype */
|
||||
"color": "#FF7F44",
|
||||
"code": "suburban",
|
||||
"title": "Пригородный поезд"
|
||||
},
|
||||
"express_type": null
|
||||
}
|
||||
```
|
||||
|
||||
#### Описание элементов JSON
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Элемент JSON** | **Тип** | **Описание** |
|
||||
| `except_days` | Строка | Дни, в которые нитка не курсирует (даже если они входят в множество, описанное элементом `days`). |
|
||||
| `arrival_date` | Строка | Дата прибытия на станцию, указанную в параметре `to`.<br>Включается в ответ, только если нитка не является _интервальной_. |
|
||||
| `from` | Строка | Пункт отправления, указанный в параметре `from`. |
|
||||
| `uid` | Строка (не более 100 символов) | Идентификатор нитки, принятый в Яндекс Расписаниях. |
|
||||
| `title` | Строка | Название нитки, составленное из полных названий первой и последней станций следования. |
|
||||
| `interval` | Объект | Информация о движении по интервальной нитке. |
|
||||
| `departure_date` | Строка | Дата отправления со станции, указанной в параметре `from`.<br>Включается в ответ, только если нитка не является _интервальной_. |
|
||||
| `start_time` | Строка | Время отправления с первой станции следования по местному времени станции.<br>Включается в ответ, только если нитка не является _интервальной_. |
|
||||
| `number` | Строка | Номер [рейса](https://yandex.ru/dev/rasp/doc/ru/concepts/termin#schedule). |
|
||||
| `short_title` | Строка | Название нитки, составленное из коротких названий первой и последней станций следования. |
|
||||
| `days` | Строка | Дни курсирования нитки. |
|
||||
| `to` | Строка | Пункт прибытия, указанный в параметре `to`. |
|
||||
| `carrier` | Объект | Информация о [перевозчике](https://yandex.ru/dev/rasp/doc/ru/concepts/termin#carrier). |
|
||||
| `transport_type` | Строка | Тип транспорта. Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — водный транспорт;<br>- `helicopter` — вертолет. |
|
||||
| `stops` | Массив | Список станций следования. |
|
||||
| `vehicle` | Строка | Название транспортного средства. |
|
||||
| `start_date` | Строка | Дата отправления с первой станции следования. |
|
||||
| `transport_subtype` | Объект | Информация о подтипе транспортного средства. |
|
||||
| `express_type` | Строка | Признак экспресса или аэроэкспресса. Значение по умолчанию — `null`.<br>Если тип транспорта — электричка (ключ `transport_type` возвращен со значением `suburban`), принимает одно из значений:<br>- `express` — экспресс-рейс;<br>- `aeroexpress` — рейс, курсирующий между городом и аэропортом. |
|
||||
|
||||
**Элементы объекта**`interval`
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Элемент JSON** | **Тип** | **Описание** |
|
||||
| `density` | Строка | Описание периодичности движения в свободной форме. |
|
||||
| `end_time` | Строка | Дата и время окончания движения по нитке. Всегда указывается в часовом поясе станции отправления.<br>Могут быть указаны в одном из двух форматов:<br>- `YYYY-MM-DD`, если в запросе не был передан параметр `date`.<br>- `YYYY-MM-DDTHH:MM:SS`, если параметр `date` был передан. |
|
||||
| `begin_time` | Число | Дата и время начала движения по нитке. Всегда указывается в часовом поясе станции отправления.<br>Могут быть указаны в одном из двух форматов:<br>- `YYYY-MM-DD`, если в запросе не был передан параметр `date`.<br>- `YYYY-MM-DDTHH:MM:SS`, если параметр `date` был передан. |
|
||||
|
||||
**Элементы объекта**`stops`
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Элемент JSON** | **Тип** | **Описание** |
|
||||
| `arrival` | Строка | Время прибытия, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).<br>Если параметр `result_timezone` не был передан, указывается в часовом поясе станции. |
|
||||
| `departure` | Строка | Время отправления, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).<br>Если параметр `result_timezone` не был передан, указывается в часовом поясе станции. |
|
||||
| `duration` | Число | Время в пути между станциями (в секундах). |
|
||||
| `stop_time` | Число | Продолжительность остановки (в секундах). |
|
||||
| `station` | Объект | Информация о станции следования. |
|
||||
| `terminal` | Строка | Терминал аэропорта (например, «D»).<br>Принимает значение `null`, если информации о терминале нет. |
|
||||
| `platform` | Строка | Платформа или путь, с которого отправляется рейс (например, «3 путь»).<br>Пустая строка значит, что информации о платформе или пути нет. |
|
||||
|
||||
**Элементы объекта**`station`
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Элемент JSON** | **Тип** | **Описание** |
|
||||
| `codes` | Объект | Список кодов станции в других [системах кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system), поддерживаемый Яндекс Расписаниями. |
|
||||
| `title` | Строка | Название станции. |
|
||||
| `station_type` | Строка | Тип станции.<br>- `station` — станция;<br>- `platform` — платформа;<br>- `stop` — остановочный пункт;<br>- `checkpoint` — блок-пост;<br>- `post` — пост;<br>- `crossing` — разъезд;<br>- `overtaking_point` — обгонный пункт;<br>- `train_station` — вокзал;<br>- `airport` — аэропорт;<br>- `bus_station` — автовокзал;<br>- `bus_stop` — автобусная остановка;<br>- `unknown` — станция без типа;<br>- `port` — порт;<br>- `port_point` — портпункт;<br>- `wharf` — пристань;<br>- `river_port` — речной вокзал;<br>- `marine_station` — морской вокзал. |
|
||||
| `station_type_name` | Строка | Название типа станции, зависит от языка ответа. Возможные значения на русском — в списке значений ключа `station_type`. |
|
||||
| `popular_title` | Строка | Общепринятое название станции. |
|
||||
| `short_title` | Строка | Короткое название станции. |
|
||||
| `code` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
|
||||
| `type` | Строка | Вид станции. Для запроса расписания по станции возможно только одно значение — `station`. |
|
||||
|
||||
**Элементы объекта**`codes`
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Элемент JSON** | **Тип** | **Описание** |
|
||||
| `express` | Строка | Код станции в системе кодирования [Экспресс-3](http://www.express-3.ru/). |
|
||||
| `yandex` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
|
||||
| `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). |
|
||||
|
||||
**Элементы объекта**`carrier`
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Элемент JSON** | **Тип** | **Описание** |
|
||||
| `code` | Число | Код перевозчика в системе кодирования Яндекс Расписаний. |
|
||||
| `codes` | Объект | Список кодов перевозчика в других системах кодирования, поддерживаемый Яндекс Расписаниями. |
|
||||
| `title` | Строка | Название перевозчика. |
|
||||
|
||||
**Элементы объекта**`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). |
|
||||
|
||||
**Элементы объекта**`transport_subtype`
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Элемент JSON** | **Тип** | **Описание** |
|
||||
| `color` | Строка | Основной цвет транспортного средства в шестнадцатеричном формате. |
|
||||
| `code` | Строка | Код подтипа транспорта для типа, указанного в элементе `transport_type`. Подтип может совпадать с типом (например, для обычной электрички указывается тип `suburban` и подтип `suburban`).<br>Другие возможные значения:<br>- `helicopter` — вертолет (для типа `plane`)<br>- `rex` — экспресс РЭКС (для типа `suburban`)<br>- `sputnik` — «Спутник» (для типа `suburban`)<br>- `skiarrow` — «Лыжная стрела» (для типа `suburban`)<br>- `shezh` — «Снежинка» (для типа `suburban`)<br>- `skirus` — «Лыжня России» (для типа `suburban`)<br>- `city` — городская электричка (для типа `suburban`)<br>- `kalina` — «Калина красная» (для типа `suburban`)<br>- `vostok` — «Восток» (для типа `suburban`)<br>- `prostoryaltaya` — «Просторы Алтая» (для типа `suburban`)<br>- `14vag` — состав из 14 вагонов (для типа `suburban`)<br>- `last` — «Ласточка» (для типа `suburban`)<br>- `exprdal` — экспресс с билетами на конкретные места (для типа `suburban`)<br>- `volzhex` — «Волжский экспресс» (для типа `suburban`)<br>- `stdplus` — электрички типа «стандарт плюс» (для типа `suburban`)<br>- `express` — экспресс (для типа `suburban`)<br>- `skor` — ускоренный поезд (для типа `suburban`)<br>- `fiztekh` — Физтех.Электричка (для типа `suburban`)<br>- `vag6` — состав из 6 вагонов (для типа `suburban`);<br>- `river` — речной транспорт (для типа `water`);<br>- `sea` — морской транспорт (для типа `water`). |
|
||||
| `title` | Строка | Описание подтипа транспорта на естественном языке. |
|
||||
|
||||
```
|
||||
<response>
|
||||
<except_days>18 марта</except_days>
|
||||
<from>xsi:nil="true"</from>
|
||||
<uid>038AA_tis</uid>
|
||||
<start_date>2017-03-19</start_date>
|
||||
<title>Москва - Санкт-Петербург</title>
|
||||
<interval>
|
||||
<begin_time>2017-06-10T06:00:00</begin_time>
|
||||
<end_time>2017-06-10T22:30:00</end_time>
|
||||
<density>автобус раз в 10-15 минут</density>
|
||||
</interval>
|
||||
<start_time>22:41</start_time>
|
||||
<number>038А</number>
|
||||
<short_title>Москва - Санкт-Петербург</short_title>
|
||||
<days>ежедневно, кроме вс</days>
|
||||
<to>xsi:nil="true"</to>
|
||||
<carrier>
|
||||
<code{carrier}>112</code>
|
||||
<title{carrier}>РЖД/ФПК</title>
|
||||
<codes{carrier}>
|
||||
<iata/>
|
||||
<icao/>
|
||||
<sirena/>
|
||||
</codes>
|
||||
</carrier>
|
||||
<transport_type>train</transport_type>
|
||||
<stop>
|
||||
<arrival/>
|
||||
<duration>0.0</duration>
|
||||
<platform/>
|
||||
<terminal/>
|
||||
<departure>2014-02-20T00:44:00+03:00</departure>
|
||||
<stop_time/>
|
||||
<station>
|
||||
<code{station}>s2006004</code>
|
||||
<type>station</type>
|
||||
<codes{station}>
|
||||
<esr>060073</esr>
|
||||
<yandex>s2006004</yandex>
|
||||
<express>2006004</express>
|
||||
</codes>
|
||||
<title{station}>Москва (Ленинградский вокзал)</title>
|
||||
<short_title>М-Ленинградск</short_title>
|
||||
<popular_title>Ленинградский вокзал</popular_title>
|
||||
</station>
|
||||
</stop>
|
||||
<stop>
|
||||
...
|
||||
</stop>
|
||||
...
|
||||
<vehicle>xsi:nil="true"</vehicle>
|
||||
<transport_subtype>
|
||||
<color>#FF7F44</color>
|
||||
<code>suburban</code>
|
||||
<title>Пригородный поезд</title>
|
||||
</transport_subtype>
|
||||
<express_type>xsi:nil="true"</express_type>
|
||||
</response>
|
||||
```
|
||||
|
||||
#### Описание элементов XML
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Элемент XML** | **Тип** | **Описание** |
|
||||
| `except_days` | Строка | Дни, в которые нитка не курсирует (даже если они входят в множество, описанное элементом `days`). |
|
||||
| `arrival_date` | Строка | Дата прибытия на станцию, указанную в параметре `to`.<br>Включается в ответ только если нитка не является _интервальной_. |
|
||||
| `from` | Строка | Пункт отправления, указанный в параметре `from`. |
|
||||
| `uid` | Строка (не более 100 символов) | Идентификатор нитки, принятый в Яндекс Расписаниях. |
|
||||
| `interval` | Информация о движении по интервальной нитке. | |
|
||||
| `start_time` | Строка | Время отправления с первой станции следования по местному времени станции. |
|
||||
| `number` | Строка | Номер рейса. |
|
||||
| `stops` | Массив | Элемент, описывающий станцию следования. |
|
||||
| `express_type` | Строка | Признак экспресса или аэроэкспресса. Значение по умолчанию — `null`.<br>Если тип транспорта — электричка (ключ `transport_type` возвращен со значением `suburban`), принимает одно из значений:<br>- `express` — экспресс-рейс;<br>- `aeroexpress` — рейс, курсирующий между городом и аэропортом. |
|
||||
| `title` | Строка | Название нитки, составленное из полных названий первой и последней станций следования. |
|
||||
| `departure_date` | Строка | Дата отправления со станции, указанной в параметре `from`.<br>Включается в ответ, только если нитка не является _интервальной_. |
|
||||
| `days` | Строка | Дни курсирования нитки. |
|
||||
| `short_title` | Строка | Название нитки, составленное из коротких названий первой и последней станций следования. |
|
||||
| `to` | Строка | Пункт прибытия, указанный в параметре `to`. |
|
||||
| `carrier` | Информация о перевозчике. | |
|
||||
| `transport_type` | Строка | Тип транспорта. Возможные значения:<br>- `plane` — самолет;<br>- `train` — поезд;<br>- `suburban` — электричка;<br>- `bus` — автобус;<br>- `water` — водный транспорт;<br>- `helicopter` — вертолет. |
|
||||
| `vehicle` | Строка | Название транспортного средства. |
|
||||
|
||||
**Элементы, вложенные в элемент**`interval`
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Элемент XML** | **Тип** | **Описание** |
|
||||
| `begin_time` | Число | Дата и время начала движения по нитке. Всегда указывается в часовом поясе станции отправления.<br>Могут быть указаны в одном из двух форматов:<br>- `YYYY-MM-DD`, если в запросе не был передан параметр `date`.<br>- `YYYY-MM-DDTHH:MM:SS`, если параметр `date` был передан. |
|
||||
| `end_time` | | Дата и время окончания движения по нитке. Всегда указывается в часовом поясе станции отправления.<br>Могут быть указаны в одном из двух форматов:<br>- `YYYY-MM-DD`, если в запросе не был передан параметр `date`.<br>- `YYYY-MM-DDTHH:MM:SS`, если параметр `date` был передан. |
|
||||
| `density` | Строка | Описание периодичности движения в свободной форме. |
|
||||
|
||||
**Элементы, вложенные в элемент**`stop`
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Элемент XML** | **Тип** | **Описание** |
|
||||
| `arrival` | Строка | Время прибытия, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).<br>Если параметр `result_timezone` не был передан, указывается в часовом поясе станции. |
|
||||
| `duration` | Число | Время в пути между станциями (в секундах). |
|
||||
| `station` | | Элемент, содержащий информацию о станции следования. |
|
||||
| `departure` | Строка | Время отправления со станции по местному времени станции. |
|
||||
| `stop_time` | Число | Время остановки (в секундах). |
|
||||
| `platform` | Строка | Платформа или путь, с которого отправляется рейс (например, «3 путь»).<br>Пустая строка значит, что информации о платформе или пути нет. |
|
||||
| `terminal` | Строка | Терминал аэропорта (например, «D»).<br>Принимает значение `null`, если информации о терминале нет. |
|
||||
|
||||
**Элементы, вложенные в элемент**`station`
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Элемент XML** | **Тип** | **Описание** |
|
||||
| `codes` | | Элемент, содержащий список кодов станции в других системах кодирования, поддерживаемый Яндекс Расписаниями. |
|
||||
| `title` | Строка | Название станции. |
|
||||
| `station_type` | Строка | Тип станции:<br>- `station` — станция;<br> <br>- `platform` — платформа;<br> <br>- `stop` — остановочный пункт;<br> <br>- `checkpoint` — блок-пост;<br> <br>- `post` — пост;<br> <br>- `crossing` — разъезд;<br> <br>- `overtaking_point` — обгонный пункт;<br> <br>- `train_station` — вокзал;<br> <br>- `airport` — аэропорт;<br> <br>- `bus_station` — автовокзал;<br> <br>- `bus_stop` — автобусная остановка;<br> <br>- `unknown` — станция без типа;<br> <br>- `port` — порт;<br> <br>- `port_point` — портпункт;<br> <br>- `wharf` — пристань;<br> <br>- `river_port` — речной вокзал;<br> <br>- `marine_station` — морской вокзал. |
|
||||
| `station_type_name` | Строка | Название типа станции, зависит от языка ответа. Возможные значения на русском — в списке значений элемента `station_type`. |
|
||||
| `popular_title` | Строка | Общепринятое название станции. |
|
||||
| `short_title` | Строка | Короткое название станции. |
|
||||
| `code` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
|
||||
| `type` | Строка | Вид станции. Для запроса расписания по станции возможно только одно значение — `station`. |
|
||||
|
||||
**Элементы, вложенные в элемент**`codes`
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Элемент XML** | **Тип** | **Описание** |
|
||||
| `express` | Строка | Код станции в системе кодирования [Экспресс-3](http://www.express-3.ru/). |
|
||||
| `yandex` | Строка | Код станции в системе кодирования Яндекс Расписаний. |
|
||||
| `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). |
|
||||
|
||||
**Элементы, вложенные в элемент**`carrier`
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Элемент XML** | **Тип** | **Описание** |
|
||||
| `code` | Число | Код перевозчика в системе кодирования Яндекс Расписаний. |
|
||||
| `codes` | | Элемент, содержащий список кодов перевозчика в других системах кодирования, поддерживаемый Яндекс Расписаниями. |
|
||||
| `title` | Строка | Название перевозчика. |
|
||||
|
||||
**Элементы, вложенные в элемент**`codes`
|
||||
|
||||
| | | |
|
||||
| --- | --- | --- |
|
||||
| **Элемент XML** | **Тип** | **Описание** |
|
||||
| `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
|
||||
```
|
||||
|
||||
Идентификатор нитки в Яндекс Расписаниях.
|
||||
|
||||
Идентификатор нитки может меняться со временем. Поэтому перед каждым запросом станций нитки необходимо получать актуальный идентификатор запросом [расписания рейсов между станциями](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/concepts/coding-system).
|
||||
|
||||
При использовании системы кодирования Яндекс Расписаний в данном параметре также можно указать код населенного пункта.
|
||||
|
||||
Код населенного пункта или код станции можно получить из адресной строки, пользуясь Яндекс Расписаниями. Например, из адресной строки:
|
||||
|
||||
- «http://rasp.yandex.ru/station/9600213» — код станции «s9600213» (к числовому значению кода добавляется латинская буква «s»);
|
||||
- «http://rasp.yandex.ru/city/146» — код населенного пункта «c146» (к числовому значению кода добавляется латинская буква «c»).
|
||||
|
||||
Код станции прибытия. Должен быть указан в [системе кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system).
|
||||
|
||||
При использовании системы кодирования Яндекс Расписаний в данном параметре также можно указать код населенного пункта.
|
||||
|
||||
Код населенного пункта или код станции можно получить из адресной строки, пользуясь Яндекс Расписаниями. Например, из адресной строки:
|
||||
|
||||
- «https://rasp.yandex.ru/station/9600213» — код станции «s9600213» («s» от сокращенного «station»).
|
||||
- «https://rasp.yandex.ru/city/146» — код населенного пункта «c146» («c» от сокращенного «city»).
|
||||
|
||||
Формат ответа. Поддерживаемые значения:
|
||||
|
||||
- `json` (по умолчанию);
|
||||
- `xml`.
|
||||
|
||||
Язык возвращаемой информации, в формате <код языка>\_<код страны>. Поддерживаемые коды языка описаны стандартом [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` — Украина.
|
||||
|
||||
Дата, на которую необходимо получить список станций следования. Должна быть указана в формате, соответствующем стандарту [ISO 8601](https://ru.wikipedia.org/wiki/ISO_8601). Например, YYYY-MM-DD.
|
||||
|
||||
По умолчанию возвращается список станций следования на первую дату хождения нитки.
|
||||
|
||||
[Cистеме кодирования](https://yandex.ru/dev/rasp/doc/ru/concepts/coding-system), в которой необходимо получить коды станций (в элементе ответа `codes`, вложенном в элемент `station`).
|
||||
|
||||
Возможные значения:
|
||||
|
||||
- `yandex` — система кодирования Яндекс Расписаний;
|
||||
- `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);
|
||||
- `all` — коды всех поддерживаемых систем кодирования.
|
||||
|
||||
|
||||
|
||||
|
||||
По умолчанию элемент `station` не содержит элемента `codes`.
|
||||
|
||||
**Тип**
|
||||
|
||||
Объект
|
||||
|
||||
**Описание**
|
||||
|
||||
Информация о станции отправления рейса.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Код пункта прибытия в системе кодирования Яндекс Расписаний.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Вид пункта отправления.
|
||||
|
||||
Возможные значения:
|
||||
|
||||
- `station` — станция;
|
||||
- `settlement` — поселение.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Название пункта отправления.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Время прибытия, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).
|
||||
|
||||
Если параметр `result_timezone` не был передан, указывается в часовом поясе станции.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Тип отправляющегося транспортного средства.
|
||||
|
||||
Возможные значения:
|
||||
|
||||
- `plane` — самолет;
|
||||
- `train` — поезд;
|
||||
- `suburban` — электричка;
|
||||
- `bus` — автобус;
|
||||
- `water` — водный транспорт;
|
||||
- `helicopter` — вертолет.
|
||||
|
||||
**Тип**
|
||||
|
||||
Объект
|
||||
|
||||
**Описание**
|
||||
|
||||
Код перевозчика в системе кодирования [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).
|
||||
|
||||
**Тип**
|
||||
|
||||
Объект
|
||||
|
||||
**Описание**
|
||||
|
||||
Информация о подтипе транспортного средства.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Основной цвет транспортного средства в шестнадцатеричном формате.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Название транспортного средства.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Признак экспресса или аэроэкспресса. Значение по умолчанию — `null`.
|
||||
|
||||
Если тип транспорта — электричка (ключ `transport_type` возвращен со значением `suburban`), принимает одно из значений:
|
||||
|
||||
- `express` — экспресс-рейс;
|
||||
- `aeroexpress` — рейс, курсирующий между городом и аэропортом.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Время отправления, в формате ISO 8601 (YYYY-MM-DDThh:mm:ss±hh:mm).
|
||||
|
||||
Если параметр `result_timezone` не был передан, указывается в часовом поясе станции.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Дни, в которые нитка не курсирует (даже если они входят в множество, описанное элементом days).
|
||||
|
||||
**Тип**
|
||||
|
||||
Объект
|
||||
|
||||
**Описание**
|
||||
|
||||
Информация о перевозчике.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Платформа или путь, с которого отправляется рейс (например, «3 путь»).
|
||||
|
||||
Пустая строка значит, что информации о платформе или пути нет.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Дни, в которые нитка не курсирует (даже если они входят в множество, описанное элементом days).
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Терминал аэропорта (например, «D»).
|
||||
|
||||
Принимает значение `null`, если информации о терминале нет.
|
||||
|
||||
**Тип**
|
||||
|
||||
Объект
|
||||
|
||||
**Описание**
|
||||
|
||||
Информация об указанной в запросе станции.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Код станции в системе кодирования Яндекс Расписаний.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Код станции в системе кодирования [ЕСР](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).
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка (не более 100 символов)
|
||||
|
||||
**Описание**
|
||||
|
||||
Идентификатор нитки, принятый в Яндекс Расписаниях.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Дата отправления с первой станции следования.
|
||||
|
||||
**Тип**
|
||||
|
||||
Объект
|
||||
|
||||
**Описание**
|
||||
|
||||
Информация о движении по интервальной нитке.
|
||||
|
||||
**Тип**
|
||||
|
||||
Число
|
||||
|
||||
**Описание**
|
||||
|
||||
Дата и время начала движения по нитке. Всегда указывается в часовом поясе станции отправления.
|
||||
|
||||
Могут быть указаны в одном из двух форматов:
|
||||
|
||||
- `YYYY-MM-DD`, если в запросе не был передан параметр `date`.
|
||||
- `YYYY-MM-DDTHH:MM:SS`, если параметр `date` был передан.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Дата и время окончания движения по нитке. Всегда указывается в часовом поясе станции отправления.
|
||||
|
||||
Могут быть указаны в одном из двух форматов:
|
||||
|
||||
- `YYYY-MM-DD`, если в запросе не был передан параметр `date`.
|
||||
- `YYYY-MM-DDTHH:MM:SS`, если параметр `date` был передан.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Описание периодичности движения в свободной форме.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Время отправления с первой станции следования по местному времени станции.
|
||||
|
||||
Включается в ответ только если нитка не является [интервальной](https://yandex.ru/dev/rasp/doc/ru/concepts/termin#intervalthread).
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Название нитки, составленное из коротких названий первой и последней станций следования.
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Пункт прибытия, указанный в параметре `to`.
|
||||
|
||||
**Тип**
|
||||
|
||||
Число
|
||||
|
||||
**Описание**
|
||||
|
||||
Время в пути между станциями (в секундах).
|
||||
|
||||
**Тип**
|
||||
|
||||
Число
|
||||
|
||||
**Описание**
|
||||
|
||||
Продолжительность остановки (в секундах).
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Код станции в системе кодирования [Экспресс-3](http://www.express-3.ru/).
|
||||
|
||||
**Тип**
|
||||
|
||||
Строка
|
||||
|
||||
**Описание**
|
||||
|
||||
Общепринятое название станции.
|
||||
Reference in New Issue
Block a user