CTS Service Interface Hotel Platform 1 39

InfoTec

Common Tourist ServiceService Interface XML Format Specification- Hotel Platform -

Common Tourist Service

Service Interface

XML Format Specification

– Hotel Platform (HoPla) –

Version 1.38

This document may contain information which is confidential and/or protected by intellectual property rights and are intended for the sole use of TUI and its

08/04/2023 CTS Service Interface - Hotel Platform

InfoTec


subsidiaries. Any use of the information contained herein (including, but not limited to, total or partial reproduction, communication or distribution in any form) or the taking of any action in reliance on the contents by persons other than the designated recipient(s), is strictly prohibited.


InfoTec


Version

Author Date State / Hints

1.0 Michael Klemm 25.06.2005 Draft1.1 Nils Koschmieder 17.05.2006 Translation & actualisation1.2 Nils Koschmieder 3.11.2006 Example for Multi Occupancy

Request1.3 Tim Frana 10.11.2006 net + prepayment1.4 Tim Frana 21.11.2006 pricedetails1.5 Markus Nolte 21.12.2006 OfferRange Transaction1.6 Tim Frana 17.01.2007 Option bookings for THM1.7 Oliver Richardson 25.05.2007 GTA mandatory fields1.8 Tim Frana 30.05.2007 Pricedetail extensions for THM new

rate model1.9 Tim Frana 01.06.2007 Correction for Pricedetail/Savings1.10 Frank Beier 24.07.2007 HotelKey Transaction1.11 Sudhaker Raparthi 20.08.2007 Added Hotelbeds inventory details1.12 Shanmugaraja C K 27.08.2007 Corrected GTA, HotelBeds details1.13 Shanmugaraja C K 01.10.2007 Added Geo Search under

HotelSearchRequest1.14 Martin Spiller 09.11.2007 Added chapter for mandatory

specific requests and NPM information.

1.15 Jörg Weinspach 12.12.2007 Added chapter “Maintenance”1.16 Christian Fleger 19.05.2007 Updated HotelSearchResponse and

HotelSearchRequest1.17 Frank Hänisch 12.09.2008 Updated HotelSearchResponse and

HotelSearchRequest: parallel search with IsNet and IsGross, parallel search for pre- / postpayment.

1.18 Nils Koschmieder 10.10.2008 Added chapter for AOWLB specific adaptations & mark-ups. Added mandatory country code field for IRIS booking requests.

1.19 Nils Koschmieder 15.10.2008 Added AOWLB specific chapter for additional info in account data.

1.20 Shanmugaraja C K 20.11.2008 Added Hotelbeds Source specific mandatory details for Vouchers (section 12.6.2)

1.21 Patrick Zeising 05.12.2008 Updated 10.11.22 Christian Fleger 10.12.2008 Updated mark up element1.23 Shanmugaraja C K 12.01.2009 Corrected Hotelbeds section1.24 Patrick Zeising 14.01.2009 Overhaul of the layout and

3ormatting, section 1 to 4.1.25 Patrick Zeising 15.01.2009 Overhaul of the layout and

3ormatting, section 5.1.26 Patrick Zeising 19.01.2009 Overhaul of the layout and

3ormatting, section 6-151.27 Patrick Zeising 20.01.2009 Another overhaul of chapter 1-101.28 Patrick Zeising 23.01.2009 Another overhaul of chapter 11-141.29 Patrick Zeising 04.02.2009 Added updated PriceDetails

08/04/2023 CTS Service Interface - Hotel Platform 3

InfoTec


description and PriceTO description. Overhaul of document structur and formatting.

1.30 Jagadesh Reddy 23.02.2009 Updated the hotel product with productId description

1.31 Reinhard Liermann 02.03.2009 IRIS-Insurance added1.32 Shanmugaraja C K 06.03.2009 Updated Hotelbeds specific details

for Amendments and Booking related ProductInfo details. Added section 11.7 for Booking Amendments for Hotelbeds.

1.33 Jagadesh Reddy 07.04.2009 GeoGroup Search1.34 Faisal Owais 07.04.2009 Added chapter “Hotel Availability”1.35 Jagadesh Reddy 08.04.2009 Adding Comres Details1.36 Jagadesh Reddy 09.04.2009 Adding DocumentDispatch details

for IRIS BookingChange1.37 Faisal Owais 21.04.2009 Updated chapter 7 “Hotel

Availability”. The examples for HotelAvailabilityRequest and HotelAvailabilityResponse have been changed.

1.38 Jagadesh Reddy 04.05.2009 Correcting Comres details1.39 Janardhan Battini 14.12.2009 Added CatalogInfo for

HotelProducts in HotelSearchResponse (Currently available for Iris Products only). Updated section 4.2.4.


InfoTec


Contents

1 Introduction 7

2 Hotel specific Offer extensions 8

2.1 The offer.....................................................................................................8

2.2 Offer items...............................................................................................10

2.3 Price details..............................................................................................10

2.3.1 Applied offer and rate type............................................................112.3.2 Savings...........................................................................................112.3.3 Markups.........................................................................................11

2.4 Tour operator price..................................................................................12

3 Initialisation 13

3.1 Retrieve available meal types..................................................................13

3.2 Retrieve all available hotel chains............................................................15

3.3 Retrieve available hotel types..................................................................16

3.4 Retrieve available hotel categories..........................................................17

3.5 Retrieve available tour operators.............................................................18

4 Available hotel products 20

4.1 Requesting available hotel products........................................................20

4.1.1 Arrival date....................................................................................204.1.2 Duration.........................................................................................204.1.3 Occupancy.....................................................................................214.1.4 City or region or GeoGroup............................................................214.1.5 The hotel product...........................................................................224.1.6 Geo search.....................................................................................224.1.7 Net, gross and prepayment............................................................244.1.8 Default values................................................................................244.1.9 Possible rate type / payment combinations...................................244.1.10Mixed result set from single request..............................................254.1.11Additional search criteria...............................................................254.1.12Restricted search...........................................................................254.1.13Example for a complete HotelSearchRequest..............................27

4.2 Receiving hotel products..........................................................................27

4.2.1 Result details..................................................................................284.2.2 Score details..................................................................................284.2.3 Offer items.....................................................................................294.2.4 The hotel product...........................................................................31

5 Room type variations 34

5.1 Requesting room type variations.............................................................34

5.2 Reveicing room type variations................................................................35


InfoTec


6 Arrival date variations 37

6.1 Requesting variations of the arrival date.................................................37

6.2 Receiving variations of the arrival date....................................................38

7 Hotel Availability 41

7.1 Requesting hotel availability....................................................................41

7.2 Receiving hotel availability.......................................................................42

8 Unique HoPla hotel IDs 47

8.1 Requesting a hotel key.............................................................................47

8.2 Receiving hotel keys................................................................................49

9 Detailed hotel information 51

9.1 Requesting detailed information on hotels...............................................51

9.1.1 Level of detail.................................................................................519.1.2 Specifying a set of hotels...............................................................519.1.3 Search with partial querries...........................................................519.1.4 Example for a HotelDetailRequest..............................................52

9.2 Receiving detailed hotel information........................................................52

9.2.1 Localised hotel and room descriptions...........................................529.2.2 Example for a HotelDetailResponse............................................52

10 Supported source systems 55

10.1 Meta data for TUI Hotelmanager........................................................55

10.2 Meta data for Pegasus........................................................................55

10.3 Meta data for Ocean...........................................................................56

10.4 Meta data for IRIS...............................................................................56

10.5 Meta data for GTA..............................................................................57

10.6 Meta data for Hotelbeds.....................................................................57

10.7 Meta data for ComRes........................................................................58

11 Supported Functions by CRS (HoPla) 59

12 Source specific transactions 62

12.1 BookingRequest for TUI Hotelmanager..............................................62

12.1.1Optional bookings for THM.............................................................65

12.2 BookingRequest for Pegasus..............................................................66

12.2.1Example-Request...........................................................................67

12.3 BookingRequest for Ocean.................................................................70

12.3.1Example-Request...........................................................................71

12.4 BookingRequest for Iris......................................................................72

12.4.1Example-Request...........................................................................73


InfoTec


12.5 BookingRequest for GTA....................................................................75

12.5.1Example-Request...........................................................................75

12.6 BookingRequest for Hotelbeds...........................................................77

12.6.1Example-Request...........................................................................7712.6.2Mandatory details for vouchers......................................................7912.6.3Contractor specific remarks...........................................................7912.6.4Supplier and payment information.................................................79

12.7 Booking Amendments for Hotelbeds..................................................81

12.8 BookingRequest for ComRes..............................................................83

12.8.1Optional bookings for Comres........................................................93

13 Common tags 94

13.1 Address..............................................................................................94

13.2 Communication..................................................................................95

14 Mandator specific transactions 96

14.1 NPM (@comRes).................................................................................96

14.1.1IRIS HotelSearch...........................................................................9614.1.2IRIS BookingRequest.....................................................................96

14.2 AO WLB..............................................................................................97

14.2.1BookingRequest with customer reward program..........................9714.2.2CheckDigits in credit card............................................................9814.2.3Additional information in account data..........................................99

14.3 IRIS Insurance....................................................................................99

15 Maintenance 102

16 Tables 103

17 Listings 105


InfoTec


1 Introduction

This document is based on the “CTS Service Interface” document which covers the common parts of the CTS Service Interface documentation. Miscellaneous tags are described there and marked by (*CTS).This documentation covers the XML interface for hotel specific services. The topology of requests and responses is described as well as functionality of bookings, booking changes and cancellations. As the service can request several internal and external sources to find appropriate offers, some information is source specific.The following sources are currently supported:

THM: Offers from the TUI Hotelmanager. Advantages of this source are detailed pricings including taxes as well as a detailed list of all additional costs.

Pegasus: Offers transmitted from the Pegasus system. Because many-detailed information of Pegasus offers are contained within continuous text fields those data will be transmitted as generic offer information (for details on the ProductInfo structure please refer to Table 43 on page 71). Therefore, it is not guaranteed that pricings returned by Pegasus are total prices including taxes. For this reason clients who request offers from Pegasus should display all available information to the user and should explicitly point out special hints to pricings.

IRIS: Offers from the TUI IRIS system which was transmitted over the IRIS interface. Advantage of this source is its great amount of offers.

Ocean: Offers from the Ocean interface. This source provides access to hotels in the United States.

GTA: Offers from the GTA system. This British based system provides access to hotels throughout the world.

Hotelbeds: Offers from the Hotelbeds system. This Spain based system provides access to hotels throughout the world.

Comres: Offers from the anite @Comres system. Hopla connects @Comres system as an other inventory to get the hotel products.

All initialisation requests as well as the general hotel search can contain a list of sources to request. If there are no sources specified all sources will be requested.


InfoTec


2 Hotel specific Offer extensions

The following tags are extensions to the basic Offer structure detailed in the general “CTS Service Interface” document.

2.1 The offer

All tags in Table 1 are silently ignored if included in a request offer. They are part of offers in responses for TUI Hotelmanager Hotels. IsNet and IsPrepayment can be used for searching, but need to be child tags of the appropriate request. For more information on how to include them in a search request please refer to section Error: Reference source not found.

Tag Description Mandatory

IsPrepayment If the offer requires prepayment Yes (response only)

IsNet If the offer uses a net rate, so the price doesn’t include the commission.

Yes (response only)

PriceDetails Detailed information on the price. For more information on the PriceDetails tag please refer to section 2.3.

Yes (response only)

PriceTO The price information in the currency configured for the requesting tour operator. See section 2.4 for details.

Yes (response only)

Table 1: Silent offer tags.

<Offer> <Source type="OCEAN" /> <TourOperator id="2" code="TD" /> <ArrivalDate format="yyyy-MM-dd">2006-06-02</ArrivalDate> <Duration>7</Duration> <Price currency="EUR">996.0</Price> <PriceDetails> <NetPrice currency="EUR">82.0</NetPrice> <Provision currency="EUR">0.0</Provision> <CommissionPercentage>11.0</CommissionPercentage> </PriceDetails> <PriceTO> <Price currency="GBP">898.99</Price> <PriceDetails> <NetPrice currency="GBP">74.01</NetPrice> <Provision currency="GBP">0.0</Provision> <CommissionPercentage>11.0</CommissionPercentage> <ExchangeRate>0.9026</ExchangeRate> </PriceDetails> </PriceTO> <IsPrepayment>false</IsPrepayment> <IsNet>false</IsNet> <OfferStates>fix,option</OfferStates> <OfferItems> <HotelOfferItem state="available">08/04/2023 CTS Service Interface - Hotel Platform 9

InfoTec


... <PriceDetails> <NetPrice currency="EUR">82.0</NetPrice> <Provision currency="EUR">0.0</Provision> <CommissionPercentage>11.0</CommissionPercentage> </PriceDetails> <PriceTO> <Price currency="GBP">898.99</Price> <PriceDetails> <NetPrice currency="GBP">74.01</NetPrice> <Provision currency="GBP">0.0</Provision> <CommissionPercentage>11.0</CommissionPercentage> <ExchangeRate>0.9026</ExchangeRate> </PriceDetails> </PriceTO> ... </HotelOfferItem> </OfferItems> <Participant type="H" age="99" index="0" /> <Participant type="D" age="99" index="1" /></Offer>Listing 1: Example for an Offer and an OfferItem (Hotelportal-Service, extract).

<Offer> <Source type="THM" /> <TourOperator id="2" code="TD" /> <ArrivalDate format="yyyy-MM-dd">2007-06-02</ArrivalDate> <Duration>7</Duration> <Price currency="EUR">996.0</Price> <PriceDetails> <NetPrice currency="EUR">82.0</NetPrice> <Provision currency="EUR">0.0</Provision> <CommissionPercentage>11.0</CommissionPercentage> <Savings> <Offers currency="EUR">8.21</Offers> </Savings> </PriceDetails> <PriceTO> <Price currency="GBP">898.99</Price> <PriceDetails> <NetPrice currency="GBP">74.01</NetPrice> <Provision currency="GBP">0.0</Provision> <CommissionPercentage>11.0</CommissionPercentage> <ExchangeRate>0.9026</ExchangeRate> </PriceDetails> </PriceTO> <IsPrepayment>false</IsPrepayment> <IsNet>false</IsNet> <OfferStates>fix,option</OfferStates> <OfferItems> <HotelOfferItem state="available"> ... <PriceDetails> <NetPrice currency="EUR">82.0</NetPrice> <Provision currency="EUR">0.0</Provision> <CommissionPercentage>11.0</CommissionPercentage> <Savings> <Offers currency="EUR">8.21</Offers> </Savings> <AppliedRateType id="61001"> <LongText locale="de_DE">Standard</LongText>


InfoTec


</AppliedRateType> <AppliedOfferType locale="de_DE">Lastminute</AppliedOfferType> <AppliedOfferType locale="de_DE" numberOfFreeNights="1"> Eine Übernachtung gratis </AppliedOfferType> </PriceDetails> <PriceTO> <Price currency="GBP">898.99</Price> <PriceDetails> <NetPrice currency="GBP">74.01</NetPrice> <Provision currency="GBP">0.0</Provision> <CommissionPercentage>11.0</CommissionPercentage> <ExchangeRate>0.9026</ExchangeRate> </PriceDetails> </PriceTO> ... </HotelOfferItem> </OfferItems> <Participant type="H" age="99" index="0" /> <Participant type="D" age="99" index="1" /></Offer>

Listing 2: Example for an Offer and an OfferItem for a THM new rate model hotel.

2.2 Offer items

Tag Description MandatoryPriceDetails Same meaning as in the Offer structure. Yes (response

only)

PriceTO Same meaning as in the Offer structure.Table 2: The OfferItem structure.

IsPrepayment and IsNet must not vary between offer items in a single offer, so these are not part of offer items. Please refer to Listing 2 for an example.

2.3 Price details

Tag Description MandatoryNetPrice The price excluding commission. If

IsNet of the offer is true, this is the same as the price.

Yes (response only)

Provision The commission. If IsNet of the offer is true, this is 0 (zero).

Yes (response only)

CommissionPercentage

The percentage of the total price used as commission. This does not apply if IsNet of the offer is true.

Yes (response only)

Savings Can contain information about savings from special offers.

No (response only)


InfoTec


MarkUp Detailed information about mark-ups, if defined. Contains platform and sales mark-up elements.

No (response only)

ExchangeRate Price details within the PriceTO structure (see section 2.4) will include the exchange rate at which the price was calculated.

Yes (response only)

Table 3: The PriceDetails structure.

Please refer to Listing 2 for an example. The tags in Table 4 are specific for THM new rate model hotels.

AppliedRateType Specifies the used rate type for a THM new rate model offer item.

No (response only)

AppliedOfferType Specifies the used offer type/s for a THM new rate model offer item.

No (response only)

Table 4: THM new rate model hotel specific tags.

For AppliedRateType and AppliedOfferType, see section Error: Reference source not found.

2.3.1 Applied offer and rate type

Tag Typ Description Mandatory

LongText Element The name of the applied rate/offer.

yes(response only)

numberOfFreeNights Attribute

If an applied offer type is a free nights offer, this specifies the number of free nights granted

no(response only)

Table 5: The AppliedRateType and AppliedOfferType structures.

For an example please refer to section 2.1.

2.3.2 Savings

Offers For THM new rate model hotels only: Specifies total savings from applied offer types.

no(response only)

Table 6: The Savings structure.

For an example please refer to section 2.1.

2.3.3 Markups


PlatformMarkUp Element The value of the platform mark-up

No


InfoTec


SalesMarkUp Element The value of the sales mark-up NoTable 7: The Markup structure.

...<PriceDetails> <NetPrice currency="EUR">142.4</NetPrice> <Provision currency="EUR">17.6</Provision> <MarkUp> <SalesMarkUp currency="EUR">24.0</SalesMarkUp> <PlatformMarkUp currency="EUR">32.0</PlatformMarkUp> </MarkUp> <CommissionPercentage>11.0</CommissionPercentage></PriceDetails>...

Listing 3: Example for PriceDetails including markups.

2.4 Tour operator price


Price Element The price in the Tour Operators currency.

Yes (response only)

PriceDetails Element Details concerning the returned Tour Operator price, e.g. the exchange rate used when determining the price.

Yes (response only)

Table 8: The PriceTO structure.

...<PriceTO> <Price currency="GBP">898.99</Price> <PriceDetails> <NetPrice currency="GBP">74.01</NetPrice> <Provision currency="GBP">0.0</Provision> <CommissionPercentage>11.0</CommissionPercentage> <ExchangeRate>0.9026</ExchangeRate> </PriceDetails></PriceTO>...Figure 1: Example for a PriceTO structure.


InfoTec


3 Initialisation

To be able to fill existing select boxes presented on the VRP user interface only with available data (e.g. locations), several initialisation requests are provided. Initialisation requests require only Head and ClientInfo as well as the desired Source systems. All initialisation requests can contain a list of sources to request. If there are no sources specified all sources will be requested.

3.1 Retrieve available meal types

The MealTypeRequest is used to get all available meal types (boards) for the requested sources.<?xml version="1.0" encoding="ISO-8859-1"?><MealTypeRequest version="1.3"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2004-11-16</Date> <Time hour="14" minutes="7" /> </Timestamp> <Session>7961665</Session> <Tracking from="VRP" to="vrp-service" /> </Head> <ClientInfo> <Locale>de_DE</Locale> <Brand>1</Brand> <Agency>021245</Agency> <TimeZoneOffset>3600000</TimeZoneOffset> </ClientInfo> <Source type="THM" /> <Source type="PEG" /></MealTypeRequest>

Listing 4: Example for a MealTypeRequest.

