Search Hotel Rooms Price

This module has now been phased out and will no longer be supported.

The Search Hotel Rooms Price Request provides the client with the ability to search for and price available hotel rooms through the API, receiving the price and availability for each room type within each hotel. All requests will need to be sent in a SYNCHRONOUS mode; any requests send in an ASYNCHRONOUS mode will return an error.

This search can ONLY be used by clients on participation level 0. Please note this search will be unavailable to all new clients.

Example XML Search Hotel Rooms Price request

The XML message below gives a sample of the expected elements needed by the API to execute a Search Hotel Rooms Price Request.

<?xml version="1.0" encoding="UTF-8" ?>
<Request>
	<Source>
		<RequestorID Client="1479" EMailAddress="client@net.com" Password="xxx" />
		<RequestorPreferences Language="en" Currency="GBP" Country="GB">
			<RequestMode>SYNCHRONOUS</RequestMode>
		</RequestorPreferences>
	</Source>
	<RequestDetails>
		<SearchHotelRoomsPriceRequest>
			<ItemDestination DestinationType="city" DestinationCode="AMS" />
			<ImmediateConfirmationOnly />
			<PeriodOfStay>
				<CheckInDate>2007-09-30</CheckInDate>
				<Duration>4</Duration>
			</PeriodOfStay>
                    <IncludeRecommended/>
			<StarRating MinimumRating="true">3</StarRating>
			<LocationCode>G1</LocationCode>
			<FacilityCodes>
				<FacilityCode>*SO</FacilityCode>
				<FacilityCode>*TE</FacilityCode>
			</FacilityCodes>
		</SearchHotelRoomsPriceRequest>
	</RequestDetails>
</Request>

Source parameters

Please refer to the API Architecture document.

Search Hotel Rooms Price attributes/parameters

A Search Hotel Rooms Price request can contain attributes/parameters to filter the hotels returned.

The request can contain the following attributes/parameters:

Parameters	Description
ItemDestination	Mandatory. Used to return all items within the specified destination type (“area” or “city”) and destination code.
ImmediateConfirmationOnly	Optional. If present the response will contain results available only for immediate confirmation.
ItemName	Optional. If specified all items containing the given characters will be returned. Note: Item names are not case sensitive.
ItemCode	Optional. If specified the details for the single code will be returned.
PeriodOfStay	Mandatory. Defines the check-in day and either the check-out day or the duration of stay (see below for further details).
IncludeRecommended	Optional. If specified GTA recommended hotels will be indicated.
RecommendedOnly	Optional. If specified only GTA recommended hotels will be returned.
StarRating	Optional. Defines the star rating of the hotel. A match or a minimum value can be specified (see below for further details).
	Attribute	Description
	MinimumRating	If set to “true” it will return all hotels for the specified star rating and higher. If set to “false” or omitted will return all hotels for the specified star rating only.
LocationCode	Optional. Used to return all items within the specified location code.
FacilityCodes	Optional. A list of <FacilityCode> elements specifying requested facilities at the hotel, e.g. swimming pool, tennis courts etc.

PeriodOfStay parameter

The following gives a list of sub-elements for a PeriodOfStay sub-element:

Element	Description
CheckInDate	Specifies the date of check in.
CheckOutDate or Duration	Specifies the date of check out OR the duration of stay.

StarRatingRange parameter

The client can request the StarRatingRange parameter instead of the StarRating parameter. These two parameters cannot work in conjunction.

An example of a <StarRatingRange> is shown below:

<StarRatingRange>
    <Min>1</Min>
    <Max>3</Max>
</StarRatingRange>

Example XML Search Hotel Price response

