Протокол AV5 для интеграции систем продажи электронных билетов перевозчиков и системы GDS
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

1028 lines
49 KiB

Спецификация на протокол AVS5RS продажи билетов для автотранспорта
==================================================================
6 years ago
**Версия документа: 2.1**
6 years ago
5 years ago
**Дата изменения: 06.09.2017**
6 years ago
Введение
========
6 years ago
Данный документ содержит спецификацию протокола AVS5RS, предназначенного
для организации удаленной продажи билетов на автотранспорте.
Спецификация предназначена для унификации процесса обмена данными между
перевозчиками, автовокзалами и агентами по продаже билетов.
6 years ago
Описание протокола
==================
6 years ago
Общие сведения
--------------
6 years ago
Обмен данными в протоколе AVS5RS производится через протокол HTTP.
6 years ago
Передача и прием данных производится в формате XML, с использованием
кодировки UTF-8.
6 years ago
Все запросы оправляются методом POST. Каждый метод протокола реализуется
через отдельный URL, который строится относительно базового адреса
сервиса, далее обозначаемого как \[BASE\_URL\].
Доступ к веб-сервису, реализующему протокол AVS5RS, должен быть закрыт с
применением Basic-аутентификации. Допускается использование протокола
HTTPS, контроля доступа по IP, передача данных через VPN-соединение.
6 years ago
Общие форматы данных:
---------------------
Формат даты: `yyyy-MM-dd`, формат даты и времени:
`yyyy-MM-dd'T'HH:mm:ss`. Пример:
2016-09-07T13:10:00 (символ T латинский, обязательный) (секунды
обязательны). Время указано в часовом поясе сервера который
предоставляет контент.
Числа с плавающий точко в качестве разделителя используют точку.
Дробная часть не обязательна и не более 2 знаков.
5 years ago
Все идентификаторы сущностей (id) это строки, произвольного формата, длинной до 36 символов.
Разрешенные символы: цифры, латинские буквы в любом регистре, и символы -={}[]$
Могут быть как искусственными (sequence) так и реальными значениями (номер билета, номер места и.т.д.)
6 years ago
Форматы данных XML
------------------
Ответы с сервера должны поступать по протоколу HTTP c кодом 200 и
HTTP-заголовком “Content-Type”, имеющим значение “application/xml; charset=UTF-8”.
Тело XML- ответа должно начинаться с объявления
`<?xml version="1.0" encoding="UTF-8"?>`. Регистр
названий тегов и атрибутов должен совпадать с регистром из примеров.
6 years ago
XML-ответ в обязательном порядке имеет корневой тег, название которого
должно соответствовать формату "&lt;НазваниеМетодаResponse&gt;" (например EchoResponse, SearchTripsResponse)
Если ответ корректный, то данные ответа содержатся во вложенном теге &lt;Body&gt;.
Если ответ не корректный, информация об ошибке должна находиться во
вложенном теге &lt;Error&gt;, который состоит из кода ошибки в теге
6 years ago
&lt;code&gt; и описания ошибки в теге &lt;message&gt;. Код ошибок в приложении.
Описание - это произвольные текст на русском языке,
поясняющий причину ошибки. Некоторые методы допускают пустой ответ.
Пустой ответ содержит только корневой тег.
6 years ago
Пустой ответ:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<UpdateTicketResponse>
</UpdateTicketResponse>
```
Пример ответа в случае успешной обработки запроса:
6 years ago
```xml
5 years ago
<?xml version="1.0" encoding="UTF-8"?>
6 years ago
<EchoResponse>
6 years ago
<Body>
<message>Test</message>
</Body>
6 years ago
</EchoResponse>
6 years ago
```
Пример ответа в случае обработки запроса с ошибкой:
6 years ago
```xml
<?xml version="1.0" encoding="UTF-8"?>
6 years ago
<BookResponse>
6 years ago
<Error>
<code>ERROR</code>
<message>Место 5 занято</message>
</Error>
6 years ago
</BookResponse>
```
Методы протокола
----------------
6 years ago
### echo
Используется для проверки доступности сервиса.
6 years ago
Метод принимает в параметре произвольную строку и возвращает её в теле
ответа.
**URL: \[BASE\_URL\]/sales/echo**
6 years ago
Запрос:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<EchoRequest>
<!-- Сообщение которое будет возвращено в ответ. Обязательно. -->
<message>Test</message>
</EchoRequest>
```
Ответ:
```xml
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
6 years ago
<EchoResponse>
6 years ago
<Body>
<!-- Сообщение переданное в запросе -->
<message>Test</message>
</Body>
6 years ago
</EchoResponse>
6 years ago
```
### getDispatchStations
Метод получения станций отправления. Продажа происходит от станции
отправления до станции назначения, поэтому метод должен вернуть хотя бы
один элемент. Обычно станциями отправления являются автовокзалы или
автоматизированные остановочные пункты с функцией продажи билетов.
6 years ago
**URL: \[BASE\_URL\]/sales/getDispatchStations**
6 years ago
Запрос:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<GetDispatchStationsRequest>
</GetDispatchStationsRequest>
```
Ответ:
```xml
<?xml version="1.0" encoding="UTF-8"?>
6 years ago
<GetDispatchStationsResponse>
6 years ago
<Body>
<!-- Станция -->
<Station>
<!-- Идентификатор станции. Обязателен. -->
<id>983</id>
<!-- Наименование станции. Обязателен. Используется для отображения в интерфейсе пользователя -->
<name>ВДНХ АС</name>
<!-- Название региона станции. Не обязателен. Используется для отображения в интерфейсе пользователя -->
<region>Москва</region>
<!-- ОКАТО станции. Не обязателен. Используется для поиска одинаковых станций и отображения в интерфейсе пользователя -->
<okato>45000000000</okato>
</Station>
<Station>
<id>853</id>
<name>Варшавская АС</name>
<region>Москва</region>
<okato>45000000000</okato>
</Station>
<Station>
<id>6</id>
<name>Красногвардейская АС</name>
<region>Москва</region>
<okato>45000000000</okato>
</Station>
</Body>
6 years ago
</GetDispatchStationsResponse>
```
6 years ago
### getArrivalStations
Метод получения станций назначения от станции отправления. В параметре
принимает идентификатор станции отправления. Станциями назначения могут
быть любые остановочные пункты до которых есть хотя бы один рейс. Если
6 years ago
станций назначения нет, метод должен вернуть пустой список.
В случае отсутствия станций назначения для указанной станции отправления
возвращать пустой ответ.
6 years ago
**URL: \[BASE\_URL\]/sales/getArrivalStations**
6 years ago
Запрос:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<GetArrivalStationsRequest>
<!-- Идентификатор станции отправления. Обязательно. -->
<dispatchStationId>983</dispatchStationId>
</GetArrivalStationsRequest>
```
Ответ:
```xml
<?xml version="1.0" encoding="UTF-8"?>
6 years ago
<GetArrivalStationsResponse>
<Body>
<Station>
<id>1069</id>
<name>Рыбинск</name>
<region>Ярославская область</region>
<okato>78415000000</okato>
</Station>
<Station>
<id>1018</id>
<name>Сергиев Посад</name>
<region>Московская область</region>
<okato>46215501000</okato>
</Station>
<Station>
<id>1084</id>
<name>Углич</name>
<region>Ярославская область</region>
<okato>78420000000</okato>
</Station>
<Station>
<id>1078</id>
<name>Утена</name>
<region>Литва</region>
</Station>
</Body>
</GetArrivalStationsResponse>
6 years ago
```
### searchTrips
Метод возвращает список рейсов от станции отправления до станции
назначения на заданную дату. В параметрах передается идентификатор
6 years ago
станции отправления, идентификатор станции назначения и дата.
В случае отсутствия рейсов для указанных параметров возвращать пустой ответ.
Рейсы должны быть отсортированы по дате отправления.
6 years ago
**URL: \[BASE\_URL\]/sales/searchTrips**
6 years ago
Запрос:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<SearchTripsRequest>
<!-- Идентификатор станции отправления. Обязательно.-->
<dispatchStationId>983</dispatchStationId>
<!-- Идентификатор станции назначения. Обязательно. -->
<arrivalStationId>678</arrivalStationId>
<!-- Дата на которую выполняется поиск рейса. Обязательно. -->
<date>2016-07-12</date>
</SearchTripsRequest>
```
Ответ:
```xml
<?xml version="1.0" encoding="UTF-8"?>
6 years ago
<SearchTripsResponse>
6 years ago
<Body>
<!-- Рейс-->
<Trip>
<!-- Идентификатор рейса. Обязательно. -->
<id>570104</id>
<!-- Номер маршрута. Не обязателен. -->
<num>000</num>
<!-- Идентификатор маршрута. Не обязательно -->
<routeId>d1e39ba7-b9d6-48f6-a4ba-03674a381c90</routeId>
6 years ago
<!-- Название маршрута. Обязателен. -->
<name>ВДНХ АС - Пенза</name>
<!-- Дата и время отправления. Обязателен. -->
<dispatchDate>2016-07-13T19:30:00</dispatchDate>
<!-- Дата и время прибытия. Обязателен. -->
<arrivalDate>2016-07-14T05:30:00</arrivalDate>
<!-- ID станции отправления. Обязателен. -->
<dispatchStationId>983</dispatchStationId>
<!-- Станция отправления рейса. Обязателен. -->
<dispatchStationName>ВДНХ АС</dispatchStationName>
<!-- ID станции назначения. Обязателен. -->
<arrivalStationId>744</arrivalStationId>
<!-- Станция назначения рейса. Обязателен. -->
<arrivalStationName>Пенза</arrivalStationName>
<!-- Цена полного проездного билета (включая сборы). Обязателен. -->
<price>1391</price>
<!-- Название перевозчика. Не Обязателен. -->
<carrierName>ИП Ерашова Валентина Анатольевна</carrierName>
<!-- ИНН перевозчика. Обязателен. -->
<carrierInn>ИНН 582700056092</carrierInn>
<!-- Описание автобуса. Обязателен. -->
<busInfo>49 Мест Категория ТС &quot;М3&quot; </busInfo>
<!--
тип рейса. Обязателен. см. ФЗ-220
5 years ago
INTERNATIONAL - Международный.
INTERREGIONAL - Межрегиональный.
ADJACENT_INTERREGIONAL - Смежный межрегиональный.
INTERMUNICIPAL - Межмуниципальный.
MUNICIPAL - Муниципальный.
6 years ago
-->
<type>INTERREGIONAL</type>
<!--
Статус рейса. Обязателен.
ON_SALE - В продаже. Можно продавать билеты на этот рейс,
SUSPENDED - Приостановка продажи. Продажа запрещена.
CANCELED - Рейс отменен. Продажа запрещена.
DISPATCHED - Рейс отправлен. Продажа запрещена.
6 years ago
UNKNOWN - Неопределенный статус. Рейс не доступен для продажи.
-->
<status>ON_SALE</status>
<!--
Класс рейса. Не обязателен. По умолчанию - регулярный
REGULAR - Регулярный рейс
CUSTOM - Заказной рейс
-->
<class>REGULAR</class>
6 years ago
<!-- Количество мест в автобусе. Обязателен. -->
<seatCount>49</seatCount>
<!-- Кол-во мест, доступных для продажи. Обязателен.-->
<freeSeatCount>49</freeSeatCount>
6 years ago
<!-- Ключ маршрута. Не обязателен. Используется при транзитных продажах -->
<RouteKey>
<!-- Uid станции формирования -->
<dispatchStationUid>d13945a8-7017-46ab-b1e6-ede1e89317ad</dispatchStationUid>
<!-- Uid конечной станции -->
5 years ago
<arrivalStationUid>279e7c39-2570-44e0-83e6-d1f473d50e0f</arrivalStationUid>
6 years ago
<!-- время выход с точки формирования -->
<dispatchTime>10:00:00</dispatchTime>
</RouteKey>
6 years ago
</Trip>
<Trip>
<id>570105</id>
<num>000</num>
<routeId>904ede1a-95af-4db3-928f-e9a2c6302278</routeId>
6 years ago
<name>ВДНХ АС - Пенза</name>
<dispatchDate>2016-07-13T21:30:00</dispatchDate>
<arrivalDate>2016-07-14T07:30:00</arrivalDate>
<dispatchStationId>983</dispatchStationId>
<dispatchStationName>ВДНХ АС</dispatchStationName>
<arrivalStationId>744</arrivalStationId>
<arrivalStationName>Пенза</arrivalStationName>
<price>1391</price>
<carrierName>ИП Ерашова Валентина Анатольевна</carrierName>
<carrierInn>ИНН 582700056092</carrierInn>
<busInfo>49 Мест Категория ТС &quot;М3&quot; </busInfo>
<type>INTERREGIONAL</type>
<status>ON_SALE</status>
<seatCount>49</seatCount>
<freeSeatCount>49</freeSeatCount>
</Trip>
</Body>
6 years ago
</SearchTripsResponse>
6 years ago
```
### getFreeSeats
Получение списка свободных мест для рейса. В параметре принимает
идентификатор рейса, идентификатор станции отправления и идентификатор
станции назначения.
6 years ago
**URL: \[BASE\_URL\]/sales/getFreeSeats**
6 years ago
Запрос:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<GetFreeSeatsRequest>
<!-- Идентификатор рейса. Обязательный. -->
<tripId>570101</tripId>
<!-- Идентификатор станции отправления. Обязательный. -->
<dispatchStationId>983</dispatchStationId>
<!-- Идентификатор станции назначения. Обязательный. -->
<arrivalStationId>1080</arrivalStationId>
</GetFreeSeatsRequest>
```
Ответ:
```xml
<?xml version="1.0" encoding="UTF-8"?>
6 years ago
<GetFreeSeatsResponse>
6 years ago
<Body>
<!-- Место-->
<Seat>
5 years ago
<!-- Идентификатор места. Обязателен. Может совпадать с номером.-->
6 years ago
<id>17926</id>
6 years ago
<!-- Номер места. Обязателен. Отображается в интерфейсе пользователя. -->
6 years ago
<num>1</num>
6 years ago
</Seat>
<Seat>
<id>17927</id>
6 years ago
<num>2</num>
6 years ago
</Seat>
<Seat>
<id>17928</id>
6 years ago
<num>3</num>
6 years ago
</Seat>
</Body>
6 years ago
</GetFreeSeatsResponse>
6 years ago
```
### getTicketTypes
Получение списка типов билетов, доступных для продажи. В параметре
принимает идентификатор рейса, идентификатор станции отправления и
идентификатор станции назначения.
6 years ago
**URL: \[BASE\_URL\]/sales/getTicketTypes**
6 years ago
Запрос:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<GetTicketTypesRequest>
<!-- Идентификатор рейса. Обязательный. -->
<tripId>570101</tripId>
<!-- Идентификатор станции отправления. Обязательный. -->
<dispatchStationId>983</dispatchStationId>
<!-- Идентификатор станции назначения. Обязательный. -->
<arrivalStationId>1080</arrivalStationId>
</GetTicketTypesRequest>
6 years ago
```
Ответ:
```xml
<?xml version="1.0" encoding="UTF-8"?>
6 years ago
<GetTicketTypesResponse>
6 years ago
<Body>
<TicketType>
<!-- Идентификатор типа билета. Обязателен. Может совпадать с названием. -->
<id>1#1#0</id>
<!-- Название типа билета. Обязателен. -->
<name>Полный</name>
<!-- Цена для заданного типа билета (со сборами). Обязателен. -->
<price>1391</price>
<!--
Класс билета. Обязателен.
PASSENGER Пассажирский билет, с выделением места
BAGGAGE Багажный билет, без выделения места
6 years ago
WITHOUT_SEAT Пассажирский билет, без выделением места
6 years ago
-->
<ticketClass>PASSENGER</ticketClass>
</TicketType>
<TicketType>
<id>38#6#0</id>
<name>Детский</name>
<price>696</price>
<ticketClass>PASSENGER</ticketClass>
</TicketType>
<TicketType>
<id>0#0#0</id>
<name>Багажный</name>
<price>40</price>
<ticketClass>BAGGAGE</ticketClass>
</TicketType>
</Body>
6 years ago
</GetTicketTypesResponse>
6 years ago
```
### getDocumentTypes
Получение списка типов документов, допустимых для удостоверения личности
при оформлении билетов через интернет. Система должна предоставить хотя
бы один тип документа. Допустимые идентификаторы и названия документов
перечислены в таблице 1 Приказа Минтранса РФ от 19 июля 2012 г. N 243
"Об утверждении Порядка формирования и ведения автоматизированных
централизованных баз персональных данных о пассажирах и персонале
(экипаже) транспортных средств, а также предоставления содержащихся в
них данных".
Текст документа в системе ГАРАНТ: <http://base.garant.ru/70229008/>
6 years ago
**URL: \[BASE\_URL\]/sales/getDocumentTypes**
6 years ago
Запрос:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<GetDocumentTypesRequest>
<!-- Идентификатор рейса. Обязательный. -->
<tripId>570101</tripId>
<!-- Идентификатор станции отправления. Обязательный. -->
<dispatchStationId>983</dispatchStationId>
<!-- Идентификатор станции назначения. Обязательный. -->
<arrivalStationId>1080</arrivalStationId>
</GetDocumentTypesRequest>
```
Ответ:
```xml
<?xml version="1.0" encoding="UTF-8"?>
6 years ago
<GetDocumentTypesResponse>
6 years ago
<Body>
<DocumentType>
<!-- ID типа документа. Обязателен. -->
<id>0</id>
6 years ago
<!-- Название типа документа. Обязателен. -->
<name>Паспорт РФ</name>
</DocumentType>
<DocumentType>
<id>3</id>
6 years ago
<name>Паспорт иностранного гражданина</name>
</DocumentType>
<DocumentType>
<id>4</id>
<name>Свидетельство о рождении</name>
6 years ago
</DocumentType>
6 years ago
</Body>
6 years ago
</GetDocumentTypesResponse>
6 years ago
```
Таблица 1. Коды документов, удостоверяющих личность, при передаче в АЦБПДП
---------------------------------------------------------------
-------------------------------------------------------------------------
Код Наименование документа
--- -------------------------------------------------------------------
5 years ago
0 Паспорт гражданина Российской Федерации
5 years ago
1 Паспорт моряка
5 years ago
2 Общегражданский заграничный паспорт гражданина Российской Федерации
5 years ago
3 Паспорт иностранного гражданина
5 years ago
4 Свидетельство о рождении
5 years ago
5 Удостоверение личности военнослужащего
5 years ago
6 Удостоверение личности лица без гражданства
5 years ago
7 Временное удостоверение личности, выдаваемое органами внутренних дел
5 years ago
8 Военный билет военнослужащего срочной службы
5 years ago
9 Вид на жительство иностранного гражданина или лица без гражданства
10 Справка об освобождении из мест лишения свободы
11 Паспорт гражданина СССР
12 Паспорт дипломатический
13 Паспорт служебный (кроме паспорта моряка и дипломатического)
14 Свидетельство о возвращении из стран СНГ
15 Справка об утере паспорта
--------------------------------------------------------------------------
6 years ago
### getTripStops
Метод возвращает список остановочных пунктов для рейса. В параметре
принимает идентификатор рейса. Информация имеет справочный характер.
6 years ago
**URL: \[BASE\_URL\]/sales/getTripStops**
6 years ago
Запрос:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<GetTripStopsRequest>
<!-- Идентификатор рейса. Обязателен. -->
<tripId>569839</tripId>
</GetTripStopsRequest>
```
Ответ:
```xml
<?xml version="1.0" encoding="UTF-8"?>
6 years ago
<GetTripStopsResponse>
6 years ago
<Body>
<Stop>
<!-- ID остановки. Совпадает с ID станции. Обязателен. -->
<id>1011</id>
<!-- Название остановки. Совпадает с названием станции. Обязателен. -->
<name>Скопин (трасса)</name>
<!-- Район расположения остановки. Не обязателен. -->
<regionName>Рязанская область</regionName>
<!-- Дата-время прибытия на остановку. Обязателен. -->
<arrivalDate>2016-07-14T16:20:00</arrivalDate>
<!-- Дата-время отправления с остановки. Обязателен. -->
<dispatchDate>2016-07-13T21:00:00</dispatchDate>
<!-- Время стоянки в минутах. Не Обязателен. -->
<stopTime>10</stopTime>
<!-- Расстояние от пункта отправления до остановки в км. Не Обязателен. -->
<distance>260</distance>
<!-- Цена полного билета. Обязателен. -->
<price>1177</price>
</Stop>
<Stop>
<id>1010</id>
<name>Мичуринск (трасса)</name>
<regionName>Тамбовская область</regionName>
<arrivalDate>2016-07-14T16:20:00</arrivalDate>
<dispatchDate>2016-07-13T21:00:00</dispatchDate>
<stopTime>10</stopTime>
<distance>385</distance>
<price>1177</price>
</Stop>
<Stop>
<id>818</id>
<name>Тамбов (трасса)</name>
<regionName>Тамбовская область</regionName>
<arrivalDate>2016-07-14T16:20:00</arrivalDate>
<dispatchDate>2016-07-13T21:00:00</dispatchDate>
<stopTime>10</stopTime>
<distance>455</distance>
<price>1177</price>
</Stop>
</Body>
6 years ago
</GetTripStopsResponse>
6 years ago
```
### bookOrder
5 years ago
Бронирование заказа. Бронь должна сохраняться в течение ограниченного времени,
от 20 до 60 минут. Если в указанный период времени не поступает
5 years ago
подтверждение оплаты через метод confirmOrder(), то система реализующая протокол
обязана отменить бронь. Метод должен выполнить все возможные проверки
5 years ago
корректности переданных данных. Если это необходимо, система обязана самостоятельно
проверить правильность ввода персональных данных. В случае ошибки заказ не должен быть
создан. Допускается бронирование нескольких билетов в рамках одного
заказа. В параметрах запроса передаются идентификатор рейса,
идентификатор станции отправления, идентификатор станции назначения,
информацию о бронируемых билетах, информацию об агенте совершивший эту
операцию. Информации о бронируемых билетах включает в себя идентификатор
типа билета, идентификатор места и информацию о пассажире. Информация об
5 years ago
агенте включает в себя наименование и ИНН агента.
6 years ago
**URL: \[BASE\_URL\]/sales/bookOrder**
6 years ago
Запрос:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<BookOrderRequest>
<!-- Идентификатор рейса. Обязательный. -->
<tripId>570101</tripId>
<!-- Идентификатор станции отправления. Обязательный. -->
<dispatchStationId>983</dispatchStationId>
<!-- Идентификатор станции назначения. Обязательный. -->
<arrivalStationId>1080</arrivalStationId>
<!-- Информация о бронируемом билете. Для каждой брони отдельный тег Sale -->
<Sale>
<!-- Идентификатор места, полученный из getFreeSeats. Обязателен. -->
<seatId>25862</seatId>
<!-- Идентификатор типа билета, полученный из getDocumentTypes. Обязателен. -->
<ticketTypeId>1#1#0</ticketTypeId>
<!-- Персональные данные пассажира. Один пассажир на один билет -->
<Passenger>
<!-- Имя пассажира. Обязательно -->
<firstName>goxUEpWCud</firstName>
<!-- Фамилия пассажира. Обязательно-->
<lastName>sKZXIloHFn</lastName>
5 years ago
<!-- Отчество пассажира. Обязательно для рейсов с типом INTERNATIONAL и INTERREGIONAL -->
6 years ago
<middleName>pCaEgXgfWO</middleName>
<!-- Номер документа удостоверяющего личности. Обязателен.-->
<docNum>jwcmdIrmcc</docNum>
<!-- Серия документа удостоверяющего личности. Не Обязателен.-->
<docSeries>iFAElsnFHn</docSeries>
<!-- Идентификатор типа документа полученный при вызове getDocumentTypes. Обязателен. -->
<docTypeId>1</docTypeId>
5 years ago
<!-- Дата рождения. Обязательно для рейсов с типом INTERNATIONAL и INTERREGIONAL -->
6 years ago
<birthday>1986-01-01</birthday>
5 years ago
<!-- Гражданство виде ISO2. Обязательно для рейсов с типом INTERNATIONAL и INTERREGIONAL -->
6 years ago
<citizenshipISO2>RU</citizenshipISO2>
<!--
5 years ago
Пол. Обязательно для рейсов с типом INTERNATIONAL и INTERREGIONAL
6 years ago
MALE - Мужской
FEMALE - Женский
-->
<gender>MALE</gender>
6 years ago
<!-- Телефон пассажира. Не обязателен. -->
<phone>999-888-77-66</phone>
<!--
Дополнительная произвольная информация. Не обязательно.
-->
<info>NjaqSdsD SDdsqlkr JFn</info>
6 years ago
</Passenger>
</Sale>
<!-- Агент выполнивший операцию. Не Обязателен. -->
<Agent>
<!-- Имя агента. Не обязателен.-->
<name>ИП Твои билеты</name>
<!-- ИНН агента. Не обязателен.-->
<inn>2225555777</inn>
</Agent>
</BookOrderRequest>
```
Ответ:
```xml
<?xml version="1.0" encoding="UTF-8"?>
6 years ago
<BookOrderResponse>
6 years ago
<Body>
<!-- Идентификатор заказ. Обязателен. -->
<orderId>9828350</orderId>
<!-- Время жизни заказа. В минутах. Не обязателен. По умолчанию значение 30 -->
<lifetime>30</lifetime>
</Body>
6 years ago
</BookOrderResponse>
6 years ago
```
### getOrder
Получение информации о заказе. В параметрах принимает идентификатор
заказа, полученный в результате bookOrder. Метод должен вернуть такое же
количество билетов сколько было передано при вызове bookOrder. Метод
должен работать на любом этапе жизни заказа т.е. после создания,
подтверждения, отмены, возврата.
6 years ago
**URL: \[BASE\_URL\]/sales/getOrder**
6 years ago
Запрос:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<GetOrderRequest>
<!-- Идентификатор заказа, полученный при вызове bookOrder. Обязателен.-->
<orderId>9828350</orderId>
</GetOrderRequest>
```
Ответ:
```xml
<?xml version="1.0" encoding="UTF-8"?>
6 years ago
<GetOrderResponse>
6 years ago
<Body>
<!-- Идентификатор заказа. Обязателен. -->
6 years ago
<orderId>9828350</orderId>
<!-- Информация о билетах. Отдельный тег для каждого билета -->
<Ticket>
<!-- Идентификатор билет. Обязателен. -->
<id>12435438</id>
<!-- Номер билета. Обязателен после подтверждения заказа. -->
<number></number>
<!-- Серия билета. Не обязателен. -->
<series></series>
<!-- Дата и время создания билета. Обязателен. -->
<created>2016-07-13T05:48:15</created>
<!-- Дата и время возврата билета. Обязателен после возврата или отмены. -->
<returned></returned>
<!--
Статус билета
RESERVED Забронирован. Данный статус билет получает после бронирования. bookOrder
SOLD Продан. Данный статус билет получает после операции продажи. confirmOrder
CANCELED Отмена билета. Данный статус билет получает после отмены билета. cancelTicket
RETURNED Выполнен возврат билета. Данный статус билет получает после возврата билета. returnTicket
-->
<status>RESERVED</status>
<!--
Класс билета
PASSENGER Пассажирский билет, с выделением места
BAGGAGE Багажный билет, без выделения места
-->
<ticketClass>PASSENGER</ticketClass>
<!-- Идентификато типа билета. Обязателен. -->
<typeId>1#1#0</typeId>
<!-- Номер маршрута. Не обязателен. -->
<routeNum>000</routeNum>
<!-- Название маршрута. Обязателен. -->
<routeName>ВДНХ АС - Рыбинск</routeName>
<!-- Информация об автобусе. Обязателен -->
<busInfo>19 Мест Категория ТС &quot;М3&quot; </busInfo>
<!-- Название перевозчика. Не обязателен -->
<carrierName>ООО &quot;ВВМЛ&quot;</carrierName>
<!-- ИНН перевозчика. Обязателен. -->
<carrierInn>ИНН 7610074937</carrierInn>
<!-- Платформа отправления. Не обязателен. -->
<platform>Перрон 11</platform>
<!-- Дата и время отправления рейса. Обязателен. -->
<dispatchDate>2016-07-13T12:20:00</dispatchDate>
<!-- Станция посадки. Обязателен.-->
<dispatchStation>ВДНХ АС</dispatchStation>
<!-- Адрес станции посадки. Не обязателен -->
<dispatchAddress>пл.Шарля де Голля напротив Космонавтов2А,</dispatchAddress>
<!-- Дата и время прибытия. Обязателен. -->
<arrivalDate>2016-07-13T16:20:00</arrivalDate>
<!-- Станция назначения. Обязателен. -->
<arrivalStation>Углич</arrivalStation>
5 years ago
<!-- Название места. Обязателен для билетов с местом. -->
6 years ago
<seatNum>1</seatNum>
6 years ago
<!-- Информация о пассажире. -->
<Passenger>
<lastName>Ckayuukvgn</lastName>
<firstName>Bgkzxffotu</firstName>
<middleName>Isdikvryin</middleName>
<docNum>PUPrvbqlgU</docNum>
<docSeries>fRHEoBHVbG</docSeries>
<docTypeId>1</docTypeId>
<birthday>1985-01-01</birthday>
<citizenshipISO2>RU</citizenshipISO2>
<gender>MALE</gender>
6 years ago
<phone>999-888-77-66</phone>
<info>FewwLks Mq</info>
6 years ago
</Passenger>
<!-- Тариф (руб). Обязателен после подтверждения. -->
<fare>0</fare>
5 years ago
<!-- Cборы автовокзала(руб). Обязателен после подтверждения. Если нет то 0. -->
6 years ago
<fees>0</fees>
5 years ago
<!-- Сумма возврата (руб). Обязателен в случает возврата. -->
6 years ago
<repayment>0</repayment>
6 years ago
<!-- Информация о страховании. Обязательно. Необходим при печати билета. -->
<insuranceInfo>СТРАХОВЩИК: ПАО &quot;Росстрах&quot;; 119991; г. Москва; ул. Большая Ордынка; д. 40; стр.</insuranceInfo>
</Ticket>
</Body>
6 years ago
</GetOrderResponse>
6 years ago
```
### confirmOrder
Подтверждение оплаты заказа. Данный метод должен вызываться только после
того как заказ действительно был оплачен покупателем. Метод не должен
делать проверок корректности заказа, все проверки должны выполняться в
bookOrder или updateTicket. Вызов этого метода означает подтверждение
правильного приема данных и получение денег от покупателя. В параметрах
принимает идентификатор заказа, полученный в результате bookOrder и
информацию об агенте который совершил операцию.
Агент может измениять тариф билета, только при наличии прямого договора между агентом и перевозчиком, и
соответствующего разрешения у агента. В этом случае агент обязан передать новый тариф для каждого билета.
6 years ago
**URL: \[BASE\_URL\]/sales/confirmOrder**
6 years ago
Запрос:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<ConfirmOrderRequest>
6 years ago
<!-- ID заказа. Обязателен. -->
6 years ago
<orderId>9828585</orderId>
<!-- Агент выполнивший операцию. Не Обязателен. -->
<Agent>
<!-- Имя агента. Не обязателен.-->
<name>ИП Твои билеты</name>
<!-- ИНН агента. Не обязателен.-->
<inn>2225555777</inn>
</Agent>
<TicketFare> <!-- Изменение тарифа билета. Не обязателен. -->
<fare>100</fare> <!-- новый тариф -->
<ticketId>0000002681</ticketId> <!-- ID билета -->
</TicketFare>
6 years ago
</ConfirmOrderRequest>
```
Ответ:
6 years ago
Ответ аналогичен ответу на запрос [getOrder](#getorder) c именем корневого тега ConfirmOrderResponse
6 years ago
### cancelTicket
6 years ago
Отмена одного или нескольких билетов. Техническая операция, выполняет полный возврат билета без
удержаний. Необходима при нештатных ситуациях: в случае сбоев ККМ или
обнаружения ошибки выбора рейса, персональных данных. В параметрах
6 years ago
принимает идентификаторы билета и информацию об агенте который совершил
операцию. Все билеты должны быть обработы в рамках одной транзакции.
т.е. если было передано 2 билета, первый был обработан а при обработке второго возникла ошибка
то обработка первого должна быть отменена.
Можно выполнять после создания заказа и в течении 5-30 минут
после подтверждения заказа.
5 years ago
При интеграции с сервисом GDS гарантируется,
что переданные ticketId будут принадлежать одному заказу.
Решение допускать ли передачу Id билетов из разных заказов остается за вокзалом,
который реализует данный протокол.
6 years ago
**URL: \[BASE\_URL\]/sales/cancelTicket**
6 years ago
Запрос:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<CancelTicketRequest>
6 years ago
<!-- ID билетов для возврата. произвольное количество тегов. -->
<ticketId>34</ticketId>
<ticketId>36</ticketId>
6 years ago
<!-- Агент выполнивший операцию. Не Обязателен. -->
<Agent>
<!-- Имя агента. Не обязателен.-->
<name>ИП Твои билеты</name>
<!-- ИНН агента. Не обязателен.-->
<inn>2225555777</inn>
</Agent>
</CancelTicketRequest>
```
Ответ:
5 years ago
Ответ аналогичен ответу на запрос [getOrder](#getorder) c именем корневого тега CancelTicketResponse. В ответе необходимо возвращать информацию только по обработанным билетам.
6 years ago
### returnTicket
6 years ago
Возврат одного или нескольких билетов. При возврате возможны удержания. В параметрах принимает
идентификатор билета и информацию об агенте который совершил операцию.
Все билеты должны быть обработы в рамках одной транзакции.
т.е. если было передано 2 билета, первый был обработан а при обработке второго возникла ошибка
то обработка первого должна быть отменена.
Билет можно вернуть только после подтверждения confirmOrder.
5 years ago
При интеграции с сервисом GDS гарантируется,
что переданные ticketId будут принадлежать одному заказу.
Решение допускать ли передачу Id билетов из разных заказов остается за вокзалом,
который реализует данный протокол.
6 years ago
**URL: \[BASE\_URL\]/sales/returnTicket**
6 years ago
Запрос:
```xml
<?xml version="1.0" encoding="UTF-8"?>
<ReturnTicketRequest>
6 years ago
<!-- ID билетов для возврата. произвольное количество тегов. -->
<ticketId>35</ticketId>
<ticketId>36</ticketId>
6 years ago
<!-- Агент выполнивший операцию. Не Обязателен. -->
<Agent>
<!-- Имя агента. Не обязателен.-->
<name>ИП Твои билеты</name>
<!-- ИНН агента. Не обязателен.-->
<inn>2225555777</inn>
</Agent>
</ReturnTicketRequest>
```