The MealTypeResponse returns a list of all available meal types. Every meal type got an unique Hotelportal-ID as well as an IRIS compatible code.An exception is the meal type 4005, the standard meal type for Pegasus hotels. This meal type is only virtual and no option for the user. Because this type has also no IRIS code, it cannot be selected in the VRP combo boxes.At the moment all meal types got additional localised identifier, although they are actually not used.<?xml version="1.0" encoding="ISO-8859-1"?><MealTypeResponse version="1.3"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2006-05-29</Date> <Time hour="12" minutes="35" /> </Timestamp> <Session>7961665</Session> <Tracking from="vrp-service" to="VRP" /> </Head> <MealType id="4005"> <LongText locale="de_DE">unbekannt</LongText> <ShortText locale="de_DE" /> </MealType> <MealType id="4025" code="X">08/04/2023 CTS Service Interface - Hotel Platform 14

InfoTec


<LongText locale="de_DE">gem. Programm</LongText> <ShortText locale="de_DE" /> </MealType> <MealType id="4006"> <LongText locale="de_DE">Amerikanisches Frühstück</LongText> <ShortText locale="de_DE" /> </MealType> <MealType id="4007"> <LongText locale="de_DE">Buffet Frühstück</LongText> <ShortText locale="de_DE" /> </MealType> <MealType id="4008"> <LongText locale="de_DE">kontinentales Frühstück</LongText> <ShortText locale="de_DE" /> </MealType> <MealType id="4009"> <LongText locale="de_DE">englisches Frühstück</LongText> <ShortText locale="de_DE" /> </MealType> <MealType id="4010"> <LongText locale="de_DE">a-la-carte Frühstück</LongText> <ShortText locale="de_DE" /> </MealType> <MealType id="4011"> <LongText locale="de_DE">irisches Frühstück</LongText> <ShortText locale="de_DE" /> </MealType> <MealType id="4012"> <LongText locale="de_DE">Schottisches Frühstück</LongText> <ShortText locale="de_DE" /> </MealType> <MealType id="4013"> <LongText locale="de_DE">Europäisches Frühstück</LongText> <ShortText locale="de_DE" /> </MealType> <MealType id="4014"> <LongText locale="de_DE">a-la-carte Halbpension</LongText> <ShortText locale="de_DE" /> </MealType> <MealType id="4015"> <LongText locale="de_DE">Luxury Semi-Inclusive Plan</LongText> <ShortText locale="de_DE" /> </MealType> <MealType id="4016"> <LongText locale="de_DE">Halfboard Dine around</LongText> <ShortText locale="de_DE" /> </MealType> ... <MealType id="4001" code="G"> <LongText locale="de_DE">Frühstück</LongText> <ShortText locale="de_DE">FR</ShortText> </MealType> <MealType id="4002" code="H"> <LongText locale="de_DE">Halbpension</LongText> <ShortText locale="de_DE">HP</ShortText> </MealType> <MealType id="4003" code="V"> <LongText locale="de_DE">Vollpension</LongText> <ShortText locale="de_DE">VP</ShortText> </MealType> <MealType id="4004" code="I">


InfoTec


<LongText locale="de_DE">Alles inklusive</LongText> <ShortText locale="de_DE">AI</ShortText> </MealType> <MealType id="4000" code="U"> <LongText locale="de_DE">ohne</LongText> <ShortText locale="de_DE">OV</ShortText> </MealType></MealTypeResponse>

Listing 5: Example for a MealTypeResponse (extract).

3.2 Retrieve all available hotel chains

The HotelChainRequest is used to get all available hotel chains of the Hotel Platform.<?xml version="1.0" encoding="ISO-8859-1"?><HotelChainRequest version="1.3"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2004-11-16</Date> <Time hour="14" minutes="7" /> </Timestamp> <Session>7961665</Session> <Tracking from="VRP" to="vrp-service" /> </Head> <ClientInfo> <Locale>de_DE</Locale> <Brand>1</Brand> <Agency>021245</Agency> <TimeZoneOffset>3600000</TimeZoneOffset> </ClientInfo> <Source type="THM" /> <Source type="PEG" /></HotelChainRequest>

Listing 6: Example for a HotelChainRequest.

The HotelChainResponse returns available hotel chains in the following structure: The HotelChain tag contains information about hotel groups. The SubChain tag contains information about hotel chains which are directly assigned to the hotel.If there is more than one hotel assigned to different hotel chains and these chains belong to the same group, then multiple HotelChain tags with the same ID but with different sub chains will be returned. If a hotel chain is not assigned to any group, the ID of the HotelChain and the SubChain is both the same.All delivered IDs which are part of the Hotel Platform world must be mapped if required (e.g. to VRP hotel chain IDs).


InfoTec


<?xml version="1.0" encoding="ISO-8859-1"?><HotelChainResponse sessionId="1234"> <HotelChain id="1"> <Name>Accor International</Name> <SubChain id="4"> <Name>Mercure</Name> </SubChain> </HotelChain> <HotelChain id="11"> <Name>Best Western International, Inc.</Name> <SubChain id="11"> <Name>Best Western International, Inc.</Name> </SubChain> </HotelChain> <HotelChain id="29"> <Name>Choice Hotels International, Inc.</Name> <SubChain id="30"> <Name>Clarion Inns</Name> </SubChain> </HotelChain> <HotelChain id="29"> <Name>Choice Hotels International, Inc.</Name> <SubChain id="31"> <Name>Comfort Inns</Name> </SubChain> </HotelChain></HotelChainResponse>

Listing 7: Example HotelChainResponse (extract).

3.3 Retrieve available hotel types

The HotelTypeRequest is used to get all available hotel types of the Hotel Platform.

<?xml version="1.0" encoding="ISO-8859-1"?><HotelTypeRequest version="1.3"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2004-11-16</Date> <Time hour="14" minutes="7" /> </Timestamp> <Session>7961665</Session> <Tracking from="VRP" to="vrp-service" /> </Head> <ClientInfo> <Locale>de_DE</Locale> <Brand>1</Brand> <Agency>021245</Agency> <TimeZoneOffset>3600000</TimeZoneOffset> </ClientInfo> <Source type="THM" /> <Source type="PEG" /></HotelTypeRequest>

Listing 8: Example for a HotelTypeRequest.

The HotelTypeResponse returns all available hotel types including the Hotel Platform IDs as well as localised descriptions. At the moment these data will not be interpreted by the VRP.


InfoTec


<?xml version="1.0" encoding="ISO-8859-1"?><HotelTypeResponse version="1.3"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2004-11-19</Date> <Time hour="14" minutes="57" /> </Timestamp> <Session>7961665</Session> <Tracking from="vrp-service" to="VRP" /> </Head> <HotelType id="1"> <Name locale="fr_FR">Hôtel</Name> <Name locale="es_ES">Hotel</Name> <Name locale="en_GB">Hotel</Name> <Name locale="de_DE">Hotel</Name> <Name locale="it_IT">Hotel</Name> </HotelType> ... <HotelType id="14"> <Name locale="de_DE">Motel</Name> <Name locale="en_GB">Motel</Name> <Name locale="fr_FR">Motel</Name> <Name locale="es_ES">Motel</Name> <Name locale="it_IT">Motel</Name> </HotelType> <HotelType id="15"> <Name locale="de_DE">Ferienwohnungen</Name> <Name locale="en_GB">Holiday apartment</Name> <Name locale="fr_FR">Appartements de vacances</Name> <Name locale="es_ES">Apartamentos vacacionales</Name> <Name locale="it_IT">Alloggi vacanza tipo appartamento</Name> </HotelType> ... <HotelType id="26"> <Name locale="de_DE">Golfhotel</Name> <Name locale="en_GB">Golf hotel</Name> <Name locale="fr_FR">Hôtel de golf</Name> <Name locale="es_ES">Hotel de golf</Name> <Name locale="it_IT">Hotel con campo da golf</Name> </HotelType></HotelTypeResponse>

Listing 9: Example HotelTypeResponse (extract).

3.4 Retrieve available hotel categories

The HotelCategoryRequest is used to get all available hotel categories (currently 0.0, 1.0, 2.0, 3.0, 4.0, 5.0 stars, country specific).


InfoTec


<?xml version="1.0" encoding="ISO-8859-1"?><HotelCategoryRequest version="1.3"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2004-11-16</Date> <Time hour="14" minutes="7" /> </Timestamp> <Session>7961665</Session> <Tracking from="VRP" to="vrp-service" /> </Head> <ClientInfo> <Locale>de_DE</Locale> <Brand>1</Brand> <Agency>021245</Agency> <TimeZoneOffset>3600000</TimeZoneOffset> </ClientInfo> <Source type="THM" /> <Source type="PEG" /></HotelCategoryRequest>

Listing 10: Example for a HotelCategoryRequest.

The HotelCategoryResponse returns the categories as decimal value, so that also categories that lie between two categories can be displayed (e.g. 2,5 stars). However, this is actually not supported by the Hotel Platform.The id attribute is used to map the values to the TUI Hotel Platform categories.

<?xml version="1.0" encoding="ISO-8859-1"?><HotelCategoryResponse version="1.3"> <Head> ... </Head> <Category id="1000" rating="0">0.0</Category> <Category id="1002" rating="1">1.0</Category> <Category id="1004" rating="2">2.0</Category> <Category id="1005" rating="2+">2.5</Category> <Category id="1006" rating="3">3.0</Category> <Category id="1007" rating="3+">3.5</Category> <Category id="1008" rating="4">4.0</Category> <Category id="1009" rating="4+">4.5</Category> <Category id="1010" rating="5">5.0</Category> <Category id="1011" rating="5+">5.5</Category></HotelCategoryResponse>

Listing 11: Example for a HotelCategoryResponse.

3.5 Retrieve available tour operators

This request is used to get all tour operators for all given sources from the database.

TourOperatorRequest

Tag Type

Mandatory

Description

Version A Yes (*CTS)

Head E Yes (*CTS)


InfoTec


ClientInfo

E Yes (*CTS)

Source E Yes Get all tour operators from this sourceTable 9: The TourOperatorRequest structure.

<?xml version="1.0" encoding="ISO-8859-1"?><TourOperatorRequest version="1.3"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2005-09-08</Date> <Time hour="16" minutes="24" /> </Timestamp> <Tracking from="musyk" to="vrp-service" /> </Head> <ClientInfo> <Locale>de_DE</Locale> <Brand>1</Brand> <Agency>3084</Agency> <Terminal>$FNJ</Terminal> <User>5322</User> <TimeZoneOffset>60</TimeZoneOffset> </ClientInfo> <Source type="IRIS" /></TourOperatorRequest>

Listing 12: Example for a TourOperatorRequest.

TourOperatorRe sponse

Tag Type

Mandatory

Description

version A Yes (*CTS)

Head E Yes (*CTS)

Source E Yes Get all tour operators from this source

TourOperator

E No The TourOperators from the database

Table 10: The TourOperatorResponse structure.

<?xml version="1.0" encoding="ISO-8859-1"?><TourOperatorResponse version="1.3"> <Head> ... </Head> <TourOperator id="2" code="TD" /> <TourOperator id="3" code="TA" /> <TourOperator id="6" code="TP" /> <TourOperator id="7" code="TS" /></TourOperatorResponse>

Listing 13: Corresponding TourOperatorResponse to the example request in Listing 12.


InfoTec


4 Available hotel products

With this request a search for vacant and priced hotel products is started. Depending on the specific source of the hotels, different backend systems are connected and availabilities and prices are requested for these hotels.It can be searched within a list of cities or regions (see section 4.1.4) and for a specific hotel product (see section 4.1.5).

4.1 Requesting available hotel products

HotelSearchRequest

Tag Type

Mandatory

Description


Head E Yes (*CTS)

OfferControl E Yes (*CTS)

ClientInfo E Yes (*CTS)

City E No Search for hotel products in this city

Region E No Search for hotel products in this region

InitialResultSet

E No Request a configured list of hotel products

HotelProduct E No Search for specific hotel product

ArrivalDate E Yes (*CTS)

Duration E Yes Duration of stay (in nights)

Occupancy E Yes (*CTS)

IsNet E No Search only net rates

IsPrepayment

E No Search only rates with prepayment

Table 11: The HotelSearchRequest XML structure.

The following search criteria are mandatory for a successful search request: Arrival date Duration Occupancy (max. of two)

Additionally, at least one more search criteria must be defined (see 4.1.4, 4.1.5 and 4.1.6).

4.1.1 Arrival date

A valid arrival date lies at least one day in the future. The format attribute defines the format of the date (Java pattern).<ArrivalDate format="yyyy-MM-dd">2005-01-30</ArrivalDate>

Listing 14: Example for an ArricalDate.


InfoTec


4.1.2 Duration

The duration of the travel must be a positive number greater than zero. It defines the number of overnight stays.<Duration>14</Duration>

Listing 15: Example for a Duration.

4.1.3 Occupancy

If the client requests for multiple occupancies, the number of beds (personsPerUnit attribute) within the several occupancies must define different values. The specific occupancy will be calculated by the number and age of the travellers.The number of occupancies supported varies for different sources. The Pegasus (PEG) source currently does not support multiple occupancies, THM only supports multiple occupancies within the hotel search (no booking), IRIS currently is restricted to two different occupancies with only 12 travellers, OCEAN is limited to a maximum number of 99 travellers while GTA supports a maximum number of 4 occupancies and only 9 passengers. Hotelbeds supports this in a different way, i.e either maximum of 5 rooms or maximum of 19 passengers.Please refer to section 11 for more details on the different options supported by different sources.Furthermore, the occupancy tag contains additional information about the travellers. Information about the age of the travellers can affect the offer result depending on the requested source (e.g. hotel room with a camp bed). As a basic principle, travellers (or participants) without specified age will be considered as adults.Travellers with a specification of an age will be considered as infants, children or adults within the THM source depending on the current definition of the Hotel Platform.Additional information about the travellers (e.g. address data) does not influence the hotel search but are only relevant at booking time.

<Occupancy index="0" numberOfUnits="1" personsPerUnit="2" numberOfPersons="2"> <Participant type="H" age="99" index="0" /> <Participant type="D" age="99" index="1" /></Occupancy>

Listing 16: Example for an Occupancy.

<Occupancy index="0" numberOfUnits="1" personsPerUnit="2" numberOfPersons="2"> <Participant type="H" age="99" index="0" /> <Participant type="D" age="99" index="1" /></Occupancy><Occupancy index="1" numberOfUnits="1" personsPerUnit="1" numberOfPersons="1"> <Participant type="D" age="99" index="2" /></Occupancy>

Listing 17: Example for a multi occupancy.


InfoTec


4.1.4 City or region or GeoGroup

City/Region

Tag Type

Mandatory

Description

Id A Yes Geolocation IdTable 12: The City / Region/GeoGroup structure.

<City id="11094" /><Region id="1109" /><GeoGroup id="21109" />

Listing 18: Example for a City and a Region.

4.1.5 The hotel product

HotelProduct

Tag Type

Mandatory

Description

TourOperator E No The organiser

ProductKey E No Source specific product key

ProductManagement

E No Carrier

Hotel E No The concrete hotel within the Hotel Platform

Source

Tag Type

Mandatory

Description

type A yes CRS

TourOperator

Tag Type

Mandatory

Description

Id A yes Id of the tour operator

ProductManagement

Tag Type

Mandatory

Description

id A yes Id of the product management

Hotel

Tag Typ Mandat Description


InfoTec


e ory

id A yes Id of the hotelTable 13: HotelProduct and its subordinate structures.

<HotelProduct> <TourOperator id="2" /> <ProductKey>ACE20003</ProductKey> <ProductManagement id="21" /> <Hotel id="81473" /></HotelProduct>

Listing 19: Example for a HotelProduct.

4.1.6 Geo search

This allows to search based on Geocode or IATA code of a point of interest. Please note that if Geo Search is requested, City or Region or HotelProduct can NOT be specified.Geo Search has two different options. Either Geocode or IataCode should be specified and only one of them must be specified. For Geocode Latitude, Longitude and one of Circle, Rectangle, Proximity is mandatory.

Geocode

Tag Type

Mandatory

Description

Latitude E Yes Latitude(Grad_Y) of the POI (Point of Interest) in decimal degrees

Longitude E Yes Longitude(Grad_X) of the POI (Point of Interest) in decimal degrees

Circle E No For search within a circle

Measurement A No Measurement unit of the radius (Defaults to Kilometers)

Radius A Yes Radius within which the search is requested.

Reactangle E No For search within a rectangle

Measurement A No Measurement unit of the rectangle(Defaults to Kilometers)

Length A Yes Length of the rectangle (interested area)

Width A Yes Width of the rectangle (interested area)

Proximity E No For search based on proximity

Count A Yes How many hotels are requestedTable 14: The Geocode structure.

<HotelSearchRequest> ... <Geocode> <Latitude>32.980451</Latitude> <Longitude>-12.009865</Longitude>

<Circle measurement="km" radius="10" />


InfoTec


OR <Rectangle measurement="km" length="20" width="10" />OR <Proximity count="50" />

</Geocode> ...</HotelSearchRequest>

Listing 20: Example for a HotelSearchRequest with geo search.

For IataCode Code and one of Circle, Rectangle, Proximity is mandatory.

IataCode

Tag Type

Mandatory

Description

Code E Yes IATA Code of the Airport

Circle E No For search within a circle

measurement A No Measurement unit of the radius (Defaults to Kilometers)

radius A Yes Radius within which the search is requested.

Reactangle E No For search within a rectangle

measurement A No Measurement unit of the rectangle(Defaults to Kilometers)

length A Yes Length of the rectangle (interested area)

width A Yes Width of the rectangle (interested area)

Proximity E No For search based on proximity

count A Yes How many hotels are requestedTable 15: The IataCode structure.

<HotelSearchRequest> <IataCode> <Code>TXL</Code> <Circle measurement="km" radius="10" /> <Rectangle measurement="km" length="20" width="10" /> <Proximity count="50" /> </IataCode></HotelSearchRequest>

Listing 21: Example for a HotelSearchRequest with IATA code search.

Please note: Proximity search (both for IATA and Geocode), offers are not ordered by their distance from the Point of Interest. Proximity search is done before checking for availability on the respective sources, hence it is possible the response may have less offers than specified in the ‘count’ attribute.

4.1.7 Net, gross and prepayment

IsNet tells if the searched rates must be net (not including commission), if false only gross rates are searched. IsGross enables the search for gross rates (similar to IsNet=false) but you can combine it with IsNet=true. The isGross=true and isNet=true request will now search for net and gross rates at the same time in a single request. They all can contain simple boolean values (true or false) or be omitted.


InfoTec


Of course some hotels might allow both rates – to define what is to be returned a new mandator specific prefer rule has been defined. A mandator can “prefer net rates”, “prefer gross rates” or “prefer best price” (default).IsPrepayment tells if the searched rates must require prepayment, if false only rates which require payment at the hotel are searched.If this is omitted from the request the following rules are applied:

Each mandator defines whether prepayment is supported. In case it is not the search is done for postpay offers, only (same as isPrepayment=false).

Otherwise the search for pre and postpay offers is done in a single request.

Per hotel a definition is supported whether to return prepay or postpay offers.

4.1.8 Default values

A request without any value for IsNet / IsGross / IsPrepayment will default to: search for gross rates (pre- / postpay as per hotel configuration).The default prefer rule is “best price”.There is no default for IsPrepayment because that is configured on hotel level. The flag can still be given on request level to filter the results for a payment model, though.

4.1.9 Possible rate type / payment combinations

Specifying PackagingOnly=true (see below) will search only for packaging rates. Packaging rates are always net rates. Net rates are always prepayment offers.Based on that the following rate type / payment model combinations exist:

Net (Prepay)

Packaging (Net / Prepay)

Gross / Prepay

Gross / Postpay

4.1.10 Mixed result set from single request

Performance optimization can be achieved by avoiding sending multiple search requests and combine them into a single request instead.To summarize the combinations explained in the previous chapter: It is possible to get a mixed result set (net and gross prepay / postpay offers) with a single request. The result does not contain variations of this on hotel level because the configuration defines what to return per hotel.E.g. source THM: the result may contain a gross / postpay offer from “Hotel A” as well as net / prepay offer from “Hotel B”. It won’t contain a gross / postpay and a net / prepay offer from the same hotel even if the hotel supports it.


InfoTec


4.1.11 Additional search criteria