The XML message below gives a sample of that given by the API in response to a Search Hotel Rooms Price Request.

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference = "REF_123_1155719151401">
    <ResponseDetails Language = "en">
        <SearchHotelRoomsPriceResponse>
            <HotelDetails>
                <Hotel
                    HasExtraInfo = "true"
                    HasMap = "true"
                    HasPictures = "true">
                    Recommended = "true">
                    <City Code = "WARW"><![CDATA[ Warwick ]]></City>
                    <Item Code = "EXP"><![CDATA[ EXPRESS BY HOLIDAY INN ]]></Item>
                    <LocationDetails>
                        <Location Code = "G1"><![CDATA[ Central  ]]></Location>
                    </LocationDetails>
                    <StarRating>5</StarRating>
                    <HotelRoomPrices>
                        <HotelRoom Code = "TB" Description = "Twin">
                            <RoomPrice Gross = "180.00" Currency = "USD"/>
                            <Confirmation Code = "IM"><![CDATA[ AVAILABLE ]]></Confirmation>
                        </HotelRoom>
                        <HotelRoom Code = "DB" Description = "Double">
                            <RoomPrice Gross = "180.00" Currency = "USD"/>
                            <Confirmation Code = "IM"><![CDATA[ AVAILABLE ]]></Confirmation>
                        </HotelRoom>
                        <HotelRoom
                            Code = "CH"
                            Description = "Child"
                            FromAge = "2"
                            SharingBedding = "false"
                            ToAge = "5">
                            <RoomPrice Gross = "80.00" Currency = "USD"/>
                            <Confirmation Code = "OR"><![CDATA[ On Request]]></Confirmation>
                        </HotelRoom>
                        <HotelRoom
                            Code = "CH"
                            Description = "Child"
                            FromAge = "6"
                            SharingBedding = "false"
                            ToAge = "18">
                            <RoomPrice Gross = "180.00" Currency = "USD"/>
                            <Confirmation Code = "OR"><![CDATA[ On Request]]></Confirmation>
                        </HotelRoom>
                        <HotelRoom Code = "CT" Description = "Cot">
                            <RoomPrice Gross = ".00" Currency = "USD"/>
                            <Confirmation Code = "OR"><![CDATA[ On Request]]></Confirmation>
                        </HotelRoom>
                    </HotelRoomPrices>
                    <Meals>
                        <Basis Code = "B"><![CDATA[ Breakfast included ]]></Basis>
                        <Breakfast Code = "H"><![CDATA[ Hot Buffet ]]></Breakfast>
                    </Meals>
                    <EssentialInformation>
                        <Information>
                            <Text><![CDATA[Complimentary dinner provided. ]]></Text>
                            <DateRange>
                                <FromDate>0001-01-01</FromDate>
                                <ToDate>9999-12-31</ToDate>
                            </DateRange>
                        </Information>
                    </EssentialInformation>
                </Hotel>
                <Hotel
                    HasExtraInfo = "true"
                    HasMap = "true"
                    HasPictures = "true">
                    <City Code = "WARW"><![CDATA[ Warwick ]]></City>
                    <Item Code = "HIL"><![CDATA[ HILTON]]></Item>
                    <LocationDetails>
                        <Location Code = "G9"><![CDATA[ Near Center ]]></Location>
                    </LocationDetails>
                    <StarRating>4</StarRating>
                    <HotelRoomPrices>
                        <HotelRoom Code = "TB" Description = "Twin">
                            <RoomPrice
                                Gross = "180.00"
                                Currency = "USD"
                                GrossWithoutDiscount = "240.00"
                                IncludedOfferDiscount = "60.00"/>
                            <Confirmation Code = "IM"><![CDATA[ AVAILABLE ]]></Confirmation>
                        </HotelRoom>
                        <HotelRoom Code = "DB" Description = "Double">
                            <RoomPrice
                                Gross = "180.00"
                                Currency = "USD"
                                GrossWithoutDiscount = "240.00"
                                IncludedOfferDiscount = "60.00"/>
                            <Confirmation Code = "IM"><![CDATA[ AVAILABLE ]]></Confirmation>
                        </HotelRoom>
                        <HotelRoom
                            Code = "CH"
                            Description = "Child"
                            FromAge = "2"
                            SharingBedding = "false"
                            ToAge = "5">
                            <RoomPrice
                                Gross = "80.00"
                                Currency = "USD"
                                GrossWithoutDiscount = "100.00"
                                IncludedOfferDiscount = "20.00"/>
                            <Confirmation Code = "OR"><![CDATA[ On Request]]></Confirmation>
                        </HotelRoom>
                        <HotelRoom
                            Code = "CH"
                            Description = "Child"
                            FromAge = "6"
                            SharingBedding = "false"
                            ToAge = "18">
                            <RoomPrice
                                Gross = "180.00"
                                Currency = "USD"
                                GrossWithoutDiscount = "240.00"
                                IncludedOfferDiscount = "60.00"/>
                            <Confirmation Code = "OR"><![CDATA[ On Request]]></Confirmation>
                        </HotelRoom>
                        <HotelRoom Code = "CT" Description = "Cot">
                            <RoomPrice Gross = ".00" Currency = "USD"/>
                            <Confirmation Code = "OR"><![CDATA[ On Request]]></Confirmation>
                        </HotelRoom>
                    </HotelRoomPrices>
                    <Meals>
                        <Basis Code = "B"><![CDATA[ Breakfast included ]]></Basis>
                        <Breakfast Code = "H"><![CDATA[ Hot Buffet ]]></Breakfast>
                    </Meals>
                    <Offer Code = "FNT"><![CDATA[ Free Night(s) ]]></Offer>
                    <EssentialInformation>
                        <Information>
                            <Text><![CDATA[Complimentary dinner provided. ]]></Text>
                            <DateRange>
                                <FromDate>0001-01-01</FromDate>
                                <ToDate>9999-12-31</ToDate>
                            </DateRange>
                        </Information>
                    </EssentialInformation>
                </Hotel>
            </HotelDetails>
        </SearchHotelRoomsPriceResponse>
    </ResponseDetails>
