+7(499) 450-28-09

Боковая панель

Содержание

docs:uav:admin:protocol:start

Содержание

API продажи билетов

Система «Авибус: Управление автовокзалами» предоставляет доступ к API продажи билетов через службу web-сервисов. Web-сервисы «1С» используют протокол SOAP версии 1.1, файл описания web-сервиса доступен по адресу:

http://<host>/<app dir>/ws/saleport?wsdl

для диспетчерского API:

http://<host>/<app dir>/ws/dispatchport?wsdl

для использования единого пространства мест API:

http://<host>/<app dir>/ws/tripsharingport?wsdl

При возникновении ошибок на сервере возникает исключение, и ошибка возвращается в виде текста с тегами.

  • errorcode – код ошибки, используется для обработки ошибок;
  • errordescription — описание ошибки, используется для вывода пользователям;
  • errordetails — подробное описание ошибки, выводится пользователям в виде всплывающей подсказки при наведении мышки на текст ошибки.

Если сервер не сможет классифицировать ошибку, то ее текст не будет содержать тегов. В этом случае в качестве описания нужно вывести “Неизвестная ошибка”, а в качестве подробного описания (всплывающей подсказки) весь текст, который придет с сервера.

Web-сервис SalePort

Полный список функций web-сервиса (SalePort):
AddServiceReturn – создание заказа на возврат услуг;
AddServices – создание заказа на продажу услуг;
AddTicketReturn – создание заказа на возврат билетов;
AddTickets – добавление билетов в заказ;
CancelPayment – отмена оплаты заказа;
CancelPaymentByCheques – отмена оплаты;
CancelReturnPayment – отмена проведения возврата;
CancelReturnPaymentByCheques – отмена возврата оплаты, если при возврате произошла ошибка;
CashIncome – внесение наличных в кассу;
CashOutcome – выемка наличных из кассы;
CheckIn – для внутреннего использования;
CloseCashSession – закрытие кассовой смены;
DelTicketReturn – удаление из заказа на возврат билета к возврату;
DelTickets – удаление билетов из заказа;
GetActiveCashSession – определение суммы наличных в кассе;
GetAllTripsSegments – для внутреннего использования;
GetAvailablePrivileges – запрос списка доступных льгот;
GetAvailableReserveKinds – запрос списка доступных видов бронирования;
GetBusStops – запрос списка остановок;
GetDestinations – запрос списка возможных пунктов назначения;
GetHostInfo – проверка связи с сервером;
GetOccupiedSeats – запрос занятых мест по рейсу;
GetPaymentTransactions – сверка выполненных операций по текущему пользователю;
GetServicesDescription – запрос информации по услуге (необходимые персональные данные, дополнительные реквизиты);
GetServices – получение списка услуг;
GetTrip – запрос информации по рейсу;
GetTrips – поиск рейсов;
GetTripSegment – запрос информации по отрезку пути;
Payment – оплата заказа;
ReserveOrder – бронирование заказа;
ReturnPayment – завершение возврата заказа;
SetCustomer – добавление информации о покупателе в заказ;
SetLoyalityCode – применение карты лояльности к заказу;
SetPersonalDataByPersonIdentifier – заполнение персональных данных пассажира по идентификатору;
SetPrivilege – выбор льгот для заказа;
SetReturnData – передача на сервер данных по возврату;
SetTicketData – отправка на сервер персональных данных;
StartSaleSession – получение информации по заказу и рейсу.

AddServiceReturn

Описание Создание заказа на возврат услуг
Синтаксис AddServiceReturn(ServiceNumber, Departure, [ReturnOrderId])
Параметры ServiceNumber – номер реализации услуги;
Departure – пункт оказания услуг;
ReturnOrderId – номер заказа на возврат
Возвращаемое значение Объект типа ReturnOrder

AddServices

Описание Создание заказа на продажу услуг
Синтаксис AddServices(Services, Departure, [OrderId])
Параметры Services – список услуг;
Departure – пункт оказания услуг;
OrderId – необязательный, идентификатор заказа для добавления услуг к заказу
Возвращаемое значение Объект типа Order. Функция вернет номер заказа, который нужно оплатить функцией Payment

AddTicketReturn

Описание Создание заказа на возврат
Синтаксис AddTicketReturn(TicketNum, [SeatNum], Departure, ReturnOrderId)
Параметры TicketNum – номер билета;
SeatNum – (необязательный) номер места, если передан, то будет проверяться, совпадает ли номер места найденного билета с переданным;
Departure – идентификатор пункта отправления билета (название, код или id), необязателен, если указан ReturnOrderId;
ReturnOrderId – номер заказа на возврат, указывается для групповых возвратов при добавлении второго билета и далее
Возвращаемое значение Объект типа ReturnOrder

AddTickets

Описание Добавление билетов в заказ
Синтаксис AddTickets (OrderId, TicketSeats)
Параметры OrderId – номер заказа;
TicketSeats – список необходимых мест, если нужно конкретное место (выбрано на схеме), то его номер указывается в поле SeatNum, иначе SeatNum нужно оставить пустым, чтобы номер присвоился автоматически. Параметр Входной/Выходной, после выполнения функции в TicketSeat.TicketNumber заполняется номер добавленного билета
Возвращаемое значение Объект типа Order

CancelPayment

Описание Отмена оплаты заказа
Синтаксис CancelPayment(OrderId, TicketSeats, Services, PaymentItems)
Параметры OrderId – номер заказа;
TicketSeats – список отменяемых мест, если не заполнен, то все;
Services – признак необходимости отмены услуг, если не заполнен, то услуги будут отменены;
PaymentItems – отменяемые суммы по способам оплаты, если не заполнен, то отменяются все способы оплаты
Возвращаемое значение Ответ типа Boolean

CancelPaymentByCheques

Описание Отмена оплаты
Синтаксис CancelPaymentByCheques(OrderId, Cheques, PaymentItems)
Параметры OrderId – номер заказа;
Cheques – массив идентификаторов ненапечатанных чеков;
PaymentItems – отменяемые суммы по способам оплаты, если не заполнен, то отменяются все способы оплаты
Возвращаемое значение Значение типа Boolean

CancelReturnPayment

Описание Отмена проведения возврата
Синтаксис CancelReturnPayment(OrderId, TicketNums, Services, PaymentItems)
Параметры OrderId – номер заказа;
TicketNums – список номеров отменяемых билетов, если не заполнен, то все;
Services – признак необходимости отмены услуг, если не заполнен, то услуги будут отменены;
PaymentItems – отменяемые суммы по способам оплаты, если не заполнен, то отменяются все способы оплаты
Возвращаемое значение Значение типа Boolean

CancelReturnPaymentByCheques

Описание Отмена возврата оплаты, если при возврате произошла ошибка
Синтаксис CancelReturnPaymentByCheques(OrderId, Cheques, PaymentItems)
Параметры OrderId – номер заказа;
Cheques – массив идентификаторов ненапечатанных чеков к отмене;
PaymentItems – отменяемые суммы по способам оплаты, если не заполнен, то отменяются все способы оплаты
Возвращаемое значение Значение типа Boolean