The search result can be additionally restricted by several search criteria (as multi select). Note that not all sources support these criteria (e.g. Pegasus does not support no meal types). Future extensions can be implemented without changing the XML interface.The following search criteria are supported by the HotelSearchRequest so far:

Indicator for packaging rates (defines if only packing rates should be returned, to be used only for Virtual Tour Operator (VTO) at the moment):<PackagingOnly>false</PackagingOnly>

One or more hotel types (multi select):<HotelType id="14" />

One or more hotel chains (multi select):<HotelChain id="11" />

One or more hotels (multi select):<Hotel id="53835" />

One meal type:<Mealtype id="4001" code="G" />

A minimum category:<MinimumCategory>2.0</ MinimumCategory >

These additional search criteria must all define (except for the minimum category) the specific Hotel Platform ID for identification purposes.It is possible to join search criteria. Basically all search criteria of the same type will be considered as “or-relation” (city A or city B), criteria of different types as “and-relation” (minimum category and city). Exceptions are only the City and Region tags, which are considered as “or-relation” (city A or region B).

4.1.12 Restricted search

Within the OfferControl tag the client can restrict the result list of the different sources.

Time limit

A time limit defines how many seconds the search request may take to return. An additional time may take the serialisation / de-serialisation as well as the data transfer.If a time limit is specified this limit got the highest priority within all other limits. That means, if not all requested offers can be returned within the specified time limit, all offers that were found until then will be returned instead (including bookmark). The specification of a time limit is optional.

<OfferControl timeLimit="120"> <Source type="THM" /> <Source type="PEG" /></OfferControl>

Listing 22: Example for limiting a search by a time limit.


InfoTec


Offer limit

The offer limit defines the maximum amount of requested offers. If no other quoting or ranking values are specified, the amount of the returned offer list depends on the response times of the specific sources. A specified time limit got higher priority.

<OfferControl maxOffers="10"> <Source type="THM" /> <Source type="PEG" /></OfferControl>

Listing 23: Example for limiting a search by a maximum number of offers.

Quoting / ranking

The quoting defines how the requested results should be distributed to the several sources. Quoting information will be specified in form of a ranking. This ranking defines in conjunction with the specified offer limit the distribution of the offer list to the specific sources. If the requested quoting cannot be accomplished, the Service tries to increase the total amount of offers with other sources.

<OfferControl timeLimit="120" maxOffers="30"> <Source type="THM" ranking="20" /> <Source type="PEG" ranking="10" /></OfferControl>

Listing 24: Example for limiting a search by ranking offer sources.

The response contains (if possible) 30 offers, 20 from THM and 10 from PEG. If there are only 15 offers available in THM, then the response will be filled up with five additional offers from PEG.Please note: The ranking is used together with maxOffers to support paging. In combination with cached offers this is more complex. Offers from cache aren’t controlled by the ranking (they do not count into the ranking of the source). Lets say the source is the cache and you cannot specify a cache ranking. Because of this behaviour you shouldn’t combine paging with cache usage for one mandator.

Bookmarks

If a bookmark is specified within a HotelSearchRequest, no other search criteria will be considered or validated. A bookmark within the Hotelportal-Service will be realised in form of a HTTP-GET parameter to make sure that the load balancer forwards the request correctly to the specific application server.To use this functionality the ServerInfo tag must include a specific session id (of the servlet container). The client has to transmit this session id as GET parameter (parameter name will be defined within the deployment descriptor of the application server). Because the way of adding this parameter to the URL is not standardised, the HotelSearchResponse transmits the complete value as an URL postfix.If a client sends a request with a bookmark the limitation of the previous requests are still significant.

<ServerInfo> <UrlPostfix>;jsessionid=D7A462B5B2363C49A3001FC975B6823B</UrlPostfix></ServerInfo>


InfoTec


Listing 25: Example for using bookmarks in search requests.

4.1.13 Example for a complete HotelSearchRequest

<?xml version="1.0" encoding="ISO-8859-1"?><HotelSearchRequest version="1.3"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2005-06-25</Date> <Time hour="11" minutes="55" /> </Timestamp> <Tracking from="musyk" to="vrp-service" /> </Head> <ClientInfo> <Locale>de_DE</Locale> <Brand>3</Brand> <Mandator>3</Mandator> <Agency>3084</Agency> <Terminal>$FNJ</Terminal> <User>Hansen</User> <TimeZoneOffset>60</TimeZoneOffset> </ClientInfo> <OfferControl maxOffer="45"> <Source type="PEG" ranking="5" /> <Source type="OCEAN" ranking="10" /> <Source type="IRIS" ranking="20" /> <Source type="THM" ranking="5" /> <Source type="GTA" ranking="5" /> </OfferControl> <City id="1009276" /> <ArrivalDate format="yyyy-MM-dd">2005-07-22</ArrivalDate> <Duration>7</Duration> <Occupancy numberOfUnits="1" personsPerUnit="2" numberOfPersons="2"> <Participant type="H" age="43" index="0" /> <Participant type="K" age="39" index="1" /> </Occupancy></HotelSearchRequest>

Listing 26: Example of a complete HotelSearchRequest.

4.2 Receiving hotel products

If the hotel search was successful, the HotelSearchResponse contains available and priced hotel offers that can be booked. An offer contains always one or more HotelOfferItems that fits on the requested time range and occupancy.

HotelSearchResponse

Tag Type

Mandatory

Description


Head E Yes (*CTS)

ServerInfo E No (*CTS)

ResultDetails

E No Described below


InfoTec


OfferControl

E Yes (*CTS)

Offer E No (*CTS)Table 16: The HotelSearchResponse structure.

<?xml version="1.0" encoding="ISO-8859-1"?><HotelSearchResponse version="1.3"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2005-06-27</Date> <Time hour="13" minutes="42" /> </Timestamp> <Session>6362125</Session> <Tracking from="vrp-service" to="musyk" /> </Head> <ServerInfo /> <OfferControl timeLimit="120" maxOffers="30"> <Source type="THM" ranking="20" /> <Source type="IRIS" ranking="20" /> <Source type="OCEAN" ranking="20" /> </OfferControl> <Offer> <IsNet>false</IsNet> <IsPrepayment>false</IsPrepayment> <Source type="THM" /> <TourOperator id="2" code="TD" /> <Price currency="EUR">1440.0</Price> <ScoreDetails totalScore="0.125" /> <OfferStates>fix,option</OfferStates> <OfferItems> <HotelOfferItem state="available"> </HotelOfferItem> </OfferItems> <Participant age="99" index="0" /> <Participant age="99" index="1" /> </Offer></HotelSearchResponse>

Listing 27: Example for a HotelSearchResponse.

4.2.1 Result details

ResultDetails provide further information about the following result set.


InfoTec


ResultDetails

Tag Type

Mandatory

Description

numberOfResults A yes The number of offers listed below

totalNumberOfProductsFound

A yes The total number of offers that match HotelSearchRequest’s search criteria

MinPrice E yes The price of the cheapest offer below

MaxPrice E yes The price of the most expensive offer below

Table 17: The ResultDetails structure.

<ResultDetails numberOfResults="2" totalNumberOfProductsFound="20"> <MinPrice currency="USD">210.0</MinPrice> <MaxPrice currency="EUR">230.0</MaxPrice></ResultDetails>

Listing 28: Example for ResultDetails.

4.2.2 Score details

The element ScoreDetails indicates the offer’s score and thereby the offer’s ranking within the result set is determined.

4.2.3 Offer items

A HotelOfferItem is part of the whole offer and a combination of a specific room with a specific catering (or meal). In most cases, an offer contains only one HotelOfferItem that specifies the desired room and catering in that hotel.

HotelOfferItem

Tag Type

Mandatory

Description

state A yes State of the offer (e.g. available, option)

ArrivalDate E yes Date of arrival (*CTS)

Duration E yes Duration (number of nights)

Occupancy E yes (*CTS)

Price E yes Price of the OfferItem (*CTS)

PriceDetails E no More detailed information about price

ProductInfo E yes Source specific informations

HotelProduct E yes Hotel product

RoomType E yes Room

MealType E yes CateringTable 18: The HotelOfferItem structure.

PriceDetails


InfoTec


Tag Type

Mandatory

Description

NetPrice E no Price without commission

Provision E no Provision as absolute value

CommissionPercentage

E no Percentage of gross price

MarkUp E no Additional price mark ups

Savings E no t.b.d.

AppliedRateType E no t.b.d.

AppliedOfferType

E no t.b.d.

Table 19: The PriceDetails structure.

RoomType

Tag Type

Mandatory

Description

id A yes Id of room type

code E yes Source specific code of the room

LongText E no Localised description

Description E no Localised descriptionTable 20: The RoomType structure.

MealType

Tag Type

Mandatory

Description

id A yes Id of catering

code E yes Code of catering

LongText E no Localised description

Description E no Localised description

LongText / Description

Tag Type

Mandatory

Description

locale A yes Language / country of descriptionTable 21: The MealType and its subordinate structures.

<?xml version="1.0" encoding="ISO-8859-1"?><HotelOfferItem state="available"> <ArrivalDate format="yyyy-MM-dd">2005-07-22</ArrivalDate> <Duration>7</Duration> <Occupancy index="0" numberOfUnits="1" personsPerUnit="2" numberOfPersons="2"> <Participant type="H" age="43" index="0"> <IndividualPrice currency="EUR">308.0</IndividualPrice> </Participant>


InfoTec


<Participant type="K" age="39" index="1"> <IndividualPrice currency="EUR">308.0</IndividualPrice> </Participant> </Occupancy> <ProductInfo> <Source type="IRIS" /> </ProductInfo> <HotelProduct isTuiQuality="true"> <Source type="IRIS" /> <TourOperator id="2" code="TD" /> <ProductKey>PMI56030</ProductKey> <ProductManagement id="7" code="BA" /> <ProgramType id="1" code="U00" /> <ProductName>Son Menut</ProductName> <Hotel id="81985"> <Name>Son Menut</Name> <Address> <CompleteAddress>3 volta, 3040.Cami Son Negre</CompleteAddress> <Zip>07260</Zip> <City id="12243" type="City"> <Name locale="de_DE">Porreres (Felanitx)</Name> </City> <Country id="824" type="Country" code="ES"> <Name locale="de_DE">Spanien</Name> </Country> </Address> <Communication> <Phone> <AreaCode>0034-971</AreaCode> <Number>582920</Number> </Phone> </Communication> <HotelChain id="3902"> <Name>Radisson Hotel & Suites</Name> <SubChain id="3903"> <Name>Radisson Hotel & Suites</Name> </SubChain> </HotelChain> <HotelCategory id="1000" rating="0">0.0</HotelCategory> </Hotel> </HotelProduct> <RoomType id="2007" code="DBF"> <LongText locale="de_DE">Doppelzimmer,Bad,WC,Klimaanlage</LongText> <Description locale="de_DE"> Doppelzimmer, Bad, WC, Klimaanlage, Frühstück </Description> </RoomType> <MealType id="4001" code="G"> <LongText locale="de_DE">Frühstück</LongText> </MealType></HotelOfferItem>

Listing 29: Example for a HotelOfferItem.

4.2.4 The hotel product

A hotel product describes a real physical hotel object for a specific source, tour operator, product management and program type.

HotelProduct


InfoTec


Tag Type

Mandatory

Description

isTuiQuality A Yes true, if the hotel has an IRIS code

isRecommended A No true, if the hotel is regarded as recommended

productId A No Id of the hotel product

Source E Yes The source of the searched hotel product

TourOperator E Yes The tour operator

ProductKey E Yes Source specific product code

ProductManagement

E Yes Carrier

ProgramType E Yes Type of the program

ProductName E Yes Name of the product

Description E No Localised description of the product

Hotel E No Hotel

Source

Tag Type

Mandatory

Description

type A yes CRS

TourOperator

Tag Type

Mandatory

Description

id A Yes Id of the tour operator

code A Yes Code of the tour operator

ProductManagement

Tag Type

Mandatory

Description

id A Yes Id of the product management

code A Yes Code of the product management

ProgramType

Tag Type

Mandatory

Description

id A Yes Id of the program type

code A Yes Code of the program type

Description

Tag Typ Mandat Description


InfoTec


e ory

locale A Yes Language / country of the description

CatalogInfo

Tag Type

Mandatory

Description

Catalog E No Catalog of the hotel product

Season E No Season of the hotel product

Season_Year E No Season Year for the hotel product

Hotel

Tag Type

Mandatory

Description

id A No Id of the hotel within the Hotel Platform

Name E No Hotel name

Address E No Address of the hotel

Communication E No Communication of the hotel

HotelChain E No The hotel chain of the hotel

HotelCategory E No The hotel category

HotelChain / SubChain

Tag Type

Mandatory

Description

id A Yes Id of the hotel chain

Name E No Name of the chain

SubChain E No Sub chain

HotelCategory

Tag Type

Mandatory

Description

id A yes Id of the hotel category

rating A yes Hotel categoryTable 22: The HotelProduct and its subordinate structures.

<HotelProduct isTuiQuality="true" isRecommended="true" productId="207570"> <Source type="IRIS" /> <TourOperator id="2" code="TD" /> <ProductKey>ACE35001</ProductKey> <ProductManagement id="8" code="CA" /> <ProgramType id="1" code="U00" /> <ProductName>La Casona de Yaiza</ProductName> <Description locale="de_DE"> Flair, Ambiente & Flair, Halbpension</Description>


InfoTec


<CatalogInfo><Catalog>YC</Catalog><Season>W</Season><Season_Year>2009</Season_Year><Page>040</Page>

</CatalogInfo> <Hotel id="81963"> <Name>La Casona de Yaiza</Name> <Address> <Street>Calle El Rincon 11</Street> <Zip>35570</Zip> <City id="15907" type="City"> <Name locale="de_DE">Yaiza</Name> </City> <Country id="824" type="Country" code="ES"> <Name locale="de_DE">Spanien</Name> </Country> </Address> <Communication> <Phone> <AreaCode>0034-928</AreaCode> <Number>83 62 62</Number> </Phone> </Communication> <HotelChain id="3902"> <Name>Radisson Hotel & Suites</Name> <SubChain id="3903"> <Name>Radisson Hotel & Suites</Name> </SubChain> </HotelChain> <HotelCategory id="1006" rating="3">3.0</HotelCategory> </Hotel></HotelProduct>

Listing 30: Example for a HotelProduct.


InfoTec


5 Room type variations

The RoomTypeVariationRequest is used to search for all available room types within a specific hotel product that fits the requested date and occupancy.

5.1 Requesting room type variations

RoomTypeVariationRequest

Tag Type

Mandatory

Description


Head E Yes (*CTS)



HotelProduct E Yes Hotel product to search for room variations


Duration E Yes Duration (number of nights)


IsNet E No Search only net rates

IsPrepayment E No Search only rates with prepayment

HotelProduct

Tag Type

Mandatory

Description

Source E Yes CRS



ProductManagement

E Yes Carrier

ProgramType E No Program typeTable 23: The RoomTypeVariationRequest and its subordinate structures.

<?xml version="1.0" encoding="ISO-8859-1"?><RoomTypeVariationsRequest version="1.3"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2005-06-26</Date> <Time hour="11" minutes="55" /> </Timestamp> <Tracking from="musyk" to="vrp-service" /> </Head> <OfferControl> <Source type="IRIS" /> </OfferControl>


InfoTec


<ClientInfo> <Locale>de_DE</Locale> <Brand>3</Brand> <Agency>3084</Agency> <Terminal>$FNJ</Terminal> <User>5322</User> <TimeZoneOffset>60</TimeZoneOffset> </ClientInfo> <HotelProduct> <Source type="IRIS" /> <TourOperator id="2" code="TD" /> <ProductKey>LON12005</ProductKey> <ProductManagement id="9" code="CT" /> <ProgramType id="12" code="U35" /> </HotelProduct> <ArrivalDate format="yyyy-MM-dd">2005-08-05</ArrivalDate> <Duration>7</Duration> <Occupancy numberOfUnits="1" personsPerUnit="2" numberOfPersons="2"> <Participant type="H" age="36" index="0" /> <Participant type="K" age="11" index="1" /> </Occupancy></RoomTypeVariationsRequest>

Listing 31: Example for a RoomTypeVariationsRequest.

5.2 Reveicing room type variations

Each found room variation is encapsulated in an offer tag. The structure of the returned HotelOfferItem is identical with those returned in a HotelSearchResponse (see 4.2.1).

RoomTypeVariationResponse

Tag Type

Mandatory

Description

Version A yes (*CTS)

Head E yes (*CTS)

ServerInfo

E no (*CTS)

Offer E no (*CTS)Table 24: The RoomTypeVariationResponse structure.

<?xml version="1.0" encoding="ISO-8859-1"?><RoomTypeVariationsResponse version="1.3"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2005-06-27</Date> <Time hour="13" minutes="47" /> </Timestamp> <Session>default</Session> <Tracking from="vrp-service" to="musyk" /> </Head> <ServerInfo /> <Offer> <Source type="IRIS" /> <TourOperator id="2" code="TD" /> <Price currency="EUR">1526.0</Price> <OfferStates>fix,option</OfferStates>


InfoTec


<OfferItems> <HotelOfferItem state="available"> ... </HotelOfferItem> </OfferItems> <Participant type="H" age="36" index="0" /> <Participant type="K" age="11" index="1" /> </Offer> <Offer> <Source type="IRIS" /> <TourOperator id="2" code="TD" /> <Price currency="EUR">1862.0</Price> <OfferStates>fix,option</OfferStates> <OfferItems> <HotelOfferItem state="available"> ... </HotelOfferItem> </OfferItems> <Participant type="H" age="36" index="0" /> <Participant type="K" age="11" index="1" /> </Offer></RoomTypeVariationsResponse>

Listing 32: Example for a RoomyTypeVariationsResponse.


InfoTec


6 Arrival date variations

The OfferRangeRequest is used to get a variation of arrival dates of a specific offer. This transaction is not supported by all sources. At the moment only the source THM supports this transaction.

6.1 Requesting variations of the arrival date

The OfferRangeRequest must provide an offer including all attributes given in a search response (HotelOfferItem, Occupancy, HotelProduct, MealType and RoomType, ArrivalDate and Duration, see 4.2.1). Only the Price is not a mandatory attribute.These values are needed to vary the given offer (and only this specific offer) using a range of arrival days defined by the other two search criteria: DaysBefore and DaysAfter.

OfferRangeRequest

Tag Type

Mandatory

Description


Head E Yes (*CTS)


BaseOffer E Yes An offer containing all criterias to identify a specific offer (hotelOfferItem(s), occupancy, hotelProduct, meal- and roomType, arrival date and duration), only the price is not mandatory

DaysBefore E Yes Number of alternative arrival days before the base offers arrival day

DaysAfter E Yes Number of alternative arrival days after the base offers arrival day

Table 25: The OfferRangeRequest structure.

<?xml version="1.0" encoding="ISO-8859-1"?><OfferRangeRequest version="1.3"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2006-12-21</Date> <Time hour="14" minutes="7" /> </Timestamp> <Tracking from="musyk" to="hotelportal-service" /> </Head> <ClientInfo> <Locale>de_DE</Locale> <Brand>1</Brand> <Agency>3084</Agency> <Terminal>$FNJ</Terminal> <User>5322</User> <TimeZoneOffset>60</TimeZoneOffset> <ProductionMode>true</ProductionMode> </ClientInfo>


InfoTec


<Source type="THM" /> <ArrivalDate format="yyyy-MM-dd">2007-02-07</ArrivalDate> <Duration>7</Duration> <OfferItems> <HotelOfferItem> <ArrivalDate format="yyyy-MM-dd">2007-02-07</ArrivalDate> <Duration>7</Duration> <Occupancy numberOfUnits="1" personsPerUnit="2" numberOfPersons="2"> <Participant index="0" /> <Participant index="1" /> </Occupancy> <HotelProduct> <Source type="THM" /> <Hotel id="469960" /> </HotelProduct> <RoomType id="2002" /> <MealType id="4000" /> </HotelOfferItem> </OfferItems> </BaseOffer> <DaysBefore>7</DaysBefore> <DaysAfter>7</DaysAfter></OfferRangeRequest>

