Package com.artmark.gds.service
Interface SoapJsonService
public interface SoapJsonService
Внешний интерфейс сервиса по продаже билетов. Особенностью данного сервиса является прием и передача объектов,
сериализованных в формат JSON. Данный интерфейс рекомендован для статический языков (Java, C#).
- Since:
- 25.08.2014 15:29
- Author:
- V.Skorykh
-
Method Summary
Modifier and TypeMethodDescriptionБронирование заказа.cancelOrder
(long orderId) Отмена заказа.cancelTicket
(long ticketId) Отмена билета в заказе.confirmOrder
(long orderId, String paymentMethod, String options) Подтверждение оплаты заказа с возможностью изменить опции продажиЭхо-метод для тестирования соединенияgetArrivalPoints
(long dispatchPointId, String pattern) Получение списка пунктов прибытия для заданного пункта отправленияgetCarrier
(long ticketId) Получить информацию о перевозчике по идентификатору билетаПолучение списка доступных странgetDepotInfo
(long depotId) Получение информации об автовокзале.Получение списка автовокзалов, доступных для пользователя.getDispatchPoints
(long regionId) Получение списка доступных пунктов отправления, из которых возможно приобретение билетовgetDocTypes
(String raceCode) Получение списка типов документов, допустимых пи оформлении билетов.getOrder
(long orderId) Получение информации о заказеgetPointDepots
(long pointId) Получение списка автовокзалов, доступных для пункта отправленияПолучение информации о рейсе.getRaceCarrier
(String uid) Получить информацию о перевозчике UID рейсаПолучение списка рейсов на заданную дату.getRaceSeats
(String raceCode) Получение списка свободных мест для рейсаgetRaceStops
(String raceCode) Получение списка остановок для рейсаgetRaceSummary
(String uid) Получение сводной информации о рейсе.getReference
(String code) Получение информации из вспомогательного справочникаgetRegions
(long countryId) Получение списка регионов страныgetTicket
(long ticketId) Получение информации о билетеgetTicketTypes
(String raceCode) Получение списка типов билетов, доступных для продажи.Получение информации о сервере GDSreturnTicket
(long ticketId) Возврат билета.updateTicket
(long ticketId, String sale) Обновление информации о продаже в забронированном или проданном билете.
-
Method Details
-
echo
Эхо-метод для тестирования соединения- Parameters:
message
- Отправляемое сообщение- Returns:
- Получаемое сообщение. Должно соответствовать отправленному
-
getVersion
String getVersion()Получение информации о сервере GDS- Returns:
- Информация о версии сервера GDS
-
getCountries
String getCountries()Получение списка доступных стран- Returns:
- Список стран
-
getRegions
Получение списка регионов страны- Parameters:
countryId
- ID страны- Returns:
- Список регионов
- See Also:
-
Region
-
getDepots
String getDepots()Получение списка автовокзалов, доступных для пользователя. Возвращает актуальную информацию по статусу автовокзала (онлайн/оффлайн). Поскольку составление списка сопровождается опросом автовокзалов, данные метод имеет довольно низкую производительность и может зависать, если какой-то автовокзал только что ушел в оффлайн. Не рекомендуется вызывать очень часто. Рекомендуется кэшировать результат.- Returns:
- Список автовокзалов
- Since:
- 1.7
- See Also:
-
DepotInfo
-
getDepotInfo
Получение информации об автовокзале. Функция может быть полезна для того, чтобы определить, какие возможности реализованы для данного автовокзала.- Parameters:
depotId
- ID автовокзала- Returns:
- Информация об автовокзале
- See Also:
-
DepotInfo
-
getPointDepots
Получение списка автовокзалов, доступных для пункта отправления- Parameters:
pointId
- ID пункта отправления- Returns:
- Список автовокзалов
- Since:
- 1.13
- See Also:
-
DepotInfo
-
getDispatchPoints
Получение списка доступных пунктов отправления, из которых возможно приобретение билетов- Parameters:
regionId
- ID региона Если 0, то возвращается список для всех регионов.- Returns:
- Список мест, из которых можно купить билеты
- See Also:
-
Point
-
getArrivalPoints
Получение списка пунктов прибытия для заданного пункта отправления- Parameters:
dispatchPointId
- ID пункта отправленияpattern
- Образец названия станции для поиска. Если null или пустая строка - возвращаются все записи.- Returns:
- Список мест прибытия. Если указан pattern, то в списке будут только станции, название которых начинается на буквы, указанные в образце. Регистр не учитывается.
- See Also:
-
Point
-
getRaces
Получение списка рейсов на заданную дату. Информация о рейсах помещается в кэш для дальнейшего повторного использования. Время жизни информации в кэше - 5 минут.- Parameters:
dispatchPlaceId
- ID места отправленияarrivalPlaceId
- ID места прибытияdate
- Дата отправления- Returns:
- Список рейсов
- See Also:
-
Race
-
getRace
Получение информации о рейсе.- Parameters:
raceCode
- Код рейса- Returns:
- Информация о рейсе
- See Also:
-
Race
-
getRaceSummary
Получение сводной информации о рейсе. Если логика приложения требует последывательно вызывать методы getDepotInfo(), getRace(), getRaceStops(), getRaceSeats(), getTicketTypes() и getDocTypes(), то использование данного метода позволит сократить накладные расходы на передачу данных и получить все данные одним HTTP-запросом.- Parameters:
uid
- Универсальный идентификатор рейса- Returns:
- Сводная информация о рейсе
- Since:
- 1.7
- See Also:
-
RaceSummary
-
getRaceStops
Получение списка остановок для рейса- Parameters:
raceCode
- Код рейса- Returns:
- Список остановок
- See Also:
-
Stop
-
getRaceSeats
Получение списка свободных мест для рейса- Parameters:
raceCode
- Код рейса- Returns:
- Список свободных мест
- See Also:
-
Seat
-
getTicketTypes
Получение списка типов билетов, доступных для продажи.- Parameters:
raceCode
- Код рейса- Returns:
- Список типов билетов. Включает информацию о цене.
- See Also:
-
TicketType
-
getDocTypes
Получение списка типов документов, допустимых пи оформлении билетов.- Parameters:
raceCode
- Код рейса- Returns:
- Список типов документов
- See Also:
-
DocType
-
bookOrder
Бронирование заказа. Бронь сохраняется в течение ограниченного времени, от 20 до 60 минут. Если в указанный период времени не поступает подтверждение оплаты через метод confirmOrder(), то бронирование автоматически отменяется.- Parameters:
raceCode
- Код рейсаsales
- Информация о бронируемых билетах. За один раз может быть забронировано сразу несколько мест.- Returns:
- Информация о сформированном заказе и билетах. Может быть неполной, так как на момент бронирования не все атрибуты заказа и билетов известны.
- See Also:
-
Sale
Order
-
confirmOrder
Подтверждение оплаты заказа с возможностью изменить опции продажи- Parameters:
orderId
- ID заказаpaymentMethod
- Способ оплаты. Допустимые значения: "Наличный расчет" - при оплате наличными, "По банковской карте" - при безналичной оплате.options
- Опции продажи для билетов или null, если опций нет.- Returns:
- Информация о заказе и билетах, дополненая после продажи.
- Since:
- 1.13.4
-
getOrder
Получение информации о заказе- Parameters:
orderId
- ID заказа- Returns:
- Информация о заказе и билетах. Извлекается из локальной базы GDS и может не соответствовать реальному статусу билетов на автовокзале.
- See Also:
-
Order
-
getTicket
Получение информации о билете- Parameters:
ticketId
- ID билета- Returns:
- Информация о билете. Извлекается из локальной базы GDS и может не соответствовать реальному статусу билетов на автовокзале.
- Since:
- 1.7
- See Also:
-
Ticket
-
updateTicket
Обновление информации о продаже в забронированном или проданном билете. На данный момент метод работает только для автовокзалов, использующих АСУ "Е-автовокзал". Поскольку персональные данные пассажиров передаются в ЗащитуИнфорТранс, желательно ограничивать время, в течение которого возможно исправление персональных данных пассажира.- Parameters:
ticketId
- ID Билетаsale
- Обновленная информация. Исправить можно только персональные данные пассажира, изменение типа билета или номера места не поддерживается.- Returns:
- Информация о билете с обновлениями в случае успеха или информация об ошибке
- Since:
- 1.7
- See Also:
-
Sale
-
returnTicket
Возврат билета. При выполнении возврата сервером автовокзала производится расчет удержаний.- Parameters:
ticketId
- ID билета- Returns:
- Информация по билету после выполнения возврата
- See Also:
-
Ticket
-
cancelOrder
Отмена заказа. В процессе отмены удержания от стоимости билетов не производятся. Операция поддерживается только в AVServer и только в течение ограниченного периода времени. ВНИМАНИЕ! Данная операция предназначена для экстренных случаев для использования персоналом. Она не должна быть доступна покупателям и не должна применяться для массовой отмены заказов после оплаты!- Parameters:
orderId
- ID заказа- Returns:
- Информация о заказе после отмены
- See Also:
-
Order
-
cancelTicket
Отмена билета в заказе.- Parameters:
ticketId
- ID билета- Returns:
- Информация об отмененном билете
-
getCarrier
Получить информацию о перевозчике по идентификатору билета- Parameters:
ticketId
- ID билета- Returns:
- Информация о перевозчике
- Since:
- 1.14.4
-
getRaceCarrier
Получить информацию о перевозчике UID рейса- Parameters:
uid
- Race UID- Returns:
- Информация о перевозчике
- Since:
- 1.14.4
-
getReference
Получение информации из вспомогательного справочника- Parameters:
code
- Код справочника. Например: 'payment_methods' - допустимые способы оплаты заказа, значения используются при вызове confirmOrder()- Returns:
- Справочник
- Since:
- 1.5
-