CashIncome

Описание Внесение наличных в кассу (например, мелочи для сдачи в начале дня)
Синтаксис CashIncome(TerminalId, CashOrderNum)
Параметры TerminalId – номер фискального регистратора;
CashOrderNum – номер расходного кассового ордера (РКО)
Возвращаемое значение Сумма внесенных средств Integer. После необходимо внести деньги с помощью API фискального регистратора

CashOutcome

Описание Выемка наличных из кассы
Синтаксис CashOutcome(TerminalId, Amount)
Параметры TerminalId – номер фискального регистратора;
Amount – сумма изымаемых средств
Возвращаемое значение Значение типа Boolean

CheckIn

Описание Для внутреннего использования
Синтаксис CheckIn(AppInfo, LicenseInfo, Sign)

CloseCashSession

Описание Закрытие кассовой смены.
Необходимо вызвать перед печатью z-отчета на фискальном регистраторе.
Синтаксис CloseCashSession(TerminalId)
Параметры TerminalId – номер фискального регистратора
Возвращаемое значение Объект типа CashSession

DelTicketReturn

Описание Удаление из заказа на возврат билета к возврату
Синтаксис DelTicketReturn(ReturnOrderId, TicketNumber)
Параметры ReturnOrderId – номер заказа на возврат;
TicketNumber – номер билета
Возвращаемое значение Объект типа ReturnOrder

DelTickets

Описание Удаление билетов из заказа. Также используется для отмены заказа, если передан пустой параметр TicketSeats
Синтаксис DelTickets(OrderId, TicketSeats)
Параметры OrderId – номер заказа;
TicketSeats – список необходимых мест, если нужно конкретное место (выбрано на схеме), то его номер указывается в поле SeatNum, иначе SeatNum нужно оставить пустым. Параметр Входной/Выходной, после выполнения функции в TicketSeat.TicketNumber заполняется номер удаленного билета. Если передать пустой TicketSeats, то удалятся все билеты. Это можно применять для отмены заказа.
Возвращаемое значение Объект типа Order

GetActiveCashSession

Описание Определение суммы наличных в кассе
Синтаксис GetActiveCashSession(TerminalId)
Параметры TerminalId – номер фискального регистратора
Возвращаемое значение Объект типа CashSession

GetAllTripsSegments

Описание Для внутреннего использования
Синтаксис GetAllTripsSegments()
Параметры Отсутствуют
Возвращаемое значение Объект типа TripSegments

GetAvailablePrivileges

Описание Получение списка доступных льгот
Синтаксис GetAvailablePrivileges(OrderId, TicketNumber)
Параметры OrderId – номер заказа;
TicketNumber – номер билета
Возвращаемое значение Список льгот типа Privileges

GetAvailableReserveKinds

Описание Получить список доступных видов бронирования
Синтаксис GetAvailableReserveKinds(OrderId)
Параметры OrderId – номер заказа
Возвращаемое значение Список значение типа ReserveKinds

GetBusStops

Описание Получить список остановок
Синтаксис GetBusStops()
Параметры Отсутствуют
Возвращаемое значение Список значений типа BusStop

GetDestinations

Описание Запрос списка возможных пунктов назначения
Синтаксис GetDestinations(Substring, Departure)
Параметры Substring (String) – часть названия остановки;
Departure (String) – идентификатор пункта отправления (код, название или id)
Возвращаемое значение Список значений типа BusStop

GetHostInfo

Описание Проверка связи с сервером
Синтаксис GetHostInfo(ClientInfo)
Параметры ClientInfo – не обязательный
Возвращаемое значение

GetOccupiedSeats

Описание Запрос занятых мест по рейсу
Синтаксис GetOccupiedSeats(TripId, Departure, Destination, OrderId, Bus)
Параметры TripId – идентификатор рейса;
Departure (String) – идентификатор пункта отправления;
Destination – идентификатор пункта назначения(код, название или id);
OrderId – номер заказа;
Bus – автобус, объект типа Bus (выходной параметр)
Возвращаемое значение Объект типа BusSeats

GetPaymentTransactions

Описание Сверка выполненных операций по текущему пользователю
Синтаксис GetPaymentTransactions(StartDate, EndDate)
Параметры StartDate – начало периода отчета;
EndDate – окончание периода отчета
Возвращаемое значение Объект типа PaymentTransactions

GetServicesDescription

Описание Запрос информации по услуге (необходимые персональные данные, дополнительные реквизиты)
Синтаксис GetServicesDescription(Departure, ServiceId)
Параметры Departure – пункт оказания услуг;
ServiceId – идентификатор услуги
Возвращаемое значение Объект типа Services

GetServices

Описание Получение списка услуг
Синтаксис GetServices(Departure)
Параметры Departure – пункт оказания услуг
Возвращаемое значение Список услуг доступных в выбранном пункте отправления типа Service

GetTrip

Описание Запрос информации по рейсу
Синтаксис GetTrip(TripId, BusStop)
Параметры TripId – идентификатор рейса, либо <tripdate>дата отправления, формат dateTime</tripdate><scheduletripid>id рейса раписания</scheduletripid>;
BusStop – идентификатор остановки
Возвращаемое значение Объект типа Trip

GetTrips

Описание Поиск рейсов
Синтаксис GetTrips(Departure, Destination, TripsDate)
Параметры Departure – идентификатор пункта отправления (код, название или id);
Destination – идентификатор пункта назначения(код, название или id);
TripsDate – дата рейсов в формате 2013-07-30
Возвращаемое значение Список значений типа Trip.
По умолчанию рейсы сортируются по времени отправления

GetTripSegment

Описание Запрос информации по рейсу
Синтаксис GetTrip(TripId, BusStop, Destination)
Параметры TripId – идентификатор рейса;
BusStop – идентификатор остановки;
Destination – идентификатор пункта назначения(код, название или id)
Возвращаемое значение Объект типа Trip. В возвращаемой структуре расстояние, время в пути и тариф передается для участка пути.

Payment

Описание Производит оплату заказа
Синтаксис Payment(OrderId, TerminalId, TerminalSessionId, PaymentItems, ChequeSettings)
Параметры OrderId – номер заказа;
TerminalId – номер фискального регистратора;
TerminalSessionId – номер смены ККМ. Нужно определять перед вызовом этих функции с помощью API фискального регистратора;
PaymentItems – способы оплаты;
ChequeSettings – настройки печати чеков
Возвращаемое значение Объект типа Order

ReserveOrder

Описание Бронирование заказа
Синтаксис ReserveOrder(OrderId, [Customer], ReserveKind, [ChequeSettings])
Параметры OrderId – номер заказа;
[Customer] – покупатель (необязательный);
ReserveKind – вид бронирования;
[ChequeSettings] – необязательный, параметры печати чека (не фискальный чек с информацией о заказе)
Возвращаемое значение Объект типа Order. После бронирования бронь продлевается. Длительность брони будет передана в параметре SecondsToUnlockSeats