Listing 33: Example for an OfferRangeRequest.

6.2 Receiving variations of the arrival date

The OfferRangeResponse returns a list offers that are varying the requested base offers arrival day. The structure of the returned offers is identical with those returned in a HotelSearchResponse (see 4.2.1).

OfferRangeResponse

Tag Type

Mandatory

Description

version A yes (*CTS)

Head E yes (*CTS)

ServerInfo

E no (*CTS)

Offer E no (*CTS)Table 26: The OfferRangeResponse structure.

<?xml version="1.0" encoding="ISO-8859-1"?><OfferRangeResponse version="1.3"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2006-12-21</Date> <Time hour="14" minutes="27" /> </Timestamp> <Session>unknown</Session> <Tracking from="hotelportal-service" to="musyk" /> </Head> <Offer> <Source type="THM" /> <TourOperator id="1" /> <ArrivalDate format="yyyy-MM-dd">2007-02-01</ArrivalDate>


InfoTec


<Duration>7</Duration> <Price currency="EUR">700.0</Price> <PriceDetails> ... </PriceDetails> <IsPrepayment>false</IsPrepayment> <IsNet>false</IsNet> <OfferStates>fix,option</OfferStates> <OfferItems> <HotelOfferItem state="available"> <ArrivalDate format="yyyy-MM-dd">2007-02-01</ArrivalDate> <Duration>7</Duration> <Occupancy numberOfUnits="1" personsPerUnit="2" numberOfPersons="2"> <Participant index="0" /> <Participant index="1" /> </Occupancy> <Price currency="EUR">700.0</Price> <PriceDetails> ... </PriceDetails> <ProductInfo> <Source type="THM" /> <Code type="is.packaging.rate">false</Code> </ProductInfo> <HotelProduct isTuiQuality="false"> ... <Hotel id="469960"> ... </Hotel> </HotelProduct> <RoomType id="2002" code="3D D" beds="2" campbeds="1"> ... </RoomType> </HotelOfferItem> </OfferItems> <Participant index="0" /> <Participant index="1" /> </Offer> ... <Offer> <Source type="THM" /> <TourOperator id="1" /> <ArrivalDate format="yyyy-MM-dd">2007-02-03</ArrivalDate> <Duration>7</Duration> <Price currency="EUR">700.0</Price> <PriceDetails> ... </PriceDetails> <IsPrepayment>false</IsPrepayment> <IsNet>false</IsNet> <OfferStates>fix,option</OfferStates> <OfferItems> <HotelOfferItem state="available"> <ArrivalDate format="yyyy-MM-dd">2007-02-03</ArrivalDate> <Duration>7</Duration> <Occupancy numberOfUnits="1" personsPerUnit="2" numberOfPersons="2"> <Participant index="0" /> <Participant index="1" /> </Occupancy>


InfoTec


<Price currency="EUR">700.0</Price> <PriceDetails> ... </PriceDetails> <ProductInfo> <Source type="THM" /> <Code type="is.packaging.rate">false</Code> </ProductInfo> <HotelProduct isTuiQuality="false"> ... <Hotel id="469960"> ... </Hotel> </HotelProduct> <RoomType id="2002" code="3D D" beds="2" campbeds="1"> ... </RoomType> </HotelOfferItem> </OfferItems> <Participant index="0" /> <Participant index="1" /> </Offer></OfferRangeResponse>

Listing 34: Example for an OfferRangeResponse.


InfoTec


7 Hotel Availability

The HotelAvailabilityRequest is used to search availability status of all room types within a specific hotel product that fits the requested date and occupancy.

7.1 Requesting hotel availability

HotelAvailabilityRequest

Tag Type

Mandatory

Description


Head E Yes (*CTS)



HotelProduct E Yes Hotel product to search for room variations


Duration E Yes Duration (number of nights)

Occupancy E No (*CTS)

MealType E No (*CTS)

Tolerance E No Days of tolerance

HotelProduct

Tag Type

Mandatory

Description

Source E Yes CRS



ProductManagement

E Yes Carrier

ProgramType E No Program type

Tolerance

Tag Type

Mandatory

Description

ArrivalDateTolerance

E Yes Days of tolerance in arrival date

DepartureDateTolerance

E Yes Days of tolerance in departure date

Table 27: The HotelAvailabilityRequest and its subordinate structure

<?xml version = '1.0' encoding = 'ISO-8859-1'?><HotelAvailabilityRequest version="1.3"> <Head>


InfoTec


<Timestamp> <Date format="yyyy-MM-dd">2005-08-24</Date> <Time hour="11" minutes="47"/> </Timestamp> <Session>6092531</Session> <Tracking from="musyk" to="vrp-service"/> </Head> <ClientInfo> <Locale>de_DE</Locale> <Brand>3</Brand> <Mandator>27</Mandator> <Agency>3084</Agency> <Terminal>$FNJ</Terminal> <User>TEST</User> <TimeZoneOffset>7200000</TimeZoneOffset> <ProductionMode>true</ProductionMode> </ClientInfo> <TourOperator id="2" code="TD"/> <HotelProduct> <Source type="IRIS"/> <ProductKey>LON12158</ProductKey> <ProductManagement id="9" code="CT"/> <ProgramType id="12" code="U35"/> </HotelProduct> <ArrivalDate format="yyyy-MM-dd">2009-05-01</ArrivalDate> <Duration>7</Duration> <Tolerance type="day"> <ArrivalDateTolerance>1</ArrivalDateTolerance> <DepartureDateTolerance>2</DepartureDateTolerance> </Tolerance> <Occupancy numberOfUnits="1" personsPerUnit="2" numberOfPersons="2"> <Participant type="H" age="99" index="0"/> <Participant type="H" age="99" index="1"/> </Occupancy> <Occupancy numberOfUnits="1" personsPerUnit="1" numberOfPersons="1"> <Participant type="H" age="99" index="0"/> </Occupancy></HotelAvailabilityRequest>

Listing 35: Example for a HotelAvailabilityRequest

7.2 Receiving hotel availability

The HotelAvailabilityResponse delivers the lists of availability status of all room types corresponding to the given occupancy. If no occupany is mentioned in the request, then the response contains result of all possible occupancies.

HotelAvailabilityResponse

Tag Type

Mandatory

Description


Head E Yes (*CTS)

ServerInfo E no (*CTS)

HotelAvailability E Yes Contains hotel availability items

HotelAvailability


InfoTec


Tag Type

Mandatory

Description

HotelAvailabilityItems

E Yes The items of availabiity

HotelAvailabilityItems

Tag Type

Mandatory

Description

HotelAvailabilityItem E Yes The item of hotel availability

HotelAvailabilityItem

Tag Type

Mandatory

Description


HotelProduct E Yes (*CTS)

RoomType E Yes (*CTS)

MealType E Yes (*CTS)

HotelAvailabilityList E Yes The list of availabilities for the requested period

HotelAvailabilityList

Tag Type

Mandatory

Description

BusinessDay E Yes The day with availability and statusTable 28: The HotelAvailabilityResponse structure

<?xml version = '1.0' encoding = 'ISO-8859-1'?><HotelAvailabilityResponse version="1.3">

<Head><Timestamp>

<Date format="yyyy-MM-dd">2009-04-21</Date><Time hour="13" minutes="14"/>

</Timestamp><Session>6092531</Session><Tracking from="vrp-service" to="musyk"/>

</Head><ServerInfo/><HotelAvailability>

<Source type="IRIS"/><TourOperator id="2" code="TD"/><HotelAvailabilityItems>

<HotelAvailabilityItem><Occupancy personsPerUnit="1"/><HotelProduct isTuiQuality="true" productId="237404">

<Source type="IRIS"/><TourOperator id="2" code="TD"/><ProductKey>LON12158</ProductKey><ProductManagement id="9" code="CT"/><ProgramType id="12" code="U35"/><ProductName>H.I. Bloomsbury</ProductName><Hotel id="602444">

<Name>Holiday Inn Bloomsbury</Name><Address>


InfoTec


<Street>Coram Street</Street><Zip>WC1N 1HT</Zip><City id="1009276" type="City"

code="LON"><Name locale="de_DE">London</

Name></City><Country id="1000926" type="Country"

code="GB" code2="GBR"><Name

locale="de_DE">Großbritannien</Name></Country>

</Address><Communication>

<Phone><AreaCode> 0044</AreaCode><Number>8704009222</Number>

</Phone><Fax>

<AreaCode> 0044</AreaCode><Number>2072786798</Number>

</Fax></Communication><HotelChain id="67">

<Name>Inter-Continental Hotel Group</Name>

<SubChain id="69"><Name>Holiday Inn</Name>

</SubChain></HotelChain><HotelCategory id="1008" rating="4">4.0</

HotelCategory></Hotel>

</HotelProduct><RoomType id="2007" code="DBF ">

<LongText locale="de_DE">Doppelzimmer, Bad, WC, Klimaanlage</LongText>

</RoomType><MealType id="4001" code="G"/><HotelAvailabilityList>

<BusinessDay><Date format="yyyy-MM-dd">2009-04-30</Date><Availability>1</Availability>

</BusinessDay><BusinessDay>

<Date format="yyyy-MM-dd">2009-05-01</Date><Availability>1</Availability>











</BusinessDay>


InfoTec









</BusinessDay></HotelAvailabilityList>

</HotelAvailabilityItem><HotelAvailabilityItem>

<Occupancy personsPerUnit="2"/><HotelProduct isTuiQuality="true" productId="237404">

<Source type="IRIS"/><TourOperator id="2" code="TD"/><ProductKey>LON12158</ProductKey><ProductManagement id="9" code="CT"/><ProgramType id="12" code="U35"/><ProductName>H.I. Bloomsbury</ProductName><Hotel id="602444">

<Name>Holiday Inn Bloomsbury</Name><Address>

<Street>Coram Street</Street><Zip>WC1N 1HT</Zip><City id="1009276" type="City"

code="LON"><Name locale="de_DE">London</

Name></City><Country id="1000926" type="Country"

code="GB" code2="GBR"><Name

locale="de_DE">Großbritannien</Name></Country>


<Phone><AreaCode> 0044</AreaCode><Number>8704009222</Number>

</Phone><Fax>

<AreaCode> 0044</AreaCode><Number>2072786798</Number>

</Fax></Communication><HotelChain id="67">

<Name>Inter-Continental Hotel Group</Name>

<SubChain id="69"><Name>Holiday Inn</Name>

</SubChain></HotelChain><HotelCategory id="1008" rating="4">4.0</

HotelCategory></Hotel>

</HotelProduct><RoomType id="2007" code="DBF ">

<LongText locale="de_DE">Doppelzimmer, Bad, WC, Klimaanlage</LongText>

</RoomType>


InfoTec


<MealType id="4001" code="G"/><HotelAvailabilityList>






















</BusinessDay></HotelAvailabilityList>

</HotelAvailabilityItem></HotelAvailabilityItems>

</HotelAvailability></HotelAvailabilityResponse>

Listing 36: Example for a HotelAvailabilityResponse


InfoTec


8 Unique HoPla hotel IDs

The hotel key search enables a client system to retrieve a unique HoPla ID for a hotel. The client sends a request containing all important know data to the CTS service interface. The interface tries to identify a unique hotel. If there is exactly one matching hotel found, the key is returned immediately in the response. If more than one hotel matches to the provided hotel data, the response contains a message that prompts the client to give more detailed hotel data. If no matching hotel is found, a process for adding a new hotel is initiated. As the process to add a new hotel may take some days, the client is pleased to query HoPla again.The process to add new hotels is done on an ACCESS database which is connected to HoPla. There are some automatic functions on the ACCESS which are used to identify duplicate hotels. For better results there are manual postprocessing tasks.

8.1 Requesting a hotel key

HotelKeyRequest

Tag Type

Mandatory

Description


Head E Yes (*CTS)


Hotel E Yes Container for known hotel data

Source E No Information about external source/CRS


Client systeme.g. TUI NL

Hotel PlatformCTS Service Interface

1Client sendsdata of a(new) hotel

ACCESS database

2a 2b 2c

2c

2a (1 hotel found):Response contains unique ID.2b (>1 hotels found):Client has to provide more details2c (0 hotels found):Platform adds new hotelClient has to query again later

HoPla sends hotel data

3HoPla get information about uniqueness of new hotel

50

InfoTec


type A Yes CRS, e.g. “PEGS”

id A Yes External ID at CRS

Name E No Name of hotel

Address E No Address of hotel

Street E No Street

StreetNumber E No Streetnumber

Zip E No ZIP

City E No Container for city data

id A No HoPla geo location ID for city

Name E No Name of city

locale A No Used language for city name

Country E No Container for country data

id A No HoPla geo location ID for country

code A No ISO 3166 code for country

Name E No Name of country

locale A No Used language for country name

Communication E No Container for communication data

Phone E No Phone number

CountryCode E No Country code

AreaCode E No Area code

Number E No Number

Email E No E-MailTable 29: The HotelKeyRequest structure.

This request can be used to find a unique ID for “Hotel Melia” in Puerto del Carmen.

<?xml version="1.0" encoding="ISO-8859-1"?><HotelKeyRequest version="1.3"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2007-07-01</Date> <Time hour="11" minutes="55" /> </Timestamp> <Tracking from="tui-nl" to="vrp-service" /> </Head> <ClientInfo> <Locale>en_GB</Locale> <Brand>45</Brand> <Mandator>6</Mandator> <Agency>000000</Agency> </ClientInfo> <Hotel> <Source type="Costa" id="PDC18001" /> <Name>Hotel Melia</Name> <Address> <Street>Avenue Santiago</Street> <StreetNumber>18</StreetNumber> <Zip>12345</Zip>


InfoTec


<City id="1003437"> <Name locale="en_GB">Puerto del Carmen</Name> </City> <Country id="1001017" code="ES"> <Name locale="en_GB">Spain</Name> </Country> </Address> <Communication> <Phone> <CountryCode>34</CountryCode> <AreaCode>127</AreaCode> <Number>844738</Number> </Phone> <Email>[email protected]</Email> </Communication> </Hotel></HotelKeyRequest>

Listing 37: Example for a HotelKeyRequest.

8.2 Receiving hotel keys

HotelKeyResponse

Tag Type

Mandatory

Description


State A Yes “success”: unique hotel ID found“inaccurate”: >1 hotels found“unknown”: 0 hotels hound

Head E Yes (*CTS)

ServerInfo E Yes (*CTS)

Hotel E No Container for known hotel data

id A Yes Unique HoPla id

Source E No Information about external source/CRS

type A Yes CRS, e.g. “PEGS”

id A Yes External ID at CRSTable 30: The HotelKeyResponse structure.

This is how the response looks like if exactly one hotel is found.

<?xml version="1.0" encoding="ISO-8859-1"?><HotelKeyResponse version="1.3" state="success"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2007-07-01</Date> <Time hour="11" minutes="55" /> </Timestamp> <Session>6362125</Session> <Tracking from="vrp-service" to="tui-nl" /> </Head> <ServerInfo />


InfoTec


<Hotel id="537411"> <Source type="THM" id="423810" /> <Source type="PEGS" id="TF;AR17" /> <Source type="Costa" id="PDC18001" /> </Hotel></HotelKeyResponse>

Listing 38: Example for a HotelKeyResponse with exactly one result.

The following example shows the response if more than one hotel matches the criteria of the request.

<?xml version="1.0" encoding="ISO-8859-1"?><HotelKeyResponse version="1.3" state="inaccurate"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2007-07-01</Date> <Time hour="11" minutes="55" /> </Timestamp> <Session>6362125</Session> <Tracking from="vrp-service" to="tui-nl" /> </Head> <ServerInfo>More than one hotel match your criterias.</ServerInfo></HotelKeyResponse>

Listing 39: Example for a HotelKeyResponse if more than one result is found.

Finally this is how a response looks like if no matching hotel has been found.

<?xml version="1.0" encoding="ISO-8859-1"?><HotelKeyResponse version="1.3" state="unknown"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2007-07-01</Date> <Time hour="11" minutes="55" /> </Timestamp> <Session>6362125</Session> <Tracking from="vrp-service" to="tui-nl" /> </Head> <ServerInfo> The hotel provided in the request hasn't been found at HoPla. It will be added to the database soon. </ServerInfo></HotelKeyResponse>

Listing 40: Example for a HotelKeyResponse with no results found.


InfoTec


9 Detailed hotel information

9.1 Requesting detailed information on hotels

The HotelDetailRequest is used to get detailed information about a list of requested hotels. This so-called “quick search” is an offline search, which means that no backend systems are requested. Furthermore the returned hotels contain neither availabilities nor prices but detailed information from the local product database.The following parameters are mandatory:

A detail level

One or more hotels

Or a quick search value

9.1.1 Level of detail

The detail level defines the complexity of the returned hotel data. The following levels are possible:

1 Returns complete hotel details including images and descriptionsATTENTION: This request is very time and resource expensive!

2 Return hotel info only.

3 A quick search requests only hotels, bookable periods for these hotels and other different data.

4 Returns only hotel id's from different sources and the TUI quality flag.

<HotelDetailRequest version="1.3" detail="1">Listing 41: Setting the detail level.

9.1.2 Specifying a set of hotels

The requested hotels must be identifiable over their Hotel Platform-ID. The length of the hotel list is not restricted.<HotelProduct> <Hotel id="21410" /></HotelProduct>

Listing 42: Example of the Hotel tag within the HotelProduct tag.

9.1.3 Search with partial querries

It is possible to search for a partial product key if the concrete hotel product is not known. This value (known as quick search) can also be a part of a product name, if no product key with this value was found.

<QuickSearch>ACE</QuickSearch>Listing 43: Example of a QuickSearch tag.


InfoTec


9.1.4 Example for a HotelDetailRequest

<?xml version="1.0" encoding="ISO-8859-1"?><HotelDetailRequest version="1.3" detail="1"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2004-11-08</Date> <Time hour="14" minutes="56" /> </Timestamp> <Session>9387726</Session> <Tracking from="VRP" to="vrp-service" /> </Head> <ClientInfo> <Locale>de_DE</Locale> <Brand>1</Brand> <Agency>021245</Agency> <TimeZoneOffset>3600000</TimeZoneOffset> </ClientInfo> <HotelProduct> <Hotel id="21410" /> </HotelProduct></HotelDetailRequest>

Listing 44: Example for a HotelDetailRequest.

9.2 Receiving detailed hotel information

The HotelDetailResponse returns all information about the requested hotels depending on the requested detail level.

9.2.1 Localised hotel and room descriptions

Localised hotel and room descriptions are part of the HotelProduct tags. These descriptions are grouped by rubrics. Each rubric has a name and several sub rubrics to keep the hierarchical structure of the global hotel description.

9.2.2 Example for a HotelDetailResponse

<?xml version="1.0" encoding="ISO-8859-1"?><HotelDetailResponse version="1.3"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2006-05-18</Date> <Time hour="11" minutes="17" /> </Timestamp> <Session>9387726</Session> <Tracking from="vrp-service" to="VRP" /> </Head> <HotelProduct isTuiQuality="false"> <Source type="THM" /> <TourOperator id="1" code="HP" /> <ProductKey>21410</ProductKey> <ProductName>Adam</ProductName> <BookablePeriod> <From format="yyyy-MM-dd">2004-02-12</From>


InfoTec


