Спецификация формата XML-файла заказа — различия между версиями
(→Объект «HotelProduct») |
|||
Строка 2224: | Строка 2224: | ||
! Описание | ! Описание | ||
|- | |- | ||
− | | | + | | agency |
+ | | Объект «Organization» | ||
+ | | Агентство, в рамках которого был оформлен билет | ||
+ | |- | ||
+ | | cancellable | ||
| Строка | | Строка | ||
− | | | + | | Флаг, информирующий о принципиальной возможности отменить заказ: |
+ | *true - отмена возможна | ||
+ | *false - иначе | ||
|- | |- | ||
− | | | + | | cancellableNow |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
| Строка | | Строка | ||
− | | | + | | Флаг, информирующий о возможности отменить заказ в данную минуту: |
− | * | + | * true - отмена возможна |
− | * | + | * false - иначе |
− | + | ||
− | + | ||
|- | |- | ||
− | | | + | | cancellationCharges |
− | | | + | | Объекты «CancellationCharge» |
− | | | + | | Список возможных штрафов отельного провайдера за отмену заказа |
− | + | |- | |
− | + | | CF | |
+ | | Строка | ||
+ | | CF-код | ||
|- | |- | ||
| checked | | checked | ||
Строка 2251: | Строка 2253: | ||
*TRUE – продукт отмечен флагом «Проверен» | *TRUE – продукт отмечен флагом «Проверен» | ||
*FALSE - продукт не отмечен флагом «Проверен» | *FALSE - продукт не отмечен флагом «Проверен» | ||
+ | |- | ||
+ | | clientVat | ||
+ | | Строка | ||
+ | | Сумма НДС (для клиента) или пустая строка, если этот НДС отсутствует или не указан (присутствует лишь в некоторых инсталляциях) | ||
|- | |- | ||
| completed | | completed | ||
Строка 2258: | Строка 2264: | ||
*FALSE - продукт не отмечен флагом «Завершено» | *FALSE - продукт не отмечен флагом «Завершено» | ||
|- | |- | ||
− | | | + | | contractRelations |
− | | | + | | Объекты «HotelProductContractRelationData» |
− | | | + | | Список данных о финансовых обязательствах между клиентом и субагентством, субагентством и агентством и т.п. |
|- | |- | ||
− | | | + | | contractRulesApplied |
− | | | + | | строка |
− | | | + | | Флаг, информирующий о том, были ли применены правила договора. Возможные значения: |
− | * | + | * TRUE - правила применены |
− | * | + | * FALSE - правила не применены |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
|- | |- | ||
− | | | + | | cotsGuaranteed |
| Строка | | Строка | ||
− | | | + | | Флаг, информирующий о гарантированном предоставлении доп. кроватей для младенцев: |
+ | * true - если отельный провайдер гарантировал предоставление таких кроватей | ||
+ | * false - иначе | ||
|- | |- | ||
− | | | + | | directContractHotelProfile |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
| Объект «Organization» | | Объект «Organization» | ||
− | | | + | | «Профиль гостиницы» из прямого договора, на основании которого создан продукт (присутствует лишь в некоторых инсталляциях) |
|- | |- | ||
− | | | + | | directContractRateUid |
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
− | + | ||
| Строка | | Строка | ||
− | | | + | | Идентификатор тарифа в прямом договоре, на основании которого создан продукт (присутствует лишь в некоторых инсталляциях) |
|- | |- | ||
− | | | + | | directContractUid |
| Строка | | Строка | ||
− | | | + | | Идентификатор прямого договора, на основании которого создан продукт (присутствует лишь в некоторых инсталляциях) |
|- | |- | ||
− | | | + | | error |
| Строка | | Строка | ||
− | | | + | | Флаг, информирующий об успешности бронирования: |
+ | *true - бронирование завершилось ошибкой или отказом | ||
+ | *false - иначе | ||
|- | |- | ||
| forcedRefund | | forcedRefund | ||
Строка 2310: | Строка 2304: | ||
*FALSE - продукт не отмечен флагом «Вынужденный возврат/обмен» | *FALSE - продукт не отмечен флагом «Вынужденный возврат/обмен» | ||
|- | |- | ||
− | | | + | | guaranteeCode |
| Строка | | Строка | ||
− | | Код отеля | + | | Код гарантии бронирования отеля. |
+ | |- | ||
+ | | guaranteeType | ||
+ | | Строка | ||
+ | | Гарантия бронирования отеля. Пример значения: CREDIT_CARD | ||
|- | |- | ||
| hotelAddress | | hotelAddress | ||
Строка 2318: | Строка 2316: | ||
| Адрес отеля | | Адрес отеля | ||
|- | |- | ||
− | | | + | | hotelChainCode |
| Строка | | Строка | ||
− | | | + | | Название цепочки отелей |
+ | |- | ||
+ | | hotelCountry | ||
+ | | Справочник «Country» | ||
+ | | Страна, где расположен отель | ||
|- | |- | ||
| hotelFax | | hotelFax | ||
Строка 2326: | Строка 2328: | ||
| Факс отеля | | Факс отеля | ||
|- | |- | ||
− | | | + | | hotelLocation |
+ | | Справочник «GeoLocation» | ||
+ | | Город, где расположен отель | ||
+ | |- | ||
+ | | hotelName | ||
| Строка | | Строка | ||
− | | | + | | Название отеля |
|- | |- | ||
− | | | + | | hotelPhone |
| Строка | | Строка | ||
− | | | + | | Телефон отеля |
|- | |- | ||
− | | | + | | hotelPropertyId |
| Строка | | Строка | ||
− | | | + | | Код отеля |
|- | |- | ||
− | | | + | | hotelStars |
+ | | Число | ||
+ | | Количество звезд у отеля | ||
+ | |- | ||
+ | | issueDate | ||
+ | | Дата | ||
+ | | Дата операции с бронированием отеля | ||
+ | |- | ||
+ | | onHold | ||
| Строка | | Строка | ||
− | | | + | | Флаг, информирующий о заморозке средств: |
+ | *true - средства заморожены | ||
+ | *false - иначе | ||
|- | |- | ||
− | | | + | | ordOwners |
+ | | Объекты «OrdOwner» | ||
+ | | Список «Основных сотрудников» в заказе (присутствует лишь в некоторых инсталляциях) | ||
+ | |- | ||
+ | | pcc | ||
| Строка | | Строка | ||
− | | | + | | Номер PCC в котором оформлен билет |
|- | |- | ||
− | | | + | | provider |
+ | | Строка | ||
+ | | Провайдер отелей, через которого совершено бронирование. Возможные значения: | ||
+ | *INTERNAL - бронирование по прямому договору | ||
+ | *OFFLINE - бронирование вручную (присутствует лишь в некоторых инсталляциях) | ||
+ | *HOTELBOOK, SABRE и т.п. - название отельного провайдера | ||
+ | |- | ||
+ | | reservation | ||
+ | | Объект «Reservation» | ||
+ | | Бронирование, в котором содержится данный билет | ||
+ | |- | ||
+ | | rooms | ||
+ | | Объекты «Room» | ||
+ | | Список комнат отельного продукта | ||
+ | |- | ||
+ | | salesChain | ||
+ | | Объект «SalesChain» | ||
+ | | Цепочка продаж | ||
+ | |- | ||
+ | | salesPoint | ||
+ | | Объект «SalesPoint» | ||
+ | | Точка продаж, в которой было произведено оформление билета | ||
+ | |- | ||
+ | | status | ||
+ | | Строка | ||
+ | | Статус бронирования отеля. Возможные значения: | ||
+ | *SELL - продажа | ||
+ | *VOID - аннулировано | ||
+ | *REFUND - возврат | ||
+ | *EXCHANGE - обмен | ||
+ | *BOOKING - бронь | ||
+ | *VOID_BOOKING - аннулированная бронь | ||
+ | |- | ||
+ | | subagency | ||
+ | | Объект «Organization» | ||
+ | | Субагентство, в рамках которого был оформлен билет | ||
+ | |- | ||
+ | | supplier | ||
+ | | Объект «Organization» | ||
+ | | Поставщик | ||
+ | |- | ||
+ | | systemNumber | ||
+ | | Строка | ||
+ | | «Номер заказа», присвоенный мидофисом | ||
+ | |- | ||
+ | | ticketType | ||
+ | | Строка | ||
+ | | Тип билета. Доступные значения: | ||
+ | *EXTERNAL - Внешний | ||
+ | *OWN - Свой | ||
+ | *FAKE - Фиктивный | ||
+ | *NOT_OWN - Чужой | ||
+ | |- | ||
+ | | travellers | ||
+ | | Объекты «Traveller» | ||
+ | | Список путешественников | ||
+ | |- | ||
+ | | travellersPassengerTypes | ||
+ | | Объекты «PassengerTypeReference» | ||
+ | | Привязка путешественников к словарю «PassengerType» | ||
+ | |- | ||
+ | | uid | ||
+ | | Строка | ||
+ | | Уникальный идентификатор объекта | ||
+ | |- | ||
+ | | unholdDate | ||
+ | | Дата | ||
+ | | Дата разморозки средств | ||
+ | |- | ||
+ | | validationMessages | ||
+ | | Объекты «ValidationMessage» | ||
+ | | Список валидационных сообщений | ||
+ | |- | ||
+ | | validatorCode | ||
+ | | Строка | ||
+ | | Номер валидатора | ||
+ | |- | ||
+ | | waitingForRefundConfirmation | ||
| Строка | | Строка | ||
− | | | + | | Флаг, информирующий о состоянии продукта: |
+ | *true - если продукт находится в состоянии ожидания подтверждения возврата | ||
+ | *false - иначе | ||
|} | |} | ||
{{tc|num=27|cpt=Описание основных полей «HotelProduct»}} | {{tc|num=27|cpt=Описание основных полей «HotelProduct»}} |
Версия 13:21, 15 ноября 2019
Структура файла
Во время выгрузки заказа в XML файл данные формируются по следующей схеме:
<export> <bookingFiles> <bookingFile></bookingFile> <bookingFile></bookingFile> ... </bookingFiles> <entities> <entity></entity> <entity></entity> ... </entities> <dictionaries> <dictionary></dictionary> <dictionary></dictionary> ... </dictionaries> </export>
Структура состоит из трех разделов:
- bookingFiles содержит описание самих объектов заказов;
- entities содержит описание вспомогательных объектов;
- dictionaries содержит описание объектов справочников.
Объекты заказа bookingFiles являются корневыми, то есть объектами, с которых начинается (инициируется) экспорт. По сути, эти объекты равноценны объектам в разделе entities, но так как именно они представляют первичный интерес при выгрузке, то они вынесены в отдельный раздел. Объекты заказа могут содержать в себе другие объекты (например, «агентство» или «бронирование»). Такие объекты экспортируются в виде отдельных записей и заносятся в раздел entities. В самом же родительском объекте (то есть в том, что содержит эти записи) указывается лишь ссылка на них:
<export> <bookingFiles> <bookingFile> <agency type="com.gridnine.xtrip.common.model.profile.Organization" uid="ece8759f-2a9b-4b24-bb11-ef149a20c0bd"/> </bookingFile> </bookingFiles> <entities> <entity type="com.gridnine.xtrip.common.model.profile.Organization" uid="ece8759f-2a9b-4b24-bb11-ef149a20c0bd"> ... </entity> </entities> </export>
Таким образом, чтобы получить данные по этому объекту (в примере выше это agency) необходимо найти соответствующее описание этого объекта в разделе entities. Поиск в данном случае следует производить по уникальному идентификатору uid. Очевидно, что сами объекты, в свою очередь, также могут содержать другие объекты. Описание таких дочерних объектов оформляется по аналогичному принципу:
<export> <bookingFiles> <bookingFile> <agency type="com.gridnine.xtrip.common.model.profile.Organization" uid="ece8759f-2a9b-4b24-bb11-ef149a20c0bd"/> </bookingFile> </bookingFiles> <entities> <entity type="com.gridnine.xtrip.common.model.profile.Organization" uid="ece8759f-2a9b-4b24-bb11-ef149a20c0bd"> <financeRestrictions type="com.gridnine.xtrip.common.model.profile.FinanceRestrictions" uid="20bd9cdc-3b1a-4eca-a475-311c6ba37960"/> </entity> <entity type="com.gridnine.xtrip.common.model.profile.FinanceRestrictions" uid="20bd9cdc-3b1a-4eca-a475-311c6ba37960"> ... </entity> </entities> </export>
В приведенном примере заказ содержит объект agency, который в свою очередь содержит объект financeRestrictions. Понятно, что цепочка вложенных объектов может быть достаточно длинной. В случае, если вложенный объект является элементом справочника, то описание такого объекта заносится в раздел dictionaries:
<export> <entities> <entity type="com.gridnine.xtrip.common.model.booking.air.Product" uid="4fc597c9-e5f8-4324-be14-977cc037f060"> <blankType type="com.gridnine.xtrip.common.model.booking.BlankType" uid="00aba718-034e-4e2c-82e1-ea347bbf0c75"/> </entity> </entities> <dictionaries> <dictionary type="com.gridnine.xtrip.common.model.booking.BlankType" uid="00aba718-034e-4e2c-82e1-ea347bbf0c75"> ... </dictionary> </dictionaries> </export>
Вполне корректными являются ссылки в описании объектов entities, указывающие на dictionaries, и наоборот. Более того, допустимы ссылки из объектов entities или dictionaries на сами корневые объекты bookingFiles. Данные, не являющиеся объектами выгружаются в явном виде, как есть:
<export> <bookingFiles> <bookingFile> <number>0000299</number> <createDate>2010-09-10 00:00:00.000</createDate> </bookingFile> </bookingFiles> </export>
При экспорте данных, содержащихся в списках, каждый элемент списка оформляется в виде отдельной записи item:
<export> <bookingFiles> <bookingFile type="com.gridnine.xtrip.common.model.booking.BookingFile" uid="7b012f03-4e50-11e0-b554-6cf04915934f"> <travellers> <item type="com.gridnine.xtrip.common.model.booking.Traveller" uid="47c846d3-4e51-11e0-b554-6cf04915934f"/> <item type="com.gridnine.xtrip.common.model.booking.Traveller" uid="7b015615-4e50-11e0-b554-6cf04915934f"/> <item type="com.gridnine.xtrip.common.model.booking.Traveller" uid="b9c13d5a-508b-11e0-8639-6cf04915934f"/> </travellers> </bookingFile> </bookingFiles> </export>
Описание полей
Каждый объект содержит свой уникальный набор полей. Ниже представлены описания базовых объектов и их основных полей.
Объект «BookingFile»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
number | Строка | Номер заказа |
numberPrefix | Строка | Префикс номера заказа |
numberSuffix | Строка | Суффикс номера заказа |
createDate | Дата | Дата создания заказа |
customerProfile | Объект «Organization» | Корпоративный клиент, для которого оформлен данный заказ |
agency | Объект «Organization» | Агентство, в рамках которого был оформлен заказ |
travellers | Объекты «Traveller» | Полный список путешественников по данному заказу |
reservations | Объекты «Reservation» | Список всех бронирований (PNR) данного заказа |
Объект «Reservation»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
bookingFile | Объект «BookingFile» | Заказ, в котором содержится данное бронирование |
subagency | Объект «Organization» | Субагентство, в рамках которого было оформлено бронирование |
salesPoint | Объект «SalesPoint» | Точка продаж, в которой было произведено оформление бронирования |
recordLocator | Строка | Номер бронирования (значение PNR) |
resDate | Дата | Дата бронирования |
gdsName | Строка | Система бронирования. Возможные значения:
|
bookingAgent | Объект «Person» | Агент, который произвел оформление бронирования |
products | Объекты «Product» | Список всех продуктов данного бронирования |
Объект «Product»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
reservation | Объект «Reservation» | Бронирование, в котором содержится данный авиабилет или MCO |
blankOwnerRef | Объект «Organization» | Владелец бланка |
blankType | Справочник «BlankType» | Тип бланка |
issueDate | Дата | Дата операции над авиабилетом или MCO |
systemNumber | Строка | Номер авиабилета или MCO |
status | Строка | Статус авиабилета или MCO. Возможные значения:
|
validatorCode | Строка | Номер валидатора |
cashier | Объект «Person» | Агент, который произвел оформление авиабилета или MCO |
salesPoint | Объект «SalesPoint» | Точка продаж, в которой было произведено оформление билета или MCO |
subagency | Объект «Organization» | Субагентство, в рамках которого был оформлен билет или MCO |
agency | Объект «Organization» | Агентство, в рамках которого был оформлен билет или MCO |
supplier | Объект «Organization» | Поставщик бланков |
previousProduct | Объекты «Product» | Предыдущий связанный авиабилет или MCO |
nextProduct | Объекты «Product» | Следующий связанный авиабилет или MCO |
traveller | Объекты «Traveller» | Путешественник |
forcedRefund | Логическое | Вынужденный возврат |
fares | Объекты «ProductFare» | Список всех тарифов |
commissions | Объекты «Commission» | Список всех начисленных комиссий и сборов |
segmentTariffs | Объекты «SegmentTariff» | Список всех сегментов |
taxes | Объекты «Tax» | Список всех такс |
Объект «ProductFare»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
segmentTariff | Объект «SegmentTariff» | Сегмент к которому относится данный тариф |
baseFare | Объект «Money» | Базовый тариф в валюте назначения |
nucFare | Число | Величина тарифа в NUC единицах |
roe | Число | Отношение NUC единицы к единице в валюте назначения (курс) |
equivalentFare | Число | Величина тарифа в валюте оплаты |
Объект «Tax»
Наименование | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
segmentTariff | Объект «SegmentTariff» | Сегмент, в рамках которого была применена такса |
code | Строка | Код таксы |
amount | Объект «Money» | Величина таксы в валюте назначения |
equivalentAmount | Число | Величина таксы в валюте оплаты |
Объект «Commission»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
segmentTariff | Объект «SegmentTariff» | Сегмент, для которого была рассчитана данная комиссия |
contractType | Строка | Тип договора. Доступные значения:
|
rate | Число | Процентная ставка комиссии |
amount | Объект «Money» | Величина комиссии в валюте назначения |
equivalentAmount | Число | Величина комиссии в валюте оплаты |
Объект «SegmentTariff»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
segments | Объекты «Segment» | Сегменты, для которого установлен данный тариф |
Объект «Segment»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
recordNumber | Число | Номер сегмента (купона) |
departureLocation | Справочник «GeoLocation» | Пункт отправления |
arriveLocation | Справочник «GeoLocation» | Пункт прибытия |
airline | Справочник «Airline» | Авиакомпания |
flightNo | Строка | Номер рейса |
classOfService | Строка | Класс обслуживания |
startDate | Дата | Дата отправления |
seatNo | Строка | Номер места |
fareBasis | Строка | Вид тарифа |
Объект «Money»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
value | Число | Сумма |
currency | Валюта | Код валюты в соответствии со стандартом ISO 4217. |
Объект «Traveller»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
birthday | Дата | Дата рождения путешественника |
gender | Строка | Пол путешественника. Возможные значения:
|
name | Строка | Полное имя путешественника |
passenger | Объект «Person» | Путешественник |
passport | Объект «Passport» | Документ, удостоверяющий личность путешественника |
communications | Объекты «Communication» | Список всех контактов путешественника |
Объект «Passport»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
citizenship | Справочник «Country» | Гражданство / Подданство |
expired | Дата | Дата истечения срока действия документа |
firstName | Строка | Имя |
lastName | Строка | Фамилия |
middleName | Строка | Отчество |
issueCity | Строка | Город выдачи документа |
issued | Дата | Дата выдачи документа |
issueOrganization | Строка | Наименование организации, выдавшей документ |
number | Строка | Сериный номер документа |
originCountry | Справочник «Country» | |
type | Строка | Тип документа. Возможные значения:
|
birthday | Дата | Дата рождения |
gender | Строка | Пол. Возможные значения:
|
Объект «Organization»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
code | Строка | Код организации |
managers | Объекты «Manager» | Список всех ответственных лиц организации |
addresses | Объекты «Address» | Список всех адресов организации |
communications | Объекты «Communication» | Список всех контактов организации |
bankAccounts | Объекты «BankAccount» | Список всех банковских счетов организации |
metadata | Объекты «Metadata» | Список всех дополнительных параметров организации |
shortName | Строка | Краткое наименование организации |
fullName | Строка | Полное наименование организации |
legalForm | Справочник «LegalForm» | Юридическая форма организации |
registrationId | Строка | ИНН организации |
kpp | Строка | КПП организации |
okpoCode | Строка | ОКПО код организации |
types | Строка | Список ролей организации. Доступные значения:
|
Объект «Metadata»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
key | Строка | Параметр. Доступные значения:
|
value | Строка | Значение параметра |
Объект «Person»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
code | Строка | Код физического лица |
lastName | Строка | Фамилия |
firstName | Строка | Имя |
middleName | Строка | Отчество |
gender | Строка | Пол. Доступные значения:
|
types | Строка | Список ролей физического лица. Доступные значения:
|
communications | Объекты «Communication» | Список всех контактов физического лица |
passports | Объекты «Passport» | Список всех документов, удостоверяющих физическое лицо |
bankAccounts | Объекты «BankAccount» | Список всех банковских счетов физического лица |
addresses | Объекты «Address» | Список всех адресов физического лица |
Объект «SalesPoint»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
code | Строка | Код точки продаж |
shortName | Строка | Краткое наименование точки продаж |
fullName | Строка | Полное наименование точки продаж |
agency | Объект «Organization» | Организация (агентство), к которой относится данная точка продаж |
addresses | Объекты «Address» | Список всех адресов точки продаж |
communications | Объекты «Communication» | Список всех контактов точки продаж |
metadata | Объекты «Metadata» | Список всех дополнительных параметров точки продаж |
Объект «Manager»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
name | Строка | Имя ответственного лица в произвольной форме |
type | Строка | Тип ответственного лица. Доступные значения:
|
remarks | Строка | Произвольное описание ответственного лица |
Объект «Address»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
type | Строка | Тип адреса. Доступные значения:
|
address | Строка | Адресная строка в произвольной форме (улица, здание, корпус, офис и пр) |
city | Строка | Город |
zip | Строка | Почтовый индекс |
country | Справочник «Country» | Страна |
notes | Строка | Произвольное описание адреса |
Объект «Communication»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
sense | Строка | Значение контактной информации в произвольной форме (номер телефона, адрес электронной почты) |
type | Строка | Тип контактной информации. Доступные значения:
|
remarks | Строка | Произвольное описание контактной информации |
Объект «BankAccount»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
currency | Валюта | Код валюты в соответствии со стандартом ISO 4217. Более подробно см. Официальный список буквенных и цифровых кодов валют по ISO-4217 |
settlementAccount | Строка | Расчетный счет |
correspondentAccount | Строка | Корреспондентский счет |
bik | Строка | БИК (банковский идентификационный код) |
bankName | Строка | Наименование банка |
city | Справочник «GeoLocation» | Город |
remarks | Строка | Произвольное описание банковского счета |
Справочник «Airline»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор элемента |
code | Строка | Уникальный код авиакомпании |
codeVariants | Таблица строк | Таблица кодов авиакомпании в различных системах. Доступные значения систем кодов:
|
translations | Таблица строк | Таблица официальных наименований авиакомпании на различных языках. Наименование языков соответствует стандарту ISO-639. Более подробно см. Список двухбуквенных наименовний языков по ISO-639 |
spellVariants | Список строк | Варианты написаний наименования авиакомпании |
airlineNumber | Строка | Расчетный код авиакомпании |
country | Справочник «Country» | Страна принадлежности авиакомпании |
openDate | Дата | Дата открытия авиакомпании |
closeDate | Дата | Дата закрытия авиакомпании |
alliance | Справочник «AirlineAlliance» | Альянс, в который входит авиакомпания |
Справочник «AirlineAlliance»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор элемента |
code | Строка | Уникальный код альянса авиакомпаний |
codeVariants | Таблица строк | Таблица кодов альянса авиакомпаний в различных системах. Доступные значения систем кодов:
|
translations | Таблица строк | Таблица официальных наименований альянса авиакомпаний на различных языках. Наименование языков соответствует стандарту ISO-639. Более подробно см. Список двухбуквенных наименовний языков по ISO-639 |
Справочник «GeoLocation»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор элемента |
code | Строка | Уникальный код географического пункта |
codeVariants | Таблица строк | Таблица кодов географического пункта в различных системах. Доступные значения систем кодов:
|
translations | Таблица строк | Таблица официальных наименований географического пункта на различных языках. Наименование языков соответствует стандарту ISO-639. Более подробно см. Список двухбуквенных наименовний языков по ISO-639 |
spellVariants | Список строк | Варианты написаний наименования географического пункта |
type | Строка | Тип географического пункта. Доступные значения:
|
country | Справочник «Country» | Страна принадлежности географического пункта |
parent | Справочник «GeoLocation» | Пункт принадлежности географического пункта (например, аэропорт расположен в городе) |
Справочник «Country»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор элемента |
code | Строка | Уникальный код страны |
codeVariants | Таблица строк | Таблица кодов страны в различных системах. Доступные значения систем кодов:
|
translations | Таблица строк | Таблица официальных наименований страны на различных языках. Наименование языков соответствует стандарту ISO-639. Более подробно см. Список двухбуквенных наименований языков по ISO-639 |
domestic | Логическое | Является ли страна «родной» по отношению к агентству |
ruPassportAllowed | Логическое | Позволяет ли страна въезд по внутреннему российскому паспорту |
regions | Справочники «GeoRegion» | Регион принадлежности страны |
Справочник «GeoRegion»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор элемента |
code | Строка | Уникальный код географического региона |
codeVariants | Таблица строк | Таблица кодов географического региона в различных системах. Доступные значения систем кодов:
|
translations | Таблица строк | Таблица официальных наименований географического региона на различных языках. Наименование языков соответствует стандарту ISO-639. Более подробно см. Список двухбуквенных наименовний языков по ISO-639 |
Справочник «BlankType»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор элемента |
code | Строка | Уникальный код географического региона |
name | Строка | Серия бланка |
productCategory | Строка | Вид бланка. Доступные значения:
|
blankOwner | Объект «Organization» | Владелец бланка |
blankCategory | Строка | Тип бланка. Доступные значения:
|
couponsCount | Число | Количество купонов в бланке |
Справочник «LegalForm»
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор элемента |
abbreviations | Таблица строк | Таблица аббревиатур юридической формы на различных языках. Наименование языков соответствует стандарту ISO-639. Более подробно см. Список двухбуквенных наименовний языков по ISO-639 |
translations | Таблица строк | Таблица официальных наименований юридической формы на различных языках. Наименование языков соответствует стандарту ISO-639. Более подробно см. Список двухбуквенных наименовний языков по ISO-639 |
XML файлы заказов, содержащих в себе различные продукты, по структуре практически не отличаются друг от друга за исключением основных полей. Ниже приведены примеры таких заказов. |
Описание основных полей железнодорожного билета
Объект "RailwayProduct"
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
reservation | Объект «Reservation» | Бронирование, в котором содержится данный билет |
contractRulesApplied | строка | Флаг информирующий о том были ли применены правила из договора. Доступные значения:
|
ticketType | Строка | Тип билета. Доступные значения:
|
blankOwnerRef | Объект «Organization» | Владелец бланка |
blankType | Справочник «BlankType» | Тип бланка |
checked | Строка | Значение, информирующее, был ли продукту присвоен флаг "Проверен". Доступные значения:
|
completed | Строка | Значение, информирующее о том, был ли продукту назначен флаг "Завершено". Доступные значения:
|
eticket | Строка | Значение, информирующее о том, был ли продукту присвоен признак "Электронный билет". Доступные значения:
|
issueDate | Дата | Дата операции над Ж/Д билетом |
systemNumber | Строка | Номер Ж/Д билета |
status | Строка | Статус Ж/Д билета. Возможные значения:
|
validatorCode | Строка | Номер валидатора |
salesPoint | Объект «SalesPoint» | Точка продаж, в которой было произведено оформление билета |
subagency | Объект «Organization» | Субагентство, в рамках которого был оформлен билет |
agency | Объект «Organization» | Агентство, в рамках которого был оформлен билет |
supplier | Объект «Organization» | Поставщик бланков |
scn | Строка | Типографический номер бланка |
pcc | Строка | Номер PCC в котором оформлен билет |
equivalentFare | Строка | Эквивалент тарифа |
totalEquivalentFare | Строка | Всего по эквиваленту тарифа |
totalEquivalentVAT | Строка | Всего НДС |
endorsement | Строка | Номер транзакции |
fareCalculationData | Строка | Строка с расчетом тарифа |
passenger | Объект «Traveller» | Путешественник |
segments | Объект «RailwaySegment» | Сегменты маршрута для данного билета |
reservedSeats | Объект «ReservedSeat» | Номера выкупленных мест |
clientFops | Объект «RailwayProductFop» | Форма оплаты клиента |
vendorFops | Объект «RailwayProductFop» | Форма оплаты поставщика |
Объект "RailwayProductFop"
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
type | Строка | Тип формы оплаты. Возможные значения:
|
amount | Объект «Money» | Сумма по форме оплаты |
operationDate | Дата | Дата операции |
Объект "RailwaySegment"
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
number | Строка | Номер сегмента |
carriageNumber | Строка | Номер вагона |
carriageType | Строка | Тип вагона. Возможные значения:
|
compartmentType | Строка | Тип купе. Возможные значения:
|
serviceClass | Строка | Класс. Возможные значения:
|
trainNumber | Строка | Номер поезда |
departureDate | Дата | Дата отправления |
departureStation | Справочник «RailwayStation» | Станция отправления |
arriveStation | Справочник «RailwayStation» | Станция прибытия |
fare | Объект «Money» | Тариф по сегменту |
equivalentFare | Строка | Эквивалент тарифа по сегменту |
eRegEnabled | Строка | Возможность электронной регистрации. Возможные значения:
|
hasEReg | Строка | Подтверждена ли электронная регистрация. Возможные значения:
|
places | Строка | Номер места на билете для данного сегмента |
Объект "ReservedSeat"
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
fare | Объект «Money» | Тариф плацкарты |
equivalentFare | Строка | Эквивалент тарифа |
segment | Объект «RailwaySegment» | Отношение к сегменту |
Справочник "RailwayStation"
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
code | Строка | Код Ж/Д станции в справочнике |
created | Дата | Дата создания |
modified | Дата | Дата изменения |
shortName | Строка | Наименование географического пункта, к которому привязана Ж/Д станция |
Описание основных полей заказа с билетом "Аэроэкспресс"
Объект "AeroexpressTicket"
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
reservation | Объект «Reservation» | Бронирование, в котором содержится данный билет |
contractRulesApplied | строка | Флаг информирующий о том были ли применены правила из договора. Доступные значения:
|
ticketType | Строка | Тип билета. Доступные значения:
|
passengerType | Строка | Тип пассажира. Доступные значения:
|
blankOwner | Объект «Organization» | Владелец бланка |
checked | Строка | Значение информирующее о том был ли продукту присвоен флаг "Проверен". Доступные значения:
|
completed | Строка | Значение информирующее о том был ли продукту присвоен флаг "Завершено". Доступные значения:
|
eticket | Строка | Значение информирующее о том был ли продукту присвоен признак "Электронный билет". Доступные значения:
|
issueDate | Дата | Дата операции над билетом |
systemNumber | Строка | Номер Ж/Д билета |
status | Строка | Статус Ж/Д билета. Возможные значения:
|
pcc | Строка | Pcc в котором был выписан билет |
salesPoint | Объект «SalesPoint» | Точка продаж, в которой было произведено оформление билета |
subagency | Объект «Organization» | Субагентство, в рамках которого был оформлен билет |
agency | Объект «Organization» | Агентство, в рамках которого был оформлен билет |
supplier | Объект «Organization» | Поставщик бланков |
forcedRefund | Строка | Значение информирующее о том был ли продукту присвоен флаг "Вынужденный возврат/обмен". Доступные значения:
|
duplicate | Строка | Значение информирующее о том был ли продукту присвоен флаг "Дубликат". Доступные значения:
|
reservationId | Строка | Номер бронирования в ГДС |
departureDate | Дата | Дата отправления |
departureLocation | Справочник «GeoLocation» | Пункт отправления |
arrivalLocation | Справочник «GeoLocation» | Пункт прибытия |
classOfService | Строка | Класс. Возможные значения:
|
equivalentFare | Строка | Эквивалент тарифа |
gdsError | Строка | Значение информирующее об ошибках GDS. Доступные значения:
|
clientFops | Объект «GeneralProductFop» | Форма оплаты клиента |
vendorFops | Объект «GeneralProductFop» | Форма оплаты поставщика |
Объект "GeneralProductFop"
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
type | Строка | Тип формы оплаты. Возможные значения:
|
equivalentAmount | Строка | Сумма по форме оплаты |
operationDate | Дата | Дата операции |
Описание основных полей заказа в котором содержится "Страховка туристическая"
Объект "insurance.InsuranceTouristic"
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
reservation | Объект «Reservation» | Ссылка на бронирование, в котором содержится данный продукт |
contractRulesApplied | строка | Флаг, информирующий о том, были ли применены правила из договора. Возможные значения:
|
ticketType | Строка | Тип билета. Доступные значения:
|
blankOwner | Объект «Organization» | Владелец бланка |
checked | Строка | Значение, информирующее о том, был ли продукту присвоен флаг "Проверен". Доступные значения:
|
completed | Строка | Значение, информирующее о том, был ли продукту присвоен флаг "Завершено". Доступные значения:
|
issueDate | Дата | Дата выписки |
systemNumber | Строка | Номер страховки |
status | Строка | Статус страховки. Возможные значения:
|
salesPoint | Объект «SalesPoint» | Точка продаж, в которой было произведено оформление страховки |
subagency | Объект «Organization» | Субагентство, в котором была оформлена страховка |
agency | Объект «Organization» | Агентство, в котором была оформлена страховка |
supplier | Объект «Organization» | Поставщик бланков |
forcedRefund | Строка | Значение, информирующее о том, был ли продукту присвоен флаг "Вынужденный возврат". Доступные значения:
|
startDate | Дата | Дата начала действия страховки |
endDate | Дата | Дата окончания действия страховки |
countryName | Строка | Страна покрытия страховки |
additionalInfo | Строка | Дополнительная информация о программе страхования |
insuranceSum | Объект "Money" | Ссылка на объект типа "Money" где в значении "Value" содержится информация о сумме страхового покрытия и валюте. |
equivalentSum | Строка | Сумма страховой премии |
clientFops | Объект «GeneralProductFop» | Форма оплаты клиента |
vendorFops | Объект «GeneralProductFop» | Форма оплаты поставщика |
Объект "GeneralProductFop"
Название | Тип | Описание |
---|---|---|
uid | Строка | Уникальный идентификатор объекта |
type | Строка | Тип формы оплаты. Возможные значения:
|
equivalentAmount | Строка | Сумма по форме оплаты |
operationDate | Дата | Дата операции |
Описание основных полей бронирования отеля
Объект «HotelProduct»
Название | Тип | Описание |
---|---|---|
agency | Объект «Organization» | Агентство, в рамках которого был оформлен билет |
cancellable | Строка | Флаг, информирующий о принципиальной возможности отменить заказ:
|
cancellableNow | Строка | Флаг, информирующий о возможности отменить заказ в данную минуту:
|
cancellationCharges | Объекты «CancellationCharge» | Список возможных штрафов отельного провайдера за отмену заказа |
CF | Строка | CF-код |
checked | Строка | Значение, информирующее, отмечен ли продукт флагом «Проверен». Доступные значения:
|
clientVat | Строка | Сумма НДС (для клиента) или пустая строка, если этот НДС отсутствует или не указан (присутствует лишь в некоторых инсталляциях) |
completed | Строка | Значение, информирующее о том, был ли продукту назначен флаг «Завершено». Доступные значения:
|
contractRelations | Объекты «HotelProductContractRelationData» | Список данных о финансовых обязательствах между клиентом и субагентством, субагентством и агентством и т.п. |
contractRulesApplied | строка | Флаг, информирующий о том, были ли применены правила договора. Возможные значения:
|
cotsGuaranteed | Строка | Флаг, информирующий о гарантированном предоставлении доп. кроватей для младенцев:
|
directContractHotelProfile | Объект «Organization» | «Профиль гостиницы» из прямого договора, на основании которого создан продукт (присутствует лишь в некоторых инсталляциях) |
directContractRateUid | Строка | Идентификатор тарифа в прямом договоре, на основании которого создан продукт (присутствует лишь в некоторых инсталляциях) |
directContractUid | Строка | Идентификатор прямого договора, на основании которого создан продукт (присутствует лишь в некоторых инсталляциях) |
error | Строка | Флаг, информирующий об успешности бронирования:
|
forcedRefund | Строка | Значение, информирующее о том, отмечен ли продукт флагом «Вынужденный возврат/обмен». Возможные значения:
|
guaranteeCode | Строка | Код гарантии бронирования отеля. |
guaranteeType | Строка | Гарантия бронирования отеля. Пример значения: CREDIT_CARD |
hotelAddress | Строка | Адрес отеля |
hotelChainCode | Строка | Название цепочки отелей |
hotelCountry | Справочник «Country» | Страна, где расположен отель |
hotelFax | Строка | Факс отеля |
hotelLocation | Справочник «GeoLocation» | Город, где расположен отель |
hotelName | Строка | Название отеля |
hotelPhone | Строка | Телефон отеля |
hotelPropertyId | Строка | Код отеля |
hotelStars | Число | Количество звезд у отеля |
issueDate | Дата | Дата операции с бронированием отеля |
onHold | Строка | Флаг, информирующий о заморозке средств:
|
ordOwners | Объекты «OrdOwner» | Список «Основных сотрудников» в заказе (присутствует лишь в некоторых инсталляциях) |
pcc | Строка | Номер PCC в котором оформлен билет |
provider | Строка | Провайдер отелей, через которого совершено бронирование. Возможные значения:
|
reservation | Объект «Reservation» | Бронирование, в котором содержится данный билет |
rooms | Объекты «Room» | Список комнат отельного продукта |
salesChain | Объект «SalesChain» | Цепочка продаж |
salesPoint | Объект «SalesPoint» | Точка продаж, в которой было произведено оформление билета |
status | Строка | Статус бронирования отеля. Возможные значения:
|
subagency | Объект «Organization» | Субагентство, в рамках которого был оформлен билет |
supplier | Объект «Organization» | Поставщик |
systemNumber | Строка | «Номер заказа», присвоенный мидофисом |
ticketType | Строка | Тип билета. Доступные значения:
|
travellers | Объекты «Traveller» | Список путешественников |
travellersPassengerTypes | Объекты «PassengerTypeReference» | Привязка путешественников к словарю «PassengerType» |
uid | Строка | Уникальный идентификатор объекта |
unholdDate | Дата | Дата разморозки средств |
validationMessages | Объекты «ValidationMessage» | Список валидационных сообщений |
validatorCode | Строка | Номер валидатора |
waitingForRefundConfirmation | Строка | Флаг, информирующий о состоянии продукта:
|