ReturnPayment

Описание Завершение возврата заказа
Синтаксис ReturnPayment(ReturnOrderId, TerminalId, TerminalSessionId, PaymentItems, [ChequeSettings])
Параметры ReturnOrderId – номер заказа на возврат оплаты;
TerminalId – номер фискального регистратора;
TerminalSessionId – номер смены ККМ. Нужно определять перед вызовом этих функции с помощью API фискального регистратора;
PaymentItems – способы оплаты;
[ChequeSettings] – настройки печати чеков
Возвращаемое значение Объект типа ReturnOrder

SetCustomer

Описание Добавление информации о покупателе в заказ
Синтаксис SetCustomer(OrderId, Customer)
Параметры OrderId – номер заказа;
Customer – покупатель
Возвращаемое значение Объект типа Order

SetLoyalityCode

Описание Применение карты лояльности к заказу
Синтаксис SetLoyalityCode(OrderId, LoyaltyCode)
Параметры OrderId – номер заказа;
LoyaltyCode – код карты лояльности
Возвращаемое значение Объект типа Order

SetPersonalDataByPersonIdentifier

Описание Заполнение персональных данных пассажира по идентификатору , если он был ранее введен в систему. Необходимо, чтобы поле идентификатора имело признак PersonIdentifier = true
Синтаксис SetPersonalDataByPersonIdentifier(OrderId, TicketNumber, Identifier)
Параметры OrderId – номер заказа;
TicketNumber – номер билета;
Identifier – персональные данные-идентификатор
Возвращаемое значение Объект типа Ticket.
Понять, что пассажир найден, можно по заполненному полю Ticket.PassengerName билета, при этом в списке необходимых персональных данных Ticket.PersonalData остаются только незаполненные на сервере.

SetPrivilege

Описание Выбор льгот для заказа
Синтаксис SetPrivilege(OrderId, TicketNumber, Privilege)
Параметры OrderId – номер заказа;
TicketNumber – номер билета;
Privilege – название льготы
Возвращаемое значение Объект типа Ticket.
Сервер вернет новую структуру билета с новой стоимостью. В том числе может измениться состав полей персональных данных, необходимых для заполнения, поэтому после изменения льготы необходимо обновить состав полей билета.

SetReturnData

Описание Передача на сервер данных по возврату, применяется, если необходимо указать объяснение причин возврата
Синтаксис SetReturnData(ReturnOrderId, Returns)
Параметры ReturnOrderId – номер заказа на возврат;
Returns – возвраты билетов с данными по возврату
Возвращаемое значение Объект типа ReturnOrder

SetTicketData

Описание Отправка на сервер персональных данных.
Сделать это предпочтительно перед переходом к оплате сразу же для всех билетов. Выполнение этой функции может повлиять на сумму заказа. Если продаются одиночные билеты (без пассажирского) и их Fare.OnlyWithPassenger = true, тогда перед оплатой нужно попросить кассира ввести номер основного билета вручную и передать его также этой функцией
Синтаксис SetTicketData(OrderId, Tickets)
Параметры OrderId – номер заказа;
Tickets – билеты
Возвращаемое значение Объект типа Order

StartSaleSession

Описание Создание заказа на продажу. Начало продажи.
Синтаксис StartSaleSession(TripId, Departure, Destination, [OrderId])
Параметры TripId – идентификатор рейса;
Departure – идентификатор пункта отправления (код или название или id);
Destination – идентификатор пункта назначения (код или название или id) указывается, во-первых, для получения занятости мест, во-вторых, как значение по умолчанию для новых билетов, при вызове в режиме “Перрон” передается пустое значение;
[OrderId] – необязательный, для новых заказов передается пустая строка, если необходимо восстановить продажу, например, забронированных ранее билетов, то передается номер заказа бронирования, если параметр передан, то заполнять рейс и пункт назначения не нужно.
Возвращаемое значение Объект типа Order

Web-сервис DispatchPort

Полный список функций web-сервиса (DispatchPort):
CancelPerformedCarrierService – отмена документа расчета услуг и штрафов перевозчикам;
CancelTripStatus – отмена последнего установленного состояния рейса;
ChangeTrip – пересадка пассажиров;
CheckIn – для внутреннего использования;
FindValues – поиск значений;
FindValuesAtBusStop – получение списка значений для регистрации рейсов;
FreeQuotas – снятие квот с мест;
GetACBPDPSettings – служебная функция. Запрос настроек АЦБПДП;
GetArrivalTrips – запрос списка рейсов по пункту назначения;
GetAvailableCarrierServices – запрос доступных услуг перевозчикам;
GetAvailableFares – запрос доступных для рейса виды тарифов;
GetMovingTime – запрос данных о въезде и выезде автобуса на остановку;
GetOccupiedSeats – запрос занятых мест по рейсу;
GetOccupiedSeatsInfo – запрос информации по занятым местам;
GetPerformedCarrierServices – запрос списка выполненных услуг и штрафов перевозчикам;
GetRoute – запрос информации по маршруту;
GetRoutes – запрос списка маршрутов по заданному пункту отправления и пункту назначения;
GetScheduleTrip – запрос информации по рейсу расписания;
GetScheduleTrips – запрос списка действующих рейсов расписания;
GetSeatList – запрос информации по посадочной ведомости;
GetTransitSeats – запрос списка транзитных мест по рейсу и пункту отправления;
GetTrip – запрос информации по рейсу;
GetTrips – запрос списка рейсов;
GetTripsExtended – запрос списка рейсов (расширенная версия функции GetTrips);
PerformCarrierService
PrintSeatList – создание нового документа реализации услуги или штрафа перевозчику;
PrintSeatList – добавление задачи на печать посадочной ведомости;
SetBus – создание автобуса перевозчика;
SetCheckMan – установка перронного контролера;
SetDriver – создание нового водителя;
SetMovingTime – установка времени въезда или выезда транспортного средства;
SetTransitSeats – установка транзитных мест по рейсу для указанной остановки;
SetTrip – внесение изменений по рейсу;
SetTripAlerts – установка диспетчерских предупреждений для указанного пункта отправления;
SetTripArrival – регистрация прибытия рейса;
SetTripCancel – регистрация отмены рейса;
SetTripDeparture – регистрация отправки рейса;
SetTripDepartureAndAbsentTickets – регистрация отправки рейса;
SetTripFault – регистрация поломки автобуса в пути.

CancelPerformedCarrierService

Описание Отмена документа расчета услуг и штрафов перевозчикам
Синтаксис CancelPerformedCarrierService(TripId, BusStop, CarrierServiceDocId)
Параметры TripId – идентификатор рейса;
BusStop – идентификатор остановки идентификатор остановки;
CarrierServiceDocId – номер документа, который нужно отменить
Возвращаемое значение Значение типа Boolean

CancelTripStatus