<To format="yyyy-MM-dd">2006-12-31</To> </BookablePeriod> <Hotel id="21410"> <Name>Adam</Name> <Address> <Street>Kaiser-Friedrich-Str.</Street> <StreetNumber>51</StreetNumber> <Zip>10627</Zip> <City id="1008192" type="City" code="BER"> <Name locale="de_DE">Berlin</Name> </City> <Country id="1000376" type="Country" code="DE" code2="DEU"> <Name locale="de_DE">Deutschland</Name> </Country> </Address> <Communication> <Phone> <AreaCode>+49 30</AreaCode> <Number>32706811</Number> </Phone> </Communication> <HotelCategory id="1004" rating="2">2.0</HotelCategory> <Rubric> <Name locale="de_DE">Hotel</Name> <SubRubric> <Name locale="de_DE">Unterkunftstyp</Name> <Description locale="de_DE"> Hotelpension, Kinderfreundliches Hotel </Description> </SubRubric> <SubRubric> <Name locale="de_DE">Lage</Name> <Description locale="de_DE"> Stadtzentrum, Innenstadt West, Ruhige Umgebung </Description> </SubRubric> <SubRubric> <Name locale="de_DE">Anzahl Zimmer</Name> <Description locale="de_DE"> Gesamtzahl Zimmer: 27, Bauyeshr: 1970, Letzte Gesamtrenovierung: 2004, Letzte Teilrenovierung: 2005, Nichtraucherzimmer: 10 </Description> </SubRubric> <SubRubric> <Name locale="de_DE">Ausstattung</Name> <Description locale="de_DE"> Empfangshalle, Business Center geöffnet von 09:00 bis 20:00, Internet Cafe (Gebühr), Fernsehraum, Gartenterrasse, Parkplatz (Gebühr): 3.00 EUR, Parkgarage (Gebühr): 5.00 EUR, Parkplatzgarage ist gesichert, Behinderten Parkplätze, Parkplatz reservierbar (gegen Gebühr), Busparkplatz am Hotel, Babybetten </Description> </SubRubric> <SubRubric> <Name locale="de_DE">Service</Name> <Description locale="de_DE"> Rezeption besetzt von: 08:00, Rezeption besetzt bis: 22:00, Frühester Check-In: 09:00, Spätester Check-Out: 11:00, Mehrsprachiges Personal über 24 h verfügbar, Stadtrundfahrten,


InfoTec


Shuttle zum Hauptbahnhof (Gebühr), Shuttle zum Flughafen, Shuttle zur Messe (Gebühr), Shuttle zur Stadt (Gebühr) </Description> </SubRubric> <SubRubric> <Name locale="de_DE">Sicherheit</Name> <Description locale="de_DE"> Feuermelder, Rauchmelder, Automatischer Notfall-Ruf, Fluchtwegkarte im Zimmer </Description> </SubRubric> <SubRubric> <Name locale="de_DE">Verpflegung und Gastronomie</Name> <Description locale="de_DE"> Anzahl Restaurants: 1, Cafe/Bistro, Außengastronomie, Vegetarische Kost möglich, Diabetiker Kost möglich </Description> </SubRubric> <SubRubric> <Name locale="de_DE">Haustiere</Name> <Description locale="de_DE"> Hunde erlaubt, Katzen erlaubt, Kleintiere erlaubt, Anmeldung von Haustieren direkt im Hotel erforderlich </Description> </SubRubric> <SubRubric> <Name locale="de_DE">Zahlungsmittel</Name> <Description locale="de_DE"> American Express, Eurocard/Mastercard, Visa </Description> </SubRubric> </Rubric> </Hotel> </HotelProduct></HotelDetailResponse>

Listing 45: Example for a HotelDetailResponse (extract).


InfoTec


10 Supported source systems

Currently the following sources are supported:

Shortcut Description

THM TUI Hotel Manager

PEG Pegasus

OCEAN Ocean

IRIS Iris

GTA Gullivers Travels Associates

HOTELBEDS Hotelbeds

COMRES ComresTable 31: The supported source systems.

To request some sources correctly the requests should contain specific meta data that is stored in the ClientInfo tag.

10.1 Meta data for TUI Hotelmanager

ClientInfo

Tag Type

Mandatory

Description

Locale E No (*CTS)

Brand E Yes Part of the brand and mandator functionality

Mandator E Yes Part of the brand and mandator functionality

Agency E Yes Agency of the Pegasus Request

User E No User code

TimeZoneOffset

E No Time offset to GMT

Table 32: The meta data (ClientInfo) structure for TUI Hotelmanager.

10.2 Meta data for Pegasus

ClientInfo

Tag Type

Mandatory

Description

Locale E No (*CTS)



Agency E Yes Agency of the Pegasus Request

User E No User code


InfoTec


TimeZoneOffset


Table 33: The meta data (ClientInfo) structure for Pegasus.

10.3 Meta data for Ocean

ClientInfo

Tag Type

Mandatory

Description

Locale E No (*CTS)



Agency E Yes Agency of the Ocean Request

User E Yes User code of the Ocean Request

TimeZoneOffset


Table 34: The meta data (ClientInfo) structure for Ocean.

<ClientInfo> <Locale>de_DE</Locale> <Brand>3</Brand> <Mandator>3</Mandator> <Agency>3084</Agency> <Terminal>$FNJ</Terminal> <User>Hansen</User> <TimeZoneOffset>60</TimeZoneOffset></ClientInfo>

Listing 46: Example for a meta data structure for Ocean.

10.4 Meta data for IRIS

ClientInfo

Tag Type

Mandatory

Description

Locale E No (*CTS)

Brand E No Part of the brand and mandator functionality

Mandator E Yes From of Iris request

Agency E Yes Agent of Iris Request

Terminal E Yes TermId of Iris Request

User E Yes UserCode of Iris Request

TimeZoneOffset


Table 35: The meta data (ClientInfo) structure for IRIS.

<ClientInfo> <Locale>de_DE</Locale>


InfoTec


<Brand>3</Brand> <Mandator>3</Mandator> <Agency>3084</Agency> <Terminal>$FNJ</Terminal> <User>Hansen</User> <TimeZoneOffset>60</TimeZoneOffset></ClientInfo>

Listing 47: Example for meta data for IRIS.

10.5 Meta data for GTA

ClientInfo

Tag Type

Mandatory

Description

Locale E No (*CTS)


Mandator E Yes From GTA request

Agency E No Agent of GTA Request

Terminal E No TermId of GTA Request

User E No UserCode of GTA Request

TimeZoneOffset


Table 36: Table meta data (ClientInfo) structure for GTA.


Listing 48: Example for meta data for GTA.

10.6 Meta data for Hotelbeds

ClientInfo

Tag Type

Mandatory

Description

Locale E No (*CTS)


Mandator E Yes From Hotelbeds request

Agency E No Agent of Hotelbeds Request

Terminal E No TermId of Hotelbeds Request

User E No UserCode of Hotelbeds Request


InfoTec


TimeZoneOffset


Table 37: The meta data (ClientInfo) structure for Hotelbeds.


Listing 49: Example for meta data for Hotelbeds.

10.7 Meta data for ComRes

ClientInfo

Tag Type

Mandatory

Description

Locale E No (*CTS)


Mandator E Yes From ComRes request

Agency E No Agent of ComRes Request

User E No UserCode of ComRes Request

TimeZoneOffset


Table 38: The meta data (ClientInfo) structure for ComRes.

<ClientInfo> <Locale>de_DE</Locale> <Brand>50</Brand> <Mandator>76</Mandator> <Agency>3084</Agency> <User>Hansen</User> <TimeZoneOffset>60</TimeZoneOffset></ClientInfo>

Listing 50: Example for meta data for Comres.


InfoTec


11 Supported Functions by CRS (HoPla)

Function THM Pegasus IRIS Ocean1 GTA Hotelbeds Comres

Availability & Pricing Search

List transaction with prices

Yes Only price ranges

Yes Yes Yes Yes Yes

Multi Room Search Yes Yes Yes Yes Yes Yes Yes

Multi Occupancy Search

Yes,2 occupancies,12 persons

No Yes,max. 6 persons,2 rooms2

Yes,max. 99 persons

Yes,Max 4 occupancies, 10 persons

YesMax 5 occupancies, 19 persons, 5 rooms

Yes

Variations

Room variations Yes Yes Yes Yes Yes Yes Yes

Time variations No No Yes Yes Yes Yes No

Booking queries Yes No Yes Yes

Errata (hints from the hotel -> OfferTag)

No No Yes Yes Yes Yes Yes

Booking

1 Currently not in use.2 Max number of persons includes infants. Rooms limited to 2 because IRIS only supports two rooms when submitting participants with age.


InfoTec


Option booking In work No Yes Yes No No Yes

Request booking No No Yes Yes No No No

Multi Room booking Yes Yes Yes Yes Yes Yes YesMax 3 rooms

Multi Occupancy booking

Yes,2 occupancies,12 persons

No Yes,max. 6 persons,2 rooms3

Yes,max. 99 persons

Yes,Max 4 occupancies, 10 persons

Yes YesMax 2 occupancies

processing of Booking remarks (remarks from the customer -> OfferTag)

No No Yes Yes Yes(Not guranteed)

Yes*(Hotelbeds does not gurantee any remarks to be provided by Hotelier, instead it is based on availability of that facility at the time of Occupancy. )

Yes

Booking detail / display

Yes No Yes Yes Yes Yes Yes

Option booking No Yes

Automatic cancellation

In work No ? ? No No Yes

Time till cancellation In work No ? ? No No -

3 Max number of persons includes infants. Rooms limited to 2 because IRIS only supports two rooms when submitting participants with age.


InfoTec


Booking modification / Amend

Customer name/address changes (payment)


Payment changes No No Yes No No No -

Duration of stay No No Yes Yes Yes Yes Yes

Arrival date No No Yes Yes Yes Yes Yes

Traveller name changes


Traveller number changes

No No dependson occupancy/extra beds

dependson occupancy/extra beds

Yes(Treated as different roomtype/Occupancy)

Yes Treated as different roomtype/Occupancy)

Yes

Roomtype changes No No Yes Yes Yes Yes Yes

Board type changes No No Yes Yes No No Yes

Hotel changes No No No No No No No

Option->fix In work No Yes Yes No No Yes

Fix->option No No Yes No No No No

DocumentDispatch YesA – AgencyC - Customer


InfoTec


Cancellation queries Yes No Yes Yes Yes Yes Yes

Cancellation

Last free cancellation date

Yes Only as freetext

No No Yes Yes(Attributed or Freetext depending on what is given by Hotelbeds)

No

Cancellation fee Yes Only as freetext

? Yes Yes Yes(Attributed or Freetext depending on what is given by Hotelbeds)

Yes

Table 39: The supported functions by CRS (HoPla).


InfoTec


12 Source specific transactions

This chapter describes examples of source specific transactions like a booking query or a booking request. For these transactions, the requests must contain to some extent different mandatory fields depending on the source. For a detailed description, see the documentation of the Common Tourist XML interface (CTS).All necessary source specific information is source dependent and will be returned within the response of a HotelSearchRequest. It is advisable to add all returned information to the following source specific transaction (e.g. a booking query).The recommended order of source specific transactions is

1. BookingInfoRequest (booking query)

2. BookingRequest (fix, request or option booking)

3. BookingDetailRequest (displaying an existing booked offer)

4. BookingChangeInfoRequest (booking change query of an booked offer)

5. BookingChangeRequest (booking change of an booked offer)

6. CancellationInfoRequest (cancellation query of an booked offer)

7. CancellationRequest (cancellation of an booked offer)

Note that not all transactions are supported by the different sources.Here is an overview of the supported transactions for each source:

THM: BookingInfoRequest, BookingRequest, BookingDetailRequest, CancellationInfoRequest, CancellationRequest

Pegasus: BookingInfoRequest, BookingRequest, BookingDetailRequest, CancellationInfoRequest, CancellationRequest

Ocean: BookingInfoRequest, BookingRequest, BookingDetailRequest, BookingChangeInfoRequest, BookingChangeRequest CancellationInfoRequest, CancellationRequest

IRIS: BookingInfoRequest, BookingRequest, BookingDetailRequest, BookingChangeInfoRequest, BookingChangeRequest, CancellationInfoRequest, CancellationRequest

GTA: BookingInfoRequest, BookingRequest, BookingDetailRequest, BookingChangeInfoRequest, BookingChangeRequest, CancellationInfoRequest, CancellationRequest

Hotelbeds: BookingInfoRequest, BookingRequest, BookingDetailRequest, BookingChangeInfoRequest, BookingChangeRequest, CancellationInfoRequest, CancellationRequest

Comres: BookingInfoRequest, BookingRequest, BookingDetailRequest, BookingChangeInfoRequest, BookingChangeRequest, CancellationInfoRequest, CancellationRequest


InfoTec


12.1 BookingRequest for TUI Hotelmanager

In this section, only the THM specific mandatory tags are described.

BookingRequest

Tag Type

Mandatory

Description


action A yes fix

Head E yes (*CTS)

ClientInfo

E yes (*CTS)

Offer E yes The offer to book (*CTS)Table 40: The BookingRequest structure mandatory for THM.

ProductInfo

Tag Type

Mandatory

Description

is.packaging.rate Code

No Flag indicating if the rate to book is a packing rate

Table 41: The ProductInfo structure mandatory for THM.

<ProductInfo> <Source type="THM" /> <Code type="is.packaging.rate">false</Code></ProductInfo>

Listing 51: Example for a ProductInfo including the is.packaging.rate flag.

<?xml version="1.0" encoding="ISO-8859-1"?><BookingInfoRequest version="1.3" action="fix"> <Head> ... </Head> <ClientInfo> <Locale>de_DE</Locale> <Mandator>1</Mandator> <Agency>4003</Agency> <Terminal>V522</Terminal> <User>MUSYK3</User> <TimeZoneOffset>7200000</TimeZoneOffset> </ClientInfo> <Offer> <Source type="THM" /> <Customer> ... </Customer> <PaymentData> <ActualPayment> <CreditCard id="127" code="VI"> ... </CreditCard> </ActualPayment>


InfoTec


</PaymentData> <TourOperator id="1" /> <Price currency="GBP">235.0</Price> <OfferStates>fix</OfferStates> <OfferItems> <HotelOfferItem state="available"> <ArrivalDate format="yyyy-MM-dd">2006-06-09</ArrivalDate> <Duration>1</Duration> <Occupancy numberOfUnits="1" personsPerUnit="2" numberOfPersons="2"> ... </Occupancy> <Price currency="GBP">235.0</Price> <ProductInfo> <Source type="THM" /> <Code type="is.packaging.rate">false</Code> </ProductInfo> <HotelProduct isTuiQuality="false"> <Source type="THM" /> ... <ProductName>The Capital Hotel</ProductName> <Hotel id="442468" /> </HotelProduct> <RoomType id="2002" code="3A" beds="2" campbeds="0"> <LongText locale="de_DE">Doppel Standard</LongText> <ShortText locale="de_DE" /> <Description locale="de_DE"> Doppel Standard, Badezimmer mit Badewanne </Description> </RoomType> <MealType id="4000" code="U"> <LongText locale="de_DE">ohne</LongText> <ShortText locale="de_DE">OV</ShortText> </MealType> </HotelOfferItem> </OfferItems> <Participant type="H" age="99" index="0"> <Salutation>Herr</Salutation> <FirstName>Aaa</FirstName> <LastName>Test</LastName> </Participant> <Participant type="D" age="99" index="1"> <Salutation>Frau</Salutation> <FirstName>Bbb</FirstName> <LastName>Test</LastName> </Participant> </Offer></BookingInfoRequest>

Listing 52: Example for a BookingInfoRequest.

<?xml version="1.0" encoding="ISO-8859-1"?><BookingInfoResponse version="1.3" state="success"> <Head> ... </Head> <Offer> <Source type="THM" /> <PaymentData> <Amount currency="GBP">235.0</Amount> <SumTotal currency="GBP">235.0</SumTotal>


InfoTec


<CancellationPayment> <CancellationInfo guaranteePaymentNeeded="true"> <Charges currency="GBP">235.0</Charges> <LastFreeCancellation> <Date format="yyyy-MM-dd">2006-06-07</Date> <Time hour="14" minutes="0" timeZoneOffset="0" /> </LastFreeCancellation> <GuaranteePaymentType id="124" code="AMEX" /> <GuaranteePaymentType id="125" code="EURO" /> <GuaranteePaymentType id="126" code="DC" /> <GuaranteePaymentType id="127" code="VISA" /> <GuaranteePaymentType id="11053" code="JAPANCB" /> </CancellationInfo> </CancellationPayment> </PaymentData> <TourOperator id="1" /> <Price currency="GBP">235.0</Price> <OfferStates>fix</OfferStates> <OfferItems> <HotelOfferItem> <ArrivalDate format="yyyy-MM-dd">2006-06-09</ArrivalDate> <Duration>1</Duration> <Occupancy numberOfUnits="1" personsPerUnit="2" numberOfPersons="2"> ... </Occupancy> <Price currency="GBP">235.0</Price> <ProductInfo> <Source type="THM" /> <Code type="is.packaging.rate">false</Code> </ProductInfo> <HotelProduct isTuiQuality="false"> <Source type="THM" /> <ProductName>The Capital Hotel</ProductName> <Hotel id="442468"> <Name>The Capital Hotel</Name> ... </Hotel> </HotelProduct> <RoomType id="2002" code="3A" beds="2" campbeds="0"> <LongText locale="de_DE">Doppel Standard</LongText> <ShortText locale="de_DE" /> <Description locale="de_DE"> Doppel Standard, Badezimmer mit Badewanne </Description> </RoomType> <MealType id="4000" code="U"> <LongText locale="de_DE">ohne</LongText> <ShortText locale="de_DE">OV</ShortText> </MealType> </HotelOfferItem> </OfferItems> <Participant type="H" age="99" index="0"> <Salutation>Herr</Salutation> <FirstName>Aaa</FirstName> <LastName>Test</LastName> </Participant> <Participant type="D" age="99" index="1"> <Salutation>Frau</Salutation> <FirstName>Bbb</FirstName> <LastName>Test</LastName>


InfoTec


</Participant> </Offer></BookingInfoResponse>

Listing 53: Example of a BookingInfoResponse.

12.1.1 Optional bookings for THM

THM option bookings work like normal option bookings, except they do expire after a short amount of time (default 5 minutes). If there is no BookingChangeRequest changing the status to “fix” in this time, the booking will be deleted.

12.2 BookingRequest for Pegasus

In this section, only the Pegasus specific mandatory tags are described.

BookingRequest

Tag Type

Mandatory

Description


action A yes fix

Head E yes (*CTS)

ClientInfo

E yes (*CTS)

Offer E yes The offer to book (*CTS), including the complete address of the first participant (see below)

Table 42: The BookingRequest structure mandatory for Pegasus.

ProductInfo

Tag Type

Mandatory

Description

BookableRate Code

yes Price of the first night. Without this price no booking is possible

RatePlan.Code Code

yes Rate plan of the hotel room

RoomType.Code Code

yes Room code of the hotel room

DepositPolicy.Required

Code

yes Defines if the a deposit must be payed to book the offer (true/false)

RatePlan.Description Text No Description of the rate plan. Often used by hotels to specify the catering for this rate

Room.Description Text No Description of the room. Often used by hotels to specify the catering for this room

is.packaging.rate Code

No Flag indicating if the rate to book is a packing rate


InfoTec


is.negotiated.rate Code

No Flag indicating if the rate to book is a negotiated rate

Table 43: The ProductInfo XML structure mandatory for Pegasus.

Pegasus offers also require product information within the ProductInfo tag. This information is used to identify the specific product within the Pegasus system.First of all the “BookableRate” (price of the first night) is mandatory because this is the price with those the offer is booked. If there are rate changes within the duration (often if the hotel will be booked for a week), the Pegasus system calculates the total price automatically.The “RatePlan.Code” and the “RoomType.Code” define the concrete hotel room of a concrete hotel rate. They are also mandatory.

<ProductInfo> <Source type="PEG" /> <Text type="RatePlan.Description">BEST AVAILABLE RATE</Text> <Text type="Room.Description">DOUBLE ROOM/TWIN OR QUEEN BED/14SQM/</Text> <Code type="RatePlan.Code">DR</Code> <Code type="RoomType.Code">IEXC</Code> <Code type="BookableRate">145.00</Code> <Code type="DepositPolicy.Required">false</Code> <Code type="is.packaging.rate">false</Code> <Code type="is.negotiated.rate">false</Code></ProductInfo>

Listing 54: Example for a ProductInfo including Pegasus flags.

