Update README.md

master
Nikolay Ushmodin 7 years ago committed by GitHub
parent c5c20a35c7
commit eba14ecfea

@ -31,30 +31,6 @@
применением Basic-аутентификации. Допускается использование протокола применением Basic-аутентификации. Допускается использование протокола
HTTPS, контроля доступа по IP, передача данных через VPN-соединение. HTTPS, контроля доступа по IP, передача данных через VPN-соединение.
Отличия от версии 1
-------------------
* Удален атрибут success. Анализ ошибки проиводится по наличию тега Error
* Изменено именования корневых тегов ответа.
* Отмена или ворзрат нескольких билетов одновременно.
* Введены коды ошибок
* Поля
* Trip
* Добавлено platform
* Seat
* Добавлено num
* Удалено name
* Удалено type
* Passenger
* Добавлено info
* Добавлено phone
* Ticket
* Дабавлено repayment
* Удалено chargeFare
* Удалено chargeOthers
* Удалено repaymentFare
* Удалено repaymentOthers
* Мелкие уточнения
Общие форматы данных: Общие форматы данных:
--------------------- ---------------------
@ -68,9 +44,9 @@ HTTPS, контроля доступа по IP, передача данных ч
Числа с плавающий точко в качестве разделителя используют точку. Числа с плавающий точко в качестве разделителя используют точку.
Дробная часть не обязательна и не более 2 знаков. Дробная часть не обязательна и не более 2 знаков.
Все идентификаторы сущностей (id) это строки, Все идентификаторы сущностей (id) это строки, произвольного формата, длинной до 36 символов.
произвольного формата, длинной до 36 символов. Могут быть как искусственными Разрешенные символы: цифры, латинские буквы в любом регистре, и символы -={}[]$
(sequence) так и реальными значениями (номер билета, номер места и.т.д.) Могут быть как искусственными (sequence) так и реальными значениями (номер билета, номер места и.т.д.)
Форматы данных XML Форматы данных XML
------------------ ------------------
@ -324,7 +300,7 @@ XML-ответ в обязательном порядке имеет корне
<!-- <!--
тип рейса. Обязателен. см. ФЗ-220 тип рейса. Обязателен. см. ФЗ-220
INTERNATIONAL - Международный INTERNATIONAL - Международный.
INTERREGIONAL - Межрегиональный. INTERREGIONAL - Межрегиональный.
ADJACENT_INTERREGIONAL - Смежный межрегиональный. ADJACENT_INTERREGIONAL - Смежный межрегиональный.
INTERMUNICIPAL - Межмуниципальный. INTERMUNICIPAL - Межмуниципальный.
@ -355,7 +331,7 @@ XML-ответ в обязательном порядке имеет корне
<!-- Uid станции формирования --> <!-- Uid станции формирования -->
<dispatchStationUid>d13945a8-7017-46ab-b1e6-ede1e89317ad</dispatchStationUid> <dispatchStationUid>d13945a8-7017-46ab-b1e6-ede1e89317ad</dispatchStationUid>
<!-- Uid конечной станции --> <!-- Uid конечной станции -->
<arrivalStationUid>279e7c39-2570-44e0-83e6-d1f473d50e0f</dispatchStationUid> <arrivalStationUid>279e7c39-2570-44e0-83e6-d1f473d50e0f</arrivalStationUid>
<!-- время выход с точки формирования --> <!-- время выход с точки формирования -->
<dispatchTime>10:00:00</dispatchTime> <dispatchTime>10:00:00</dispatchTime>
</RouteKey> </RouteKey>
@ -651,10 +627,10 @@ XML-ответ в обязательном порядке имеет корне
### bookOrder ### bookOrder
Бронирование заказа. Бронь сохраняется в течение ограниченного времени, Бронирование заказа. Бронь должна сохраняться в течение ограниченного времени,
от 20 до 60 минут. Если в указанный период времени не поступает от 20 до 60 минут. Если в указанный период времени не поступает
подтверждение оплаты через метод confirmOrder(), то бронирование подтверждение оплаты через метод confirmOrder(), то система реализующая протокол
автоматически отменяется. Метод должен выполнить все возможные проверки обязана отменить бронь. Метод должен выполнить все возможные проверки
корректности переданных данных. В случае ошибки заказ не должен быть корректности переданных данных. В случае ошибки заказ не должен быть
создан. Допускается бронирование нескольких билетов в рамках одного создан. Допускается бронирование нескольких билетов в рамках одного
заказа. В параметрах запроса передаются идентификатор рейса, заказа. В параметрах запроса передаются идентификатор рейса,
@ -662,7 +638,7 @@ XML-ответ в обязательном порядке имеет корне
информацию о бронируемых билетах, информацию об агенте совершивший эту информацию о бронируемых билетах, информацию об агенте совершивший эту
операцию. Информации о бронируемых билетах включает в себя идентификатор операцию. Информации о бронируемых билетах включает в себя идентификатор
типа билета, идентификатор места и информацию о пассажире. Информация об типа билета, идентификатор места и информацию о пассажире. Информация об
агенте включает в себя наименование и ИНН агента. агенте включает в себя наименование и ИНН агента.
**URL: \[BASE\_URL\]/sales/bookOrder** **URL: \[BASE\_URL\]/sales/bookOrder**
@ -817,7 +793,7 @@ RETURNED Выполнен возврат билета. Данный статус
<arrivalDate>2016-07-13T16:20:00</arrivalDate> <arrivalDate>2016-07-13T16:20:00</arrivalDate>
<!-- Станция назначения. Обязателен. --> <!-- Станция назначения. Обязателен. -->
<arrivalStation>Углич</arrivalStation> <arrivalStation>Углич</arrivalStation>
<!-- Название места. Обязателен. --> <!-- Название места. Обязателен для билетов с местом. -->
<seatNum>1</seatNum> <seatNum>1</seatNum>
<!-- Информация о пассажире. --> <!-- Информация о пассажире. -->
<Passenger> <Passenger>
@ -835,9 +811,9 @@ RETURNED Выполнен возврат билета. Данный статус
</Passenger> </Passenger>
<!-- Тариф (руб). Обязателен после подтверждения. --> <!-- Тариф (руб). Обязателен после подтверждения. -->
<fare>0</fare> <fare>0</fare>
<!-- Cборы (руб). Обязателен после подтверждения. Если нет то 0. --> <!-- Cборы автовокзала(руб). Обязателен после подтверждения. Если нет то 0. -->
<fees>0</fees> <fees>0</fees>
<!-- Удержано Остальные сборы (руб). Обязателен в случает возврата. --> <!-- Сумма возврата (руб). Обязателен в случает возврата. -->
<repayment>0</repayment> <repayment>0</repayment>
<!-- Информация о страховании. Обязательно. Необходим при печати билета. --> <!-- Информация о страховании. Обязательно. Необходим при печати билета. -->
<insuranceInfo>СТРАХОВЩИК: ПАО &quot;Росстрах&quot;; 119991; г. Москва; ул. Большая Ордынка; д. 40; стр.</insuranceInfo> <insuranceInfo>СТРАХОВЩИК: ПАО &quot;Росстрах&quot;; 119991; г. Москва; ул. Большая Ордынка; д. 40; стр.</insuranceInfo>
@ -913,7 +889,7 @@ bookOrder или updateTicket. Вызов этого метода означае
Ответ: Ответ:
Ответ аналогичен ответу на запрос [getOrder](#getorder) c именем корневого тега CancelTicketResponse Ответ аналогичен ответу на запрос [getOrder](#getorder) c именем корневого тега CancelTicketResponse. В ответе необходимо возвращать информацию только по обработанным билетам.
### returnTicket ### returnTicket
@ -946,7 +922,7 @@ bookOrder или updateTicket. Вызов этого метода означае
Ответ: Ответ:
Ответ аналогичен ответу на запрос [getOrder](#getorder) c именем корневого тега ReturnTicketResponse Ответ аналогичен ответу на запрос [getOrder](#getorder) c именем корневого тега ReturnTicketResponse. В ответе необходимо возвращать информацию только по обработанным билетам.
### updateTicket ### updateTicket
@ -1009,3 +985,27 @@ bookOrder или updateTicket. Вызов этого метода означае
</UpdateTicketResponse> </UpdateTicketResponse>
``` ```
Отличия от версии 1
-------------------
* Удален атрибут success. Анализ ошибки проиводится по наличию тега Error
* Изменено именования корневых тегов ответа.
* Отмена или ворзрат нескольких билетов одновременно.
* Введены коды ошибок
* Поля
* Trip
* Добавлено platform
* Seat
* Добавлено num
* Удалено name
* Удалено type
* Passenger
* Добавлено info
* Добавлено phone
* Ticket
* Дабавлено repayment
* Удалено chargeFare
* Удалено chargeOthers
* Удалено repaymentFare
* Удалено repaymentOthers
* Мелкие уточнения

Loading…
Cancel
Save