Описание Отмена последнего установленного состояния рейса
Синтаксис CancelTripStatus(TripId, BusStop, Status)
Параметры TripId – идентификатор рейса;
BusStop – идентификатор остановки;
Status – состояние, которое нужно отменить
Возвращаемое значение Значение типа Boolean

ChangeTrip

Описание Пересадка пассажиров
Синтаксис ChangeTrip(OldTripId, NewTripId, BusStop, Tickets)
Параметры OldTripId – идентификатор рейса источника;
NewTripId – идентификатор рейса приемника;
BusStop – идентификатор остановки;
Tickets – билеты
Возвращаемое значение Значение типа Boolean

CheckIn

Описание Для внутреннего использования
Синтаксис CheckIn(AppInfo, LicenseInfo, Sign)

FindValues

Описание Поиск значений
Синтаксис FindValues(ValueType, Substring)
Параметры ValueType – тип значения (варианты: Carrier, Bus, Driver, TripCancelReasons);
Substring – часть названия
Возвращаемое значение Объект типа ValueList

FindValuesAtBusStop

Описание Получение списка значений для регистрации рейсов.
При регистрации рейсов необходимо заполнять обязательные поля рейса. Все поля обязательные, по умолчанию заполняются плановыми значениями из расписания или данными с других автовокзалов, если рейс уже был зарегистрирован ранее и при необходимости меняются диспетчером.
Синтаксис FindValuesAtBusStop(BusStop, ValueType, Substring, Owner)
Параметры BusStop – идентификатор остановки, на сервере которой необходимо выполнить поиск;
ValueType – тип значения (варианты: Carrier, Bus, Driver, TripCancelReasons);
Substring – часть названия;
Owner – владелец значения, для автобуса и водителя название перевозчика
Возвращаемое значение Объект типа ValueList

FreeQuotas

Описание Снятие квот с мест
Синтаксис FreeQuotas(BusStop, BusStop, QuotaSeats)
Параметры TripId – идентификатор рейса;
BusStop – идентификатор остановки;
QuotaSeats – места квот, которые необходимо снять
Возвращаемое значение Значение типа Boolean

GetACBPDPSettings

Описание Служебная функция. Запрос настроек АЦБПДП
Синтаксис GetACBPDPSettings(BusStop)
Параметры BusStop – идентификатор остановки
Возвращаемое значение Объект типа PersonalDataSet

GetArrivalTrips

Описание Запрос списка рейсов по пункту назначения
Синтаксис GetArrivalTrips(Destination, TripsDate)
Параметры Destination – идентификатор пункта назначения(код, название или id);
TripsDate – дата прибытия рейса
Возвращаемое значение Объект типа Trips

GetAvailableCarrierServices

Описание Запрос доступных услуг перевозчикам
Синтаксис GetAvailableCarrierServices(TripId, BusStop)
Параметры TripId – идентификатор рейса;
BusStop – идентификатор остановки
Возвращаемое значение Объект типа CarrierServices

GetAvailableFares

Описание Запрос доступных для рейса видов тарифов
Синтаксис GetAvailableFares(TripId, Departure, Destination)
Параметры TripId – идентификатор рейса;
Departure – идентификатор пункта отправления (код, название или id);
Destination – идентификатор пункта назначения(код, название или id)
Возвращаемое значение Объект типа Fares

GetMovingTime

Описание Запрос данных о въезде и выезде автобуса на остановку
Синтаксис GetMovingTime(TripId, BusStop)
Параметры TripId – идентификатор рейса;
BusStop – идентификатор остановки
Возвращаемое значение Значение типа Boolean

GetOccupiedSeats

Описание Запрос занятых мест по рейсу
Синтаксис GetOccupiedSeats(TripId, Departure, Destination, OrderId, Bus)
Параметры TripId – идентификатор рейса;
Departure – идентификатор пункта отправления (код, название или id);
Destination – идентификатор пункта назначения(код, название или id);
OrderId – номер заказа;
Bus – автобус, объект типа Bus (выходной параметр)
Возвращаемое значение Объект типа BusSeats

GetOccupiedSeatsInfo

Описание Запрос информации по занятым местам
Синтаксис GetOccupiedSeatsInfo(TripId, Departure)
Параметры TripId – идентификатор рейса;
Departure – идентификатор пункта отправления (код, название или id)
Возвращаемое значение Объект типа SeatsInfo

GetPerformedCarrierServices

Описание Запрос списка выполненных услуг и штрафов перевозчикам
Синтаксис GetPerformedCarrierServices(TripId, BusStop)
Параметры TripId – идентификатор рейса;
BusStop – идентификатор остановки
Возвращаемое значение Объект типа PerformedCarrierServices

GetRoute

Описание Запрос информации по маршруту
Синтаксис GetRoute(RouteId, BusStop)
Параметры RouteId – идентификатор маршрута;
BusStop – идентификатор остановки
Возвращаемое значение Объект типа Route

GetRoutes

Описание Запрос списка маршрутов по заданному пункту отправления и пункту назначения
Синтаксис GetRoutes(Departure, Destination)
Параметры Departure – идентификатор пункта отправления (код, название или id);
Destination – идентификатор пункта назначения(код, название или id)
Возвращаемое значение Объект типа Routes

GetScheduleTrip

Описание Запрос информации по рейсу расписания
Синтаксис GetScheduleTrip(ScheduleTripId, BusStop)
Параметры ScheduleTripId – ;
BusStop – идентификатор остановки
Возвращаемое значение Объект типа ScheduleTrip

GetScheduleTrips

Описание Запрос списка действующих рейсов расписания
Синтаксис GetScheduleTrips(Departure, Destination, RouteId)
Параметры Departure – идентификатор пункта отправления (код, название или id);
Destination – идентификатор пункта назначения(код, название или id);
RouteId – идентификатор маршрута
Возвращаемое значение Объект типа ScheduleTrips

GetSeatList

Описание Запрос информации по посадочной ведомости
Синтаксис GetSeatList(TripId, BusStop, CheckTripStatus)
Параметры TripId – идентификатор рейса;
BusStop – идентификатор остановки;
CheckTripStatus – признак того, что нужно проверить отмену рейса
Возвращаемое значение Объект типа SeatList

GetTransitSeats

Описание Запрос списка транзитных мест по рейсу и пункту отправления
Синтаксис GetTransitSeats(TripId, BusStop)
Параметры TripId – идентификатор рейса;
BusStop – идентификатор остановки
Возвращаемое значение Объект типа BusSeats

GetTrip

Описание Запрос информации по рейсу
Синтаксис GetTrip(TripId, BusStop, ArrivalSegment)
Параметры TripId – идентификатор рейса, либо <tripdate>дата отправления, формат dateTime</tripdate><scheduletripid>id рейса раписания</scheduletripid>;
BusStop – идентификатор остановки;
ArrivalSegment – признак необходимости получить данные о времени прибытия, если ложь, то передается время отправления
Возвращаемое значение Объект типа Trip

GetTrips