The first participant must have a complete address, the address' city needs the country code attribute:<Participant type="H" age="99" index="0"> <FirstName>Test</FirstName> <LastName>Test</LastName> <Communication> <Phone> <CountryCode>12</CountryCode> <AreaCode>345</AreaCode> <Number>67890</Number> </Phone> <Email>[email protected]</Email> </Communication> <Address> <Street>Teststreet</Street> <StreetNumber>123</StreetNumber> <Zip>12345</Zip> <City> <Name locale="en_GB">someplace</Name> </City> <Country code="D"> <Name locale="en_GB">somewhere</Name> </Country> </Address></Participant>

Listing 55: Example for a valid Participant.

12.2.1 Example-Request

<?xml version="1.0" encoding="ISO-8859-1"?><BookingInfoRequest version="1.3" action="fix">


InfoTec


<Head> ... </Head> <ClientInfo> ... </ClientInfo> <Offer> <Source type="PEG" /> <Customer> ... </Customer> <PaymentData> <ActualPayment> <CreditCard id="127" code="VI"> ... </CreditCard> </ActualPayment> </PaymentData> <TourOperator id="1" code="HP" /> <ArrivalDate format="yyyy-MM-dd">2006-06-09</ArrivalDate> <Duration>1</Duration> <Price currency="GBP">145.0</Price> <OfferStates>fix</OfferStates> <OfferItems> <HotelOfferItem> <ArrivalDate format="yyyy-MM-dd">2006-06-09</ArrivalDate> <Duration>1</Duration> <Occupancy numberOfUnits="1" personsPerUnit="2" numberOfPersons="2"> ... </Occupancy> <Price currency="GBP">145.0</Price> <ProductInfo> <Source type="PEG" /> <Text type="RatePlan.Description"> BEST AVAILABLE RATE </Text> <Text type="Room.Description"> DOUBLE ROOM/TWIN OR QUEEN BED/14SQM/ </Text> <Code type="RatePlan.Code">DR</Code> <Code type="RoomType.Code">IEXC</Code> <Code type="BookableRate">145.00</Code> <Code type="DepositPolicy.Required">false</Code> <Code type="is.packaging.rate">false</Code> <Code type="is.negotiated.rate">false</Code> </ProductInfo> <HotelProduct> <Source type="PEG" /> <TourOperator id="1" code="HP" /> <ProductKey>SW;HALONJAM</ProductKey> <ProductManagement id="2" code="PG" /> <ProgramType id="1" code="U00" /> <ProductName> St. James Club and Hotel - a Member of Worldhotels </ProductName> <Hotel id="59894"> <Name> St. James Club and Hotel - a Member of Worldhotels </Name> ...


InfoTec


</Hotel> </HotelProduct> <RoomType id="2007" code="D"> <LongText locale="de_DE">Doppelzimmer</LongText> <ShortText locale="de_DE" /> <Description locale="de_DE">Doppelzimmer</Description> </RoomType> <MealType id="4005"> <LongText locale="de_DE">unbekannt</LongText> <ShortText locale="de_DE" /> </MealType> </HotelOfferItem> </OfferItems> <Participant type="H" age="99" index="0"> <Salutation>Herr</Salutation> <FirstName>Aaa</FirstName> <LastName>Test</LastName> </Participant> <Participant type="D" age="99" index="1"> <Salutation>Frau</Salutation> <FirstName>Bbb</FirstName> <LastName>Test</LastName> </Participant> </Offer></BookingInfoRequest>

Listing 56: Example for a BookingInfoRequest.

<?xml version="1.0" encoding="ISO-8859-1"?><BookingInfoResponse version="1.3" state="success"> <Head> ... </Head> <ServerInfo /> <Offer> <Source type="PEG" /> <PaymentData> <Amount currency="GBP">145.0</Amount> <SumTotal currency="GBP">145.0</SumTotal> <CancellationPayment> <CancellationInfo guaranteePaymentNeeded="true"> <GuaranteePaymentType id="124" code="AMEX" /> <GuaranteePaymentType id="125" code="EURO" /> <GuaranteePaymentType id="126" code="DC" /> <GuaranteePaymentType id="127" code="VISA" /> </CancellationInfo> </CancellationPayment> </PaymentData> <TourOperator id="1" code="HP" /> <ArrivalDate format="yyyy-MM-dd">2006-06-09</ArrivalDate> <Duration>1</Duration> <Price currency="GBP">145.0</Price> <OfferStates>fix</OfferStates> <OfferItems> <HotelOfferItem> ... <Price currency="GBP">145.0</Price> <ProductInfo> <Source type="PEG" /> <Text type="RatePlan.Description"> BEST AVAILABLE RATE RATE INCLUDES SERVICE


InfoTec


CHARGE/EXCLUSIVE OF VAT AT 17.5 PCT/CONTINENTAL BREAKFAST EXTRA AT GBP14.50/FULL ENGLISH BREAKFAST AT GBP 19.50/LOCATED IN EXCLUSIVE MAYFAIR AREA CLOSE TO BOND STREET/JERMYN STREET AND BUCKINGHAM PALACE </Text> <Text type="Room.Description"> DOUBLE ROOM/TWIN OR QUEEN BED/14SQM/ LARGE DESK/WIRELESS BROADBAND/AIRCON </Text> <Text type="CancelPolicy.Description"> CANCELLATION MUST BE RECEIVED 02 DAYS PRIOR TO ARRIVAL LOCAL TIME TO AVOID PENALTY </Text> <Code type="RatePlan.Code">DR</Code> <Code type="RoomType.Code">IEXC</Code> <Code type="BookableRate">145.00</Code> <Code type="DepositPolicy.Required">false</Code> <Code type="is.packaging.rate">false</Code> <Code type="is.negotiated.rate">false</Code> </ProductInfo> <HotelProduct isTuiQuality="false"> <Source type="PEG" /> ... </HotelProduct> </HotelOfferItem> </OfferItems> <Participant type="H" age="99" index="0"> ... </Participant> <Participant type="D" age="99" index="1"> ... </Participant> </Offer></BookingInfoResponse>

Listing 57: Example for a BookingInfoResponse.

12.3 BookingRequest for Ocean

In this section, only the Ocean specific mandatory tags are described.

BookingRequest

Tag Type

Mandatory

Description


action A yes fix, request or option

Head E yes (*CTS)

ClientInfo E yes (*CTS)

Offer E yes The offer to book (*CTS)Table 44: The BookingRequest structure mandatory for Ocean.

Offer

Tag Type

Mandatory

Description


InfoTec


confirm A yes (*CTS)

Source E yes OCEAN

Customer E yes A booking for the OCEAN system needs to specify a customer (FirstName, LastName, Address, Communication and Email must be filled) (*CTS)

PaymentData

E yes A valid payment data must be specified (*CTS)

Table 45: The Offer structure mandatory for Ocean.

ProductInfoTag Typ

eMandatory

Description

ocean.service.type Code yes Type of product (H=hotel)ocean.brochure.code

Code yes Broshure (or season) code in which the product currently can be booked (SO06=summer 2006)

ocean.catering.code Code yes Catering for the roomocean.category.code

Code yes Room variant

ocean.service.rph Code yes Unique index within the Ocean system for this specific offer

The ProductInfo structure mandatory for Ocean.

Especially the ProductInfo within the offer items are important for booking an Ocean hotel. This information is directly transmitted to Ocean and used to identify the specific product in the Ocean system.<ProductInfo> <Source type="OCEAN" /> <Code type="ocean.service.type">H</Code> <Code type="ocean.brochure.code">SO06</Code> <Code type="ocean.catering.code">V</Code> <Code type="ocean.category.code">DD</Code> <Code type="ocean.service.rph">1</Code></ProductInfo>

Listing 58: Example for a ProductInfo including Ocean flags.


<?xml version="1.0" encoding="ISO-8859-1"?><BookingRequest version="1.3" action="fix"> <Head> ... </Head> <ClientInfo> <Locale>de_DE</Locale> <Mandator>1</Mandator> <Agency>4003</Agency> <Terminal>V522</Terminal> <User>MUSYK3</User> <TimeZoneOffset>7200000</TimeZoneOffset> </ClientInfo> <Offer> <Source type="OCEAN" />


InfoTec


<Customer> ... </Customer> <PaymentData> <ActualPayment> <CreditCard id="127" code="VI"> <Number>4546183045965875</Number> <ExpirationDate format="yy/MM">09/09</ExpirationDate> <Owner customerId="0246678999"> <Salutation>H</Salutation> <FirstName>Emil</FirstName> <LastName>Tuitest</LastName> </Owner> </CreditCard> </ActualPayment> </PaymentData> <TourOperator id="2" code="TD" /> <ArrivalDate format="yyyy-MM-dd">2006-08-02</ArrivalDate> <Duration>7</Duration> <Price currency="EUR">1610.0</Price> <OfferStates>fix,option</OfferStates> <OfferItems> <HotelOfferItem state="available"> <ArrivalDate format="yyyy-MM-dd">2006-08-02</ArrivalDate> <Duration>7</Duration> <Occupancy index="0" numberOfUnits="1" personsPerUnit="2" numberOfPersons="2"> <Participant type="H" age="99" index="0"> <IndividualPrice currency="EUR">805.0</IndividualPrice> <ExternalKey>1</ExternalKey> </Participant> <Participant type="D" age="99" index="1"> <IndividualPrice currency="EUR">805.0</IndividualPrice> <ExternalKey>2</ExternalKey> </Participant> </Occupancy> <Price currency="EUR">1610.0</Price> <ProductInfo> <Source type="OCEAN" /> <Code type="ocean.service.type">H</Code> <Code type="ocean.brochure.code">SO06</Code> <Code type="ocean.catering.code">V</Code> <Code type="ocean.category.code">DD</Code> <Code type="ocean.service.rph">1</Code> </ProductInfo> <HotelProduct isTuiQuality="false"> <Source type="OCEAN" /> <TourOperator id="2" code="TD" /> <ProductKey>MIA10010</ProductKey> <ProductManagement id="77" code="OC" /> <ProgramType id="1" code="U00" /> <ProductName>Hilton Miami Airport</ProductName> <Hotel id="402396"> ... </Hotel> </HotelProduct> <RoomType id="2002" code="DD" beds="2"> <LongText locale="de_DE">Doppelzimmer/Standard</LongText> <Description locale="de_DE">Doppel Standard</Description> </RoomType> <MealType id="4003" code="V" />


InfoTec


</HotelOfferItem> </OfferItems> <Participant type="H" age="99" index="0"> <IndividualPrice currency="EUR">805.0</IndividualPrice> <Salutation>Herr</Salutation> <FirstName>Aaa</FirstName> <LastName>Test</LastName> <ExternalKey>1</ExternalKey> </Participant> <Participant type="D" age="99" index="1"> <IndividualPrice currency="EUR">805.0</IndividualPrice> <Salutation>Frau</Salutation> <FirstName>Bbb</FirstName> <LastName>Test</LastName> <ExternalKey>2</ExternalKey> </Participant> </Offer></BookingRequest>

Listing 59: Example for a BookingRequest for Ocean.

12.4 BookingRequest for Iris

In this section, only the IRIS specific mandatory tags are described.

BookingRequest

Tag Type

Mandatory

Description


action A Yes fix, request or option

Head E Yes (*CTS)

ClientInfo

E Yes (*CTS)

Offer E Yes The offer to book (*CTS)Table 46: The BookingRequest structure mandatory for IRIS.

Offer

Tag Type

Mandatory

Description


Source E yes IRIS

AccountData E yes The AccountData must contain the expedient

Customer E yes A booking for the IRIS system needs to specify an existing customer with a corresponding customerId (customerId, FirstName, LastName, Address, Communication and Email must be filled) (*CTS)

PaymentData

E yes The specified payment data must be assigned to the specified customer (*CTS)

Table 47: The Offer structure mandatory for IRIS.


InfoTec


Customer / Address / Country

Tag Type

Mandatory

Description

code A yes Country code with 2-letter code in ISO-3166 is now mandatory to translate the country name for IRIS (e.g. a country name for Germany as “D”)

Table 48: The Customer / Address / Country structure mandatory for IRIS.

ProductInfoTag Typ

eMandatory

Description

DOCUMENTDISPATCH

Code No Document Dispatch information. A – Agency C – Customer

Table 49: The Customer / Address / Country structure mandatory for IRIS.


<?xml version="1.0" encoding="ISO-8859-1"?><BookingRequest version="1.3" action="fix"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2005-06-23</Date> <Time hour="11" minutes="55" /> </Timestamp> <Session>5507756</Session> <Tracking from="musyk" to="vrp-service" /> </Head> <ClientInfo> <Locale>de_DE</Locale> <Brand>3</Brand> <Agency>3338</Agency> <Terminal>$F5N</Terminal> <User>FRIEDRI</User> <TimeZoneOffset>7200000</TimeZoneOffset> </ClientInfo> <Offer confirm="true"> <Source type="IRIS" /> <AccountData> <ProductInfo> <Code type="EXP">0001</Code> </ProductInfo> </AccountData> <Customer customerId="0179658778"> <FirstName>Ruediger</FirstName> <LastName>Friedrich</LastName> <Communication> <Phone> <CountryCode>49</CountryCode> <AreaCode /> <Number /> </Phone> <Email>[email protected]</Email> </Communication> </Customer>


InfoTec


<PaymentData> <ActualPayment> <CreditCard code="DC"> <Number>36400207007006</Number> <ExpirationDate format="yy/MM">05/06</ExpirationDate> <Owner customerId="0179658778"> <FirstName>Ruediger</FirstName> <LastName>Friedrich</LastName> <Communication> <Phone> <CountryCode>49</CountryCode> <AreaCode /> <Number /> </Phone> <Email>[email protected]</Email> </Communication> <Address> <Street>Auf den Äckern</Street> <StreetNumber>2</StreetNumber> <Zip>31700</Zip> <City> <Name locale="de_DE">Heuerßen</Name> </City> <Country id="376"> <Name locale="de_DE">D</Name> </Country> </Address> <Birthday format="yyyy-MM-dd">1963-11-14</Birthday> </Owner> </CreditCard> </ActualPayment> </PaymentData> <TourOperator id="2" /> <ArrivalDate format="yyyy-MM-dd">2005-08-01</ArrivalDate> <Duration>7</Duration> <Price currency="EUR">756.0</Price> <OfferItems> <HotelOfferItem> <ArrivalDate format="yyyy-MM-dd">2005-08-01</ArrivalDate> <Duration>7</Duration> <Occupancy index="0" numberOfUnits="1" personsPerUnit="2" numberOfPersons="2"> <Participant type="H" age="35" index="0" /> <Participant type="D" age="35" index="1" /> </Occupancy> <Price currency="EUR">756.0</Price> <HotelProduct> <Source type="IRIS" /> <TourOperator id="2" /> <ProductKey>ACE20003</ProductKey> <ProductManagement id="21" code="HH" /> <ProgramType id="1" code="U00" /> <ProductName>Hotel Riu Olivina</ProductName> <Hotel id="81473"> <Name>Hotel Riu Olivina</Name> <HotelCategory id="1008" /> </Hotel> </HotelProduct> <RoomType id="2007" code="DBJ"> <LongText locale="de_DE"> Doppelzimmer,Bad,WC,Bk/Terr.,Kli


InfoTec


</LongText> <Description locale="de_DE"> Doppelzimmer, Bad, WC, Balkon oder Terasse, Klimaanlage, Halbpension </Description> </RoomType> <MealType id="4002" code="H" /> </HotelOfferItem> </OfferItems> <Participant type="H" age="35" index="0"> <FirstName>jkl</FirstName> <LastName>friedrich</LastName> </Participant> <Participant type="D" age="35" index="1"> <FirstName>jkl</FirstName> <LastName>friedrich</LastName> </Participant> </Offer></BookingRequest>

Listing 60: Example for a BookingRequest for IRIS.

12.5 BookingRequest for GTA

GTA only supports option bookings. An option booking is made and if a payment is not received by GTA within 3 days then the booking is cancelled without cost to the customer. For this reason payment data must not be specified within the request.Additionally, account data must also not be specified as this is generated along with a booking code by the application. In this section, only the GTA specific mandatory tags are described.

BookingRequest

Tag Type

Mandatory

Description


action A yes Option

Head E yes (*CTS)

ClientInfo

E yes (*CTS)

Offer E yes The offer to book (*CTS)Table 50: The BookingRequest structure mandatory for GTA.

Offer

Tag Type

Mandatory

Description


Source E yes GTA

Customer E Yes A booking for the GTA system needs to specify an existing customer with a corresponding customerId (customerId, FirstName, LastName, Address, Communication and Email must be


InfoTec


filled) (*CTS)Table 51: The Offer structure mandatory for GTA.


<?xml version="1.0" encoding="ISO-8859-1"?><BookingRequest version="1.3" action="option"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2007-04-23</Date> <Time hour="13" minutes="59" /> </Timestamp> <Session>5507756</Session> <Tracking from="musyk" to="vrp-service" /> </Head> <ClientInfo> <Locale>de_DE</Locale> <Brand>3</Brand> <Agency>3084</Agency> <Terminal>$FNJ</Terminal> <User>5322</User> <TimeZoneOffset>60</TimeZoneOffset> </ClientInfo> <Offer confirm="true"> <Source type="GTA" /> <Customer customerId="0179658778"> <FirstName>Ruediger</FirstName> <LastName>Friedrich</LastName> <Communication> <Phone> <CountryCode>49</CountryCode> <AreaCode /> <Number /> </Phone> <Email>[email protected]</Email> </Communication> </Customer> <TourOperator id="2" /> <ArrivalDate format="yyyy-MM-dd">2007-08-01</ArrivalDate> <Duration>5</Duration> <Price currency="EUR">450.0</Price> <OfferItems> <HotelOfferItem> <ArrivalDate format="yyyy-MM-dd">2007-08-01</ArrivalDate> <Duration>7</Duration> <Occupancy index="0" numberOfUnits="1" personsPerUnit="2" numberOfPersons="2"> <Participant type="H" age="35" index="0" /> <Participant type="D" age="35" index="1" /> </Occupancy> <Price currency="EUR">756.0</Price> <HotelProduct> <Source type="GTA" /> <TourOperator id="2" /> <ProductKey>LON;BAG</ProductKey> <ProductManagement id="91" code="HP" /> <ProgramType id="1" code="U00" /> <ProductName>Apartment Hotel Hanse </ProductName> <Hotel id="528159">


InfoTec


<Name> Apartment Hotel Hanse </Name> <HotelCategory id="1008" /> </Hotel> </HotelProduct> <RoomType id="2007" code="DB"> <LongText locale="de_DE"> Doppelzimmer,Bad,WC,Bk/Terr.,Kli </LongText> <Description locale="de_DE"> Doppelzimmer, Bad, WC, Balkon oder Terasse, Klimaanlage, Halbpension </Description> </RoomType> <MealType id="2505" code="B" /> </HotelOfferItem> </OfferItems> <Participant type="H" age="35" index="0"> <FirstName>jkl</FirstName> <LastName>friedrich</LastName> </Participant> <Participant type="D" age="35" index="1"> <FirstName>jkl</FirstName> <LastName>friedrich</LastName> </Participant> </Offer></BookingRequest>

Listing 61: Example for a BookingRequest for GTA.

12.6 BookingRequest for Hotelbeds

Hotelbeds only supports fix bookings. In this section, only the Hotelbeds specific mandatory tags are described

BookingRequest

Tag Type

Mandatory

Description


action A yes Fix (Currently only fix bookings are provided for Hotelbeds)

Head E yes (*CTS)

ClientInfo

E yes (*CTS)

Offer E yes The offer to book (*CTS)Table 52: The BookingRequest structure mandatory for Hotelbeds.

Offer

Tag Type

Mandatory

Description


Source E yes Hotelbeds

Customer E yes A booking for the Hotelbeds system needs to specify an existing customer with a


InfoTec


corresponding customerId (customerId, FirstName, LastName, Address, Communication and Email must be filled) (*CTS)

Table 53: The Offer structure mandatory for Hotelbeds.


