This instance is currently being migrated to the new Atlassian One Confluence sytem.
If you can't find your space anymore, it should be already in the new System: https://confluence.weareplanet.com/
...
The purpose of this page is to inform you about upcoming changes within our OTA/HTNG implementation for both property management systems. Please note that the changes are divided into onPrem and pAir PMS changes. onPrem changes won't be rolled out globally at the date that is mentioned in the table below whilst pAir Updates will always be rolled out for all customers in one step.
Please note that the XML of the examples are shortened for a clear arrangement. The full sample message can be found on the documentation page for the message.
Affected Message | Direction from protel | PMS | Path | Example | Summary | Internal reference | Version | ||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
TBA IDS | |||||||||||||||||||||||||||
TBA PWS | |||||||||||||||||||||||||||
OTA_ReadRQ | inbound | onPremise | OTA_ReadRQ | ReadRequests | HotelReadRequest | TPA_Extensions | px:ReadRequestExtensions | px:Room | @RoomID |
| Extend the OTA_ReadRQ to search for the RoomID | PWS-3130 | |||||||||||||||||||||
HTNG_HotelFolioNotifRQ HTNG_HotelFolioRQ | outbound inbound | onPremise | HTNG_HotelFolioNotifRQ | Folios | Folio | RevenueDetails | RevenueDetail | FolioIDs | FolioID |
| Add the "OResID" and "OGstID" to the FolioID Element, to display the "originalResID" and "originalGuestID" if an items was shifted from one Reservation to another. If an Item was not shifted, the Information will not be displayed | PWS-3151 | |||||||||||||||||||||
OTA_ProfileCreateRQ OTA_ProfileModifyRQ | outbound | onPremise | OTA_ProfileModifyRQ | ProfileModify | TPA_Extensions | px:ProfileInfoExtensions | px:PersonInfos | px:Language |
| Add to the Profile Message the TPA Extension for the Language Code. | PWS-3150 | |||||||||||||||||||||
TBA IPA | |||||||||||||||||||||||||||
HTNG_HotelFolioNotifRQ HTNG_HotelFolioRQ | outbound inbound | pAir | HTNG_HotelFolioNotifRQ | Folios | Folio | RevenueDetails | RevenueDetail | FolioIDs | FolioID |
| Add the "OResID" and "OGstID" to the FolioID Element, to display the "originalResID" and "originalGuestID" if an items was shifted from one Reservation to another. If an Item was not shifted, the Information will not be displayed | IPA-1043 | HTNG_HotelRoomStatusUpdateNotifRQ | outbound/inbound | pAir | HTNG_HotelRoomStatusUpdateNotifRQ | Room | RoomType | @NumberOfUnits |
Codeblock | ||||
---|---|---|---|---|
| ||||
<HTNG_HotelRoomStatusUpdateNotifRQ>
<Room>
<RoomType NumberOfUnits="1"/> |
IPA 22.16 Anker IPA 22.16 IPA 22.16
Codeblock | ||||
---|---|---|---|---|
| ||||
<OTA_ReadRQ xmlns="http://www.opentravel.org/OTA/2003/05" CorrelationID="PWS-3130" Version="0" EchoToken="PWS-3130" MaxResponses="2"> <POS> <Source> <RequestorID ID="3152" Type="10" ID_Context="protelIO"/> </Source> </POS> <ReadRequests> <HotelReadRequest> <SelectionCriteria ResStatus="In-house"/> <Verification> <PersonName> <Surname>Duck</Surname> </PersonName> </Verification> <TPA_Extensions> <px:ReadRequestExtensions xmlns:px="http://protel.io/htng/extensions"> <px:Room RoomID="303" /> </px:ReadRequestExtensions> </TPA_Extension> </HotelReadRequest> </ReadRequests> </OTA_ReadRQ> |
Codeblock | ||||
---|---|---|---|---|
| ||||
<HTNG_HotelRoomStatusUpdateNotifRQ>
<Room>
<RoomType NumberOfUnits="1"/> |
OTA_ProfileCreateRQ
OTA_ProfileModifyRQ
OTA_HotelResNotifRQ
outbound
- px:LastNameAtBirth
- px:FirstNameAtBirth
- px:LastNameMother
- px:FirstNameMother
OTA_ProfileModifyRQ | ProfileModify | TPA_Extensions | px:ProfileInfoExtensions | px:PersonInfos |
- px:LastNameAtBirth
- px:FirstNameAtBirth
- px:LastNameMother
- px:FirstNameMother
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | ResGuests | ResGuest | Profiles | ProfileInfo | Profile | Customer | TPA_Extensions | px:ProfileInfoExtensions | px:PersonInfos |
- px:LastNameAtBirth
- px:FirstNameAtBirth
- px:LastNameMother
- px:FirstNameMother
Codeblock | ||||
---|---|---|---|---|
| ||||
<TPA_Extensions> <px:ProfileInfoExtensions> <px:AddressTypes /> <px:ContactDetails/> <px:PersonInfos> <px:LastNameAtBirth/> <px:FirstNameAtBirth/> <px:LastNameMother/> <px:FirstNameMother/> <px:Language DefaultInd="true">de-de</px:Language> <px:VipCodes/> <px:MarketingCodes/> <px:Keywords/> <px:Registration BirthCountry="DE"/> </px:PersonInfos> <px:Salutation DefaultInd="false" DisplaySequence="1" ID="11" ID_Context="protelIO" Type="SALUTATION">Dear Mr.</px:Salutation> <px:ProfileStatus/> <px:DocumentTypes/> <px:StatisticalInfos/> <px:Traces/> <px:LogEntries/> <px:Memberships/> </px:ProfileInfoExtensions> </TPA_Extensions> |
IPA 22.12 Anker IPA 22.12 IPA 22.12
OTA_ProfileCreateRQ
OTA_ProfileModifyRQ
OTA_ProfileCreateRQ | Profile | TPA_Extensions | px:ProfileInfoExtensions | px:StatisticalInfos | px:ParentProfile
OTA_ProfileModifyRQ | ProfileModify | TPA_Extensions | px:ProfileInfoExtensions | px:StatisticalInfos | px:ParentProfile
Codeblock | ||||
---|---|---|---|---|
| ||||
<TPA_Extensions xmlns:px="http://protel.io/htng/extensions"> <px:ProfileInfoExtensions> <px:StatisticalInfos> <px:ParentProfile Name="Duck AG" ID="181579" ID_Context="protelIO" Type="3"/> </px:StatisticalInfos> </px:ProfileInfoExtensions> </TPA_Extensions> |
Add the new official XSD TPA_Extensions "px:ParentProfile "
IPA 22.10 Anker IPA 22.10 IPA 22.10
Codeblock | ||||
---|---|---|---|---|
| ||||
<DepositPayments> <GuaranteePayment> <AmountPercent Amount="77.00" CurrencyCode="AED" ApplyAs="FirstNightDeposit"/> <Deadline AbsoluteDeadline="2019-09-06"/> </GuaranteePayment> <GuaranteePayment> <AcceptedPayments> <AcceptedPayment PaymentTransactionTypeCode="charge"> <PaymentCard> <CardType>CASH (AED)</CardType> </PaymentCard> </AcceptedPayment> </AcceptedPayments> <AmountPercent Amount="-55.00" CurrencyCode="AED" ApplyAs="FirstNightDeposit"/> </GuaranteePayment> </DepositPayments> |
IDS 6.095 Anker IDS 6.095 IDS 6.095
OTA_HotelRatePlanNotifRQ
OnPremise
pAir
OTA_HotelRatePlanNotifRQ | RatePlans | RatePlan | Rates | Rate | AdditionalGuestAmounts | AdditionalGuestAmount | @TaxInclusive
OTA_HotelRatePlanNotifRQ | RatePlans | RatePlan | Rates | Rate | AdditionalGuestAmounts | AdditionalGuestAmount | Taxes | @Amount
OTA_HotelRatePlanNotifRQ | RatePlans | RatePlan | Rates | Rate | AdditionalGuestAmounts | AdditionalGuestAmount | Taxes | @CurrencyCode
Codeblock | ||||
---|---|---|---|---|
| ||||
<AdditionalGuestAmounts> <AdditionalGuestAmount AgeQualifyingCode="7" Amount="18.18" CurrencyCode="EUR" MaxAge="3" MinAge="0" TaxInclusive="false"> <Taxes Amount="1.82" CurrencyCode="EUR"/> </AdditionalGuestAmount> |
OnPremise
pAir
OTA_HotelRateAmountNotifRQ | RatePlans | RatePlan | Rates | Rate | AdditionalGuestAmounts | AdditionalGuestAmount | @TaxInclusive
OTA_HotelRateAmountNotifRQ | RatePlans | RatePlan | Rates | Rate | AdditionalGuestAmounts | AdditionalGuestAmount | Taxes | @Amount
OTA_HotelRateAmountNotifRQ | RatePlans | RatePlan | Rates | Rate | AdditionalGuestAmounts | AdditionalGuestAmount | Taxes | @CurrencyCode
Codeblock | ||||
---|---|---|---|---|
| ||||
<AdditionalGuestAmounts> <AdditionalGuestAmount AgeQualifyingCode="7" Amount="18.18" CurrencyCode="EUR" MaxAge="3" MinAge="0" TaxInclusive="false"> <Taxes Amount="1.82" CurrencyCode="EUR"/> </AdditionalGuestAmount> |
PWS 3.7.X Anker PWS 3.7.X PWS 3.7.X
OTA_ProfileCreateRQ
OTA_ProfileModifyRQ
OTA_ProfileCreateRQ | Profile | Customer | PersonName | MiddleName
OTA_ProfileModifyRQ | ProfileModify | Customer | PersonName | MiddleName
Codeblock | ||||
---|---|---|---|---|
| ||||
<Customer BirthDate="1980-01-01" Gender="Female">
<PersonName>
<GivenName>Doodi</GivenName>
<MiddleName>Jacksonn</MiddleName>
<Surname>Joness</Surname>
</PersonName>
<Email DefaultInd="true" EmailType="1" ShareMarketInd="No">xgomez+892372@civitfun.com</Email>
<Address DefaultInd="true" FormattedInd="false" ShareMarketInd="No" Type="1" UseType="6">
<AddressLine>Calle Dos 2</AddressLine>
<CityName>Palma</CityName>
<StateProv>Islas Baleares</StateProv>
<CountryName Code="ES">Spain</CountryName>
</Address>
<CitizenCountryName Code="ES" DefaultInd="true"/>
<Document DocID="99999999R" DocType="5" EffectiveDate="2015-01-01" ExpireDate="2024-12-31"/>
<EmployerInfo CompanyShortName="" Department=""/>
</Customer> |
OTA_ProfileCreateRQ
OTA_ProfileModifyRQ
OTA_ProfileCreateRQ | Profile | TPA_Extensions | px:ProfileInfoExtensions | px:StatisticalInfos | px:ParentProfile
OTA_ProfileModifyRQ | ProfileModify | TPA_Extensions | px:ProfileInfoExtensions | px:StatisticalInfos | px:ParentProfile
Codeblock | ||||
---|---|---|---|---|
| ||||
<TPA_Extensions xmlns:px="http://protel.io/htng/extensions"> <px:ProfileInfoExtensions> <px:StatisticalInfos> <px:ParentProfile Name="Duck AG" ID="181579" ID_Context="protelIO" Type="3"/> </px:StatisticalInfos> </px:ProfileInfoExtensions> </TPA_Extensions> |
Remove the existing TPA_Extensions
Codeblock | ||||
---|---|---|---|---|
| ||||
<TPA_Extensions xmlns:px="http://protel.io/htng/extensions"> <Master MasterAccountID="181579"/> </TPA_Extensions> |
And add the new official XSD TPA_Extensions "px:ParentProfile "
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | RoomStays | RoomStay | Guarantee
Codeblock | ||||
---|---|---|---|---|
| ||||
<Guarantee GuaranteeType="CC/DC/Voucher"> <GuaranteesAccepted> <GuaranteeAccepted> <PaymentCard CardCode="MC" CardType="1" EncryptionKey="hOSJucTz-9QDE-KKKE-qiTa-af8X4oOiNVG" ExpireDate="0123" MaskedCardNumber="XXXXXXXXXXXX5100"> <CardHolderName>AT</CardHolderName> </PaymentCard> </GuaranteeAccepted> </GuaranteesAccepted> </Guarantee> |
HTNG_ChargePostingRQ
HTNG_ChargePostingRQ | Posting | Transaction | RevenueDetails | RevenueDetail | Account
Codeblock | ||||
---|---|---|---|---|
| ||||
<RevenueDetails> <RevenueDetail Description="Cash Payment" PMSRevenueCode="1" CurrencyCode="AED" Amount="-45.00" SubTypeID="Payment"> <Account ID="555342188" Type="14" ID_Context="External"/> </RevenueDetail> </RevenueDetails> |
IO_RatePackageNotifRQ | Packages | Package | Validity
IO_RatePackageNotifRQ | Packages | Package | PackageItem | Validity
Codeblock | ||||
---|---|---|---|---|
| ||||
<Validity From="1990-01-01" To="2050-01-01"/> |
PWS 3.6.X Anker PWS 3.6.X PWS 3.6.X
OTA_HotelAvailNotifRQ
Codeblock | ||||
---|---|---|---|---|
| ||||
<?xml version='1.0' encoding='utf-8'?> <env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"> <env:Body> <OTA_HotelAvailNotifRQ MessageContentCode="3" TimeStamp="2018-12-03T00:00:00.000Z" Version="2"> <AvailStatusMessages HotelCode="3153"> <AvailStatusMessage> <StatusApplicationControl Start="2021-08-09" End="2021-08-10" RatePlanCode="Ali2" InvTypeCode="CBR"/> <RestrictionStatus Restriction="Departure" Status="Close"/> <UniqueID Type="16" ID_Context="info.rateboard.rms" ID="2"/> </AvailStatusMessage> <AvailStatusMessage> <StatusApplicationControl Start="2021-08-09" End="2021-08-10" RatePlanCode="Ali2" InvTypeCode="CS"/> <RestrictionStatus Restriction="Departure" Status="Close"/> <UniqueID Type="16" ID_Context="info.rateboard.rms" ID="2"/> </AvailStatusMessage> </AvailStatusMessages> </OTA_HotelAvailNotifRQ> </env:Body> </env:Envelope> |
Codeblock | ||||
---|---|---|---|---|
| ||||
<HTNG_ChargePostingRQ> <Posting ID="1"> <Transaction TicketID="1"> <RevenueDetails> <RevenueDetail Description="Upsell Article" PMSRevenueCode="1000" ReferenceID="1015" Amount="20.00" SubTypeID="Revenue"> <ExtendedPrice AmountAfterTax="20.00" DecimalPlaces="2" Quantity="1"/> <Account ID="341977-2" Type="16" ID_Context="protelIO"/> </RevenueDetail> |
Codeblock | ||||
---|---|---|---|---|
| ||||
<IO_RatePackageNotifRQ> <Packages> <Package> <PackageItems> <PackageItem> <Calculation AmountBeforeTax="40" AmountAfterTax="40" Currency="AED" InclusiveInd="true" Recurrence="Daily" Relation="Complex"> <DaysOfWeek Mon="true" Tue="true" Wed="true" Thu="true" Fri="true" Sat="true" Sun="true"/> |
Fix the values for the Recurrence Attribute
Possible Recurrence
- OnArrival
- OnDeparture
- Daily
- DaysOfWeek
- Floating
- Fixed
OTA_HotelResNotifRQ | HotelReservations | HotelReservation | TPA_Extensions | px:ReservationExtensions | px:FixedCharges | px:FixedCharge | px:ServiceDates | px:ServiceDate
Codeblock | ||||
---|---|---|---|---|
| ||||
<TPA_Extensions xmlns:px="http://protel.io/htng/extensions"> <px:ReservationExtensions> <px:FixedCharges> <px:FixedCharge Code="KosmetikExtNoR" Recurrence="floating" From="2021-01-05" To="2021-01-12" Quantity="1" RequestedIndicator="true"> <px:Price CurrencyCode="EUR" SingleAmountAfterTax="25.00"/> <px:UniqueID Type="FixedCharge" ID="103604" ID_Context="protelIO"/> <px:Item ItemID="75"/> <px:InvoiceText>Kosmetik täglich ab 5.1.</px:InvoiceText> <px:ServiceDates> <px:ServiceDate From="2021-01-05" To="2021-01-07"/> <px:ServiceDate From="2021-01-10" To="2021-01-12"/> </px:ServiceDates> </px:FixedCharge> </px:FixedCharges> </px:ReservationExtensions> </TPA_Extensions> |
Add the new Element "SerivceDates"
This Element will be displayed for the Recurrence= "floating"
Possible Recurrence
- OnArrival
- OnDeparture
- Daily
- DaysOfWeek
- Floating
- Fixed
Codeblock | ||||
---|---|---|---|---|
| ||||
<HTNG_HotelFolioRS> <Folios> <Folio> <RevenueDetails> <RevenueDetail> <FolioIDs xmlns="http://www.opentravel.org/OTA/2003/05"> <FolioID>SDate|2017-08-23</FolioID> <FolioID>InvID|122345</FolioID> </FolioIDs> <RevenueDetailItems> <RevenueDetailItem> <FolioIDs xmlns="http://www.opentravel.org/OTA/2003/05"> <FolioID>SDate|2017-08-23</FolioID> </FolioIDs> |
Add a short in front of the FolioID Element, to describe what is displayed
Possible values
- InvID
- InvNo
- GstID
- Code
- TAAGrp
- PkgID
- SDate
Codeblock | ||||
---|---|---|---|---|
| ||||
<HTNG_HotelFolioNotifRQ> <Folios> <Folio> <RevenueDetails> <RevenueDetail> <FolioIDs xmlns="http://www.opentravel.org/OTA/2003/05"> <FolioID>SDate|2017-08-23</FolioID> <FolioID>InvID|122345</FolioID> </FolioIDs> <RevenueDetailItems> <RevenueDetailItem> <FolioIDs xmlns="http://www.opentravel.org/OTA/2003/05"> <FolioID>SDate|2017-08-23</FolioID> </FolioIDs> |
Add a short in front of the FolioID Element, to describe what is displayed
Possible values
- InvID
- InvNo
- GstID
- Code
- TAAGrp
- PkgID
- SDate
Codeblock | ||||
---|---|---|---|---|
| ||||
<IO_StatsNotifRQ/> <Statistics> <Statistic> <StatisticApplicationSets> <StatisticApplicationSet Start="2021-10-28" End="2021-10-28"> <StatisticCodes> <StatisticCode StatCode="Group" StatCategoryCode="3" /> <StatisticCode StatCode="1" StatCategoryCode="Pseudo" /> </StatisticCodes> <RevenueCategorySummaries> <RevenueCategorySummary RevenueCategoryCode="3" CurrencyCode="EUR" Amount="0.00" /> <RevenueCategorySummary RevenueCategoryCode="6" CurrencyCode="EUR" Amount="0.00" /> <RevenueCategorySummary RevenueCategoryCode="9" CurrencyCode="EUR" Amount="0.00" /> <RevenueCategorySummary RevenueCategoryCode="17" CurrencyCode="EUR" Amount="0.00" /> <RevenueCategorySummary RevenueCategoryCode="123" CurrencyCode="EUR" Amount="0.00" /> <RevenueCategorySummary RevenueCategoryCode="126" CurrencyCode="EUR" Amount="0.00" /> <RevenueCategorySummary RevenueCategoryCode="129" CurrencyCode="EUR" Amount="0.00" /> <RevenueCategorySummary RevenueCategoryCode="1217" CurrencyCode="EUR" Amount="0.00" /> </RevenueCategorySummaries> |
...