Описание Запрос списка рейсов (расширенная версия функции GetTrips)
Синтаксис GetTrips(Departure, TripsDate)
Параметры Departure – идентификатор пункта отправления (код, название или id);
TripsDate – дата отправления рейса
Возвращаемое значение Trips

GetTripsExtended

Описание
Синтаксис GetTripsExtended(Departure, StartTripsDate, EndTripsDate, ArrivalTrips, WithoutFreeSeats, WithoutFares, WithoutTripStatuses, WithoutInactive)
Параметры Departure – идентификатор пункта отправления (код, название или id);
StartTripsDate – начальная дата рейсов;
EndTripsDate – дата окончания рейсов;
ArrivalTrips – признак того, что нужны рейсы прибытия;
WithoutFreeSeats – признак того, что в рейсах не нужно выводить занятость мест;
WithoutFares – признак того, что в рейсах не нужно выводить данные по тарифам;
WithoutTripStatuses – признак того, что не нужно выводить состояние рейсов;
WithoutInactive – признак того, что в ответе нужны только активные рейсы
Возвращаемое значение Trips

PerformCarrierService

Описание Создание нового документа реализации услуги или штрафа перевозчику
Синтаксис PerformCarrierService(TripId, BusStop, CarrierServiceId, Quantity)
Параметры TripId – идентификатор рейса;
BusStop – идентификатор остановки;
CarrierServiceId – идентификатор услуги перевозчику;
Quantity – количество услуг в реализации
Возвращаемое значение Значение типа Boolean

PrintSeatList

Описание Добавление задачи на печать посадочной ведомости
Синтаксис PrintSeatList(TripId, Departure, PrintName, NumberOfCopies)
Параметры TripId – идентификатор рейса;
Departure – идентификатор пункта отправления (код, название или id);
PrintName – имя принтера;
NumberOfCopies – количество копий
Возвращаемое значение Значение типа Boolean

SetBus

Описание Создание автобуса перевозчика
Синтаксис SetBus(Bus, Carrier, BusStop)
Параметры Bus – данные нового автобуса;
Carrier – перевозчик;
BusStop – идентификатор остановки
Возвращаемое значение Bus

SetCheckMan

Описание Создание перронного контролера
Синтаксис SetCheckMan(TripId, BusStop, CheckMan)
Параметры TripId – идентификатор рейса;
BusStop – идентификатор остановки;
CheckMan – контролер
Возвращаемое значение Значение типа Boolean

SetDriver

Описание Создание нового водителя
Синтаксис SetDriver(PersonalData, Carrier, BusStop)
Параметры PersonalData – список персональных данных;
Carrier – перевозчик;
BusStop – идентификатор остановки
Возвращаемое значение Значение типа Boolean

SetMovingTime

Описание Установка времени въезда или выезда транспортного средства
Синтаксис SetMovingTime(TripId, BusStop, InTime, OutTime)
Параметры TripId – идентификатор рейса;
BusStop – идентификатор остановки;
InTime – время въезда;
OutTime – время выезда
Возвращаемое значение Значение типа Boolean

SetTransitSeats

Описание Установка транзитных мест по рейсу для указанной остановки
Синтаксис SetMovingTime(TripId, BusStop, TransitSeats)
Параметры TripId – идентификатор рейса;
BusStop – идентификатор остановки;
TransitSeats – список транзитных мест
Возвращаемое значение Значение типа Boolean

SetTrip

Описание Внесение изменений по рейсу
Синтаксис SetTrip(Trip, BusStop)
Параметры Trip – рейс;
BusStop – идентификатор остановки
Возвращаемое значение Значение типа Boolean

SetTripAlerts

Описание Установка диспетчерских предупреждений для указанного пункта отправления
Синтаксис SetTripAlerts(BusStop, TripAlerts)
Параметры BusStop – идентификатор остановки;
TripAlerts – предупреждение
Возвращаемое значение Значение типа Boolean

SetTripArrival

Описание Регистрация прибытия рейса
Синтаксис SetTripArrival(Trip, BusStop)
Параметры Trip – рейс, регистрация которого выполнена;
BusStop – идентификатор остановки, на которой выполняется регистрация (необязательный).
Возвращаемое значение Значение типа Boolean

SetTripCancel

Описание Регистрация отмены рейса
Синтаксис SetTripCancel(TripId, BusStop, Reason, Comment)
Параметры TripId – идентификатор отмененного рейса;
BusStop – идентификатор остановки, на которой выполняется регистрация (необязательный);
Reason – причина отмены;
Comment – комментарий.
Возвращаемое значение Значение типа Boolean

SetTripDeparture

Описание Регистрация отправления рейса
Синтаксис SetTripDeparture(TripId, BusStop, AbsentTickets, ChequeSettings)
Параметры TripId – идентификатор отмененного рейса;
BusStop – идентификатор остановки, на которой выполняется регистрация (необязательный);
AbsentTickets – вычеркнутые места;
ChequeSettings – настройки чеков
Возвращаемое значение Значение типа Boolean

SetTripDepartureAndAbsentTickets

Описание Регистрация отправления рейса
Синтаксис SetTripDepartureAndAbsentTickets(TripId, BusStop, AbsentTickets)
Параметры TripId – идентификатор рейса;
BusStop – идентификатор остановки, на которой выполняется отправка;
AbsentTickets – список билетов, неявившихся на посадку;
ChequeSettings – настройки печати посадочной ведомости
Возвращаемое значение Объект типа SeatList

SetTripFault

Описание Регистрация поломки автобуса в пути
Синтаксис SetTripFault(TripId, BusStop, Tickets)
Параметры TripId – идентификатор рейса;
BusStop – идентификатор остановки, на которой выполняется отправка;
Tickets – билеты
Возвращаемое значение Значение типа Boolean

Web-сервис TripSharingPort

Полный список функций web-сервиса (TripSharingPort):
GetRoutes – получение списка доступных маршрутов;
GetRoute – получение информации по маршруту;
GetRouteScheduleTrips – получение списка доступных рейсов расписания по маршруту;
GetTripInfo – получение информации по занятости мест рейса;
TakeSeats – занятие мест по рейсу;
FreeSeats – освобождение мест по рейсу.

GetRoutes

Описание Запрос списка доступных маршрутов.
Синтаксис GetRoutes()
Параметры Без параметров
Возвращаемое значение Объект типа Routes

GetRoute

Описание Получение информации по маршруту
Синтаксис GetRoute(RouteId)
Параметры RouteId – идентификатор маршрута
Возвращаемое значение Объект типа Route

GetRouteScheduleTrips

Описание Получение списка рейсов расписания по маршруту.
Синтаксис GetRouteScheduleTrips(RouteId)
Параметры RouteId – идентификатор маршрута
Возвращаемое значение Объект типа Route

GetTripInfo

Описание Получение информации по занятости мест рейса.
Синтаксис GetTripInfo(TripId, Departure, Destination, OrderId)
Параметры TripId – идентификатор рейса;
Departure – идентификатор пункта отправления;
Destination – идентификатор пункта назначения (необязательный, если не заполнен берется последняя остановка маршрута);
OrderId – идентификатор заказа по которому запрашивается занятость мест (необязательный)
Возвращаемое значение Объект типа BusSeats