<?xml version="1.0" encoding="ISO-8859-1"?><BookingRequest version="1.3" action="fix"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2007-04-23</Date> <Time hour="13" minutes="59" /> </Timestamp> <Session>5507756</Session> <Tracking from="musyk" to="vrp-service" /> </Head> <ClientInfo> <Locale>de_DE</Locale> <Brand>3</Brand> <Agency>3084</Agency> <Terminal>$FNJ</Terminal> <User>5322</User> <TimeZoneOffset>60</TimeZoneOffset> </ClientInfo> <Offer confirm="true"> <Source type="HOTELBEDS" /> <Customer customerId="0179658778"> <FirstName>Ruediger</FirstName> <LastName>Friedrich</LastName> <Communication> <Phone> <CountryCode>49</CountryCode> <AreaCode /> <Number /> </Phone> <Email>[email protected]</Email> </Communication> </Customer> <TourOperator id="2" /> <ArrivalDate format="yyyy-MM-dd">2007-08-01</ArrivalDate> <Duration>5</Duration> <Price currency="EUR">450.0</Price> <OfferItems> <HotelOfferItem> <ArrivalDate format="yyyy-MM-dd">2007-08-01</ArrivalDate> <Duration>7</Duration> <Occupancy index="0" numberOfUnits="1" personsPerUnit="2" numberOfPersons="2"> <Participant type="H" age="35" index="0" /> <Participant type="D" age="35" index="1" /> </Occupancy> <Price currency="EUR">756.0</Price> <HotelProduct> <Source type="HOTELBEDS" /> <TourOperator id="2" /> <ProductKey>LON;BAG</ProductKey> <ProductManagement id="93" code="H1" />


InfoTec


<ProgramType id="1" code="U00" /> <ProductName>Apartment Hotel Hanse </ProductName> <Hotel id="528159"> <Name> Apartment Hotel Hanse </Name> <HotelCategory id="1008" /> </Hotel> </HotelProduct> <RoomType id="2007" code="DB"> <LongText locale="de_DE"> Doppelzimmer,Bad,WC,Bk/Terr.,Kli </LongText> <Description locale="de_DE"> Doppelzimmer, Bad, WC, Balkon oder Terasse, Klimaanlage, Halbpension </Description> </RoomType> <MealType id="2505" code="B" /> </HotelOfferItem> </OfferItems> <Participant type="H" age="35" index="0"> <FirstName>jkl</FirstName> <LastName>friedrich</LastName> </Participant> <Participant type="D" age="35" index="1"> <FirstName>jkl</FirstName> <LastName>friedrich</LastName> </Participant> </Offer></BookingRequest>

Listing 62: Example for a BookingRequest for HotelBeds.

12.6.2 Mandatory details for vouchers

Hotelbeds insists on certain details to be displayed on the vouchers created by the sales channels.HoPla provides the following details for this purpose.

Contractor specific remarks

Supplier and payment information

12.6.3 Contractor specific remarks

HotelBeds hotel Contractor for the booked Offer may provide specific information about that booking and this is provided as <Hint> in the Booked Offer (BookingResponse).This information (if provided) should be displayed in the voucher.<Hint Locale="en_GB"> When a child/children accompany adults, breakfast charges for the additional child should be payed directly at the hotel.</Hint>

Listing 63: Example for a Hint in the BookingResponse.


InfoTec


12.6.4 Supplier and payment information

The Supplier who is providing the Offer on behalf of HotelBeds will provide their details such as Name, Reference, Vat Number and Payment Information.This will be provided in the BookingResponse and BookingDetailResponse as ProductInfo (If provided by Hotelbeds).<ProductInfo> <Source type="HOTELBEDS" /> ... <Code type="Supplier.Name">TRINATOURS LIMITED</Code> <Code type="Supplier.Reference">LE</Code> <Code type="Vat.Number">1163558</Code> <Text type="Payment.Info"> *55* TRINA TOURS LIMITED, *58* NatWest Bank PLC(City of London Office, PO Box 12258, 1 Princess Street, London EC2R 8PA.) *59*39256464, Sort code:6000 01, IBAN: GB60NWBK60000139256464, *60*NWBKGB2L, 7*86* </Text></ProductInfo>

Listing 64: Example for a ProductInfo including supplier and payment information.

Voucher should display the above information in the below format:"Payable through [the appropiate Hotelbeds company that corresponds to the destination booked] , acting as agent for the service operating company, details of which can be provided upon request."Where "[the appropiate Hotelbeds company that corresponds to the destination booked]" corresponds with the supplier name, VAT number and supplier reference. Here you are an example:Example (for he above sample XML):"Payable through TRINATOURS LIMITED-LE-1163558, acting as agent for the service operating company, details of which can be provided upon request".


InfoTec


12.7 Booking Amendments for Hotelbeds

This section describes the possible amendments to Hotelbeds Bookings.NOTE:

It describes each amendment independently. When one or more operations are combined in the same operation, then the conditions may also be combined.Example1:Originally Booked: 1 Single Room and 2 Double Rooms.Adding a single room to this booking does not warrant any amendment charge. But if it is combined with removal of a double room then cancellation fees may apply for the double room that is being cancelled.Example2:Originally Booked: 20.March.2009, 5 days durationChanging the duration to 10 do not warrant any amendment fees. But combining this with changing the arrival date to 21.March.2009 may result in cancellation fee for 1 day.

This is subject to change as and when Hotelbeds make changes to their interface.

Amendment Supported

Conditions

Arrival Date

Earlier Date Yes There will not be any additional amendment fees

Cost for additional days will be charged

Subject to availability on the additional days

Later Date Yes There may be amendment fees(i.e cancellation fees for the days that were already booked)

Cost for additional days will be charged if duration is extended beyond earlier end date

Example:Booked arrival date: 10.March.2009Amendment: 09.March.2009Normal room(s) charges for the 1 additional day will be charged.

Duration

Increase Yes There will not be any additional amendment fees provided it does not involve arrival date change(i.e its just extension of stay at the end)

Cost for additional days will be charged

Subject to availability on the additional days


InfoTec


Decrease Yes There may be amendment fees(i.e cancellation fees for the days that were already booked)

Example1:Booked duration: 5 daysAmendment: 6 days(additional day at the end, i.e. arrival date is not changed)Normal room(s) charges for the 1 additional day will be charged.

Example2:Booked duration: 5 daysAmendment: 4 daysCancellation fees for the one day may be charged.

Add Room(s)

Add one or more rooms Yes There will not be any additional amendment fees

Cost for additional room(s) will be charged

Subject to availability of that room on the given days

Example:Booked rooms: 1 single roomAmendment: Add another single roomNormal room(s) charges for the 1 additional single room for the whole duration will be charged.

Remove Room(s)

Remove one or more rooms

Yes There may be cancellation fees depending on the cancellation policies for that hotel/room

Example:Booked rooms: 2 single roomAmendment: Remove one single roomCancellation fee may be charged for the 1 single room as per the cancellation policies for that room type given by the hotelier.

Room Type

Change the roomtype Yes There may be amendment fees charged, along with the cost for the new (requested) roomtype

Example:Booked rooms: 1 single standard roomAmendment: Change it to Single SuperiorThere may be amendment fees. Also


InfoTec


the cost of the Single Superior itself may be more or less or equal to the cost of the Single Standard room.

Board Type

Change the Board type Yes There may be amendment fees charged, along with the cost for the new (requested) meal type

Example:Booked board: Simple BreakfastAmendment: Change it to Full BoardThere may be amendment fees. Also the cost for the full board will be charged.

Customer Data No This is not supported at Hotelbeds

Travellers(Participants)

Traveller details change(Name, Address, Phone number, etc)

No This is not supported at Hotelbeds

Traveller Number change(Adding or removing a traveller from the booking)

Yes* Adding or removing a traveller involves change of Occupancy type. So this should be done using Room Type Change, Add Room or Remove Room operation.

Example1:Booked Participants: 2 in one room(Double Room)Amendment: Add an adult or a child or an infant to the same roomThis is nothing but changing the Occupancy, hence it should and will be treated as Roomtype change operation by HoPla. Charges and other conditions will be as Roomtype Change.

Example2:Booked Participants: 2 in one room(Double Room), 1 in another Room(Single Room)Amendment: Add an adult to the Double room and also add 2 more adults to the Single RoomThis is nothing but changing the Occupancy, hence it should and will be treated as Roomtype change operation by HoPla. Because for each Occupancy, HoPla gives as many OfferItems and in this case both OfferItems are being changed for the


InfoTec


Roomtype. Charges and other conditions will be as Roomtype Change.

Example3:Booked Participants: 2 in one room(Double Room)Amendment: Add an adult to the booking, BUT in a different room.This is nothing but adding a room, hence it should and will be treated as ‘Add Room’ operation by HoPla. Charges and other conditions will be as Add Room operation.

Table 54: Booking Amendments for Hotelbeds.

12.8 BookingRequest for ComRes

In this section, only the ComRes specific mandatory tags are described.

BookingRequest

Tag Type

Mandatory

Description


action A Yes Fix

Head E Yes (*CTS)

ClientInfo

E Yes (*CTS)

Offer E Yes The offer to book (*CTS)Table 55: The BookingRequest structure mandatory for ComRes.

ProductInfo

Tag Type

Mandatory

Description

Comres.Promotion.Code

Code

Yes Pramotion code that need to be sent to ComRes

Comres.Room.Code Code

Yes Comres Room Code

Table 56: The ProductInfo structure mandatory for ComRes.

<ProductInfo><Code type="Comres.Promotion.Code">0009</Code><Code type="Comres.Room.Code">DZX1</Code>

</ProductInfo>Listing 65: Example for a ProductInfo

<BookingRequest version="1.3" action="fix"><Head>

<Timestamp>


InfoTec


<Date format="yyyy-MM-dd">2007-06-06</Date><Time hour="13" minutes="59" />

</Timestamp><Session>unknown</Session><Tracking from="musyk" to="vrp-service" />

</Head><ClientInfo>

<Locale>de_DE</Locale><Brand>3</Brand><Mandator>27</Mandator><Agency>3084</Agency><TimeZoneOffset>120</TimeZoneOffset><ProductionMode>true</ProductionMode>

</ClientInfo><Offer>

<AccountData state="fix"><ProductInfo>

<Source type="COMRES" /><Code type="EXP">0001</Code>

</ProductInfo></AccountData><Source type="COMRES" /><TourOperator id="1" code="HP" /><ArrivalDate format="yyyy-MM-dd">2009-05-15</ArrivalDate><Duration>10</Duration><Price currency="EUR">2212.88</Price><PriceDetails>

<NetPrice currency="EUR">1762.47</NetPrice><Provision currency="EUR">195.83</Provision><MarkUp>

<PlatformMarkUp currency="EUR">254.58</PlatformMarkUp>

</MarkUp><CommissionPercentage>10.0</CommissionPercentage>

</PriceDetails><IsPrepayment>true</IsPrepayment><IsNet>false</IsNet><OfferStates>fix</OfferStates><OfferItems>

<HotelOfferItem state="available"><ArrivalDate format="yyyy-MM-dd">2009-05-15</ArrivalDate><Duration>10</Duration><Occupancy numberOfUnits="1" personsPerUnit="2"

numberOfPersons="2"><Participant type="H" age="99" index="0">

<FirstName>Test</FirstName><LastName>A</LastName>

</Participant><Participant type="D" age="99" index="1">

<FirstName>Test1</FirstName><LastName>A</LastName>

</Participant></Occupancy><Price currency="EUR">919.59</Price><PriceDetails>




InfoTec



</PriceDetails><ProductInfo>

<Code type="Comres.Promotion.Code">0009</Code><Code type="Comres.Room.Code">DZX1</Code>

</ProductInfo><HotelProduct isTuiQuality="false" productId="185012">

<Source type="COMRES" /><TourOperator id="1" code="HP" /><ProductKey>TFS11060</ProductKey><ProductManagement id="97" code="CE" /><ProgramType id="1" code="U00" /><ProductName>RIU Paraiso Resort</ProductName><Hotel id="1322058">

<Name>RIU Paraiso Resort</Name><Address>

<Street>., Calle Suiza 4</Street><Zip>35510</Zip><City id="1011094" type="City">

<Name locale="de_DE">Playa de los Po-cillos</Name>

</City><Country id="1000824" type="Country"

code="ES" code2="ESP"><Name locale="de_DE">Spanien</

Name></Country>


<Phone><AreaCode /><Number>928512400</Number>

</Phone><Fax>

<AreaCode /><Number>928512409</Number>

</Fax></Communication><HotelCategory id="1008" rating="4">4.0</HotelCategory>

</Hotel></HotelProduct><RoomType id="2001" code="DZX1">

<Description locale="de_DE">Doppelzimmer, gemäßProgramm</Description>

</RoomType><MealType id="4001" code="H" />

</HotelOfferItem><HotelOfferItem state="available">

<ArrivalDate format="yyyy-MM-dd">2009-05-15</ArrivalDate><Duration>10</Duration><Occupancy numberOfUnits="1" personsPerUnit="1"

numberOfPersons="1"><Participant type="H" age="99" index="0">

<FirstName>Test</FirstName><LastName>A</LastName>

</Participant></Occupancy><Price currency="EUR">1293.29</Price>


InfoTec


<PriceDetails><NetPrice currency="EUR">1030.05</NetPrice><Provision currency="EUR">114.45</Provision><MarkUp>




<Code type="Comres.Promotion.Code">0009</Code><Code type="Comres.Room.Code">EZL1</Code>








Name></Country>



</Phone><Fax>



</Hotel></HotelProduct><RoomType id="2001" code="EZL1">

<Description locale="de_DE">Einzelzimmer, Balkonoder Terasse, Wohnraum</Description>


</HotelOfferItem></OfferItems><Participant type="H" age="99" index="0">

<Salutation>Frau</Salutation><Title>Dr</Title><FirstName>Test</FirstName>


InfoTec


<LastName>A</LastName><Address>

<Street>Jenaer Str.</Street><StreetNumber>2</StreetNumber><Zip>10717</Zip><City id="1008192" type="City" code="BER">

<Name locale="de_DE">Berlin</Name></City><Country id="1000376" type="Country" code="DE" code2="DEU">

<Name locale="de_DE">Deutschland</Name></Country>


<Phone><Number>0190-331331</Number>

</Phone><PhoneDaytime>

<AreaCode>0170</AreaCode><Number>331331</Number>

</PhoneDaytime><Fax>


</Fax><Mobile>

<CountryCode>+49</CountryCode><AreaCode>173</AreaCode><Number>555 555</Number>

</Mobile><Email>[email protected]</Email>

</Communication></Participant><Participant type="D" age="99" index="1">

<Salutation>Miss</Salutation><Title>Fr</Title><FirstName>Test1</FirstName><LastName>A</LastName><Address>










</Fax>


InfoTec


<Mobile><CountryCode>+49</CountryCode><AreaCode>173</AreaCode><Number>555 555</Number>


</Communication></Participant><Participant type="H" age="99" index="2">

<Salutation>Mr</Salutation><Title>Dr</Title><FirstName>Test2</FirstName><LastName>A</LastName><Address>










</Fax><Mobile>



</Communication></Participant>

</Offer></BookingRequest>

Listing 66: Example for a BookingRequest.

<BookingResponse version="1.3" state="success"><Head>

<Timestamp><Date format="yyyy-MM-dd">2009-04-08</Date><Time hour="14" minutes="42" />

</Timestamp><Session>unknown</Session><Tracking from="vrp-service" to="musyk" />

</Head><ServerInfo /><Offer>


InfoTec


<AccountData state="fix"><BookingCode>COMRES-10005091</BookingCode><ProductInfo>

<Source type="COMRES" /><Code type="EXP">0001</Code>

</ProductInfo></AccountData><PaymentData>

<ActualPayment><Agency />

</ActualPayment><CancellationPayment>

<CancellationInfo guaranteePaymentNeeded="false"><Charges currency="EUR">0.0</Charges>

</CancellationInfo></CancellationPayment>

</PaymentData><Source type="COMRES" /><TourOperator id="1" code="HP" /><ArrivalDate format="yyyy-MM-dd">2009-05-15</ArrivalDate><Duration>10</Duration><Price currency="EUR">2212.88</Price><PriceDetails>


<PlatformMarkUp currency="EUR">254.58</PlatformMarkUp></MarkUp><CommissionPercentage>10.0</CommissionPercentage>

</PriceDetails><IsPrepayment>true</IsPrepayment><IsNet>false</IsNet><OfferStates>fix</OfferStates><OfferItems>

<HotelOfferItem state="available"><ArrivalDate format="yyyy-MM-dd">2009-05-15</ArrivalDate><Duration>10</Duration><Occupancy numberOfUnits="1" personsPerUnit="2"numberOfPersons="2">

<Participant type="H" age="99" index="0"><FirstName>Test</FirstName><LastName>A</LastName>

</Participant><Participant type="D" age="99" index="1">

<FirstName>Test1</FirstName><LastName>A</LastName>






InfoTec


<Code type="Comres.Promotion.Code">0009</Code><Code type="Comres.Room.Code">DZX1</Code>








Name></Country>



</Phone><Fax>


</Fax></Communication><HotelCategory id="1008" rating="4">4.0

</HotelCategory></Hotel>

</HotelProduct><RoomType id="2001" code="DZX1 ">

<Description locale="de_DE">Doppelzimmer, gemäßProgramm</Description>


</HotelOfferItem><HotelOfferItem state="available">

<ArrivalDate format="yyyy-MM-dd">2009-05-15</ArrivalDate><Duration>10</Duration><Occupancy numberOfUnits="1" personsPerUnit="1"numberOfPersons="1">

<Participant type="H" age="99" index="0"><FirstName>Test</FirstName><LastName>A</LastName>




InfoTec




<Code type="Comres.Promotion.Code">0009</Code><Code type="Comres.Room.Code">EZL1</Code>








Name></Country>



</Phone><Fax>



</Hotel></HotelProduct><RoomType id="2001" code="EZL1 ">

<Description locale="de_DE">Einzelzimmer, Balkonoder Terasse, Wohnraum</Description>


</HotelOfferItem></OfferItems><Participant type="H" age="99" index="0">

<Salutation>Frau</Salutation><Title>Dr</Title><FirstName>Test</FirstName><LastName>A</LastName><Communication>



InfoTec






</Fax><Mobile>



</Communication><Address>




</Address></Participant><Participant type="D" age="99" index="1">

<Salutation>Miss</Salutation><Title>Fr</Title><FirstName>Test1</FirstName><LastName>A</LastName><Communication>






</Fax><Mobile>







InfoTec



</Address></Participant><Participant type="H" age="99" index="2">

<Salutation>Mr</Salutation><Title>Dr</Title><FirstName>Test2</FirstName><LastName>A</LastName><Communication>






</Fax><Mobile>





<Name locale="de_DE">Berlin</Name></City>

<Country id="1000376" type="Country" code="DE" code2="DEU"><Name locale="de_DE">Deutschland</Name>

</Country></Address>

</Participant></Offer>

</BookingResponse>

Listing 67: Example of a BookingInfoResponse.

12.8.1 Optional bookings for Comres

Comres option bookings work like normal option bookings, except they do expire after a short amount of time (~1 minute). If there is no BookingChangeRequest changing the status to “fix” in this time, the booking will be cancelled.


InfoTec


13 Common tags

This chapter describes common tags, which are frequently used in other tags.

13.1 Address

Address

Tag Type

Mandatory

Description

Street E No Street

StreetNumber E No StreetNumber

CompleteAddress

E No CompleteAddress

Zip E no Zip

City E no City

Country E no Country

Western E no Optional

City

Tag Type

Mandatory

Description

id A yes City Id

type A no City

Name E no Name

Country

Tag Type

Mandatory

Description

id A yes Country Id

type A no Country

code A no Country code

Name E no NameTable 577: The common tag Address.

<Address> <Street>Calle El Rincon</Street> <StreetNumber> 11</StreetNumber> <Zip>35570</Zip> <City id="15907" type="City"> <Name locale="de_DE">Yaiza</Name> </City> <Country id="824" type="Country" code="ES">


InfoTec