</Response>

Search Hotel Rooms Price response parameters

The <HotelDetails> element can have zero or more <Hotel> sub-elements. Each <Hotel> element can have the following attributes/parameters:

Attribute	Description
HasExtraInfo	If set to 'true' there is a report available for the hotel that can be retrieved through a SearchItemInformationRequest.
HasMap	If set to 'true' a local map for the hotel is available that can be retrieved through a SearchItemInformationRequest or a SearchLinkRequest.
HasPictures	If set to 'true' there are pictures available for the hotel that can be retrieved through the a SearchItemInformationRequest or a SearchLinkRequest.
Recommended	If set to ‘true’ the hotel returned will be a GTA recommended hotel.

Parameter	Description
City	The city name in the language requested (if available).
	Attribute	Description
	Code	The unique city code held by GTA

Parameter	Description
Item	The item name.
	Attribute	Description
	Code	The unique item code held by GTA

Parameter	Description
LocationDetails	A list of locations held for the item (see below for further details).
StarRating	The hotel’s star rating.
HotelRoomPrices	A list of hotel room types for the item (see below for further details).
Meals	Describes the meal basis for the stay and the type of breakfast (see below for further details).

Parameter	Description
Offer	The offer name.
	Attribute	Description
	Code	The unique offer code held by GTA

Parameter	Description
EssentialInformation	The collection of <Information> tags for the item (see below for further details).

LocationDetails parameters

The following gives a list of attributes and sub-elements for a LocationDetails parameter:

Parameter	Description
Location	The location name in the language requested (if available).
	Attribute	Description
	Code	The unique location code held by GTA

Hotel Room parameters

The following gives a list of sub-elements for a HotelRoom parameter:

Attribute	Description
Code	Room Code held by GTA.
Description	The description of the room code in the language requested (if available)
FromAge	The minimum child age the price applies to.
SharingBedding	Specifies if the child shares existing bedding. If “true” the child will be sharing existing bedding. If “false” the child will be provided with an extra bed.
ToAge	The maximum child age the price applies to.

Parameter	Description
RoomPrice	The price details of the stay (see below for further details).
	Attribute	Description
	Currency	The ISO currency code of the currency in which the RoomPrice, GrossWithoutDiscount and the IncludedOfferDiscount are returned in.
	Gross	The total price of the stay.
	GrossWithoutDiscount	The gross price without the discount being deducted.
	IncludedOfferDiscount	The discount that is being applied to the gross price.

Parameter	Description
Confirmation	Whether the specific room type in the specific hotel is available immediately or on request.

Meals parameters

The following gives a list of sub-elements for a Meals parameter:

Parameter	Description
Basis	The meal basis description in the language requested (if available).
	Attribute	Description
	Code	Specifies the unique GTA meal basis code

Parameter	Description
Breakfast	The breakfast description in the language requested (if available).
	Attribute	Description
	Code	Specifies the unique GTA breakfast code

Essential Information parameters

The following gives a list of sub-elements for an EssentialInformation parameter:

Element	Description
Information	Contains text and the date range it is applicable to
Text	The essential information description. In the language requested (if available).
DateRange	The FromDate and ToDate for the Essential Information.

version 11 as of 9 months ago by WW Technical Support