TakeSeats

Описание Занимает места по рейсу.
Синтаксис TakeSeats(OrderId, TripId, Departure, Destination, BusSeats, LockDuration)
Параметры OrderId – идентификатор заказа, по которому занимаются места;
TripId – идентификатор рейса;
Departure – идентификатор пункта отправления;
Destination – идентификатор пункта назначения ;
BusSeats – занимаемые места, входной/выходной параметр. Если передается номер места 0, то сервер выбирает место сам и возвращает его номер;
LockDuration – длительность блокировки в секундах (если 0, то места занимаются навсегда)
Возвращаемое значение Значение типа Boolean

FreeSeats

Описание Освобождает места по рейсу.
Синтаксис FreeSeats(OrderId, TripId, Departure, BusSeats)
Параметры OrderId – идентификатор заказа, по которому освобождаются места;
TripId – идентификатор рейса;
Departure – идентификатор пункта отправления;
BusSeats – освобождаемые места
Возвращаемое значение Значение типа Boolean

Типы данных

AdditionalAttribute

Дополнительные реквизиты.

Атрибут Тип Описание
Name строка название
Caption строка заголовок
Mandatory булево обязательный
Type DataFieldTypes тип значений
ValueVariants ValueVariant вариант значений
InputMask строка маска ввода
Value строка значение
CostAttribute булево атрибут, изменение которого влияет на сумму заказа, для пересчета заказа необходимо вызвать функцию SetTicketData

Bus

Описание автобуса.

Атрибут Тип Описание
Id строка идентификатор
Model строка модель
LicencePlate строка гос. номер
Name строка название
SeatsClass строка класс обслуживания
SeatCapacity число количество мест сидя
StandCapacity число количество мест стоя
BaggageCapacity число количество багажных мест
SeatsScheme массив SeatsSchemeElement схема мест
GarageNum строка гаражный номер

BusSeat

Описание места в автобусе.

Атрибут Тип Описание
Type массив SeatTypes тип места
Number число номер места
Status массив BusSeatStatuses статус места
ParentTicketSeatNum число номер основного места, например, номер пассажирского билета к которому куплен багажный
ForCurrentOrder булево используется при передачи информации о занятости мест, если Истина, то значит, что место занято под текущий заказ

BusSeats

Описание коллекции мест в автобусе.

Атрибут Тип Описание
Elements массив значений типа BusSeat коллекция мест

BusSeatStatuses

Статус места в автобусе.

Атрибут Тип Описание
Free строка Место свободно
OnMySale строка Место в процессе продажи в текущем заказе
OnSale строка Место в процессе продажи другим кассиром
Reserved строка Место забронировано
Sold строка Место продано

BusStop

Описание автобусной остановки.

Атрибут Тип Описание
Name строка название
Code строка код
Id строка идентификатор
Country строка страна
Region строка регион
District строка район
Automated булево автоматизирована (может быть пунктом отправления)/ не автоматизирована
HasDestinations булево признак означает, что остановка может быть пунктом отправления и функцией GetBusStops были переданы возможные пункты назначения для нее, если Ложь, то пункты назначения необходимо получить функцией GetDestinations
UTC десятичная дробь часовой пояс

BusStops

Описание коллекции автобусных остановок.

Атрибут Тип Описание
Elements Массив значений типа BusStop коллекция остановок

CarrierService

Описание услуги перевозчикам.

Атрибут Тип Описание
Id строка идентификатор
Name строка название
Cost десятичная дробь цена
Editable булево признак возможности указания стоимости услуги кассиром вручную

CarrierServices

Описание коллекции услуг, предоставляемых перевозчикам.

Атрибут Тип Описание
Elements массив значений типа CarrierService коллекция услуг, предоставляемых перевозчикам

CashSession

Описание кассовой смены.

Атрибут Тип Описание
TerminalId строка
CashierName строка имя кассира
Amount десятичная дробь сумма денежных средств в кассе
Opened булево открыта/закрыта
StatusDate дата дата и время установки статуса
Number строка номер кассовой смены
TurnoverAmount десятичная дробь оборот за смену

Cheque

Описание чека.

Атрибут Тип Описание
ChequeLines массив строк строки чека
Barcode строка штрих-код
Fiscal булево фискальный/не фискальный
FiscalSum десятичная дробь сумма
Caption строка заголовок для вывода информации о печати чека
Sticker булево признак того что чек необходимо распечатать на принтере этикеток
Printed булево устаревшее поле
FiscalSection FiscalSection разбиение суммы чека по секциям
ChequeID строка идентификатор чека
DBDocNum строка Номер документа в базе данных для которого печатается чек
ParentDoc строка при печати чека услуг в этом поле передается номер билета к которому относятся услуги (если они привязаны к билету)

Customer

Описание пассажира.

Атрибут Тип Описание
Name строка ФИО
Phone строка номер телефона
Email строка электронная почта
Comment строка комментарий

DataFieldTypes

Возможные типы значений для полей персональных данных и дополнительных реквизитов.

Атрибут Тип Описание
DataFieldTypes string String, Date, Boolean, ValueList, IdentificationDocument, ContactInformation

Fare

Описание тарифа.

Атрибут Тип Описание
Name строка название
Caption строка заголовок
SeatType SeatTypes тип места
LowAgeLimit число минимальный возраст
HighAgeLimit число максимальный возраст
OnlyWithPassenger булево только с пассажирским
Cost десятичная дробь стоимость

Fares

Описание коллекции тарифов.

Атрибут Тип Описание
массив значений типа Elements Fare коллекция тарифов

FiscalSection

Сумма по секции ККМ

Атрибут Тип Описание
SectionNumber число номер секции ККМ
SectionSum десятичная дробь сумма по секции

LoyaltyCard

Описание карты лояльности.

Атрибут Тип Описание
Name строка название
Number строка номер
Owner Customer владелец
ExpiryDate дата срок действия

MarketingCampaign

Описание маркетинговой акции.

Атрибут Тип Описание
Name строка название

Order

Описание заказа.

Атрибут Тип Описание
Number строка номер
Trip Trip рейс
Departure BusStop пункт отправления
DepartureTime дата, время дата и время отправления
Destination BusStop пункт назначения
Tickets Ticket билеты
OccupiedSeats BusSeat занятые места
Amount десятичная дробь сумма
Customer Customer пассажир
Services Services услуги
SecondsToUnlockSeats число на сколько секунд установлена временная блокировка места
Reserve Reserve бронь
LoyaltyCard LoyaltyCard карта лояльности

PaymentDoc

Описание документов оплаты.

Атрибут Тип Описание
Number строка номер
Date дата, время дата, время
OrderNumber строка номер заказа
Tickets Ticket билеты
Services Services услуги
LoyaltyCard LoyaltyCard карта лояльности
Departure BusStop пункт отправления
Amount десятичная дробь сумма