<Name locale="de_DE">Spanien</Name> </Country></Address>

Listing 68: Example for an Address.

In some cases where the address is not correctly provided by the Source, it is possible to get the CompleteAddress to reprent the Street and StreetNumber of the Hotel. Currently this is provided for GTA.<Address> <CompleteAddress>Calle El Rincon 11, Yaiza 35570 </CompleteAddress> <Zip>35570</Zip> <City id="15907" type="City"> <Name locale="de_DE">Yaiza</Name> </City> <Country id="824" type="Country" code="ES"> <Name locale="de_DE">Spanien</Name> </Country></Address>

Listing 69: Example for an Address including a CompleteAddress.

13.2 Communication

Communication

Tag Type

Mandatory

Description

Phone E no Phone number

PhoneDayTime E no Phone number during the day

Fax E no Fax

Mobile E no Mobile phone

Email E no Email address

Phone / PhoneDayTime / Fax / Mobile

Tag Typ Mandatory

Description

CountyCode E no Country code

AreaCode E no Area code

Number E no NumberTable 58: The common tag Communication.

<Communication> <Phone> <Number>0190-331331</Number> </Phone> <PhoneDaytime> <AreaCode>0170</AreaCode> <Number>331331</Number> </PhoneDaytime> <Fax> <AreaCode>0180</AreaCode>


InfoTec


<Number>331331</Number> </Fax> <Mobile> <CountryCode>+49</CountryCode> <AreaCode>173</AreaCode> <Number>555 555</Number> </Mobile> <Email>[email protected]</Email></Communication>

Listing 70: Example for a Communication.


InfoTec


14 Mandator specific transactions

14.1 NPM (@comRes)

14.1.1 IRIS HotelSearch

The Terminal element has to be empty.BookingRequestTag Typ

eMandatory

Description

ClientInfo

E yes The offer to book (*CTS)

ClientInfoTag Typ

eMandatory

Description

Terminal E yes Always emptyTable 59: The Terminal tag specific for IRIS HotelSearch.

<ClientInfo> ... <Terminal></Terminal> ...</ClientInfo>

Listing 71: Example for an empty ClientInfo.

14.1.2 IRIS BookingRequest

For Mandator NPM only fix bookings are allowed for IRIS Products. The booking subtype OPTION is not supported, also rebookings are not allowed.Additionally to the common booking request content NPM bookings require an additional ClientBookingCode element in Offer/AccountData In this section, only the NPM specific tags are described.

BookingRequest

Tag Type Mandatory Description

Offer E yes The offer to book (*CTS)

Offer


AccountData E yes (*CTS)


InfoTec


AccountData


ClientBookingCode E yes String value which contains the @comRes Specific client booking code

Table 60: The BookingRequest structure specific for NPM.

<?xml version="1.0" encoding="ISO-8859-1"?><BookingRequest version="1.3" action="fix"> <Head> <Timestamp> <Date format="yyyy-MM-dd">2005-06-23</Date> <Time hour="11" minutes="55" /> </Timestamp> <Session>5507756</Session> <Tracking from="musyk" to="vrp-service" /> </Head> <ClientInfo> <Locale>de_DE</Locale> <Brand>3</Brand> <Agency>53023</Agency> <Terminal> </Terminal> <User>FRIEDRI</User> <TimeZoneOffset>7200000</TimeZoneOffset> </ClientInfo> <Offer confirm="true"> <Source type="IRIS" /> <AccountData> <ProductInfo> <Code type="EXP">0001</Code> </ProductInfo> <ClientBookingCode>31415WDIK</ClientBookingCode> </AccountData> ... </Offer></BookingRequest>

Listing 72: Example for a BookingRequest for IRIS.

14.2 AO WLB

This section contains mandator specific transactions, which currently apply ONLY for the webservice interface of AO WLB (Accomodation Only White Label Brand).

14.2.1 BookingRequest with customer reward program

In the webservice interface of AO WLB it is possible to send additional information of customer reward programs with the booking request. This data is bound to the customer element and looks like the following example.<?xml version="1.0" encoding="ISO-8859-1"?><BookingRequest version="1.3" action="fix"> ... <Customer> ... <RewardsProgram id="1" code="BM">


InfoTec


<Name locale="de_DE">Bluemiles</Name> <Number>1234</Number> </RewardsProgram> ... </Customer> ...</BookingRequest>

Listing 73: Example for a BookingRequest including a RewardsProgram.

Within an occupancy the participant may also include information concerning customer rewards programs:<?xml version="1.0" encoding="utf-8"?><Occupancy index="8377" numberOfPersons="2" numberOfUnits="1" personsPer-Unit="2"> ... <Participant index="1" state="STATE" age="45" type="TYPE"> <RewardsProgram id="1" code="BM"> <Name locale="de_DE">Bluemiles</Name> <Number>1234</Number> </RewardsProgram> ... </Participant> ...</Occupancy>

Listing 74: Example for an Occupancy including a Participant with RewardsProgram.

BookingRequest / Customer

Tag Type

Mandatory

Description

RewardsProgram E No Contains information about a rewards program of the customer that should be considered for this booking.

RewardsProgram

Tag Type

Mandatory

Description

id A No The id of the rewards program

code A No The code of the reward program

Name E No The localised name of the rewards program

Number E Yes The number of the rewards program as String (may contain characters)

Table 61: The RewardsProgram tag specific for AOWLB.

14.2.2 CheckDigits in credit card

The webservice interface also extends the credit card information by the check digit in order to send complete data to a payment provider. Here is an example of how it looks like.<CreditCard code="VI">


InfoTec


<Number>432143214321xxx</Number> <CheckDigits>123</CheckDigits> <ExpirationDate format="yy/MM">13/12</ExpirationDate> <Owner customerId="0179658778"> ... </Owner></CreditCard>

Listing 75: Example for a CreditCard including CheckDigits.

BookingRequest / PaymentData / ActualPayment / CreditCard

Tag Type

Mandatory

Description

CheckDigits E No Contains the check digits of the credit card.

Table 62: The BookingRequest / PaymentData / ActualPayment / CreditCard structure specific for AOWLB.

14.2.3 Additional information in account data

Some brands need to give additional information about the current booking in Hopla, e.g. a global reference number for a bunch of bookings in different reservations systems (e.g. for a flight or a car rental). For this purpose the AccountData tag was extended by an AdditionalInfo tag. Here is an example for the AOWLB SuperPNR that should be contained in the webservice booking response:<Offer confirm="true"> <Source type="IRIS" /> <AccountData> <AdditionalInfo type="aowlb-spnr"> 1000000 </AdditionalInfo> </AccountData> ...</Offer>

Listing 76: Example for an AccountData including AdditionalInfo.

14.3 IRIS Insurance

This section contains specific booking requests for the inventory IRIS including a desired insurance.The InsuranceOfferItem can be set in the BookingInfo- and BookingRequest and can be received in BookingInfo-, Booking- and BookingDetailResponse.An InsuranceOfferItem is part of the whole offer and can only exist in combination with one or more HotelOfferItems. At the moment the insurance can only be for the whole offer (all hotels, all participants). So, specifics to state, ArrivalDate, Duration and Occupancy in the request will be ignored. The only information needed is the ProductKey of the InsuranceProduct.If an InsuranceOfferItem is set in the reqest, it is possible to set the confirm-tag in the offer to true <Offer confirm="true"> to get price informations from the BookingInfoRequest in case of a so called “Zwangsinfo” exist for the IRIS-hotel, too.


InfoTec


InsuranceOfferItem

Tag Type

Mandatory

Description

state A no State of the offer (e.g. available, option)

ArrivalDate E no Date of arrival (*CTS)

Duration E no Duration (number of nights)

Occupancy E no (in response yes)

(*CTS)

Price E no (in response yes)

Price of the InsuracneOfferItem (*CTS)

PriceDetails E no More detailed information about price

ProductInfo E no Source specific informations

InsuranceProduct E yes Insurance productTable 63: The InsuranceOfferItem structure.

An insurance product describes a real insurance hotel object.

InsuranceProduct

Tag Type

Mandatory

Description


ProductName E no Name of the productTable 64: The InsuranceProduct structure.

<Offer> <Source type="IRIS" /> ...

<ArrivalDate format="yyyy-MM-dd">2009-06-02</ArrivalDate> <Duration>7</Duration> <Price currency="EUR">996.0</Price> ... <OfferItems> <HotelOfferItem> ... </HotelOfferItem> <HotelOfferItem> ... </HotelOfferItem> <InsuranceOfferItem> <InsuranceProduct> <ProductKey>RRV</ProductKey> </InsuranceProduct> </InsuranceOfferItem> </OfferItems> <Participant type="H" age="99" index="0" /> <Participant type="D" age="99" index="1" /></Offer>

Listing 77: Example for an InsuranceOfferItem in request (extract).

<Offer>


InfoTec


<Source type="IRIS" /> ...

<ArrivalDate format="yyyy-MM-dd">2009-06-02</ArrivalDate> <Duration>7</Duration> <Price currency="EUR">996.0</Price> ... <OfferItems> <HotelOfferItem> ... </HotelOfferItem> <HotelOfferItem> ... </HotelOfferItem> <InsuranceOfferItem> <Price currency="EUR">24.0</Price> <InsuranceProduct> <ProductKey>RRV</ProductKey> <ProductName>Reiserücktrittskosten-Topschutz ohne Selbstbeh.</Pro-ductName> </InsuranceProduct> <Occupancy index="0" numberOfUnits="1" personsPerUnit="2" numberOfPersons="2"> <Participant type="H" age="99" index="0"> ... <IndividualPrice currency="EUR">12.0</IndividualPrice> <ExternalKey>1</ExternalKey> </Participant> <Participant type="D" age="99" index="1"> ... <IndividualPrice currency="EUR">12.0</IndividualPrice> <ExternalKey>2</ExternalKey> </Participant> </Occupancy> </InsuranceOfferItem> </OfferItems> <Participant type="H" age="99" index="0" /> <Salutation>Herr</Salutation> <FirstName>aaa</FirstName> <LastName>Test</LastName> </Participant> <Participant type="D" age="99" index="0" /> <Salutation>Frau</Salutation> <FirstName>bbb</FirstName> <LastName>Test</LastName> </Participant></Offer>

Listing 78: Example for an InsuranceOfferItem in response (extract).


InfoTec


15 Maintenance

During maintenance periods of the service (e.g. because of deployments or other operational changes) a simple error message is returned instead of the normal service response. The reponse is static and looks like this:<?xml version="1.0" encoding="ISO-8859-1"?><Error version="1.3" code="5"> <Head> <Session>default</Session> <Tracking from="vrp-service" to="tui.de" /> </Head> <Message> Hotel platform: The system is down for maintenance. Please try again later. </Message></Error>

Listing 79: Example for an Error including a maintenance Message.

Maintenance downtimes are announced in advance.


InfoTec


16 Tables

Table 1: Silent offer tags........................................................................................8

Table 2: The OfferItem structure........................................................................10

Table 3: The PriceDetails structure..................................................................11

Table 4: THM new rate model hotel specific tags.................................................11

Table 5: The AppliedRateType and AppliedOfferType structures.....................11

Table 6: The Savings structure............................................................................11

Table 7: The Markup structure..............................................................................11

Table 8: The PriceTO structure............................................................................12

Table 9: The TourOperatorRequest structure.....................................................18

Table 10: The TourOperatorResponse structure.................................................19

Table 11: The HotelSearchRequest XML structure.............................................20

Table 12: The City / Region/GeoGroup structure................................................21

Table 13: HotelProduct and its subordinate structures......................................22

Table 14: The Geocode structure..........................................................................23

Table 15: The IataCode structure........................................................................24

Table 16: The HotelSearchResponse structure.....................................................27

Table 17: The ResultDetails structure..................................................................28

Table 18: The HotelOfferItem structure.............................................................29

Table 19: The PriceDetails structure................................................................29

Table 20: The RoomType structure........................................................................29

Table 21: The MealType and its subordinate structures.......................................30

Table 22: The HotelProduct and its subordinate structures...............................32

Table 23: The RoomTypeVariationRequest and its subordinate structures.........34

Table 24: The RoomTypeVariationResponse structure........................................35

Table 25: The OfferRangeRequest structure.......................................................37

Table 26: The OfferRangeResponse structure.....................................................38

Table 27: The HotelAvailabilityRequest and its subordinate structure..........41

Table 28: The HotelAvailabilityResponse structure........................................43

Table 29: The HotelKeyRequest structure...........................................................48

Table 30: The HotelKeyResponse structure.........................................................49

Table 31: The supported source systems.............................................................55

Table 32: The meta data (ClientInfo) structure for TUI Hotelmanager..............55

Table 33: The meta data (ClientInfo) structure for Pegasus.............................55


InfoTec


Table 34: The meta data (ClientInfo) structure for Ocean................................56

Table 35: The meta data (ClientInfo) structure for IRIS....................................56

Table 36: Table meta data (ClientInfo) structure for GTA.....................................57

Table 37: The meta data (ClientInfo) structure for Hotelbeds..........................57

Table 38: The meta data (ClientInfo) structure for ComRes.............................58

Table 39: The supported functions by CRS (HoPla)..............................................61

Table 40: The BookingRequest structure mandatory for THM..............................63

Table 41: The ProductInfo structure mandatory for THM.....................................63

Table 42: The BookingRequest structure mandatory for Pegasus........................66

Table 43: The ProductInfo XML structure mandatory for Pegasus.....................66

Table 44: The BookingRequest structure mandatory for Ocean...........................70

Table 45: The Offer structure mandatory for Ocean.............................................70

Table 46: The BookingRequest structure mandatory for IRIS...............................72

Table 47: The Offer structure mandatory for IRIS.................................................73

Table 48: The Customer / Address / Country structure mandatory for IRIS..........73

Table 49: The Customer / Address / Country structure mandatory for IRIS..........73

Table 50: The BookingRequest structure mandatory for GTA..............................75

Table 51: The Offer structure mandatory for GTA................................................75

Table 52: The BookingRequest structure mandatory for Hotelbeds.....................77

Table 53: The Offer structure mandatory for Hotelbeds.......................................77

Table 54: Booking Amendments for Hotelbeds....................................................83

Table 55: The BookingRequest structure mandatory for ComRes........................83

Table 56: The ProductInfo structure mandatory for ComRes................................83

Table 57: The common tag Address.....................................................................94

Table 58: The common tag Communication.........................................................95

Table 59: The Terminal tag specific for IRIS HotelSearch.....................................96

Table 60: The BookingRequest structure specific for NPM...................................97

Table 61: The RewardsProgram tag specific for AOWLB......................................98

Table 62: The BookingRequest / PaymentData / ActualPayment / CreditCard structure specific for AOWLB................................................................................99

Table 63: The InsuranceOfferItem structure.....................................................99

Table 64: The InsuranceProduct structure.......................................................100


InfoTec


17 Listings

Listing 1: Example for an Offer and an OfferItem (Hotelportal-Service, extract).9

Listing 2: Example for an Offer and an OfferItem for a THM new rate model hotel..................................................................................................................... 10

Listing 3: Example for PriceDetails including markups.....................................12

Listing 4: Example for a MealTypeRequest..........................................................13

Listing 5: Example for a MealTypeResponse (extract)..........................................15

Listing 6: Example for a HotelChainRequest.......................................................15

Listing 7: Example HotelChainResponse (extract)..............................................16

Listing 8: Example for a HotelTypeRequest........................................................16

Listing 9: Example HotelTypeResponse (extract)................................................17

Listing 10: Example for a HotelCategoryRequest...............................................18

Listing 11: Example for a HotelCategoryResponse.............................................18

Listing 12: Example for a TourOperatorRequest.................................................19

Listing 13: Corresponding TourOperatorResponse to the example request in Listing 12..............................................................................................................19

Listing 14: Example for an ArricalDate..............................................................20

Listing 15: Example for a Duration......................................................................20

Listing 16: Example for an Occupancy..................................................................21

Listing 17: Example for a multi occupancy...........................................................21

Listing 18: Example for a City and a Region.......................................................21

Listing 19: Example for a HotelProduct..............................................................22

Listing 20: Example for a HotelSearchRequest with geo search.........................23

Listing 21: Example for a HotelSearchRequest with IATA code search...............24

Listing 22: Example for limiting a search by a time limit......................................26

Listing 23: Example for limiting a search by a maximum number of offers.........26

Listing 24: Example for limiting a search by ranking offer sources......................26

Listing 25: Example for using bookmarks in search requests...............................26

Listing 26: Example of a complete HotelSearchRequest....................................27

Listing 27: Example for a HotelSearchResponse.................................................28

Listing 28: Example for ResultDetails...............................................................28

Listing 29: Example for a HotelOfferItem..........................................................31

Listing 30: Example for a HotelProduct..............................................................33

Listing 31: Example for a RoomTypeVariationsRequest.....................................35

Listing 32: Example for a RoomyTypeVariationsResponse..................................36


InfoTec


Listing 33: Example for an OfferRangeRequest...................................................38

Listing 34: Example for an OfferRangeResponse.................................................40

Listing 35: Example for a HotelAvailabilityRequest.......................................42

Listing 36: Example for a HotelAvailabilityResponse.....................................46

Listing 37: Example for a HotelKeyRequest........................................................49

Listing 38: Example for a HotelKeyResponse with exactly one result..................49

Listing 39: Example for a HotelKeyResponse if more than one result is found....50

Listing 40: Example for a HotelKeyResponse with no results found....................50

Listing 41: Setting the detail level........................................................................51

Listing 42: Example of the Hotel tag within the HotelProduct tag.....................51

Listing 43: Example of a QuickSearch tag...........................................................51

Listing 44: Example for a HotelDetailRequest...................................................52

Listing 45: Example for a HotelDetailResponse (extract)..................................54

Listing 46: Example for a meta data structure for Ocean.....................................56

Listing 47: Example for meta data for IRIS...........................................................56

Listing 48: Example for meta data for GTA..........................................................57

Listing 49: Example for meta data for Hotelbeds.................................................57

Listing 50: Example for meta data for Comres.....................................................58

Listing 51: Example for a ProductInfo including the is.packaging.rate flag.. 63

Listing 52: Example for a BookingInfoRequest...................................................64

Listing 53: Example of a BookingInfoResponse..................................................65

Listing 54: Example for a ProductInfo including Pegasus flags..........................66

Listing 55: Example for a valid Participant.......................................................67

Listing 56: Example for a BookingInfoRequest...................................................68

Listing 57: Example for a BookingInfoResponse.................................................70

Listing 58: Example for a ProductInfo including Ocean flags.............................70

Listing 59: Example for a BookingRequest for Ocean..........................................72

Listing 60: Example for a BookingRequest for IRIS..............................................75

Listing 61: Example for a BookingRequest for GTA.............................................77

Listing 62: Example for a BookingRequest for HotelBeds....................................79

Listing 63: Example for a Hint in the BookingResponse......................................79

Listing 64: Example for a ProductInfo including supplier and payment information...........................................................................................................79

Listing 65: Example for a ProductInfo...............................................................84

Listing 66: Example for a BookingRequest..........................................................88

Listing 67: Example of a BookingInfoResponse..................................................93


InfoTec


Listing 68: Example for an Address.....................................................................94

Listing 69: Example for an Address including a CompleteAddress......................95

Listing 70: Example for a Communication............................................................95

Listing 71: Example for an empty ClientInfo.....................................................96

Listing 72: Example for a BookingRequest for IRIS..............................................97

Listing 73: Example for a BookingRequest including a RewardsProgram.............98

Listing 74: Example for an Occupancy including a Participant with RewardsProgram...................................................................................................98

Listing 75: Example for a CreditCard including CheckDigits.............................98

Listing 76: Example for an AccountData including AdditionalInfo...................99

Listing 77: Example for an InsuranceOfferItem in request (extract)...............100

Listing 78: Example for an InsuranceOfferItem in response (extract).............101

Listing 79: Example for an Error including a maintenance Message.................102


CTS Service Interface Hotel Platform 1 39

Documents

Transcript of CTS Service Interface Hotel Platform 1 39