PaymentItem

Расшифровка платежа

Атрибут Тип Описание
PaymentType PaymentTypes тип оплаты
Amount десятичная дробь сумма
TerminalNum строка номер терминала, например эквайрингового
TerminalChequeNum строка номер чека в терминале
PaymentSystemOrderNum строка номер заказа в платежной системе
PaymentCardKind строка вид платежной карты
PaymentCardNum строка номер платежной карты

PaymentItems

Атрибут Тип Описание
Elements PaymentItem

PaymentTransactions

Описание платежных операций.

Атрибут Тип Описание
Payments PaymentDoc документы оплаты
ReturnPayments ReturnPaymentDoc документы возврата оплаты

PaymentTypes

Описание типов оплаты.

Атрибут Тип Описание
Cash строка касса
LoyaltyCard строка карта лояльности
PaymentCard строка карта оплаты
PaymentOnTheBoarding строка оплата на посадке
DebitPayment строка списание с баланса
Other строка прочее

PerformedCarrierService

Атрибут Тип Описание
Id строка идентификатор
Date дата, время дата и время
Service CarrierService услуга
Quantity число количество
Cost десятичная дробь стоимость
Sum десятичная дробь сумма

PersonalData

Описание персональных данных.

Атрибут Тип Описание
Name строка название
Caption строка заголовок
Mandatory булево обязательный/ не обязательный
PersonIdentifier булево идентифицирует/ не идентифицирует
Type DataFieldTypes тип данных
ValueVariants ValueVariant вариант значения
InputMask строка маска ввода
Value строка значение
ValueKind строка вид значения, используется для передачи вида документа или вида адреса
DefaultValueVariant ValueVariant вариант значения по умолчанию
DocumentIssueDateRequired булево признак обязательности заполнения даты выдачи документа
DocumentIssueOrgRequired булево признак обязательности заполнения организации, выдавшей документ
DocumentValidityDateRequired булево признак обязательности заполнения срока действия документа
DocumentInceptionDateRequired булево признак обязательности заполнения даты начала действия документа
DocumentIssuePlaceRequired булево признак обязательности заполнения места выдачи документа
Value1 строка дата выдачи документа
Value2 строка кем выдан документ
Value3 строка срок действия документа
Value4 строка дата начала действия документа
Value5 строка место выдачи документа

PersonalDataSet

Описание коллекции персональных данных.

Атрибут Тип Описание
Elements PersonalData коллекция персональных данных

Privilege

Описание льготы.

Атрибут Тип Описание
Name строка название
Caption строка заголовок
Limit число ограничение по количеству льготных билетов

Privileges

Описание коллекции льгот.

Атрибут Тип Описание
Elements Privilege коллекция льгот

Reserve

Описание брони.

Атрибут Тип Описание
Cheques Cheque чеки
SumToReturn строка сумма к возврату
SumInTicket десятичная дробь сумма по билету

ReserveKinds

Описание вида бронирования.

Атрибут Тип Описание
Elements строка вид бронирования

ReturnCalculationFee

Строка расшифровки возврата сборов

Атрибут Тип Описание
Name строка название
SumToReturn десятичная дробь сумма к возврату
SumInTicket десятичная дробь сумма по билету

ReturnOrder

Описание возврата заказа.

Атрибут Тип Описание
Number строка номер
Date дата, время дата и время
TicketReturns TicketReturn билеты к возврату
Amount десятичная дробь сумма
PaymentItems PaymentItem расшифровка суммы возврата по типам оплаты
Services Services услуги
LoyaltyCard LoyaltyCard карта лояльности
PaymentDoc PaymentDoc документ оплаты

ReturnPaymentDoc

Описание документа возврата оплаты.

Атрибут Тип Описание
Number строка номер
Date дата, время дата и время
OrderNumber строка номер заказа
TicketReturns TicketReturn билеты к возврату
Services Services услуги
LoyaltyCard LoyaltyCard карта лояльности
Departure BusStop пункт отправления
Amount десятичная дробь сумма

Route

Описание маршрута.

Атрибут Тип Описание
Id строка идентификатор
Name строка название
Number строка номер
Express булево экспресс
Distance десятичная дробь расстояние
RouteItems RouteItem остановки маршрута
Schedule ScheduleTrip расписание

RouteItem

Описание остановок маршрута.

Атрибут Тип Описание
BusStop BusStop остановка
Distance десятичная дробь расстояние
DepartureTime дата время отправления
ArrivalTime дата время прибытия
StopDuration число стоянка
DayOfTrip число день в пути, первый день всегда 0, если время прибытия до 00:00, а время отправления после, то день пути указывается для времени прибытия
Platform число платформа
BanSaleFrom булево запрет продажи от остановки
BanSaleTo булево запрет продажи до остановки

Routes

Коллекция маршрутов

Атрибут Тип Описание
Elements Route массив маршрутов

SalesStatus

Описание статусов продажи билетов.

Атрибут Тип Описание
Suspended строка приостановлено
OnSale строка в продаже
SaleOnBoarding строка в кассах допродажи

ScheduleTrip

Рейсы расписания.

Атрибут Тип Описание
Id строка идентификатор
Name строка название
DepartureTime время время отправления
RouteName строка название маршрута
Carrier строка перевозчик
Bus Bus автобус
Frequency строка регулярность
RouteItems RouteItem остановки маршрута

ScheduleTrips

Коллекция рейсов расписания

Атрибут Тип Описание
Elements ScheduleTrip массив рейсов расписания

SeatInfo

Подробная информация о занятости места

Атрибут Тип Описание
Seat BusSeat место
TicketDay дата, время дата и время
TicketNumber строка номер билета
ReserveNumber строка номер брони
Departure BusStop пункт отправления
Destination BusStop пункт назначения
Privilege строка льгота
Customer Customer пассажир
Amount десятичная дробь сумма
Agent строка агент по продажам
FareName строка название тарифа
PaymentOnTheBoarding булево оплата на посадке

SeatsInfo

Коллекция данных с информацией о местах

Атрибут Тип Описание
Elements SeatInfo массив данных с информацией о местах

SeatList

Посадочная ведомость

Атрибут Тип Описание
Number строка номер
Date дата, время дата и время
ArrivalTime дата время прибытия
Trip Trip рейс
Departure BusStop пункт оправления
Tickets Ticket билеты
Cheques Cheque чеки
Platform число платформа
Dispatcher строка диспетчер
Checkman строка перронный контролер
TripAlerts строка диспетчерские предупреждения, например о гололеде
NextBoarding Ticket билеты, с отправлениях на следующих остановках по маршруту
ActualDepartureTime дата, время фактическое время отправления
Reserves Ticket забронированные, но не выкупленные билеты

SeatTypes

Описание типов мест.

Атрибут Тип Описание
Passenger строка пассажирские
PassengerStand строка пассажирские стоя
Baggage строка багажные
WithoutSeats строка детские без мест

SeatsSchemeElement

Описание схемы мест.

Атрибут Тип Описание
XPos число номер ряда
YPos число номер места в ряду
SeatNum число номер места, Null для проходов

Service

Описание услуги.

Атрибут Тип Описание
Name строка название
Description строка описание
Measure строка единица измерения
Cost десятичная дробь стоимость
Quantity десятичная дробь количество
Amount десятичная дробь сумма
ManuallyCost булево возможность изменения стоимости вручную
Number строка номер
ParentDoc строка для услуг передается номер билета, к которому привязаны услуги

Services

Описание коллекции услуг

Атрибут Тип Описание
Elements Service услуга
Cheques Cheque чек
Date дата, время дата и время
Number строка номер
PersonalData PersonalData персональные данные
AdditionalAttributes AdditionalAttribute дополнительные реквизиты

Ticket

Описание билета.

Атрибут Тип Описание
Number строка номер
Date дата, время дата и время
TripId строка идентификатор рейса
Carrier строка перевозчик
ParentTicketSeatNum число номер основного места, например, номер пассажирского билета к которому куплен багажный
SeatType SeatTypes тип места
SeatNum строка номер места
FareName строка тариф
PrivilageName строка льгота
Calculation TicketCalculation расшифровка стоимости
Departure BusStop пункт отправления
DepartureTime дата время отправления
Destination BusStop пункт назначения
ArrivalTime дата время прибытия
Distance десятичная дробь расстояние
PassengerName строка ФИО пассажира
PassengerDoc строка документ пассажира
PersonalData PersonalData персональные данные
AdditionalAttributes AdditionalAttribute дополнительные реквизиты
Cheques Cheque чек
Absence булево отметка явки
FaultDistance число километр поломки в случае невыполнения рейса
FaultCarrier строка перевозчик, который повез пассажира после поломки автобуса в пути
PaymentOnTheBoarding булево оплата на посадке
Customer Customer пассажир
MarketingCampaign MarketingCampaign маркетинговая акция
BusstationFee десятичная дробь комиссия автовокзала

TicketCalculation

Расшифровка стоимости билета

Атрибут Тип Описание
FareDiscount десятичная дробь скидка
FareAmount десятичная дробь сумма скидки
Fees TicketCalculationFee расчет стоимости билета
TotalDiscount десятичная дробь общая скидка
TotalAmount десятичная дробь общая сумма

TicketCalculationFee

Расчет стоимости билета.

Атрибут Тип Описание
Name строка название
Discount десятичная дробь скидка
Amount десятичная дробь сумма
CarriersFee булево комиссия автовокзала

TicketReturn

Возврат билета.

Атрибут Тип Описание
Number строка номер
Ticket Ticket билет
ReturnKind строка вид возврата
NeedExplanation булево необходимость пояснений
Explanation строка пояснения
Fees ReturnCalculationFee сборы
Cheques Cheque чеки
ReturnKindDescription строка описание вида возврата
FareToReturn десятичная дробь тариф к возврату
SumToReturn десятичная дробь сумма к возврату
FaultDistance число фактическое расстояние
AvailableReturnKinds строка доступные виды возврата
MarketingCampaign MarketingCampaign маркетинговая акция

TicketSeat

Место.

Атрибут Тип Описание
FareName строка Вид тарифа.
SeatNum число Номер места, если 0 то при добавлении билета будет назначен автоматически.
Destination строка Идентификатор пункта назначения.
TicketNumber строка После добавления билета сюда будет передан номер нового билета.
ParentTicketSeatNum число Используется, например, при добавлении багажного билета для указания номера места пассажирского билета, к которому добавляется багажный.

Trip

Описание рейса.

Атрибут Тип Описание
Id строка идентификатор
RouteId строка идентификатор маршрута
ScheduleTripId строка идентификатор рейса расписания
RouteName строка название маршрута
RouteNum строка номер маршрута
Carrier строка перевозчик
Bus Bus автобус
Driver1 строка водитель
Driver2 строка второй водитель
Frequency строка регулярность
WaybillNum строка номер путевого листа
Status TripStatuses статус рейса
StatusPrint строка представление состояния рейса для отображения
StatusReason строка причина состояния, например, для состояния «Отменен» причиной может быть «Непогода»
StatusComment строка комментарий к состоянию, например «Гололед»
StatusDate дата дата и время когда было установлено состояние
Departure BusStop пункт отправления
DepartureTime дата, время время отправления
ArrivalToDepartureTime дата время прибытия в пункт отправления
Destination BusStop пункт назначения
ArrivalTime дата время приябытия
Distance десятичная дробь расстояние
Duration число стоянка
TransitSeats булево наличие транзитных мест
FreeSeatsAmount число свободно пассажирских мест
PassengerFareCost десятичная дробь стоимость пассажирского билета
Fares Fare тарифы по рейсу, заполняются только после вызова функции StartSaleSession
Platform число платформа
OnSale булево
Route RouteItem остановки маршрута
Additional булево дополнительный рейс
AdditionalTripTime RouteItem время движения дополнительного рейса
TransitTrip булево транзитный рейс
SaleStatus SalesStatus статус продажи
ACBPDP булево рейс, по которому требуется заполнить персональные данные для АЦБПДП
FactTripReturnTime фактическое время возвращения обратно из рейса

TripStatuses

Статусы рейса.

Атрибут Тип Описание
Cancelled строка отменен
Departed строка ушел
Arrived строка прибыл, если время отправления прошло, а статус по прежнему «прибыл», то считается что статус «задерживается»
Waiting строка ожидается
Unknown строка неизвестный

Trips

Описание коллекции рейсов.

Атрибут Тип Описание
Elements Trip рейс
TripsDate дата дата рейса
Departure строка пункт отправления
Destination строка пункт назначения

TripSegment

Участок пути

Атрибут Тип Описание
Route Route маршрут
ScheduleTripId строка идентификатор рейса расписания
Frequency строка регулярность
Carrier строка перевозчик
Bus Bus автобус
Departure BusStop пункт отправления
DepartureTime время время отправления
ArrivalTime время время прибытия
Destination BusStop пункт назначения
Duration число стоянка
Distance десятичная дробь расстояние
Fares Fare тариф

TripSegments

Коллекция участков пути

Атрибут Тип Описание
Elements TripSegment массив участков пути

ValueList

Список значений.

Атрибут Тип Описание
Elements строка список значений

ValueVariant

Вариант значения для выбора, например «Мужской / Женский»

Атрибут Тип Описание
Name строка название
InputMask строка маска ввода
ValueProperty1 строка признак обязательного заполнения даты выдачи документа
ValueProperty2 строка признак обязательного заполнения кем выдан документ
ValueProperty3 строка признак обязательного заполнения срока действия документа
ValueProperty4 строка признак обязательного заполнения даты начала действия документа
ValueProperty5 строка признак обязательного заполнения места выдачи документа
docs/uav/admin/protocol/start.txt · Последние изменения: 2017/08/11 10:15 — Судовиков Дмитрий

Инструменты страницы