Search Hotel Price Pax

The Search Hotel Price Pax provides the client with the ability to search for and price available hotel rooms through the API.  All requests will need to be sent in a SYNCHRONOUS mode; any requests send in an ASYNCHRONOUS will return an error.

This request is only available for clients on Participation Level 2.

If this request is used the AddBookingRequest  must be adjusted to be based on pax number. 

Example XML Search Hotel Price Pax request

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

<Request>
  <Source>
    <RequestorID Client="1479" EMailAddress="client@net.com" Password="xxx"/>
    <RequestorPreferences Country="GB" Currency="GBP" Language="en">
      <RequestMode>SYNCHRONOUS</RequestMode>
    </RequestorPreferences>
  </Source>
<RequestDetails>
    <SearchHotelPricePaxRequest>
      <ItemDestination DestinationCode = "NCE" DestinationType = "city"/>
  <ItemCodes>      
     <ItemCode>ACO</ItemCode>
      <ItemCode>BEL</ItemCode>
      <ItemCode>COM</ItemCode>
   </ItemCodes>
      <PeriodOfStay>
        <CheckInDate>2014-08-12</CheckInDate>
        <Duration>2</Duration>
      </PeriodOfStay>
      <IncludePriceBreakdown/>
      <IncludeChargeConditions/>
      <PaxRooms>
        <PaxRoom Adults="2" Cots="0" RoomIndex="1"/>
      </PaxRooms>     
    </SearchHotelPricePaxRequest>
  </RequestDetails>
</Request>

Table 1.a. Hotel price pax search request for multiple item codes

 

<Request>
    <Source>
        <RequestorID
            Client = "1479"
            EMailAddress = "client@net.com"
            Password = "xxx"/>
        <RequestorPreferences
            Country = "GB"
            Currency = "GBP"
            Language = "en">
            <RequestMode>SYNCHRONOUS</RequestMode>
        </RequestorPreferences>
    </Source>
    <RequestDetails>
        <SearchHotelPricePaxRequest>
            <ItemDestination DestinationCode = "NCE" DestinationType = "city"/>
            <ItemCode>ACA</ItemCode>
            <PeriodOfStay>
                <CheckInDate>2014-08-12</CheckInDate>
                <Duration>2</Duration>
            </PeriodOfStay>
            <IncludePriceBreakdown/>
            <IncludeChargeConditions/>
            <ShowPackageRates/>
            <MealBasisCodes>
                <MealBasis>N</MealBasis>
            </MealBasisCodes>
            <PaxRooms>
                <PaxRoom
                    Adults = "2"
                    Cots = "0"
                    RoomIndex = "1"/>
            </PaxRooms>
        </SearchHotelPricePaxRequest>
    </RequestDetails>
</Request>

 

Table 1.b. Hotel price pax search request at item level

<Request>
    <Source>
        <RequestorID
            Client = "1478"
            EMailAddress = "client@net.com"
            Password = "xxx"/>
        <RequestorPreferences
            Country = "GB"
            Currency = "EUR"
            Language = "en">
            <RequestMode>SYNCHRONOUS</RequestMode>
        </RequestorPreferences>
    </Source>
    <RequestDetails>
        <SearchHotelPricePaxRequest>
            <ItemDestination
                DestinationType = "geocode"
                Latitude = "35.009118"
                Longitude = "135.788068"
                RadiusKm = "5"/>
            <PeriodOfStay>
                <CheckInDate>2014-08-12</CheckInDate>
                <Duration>2</Duration>
            </PeriodOfStay>
            <IncludePriceBreakdown/>
            <IncludeChargeConditions/>
            <PaxRooms>
                <PaxRoom
                    Adults = "2"
                    Cots = "0"
                    RoomIndex = "1"/>
            </PaxRooms>
        </SearchHotelPricePaxRequest>
    </RequestDetails>
</Request>

Table 1.c. Hotel price pax search request by geocode

<Request>
    <Source>
        <RequestorID
            Client = "1479"
            EMailAddress = "client@net.com"
            Password = "xxx"/>
        <RequestorPreferences
            Country = "GB"
            Currency = "EUR"
            Language = "en">
            <RequestMode>SYNCHRONOUS</RequestMode>
        </RequestorPreferences>
    </Source>
    <RequestDetails>
        <SearchHotelPricePaxRequest>
            <ItemDestination
                DestinationType = "geocode"
                WestLongitude = "-0.92"
                SouthLatitude = "51.52"
                EastLongitude = "-0.1"
                NorthLatitude = "51.53"/>
            <PeriodOfStay>
                <CheckInDate>2014-08-12</CheckInDate>
                <Duration>2</Duration>
            </PeriodOfStay>
            <IncludePriceBreakdown/>
            <IncludeChargeConditions/>
            <PaxRooms>
                <PaxRoom
                    Adults = "2"
                    Cots = "0"
                    RoomIndex = "1"/>
            </PaxRooms>
        </SearchHotelPricePaxRequest>
    </RequestDetails>
</Request>

Table 1.d. Hotel price pax search request by bounding box

Source parameters

Please refer to the API Architecture document.

Search Hotel Price Pax attributes/parameters

A Search Hotel Price Pax 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 (“city” or “geocode”) and destination code.

ImmediateConfirmationOnly

Optional. If present the response will contain results available only for immediate confirmation.

 

Attribute

Description

 

DestinationCode

Mandatory. Define the GTA city when destination type is “city”

 

Latitude

Mandatory in conjunction with Longitude and RadiusKM  when destination type is “geocode”. 

 

Longitude

Mandatory in conjunction with Latitude and RadiusKM  when destination type is “geocode”. 

 

RadiusKm

Mandatory in conjunction with Longitude and Latitude when  destination type is “geocode”.

Defines the area around the geocode to form a virtual circle in Kilometers. Value can be 0 to 100.

 

WestLongitude

Mandatory in conjunction with SouthLatitude, EastLongitude and NorthLatitude when destination type is “geocode”. 

 

SouthLatitude

Mandatory in conjunction with WestLongitude, EastLongitude and NorthLatitude when destination type is “geocode”. 

 

EastLongitude

Mandatory in conjunction with WestLongitude, SouthLatitude and NorthLatitude when destination type is “geocode”. 

 

NorthLatitude

Mandatory in conjunction with WestLongitude, SouthLatitude  and EastLongitude when destination type is “geocode”. 

ItemName

Optional. If specified all items containing the given characters will be returned.

ItemCodes

Optional. A collection of one or more ItemCode parameters.

ItemCode

Optional. If specified, the details for the single code will be returned. Please remember that GTA uses item codes that are unique only in conjunction with the city codes.

PeriodOfStay

Mandatory. Defines the check-in day and either the check-out day or the duration of stay.

IncludeRecommended

Optional. If specified GTA recommended hotels will be indicated.

RecommendedOnly

Optional. If specified only GTA recommended hotels will be returned.

IncludePriceBreakdown

Optional. If specified the price breakdown information will be returned for each room category within an item.

IncludeChargeConditions

Optional. If specified the charge conditions will be returned.

 

Attribute

Description

 

DateFormatResponse

If set to “true”, the charge conditions will be returned in date format; if not specified the charge conditions will be returned in days prior to arrival format.

ExcludeChargeableItems

Optional. If specified, the response will exclude the properties that are within the <CancellationDeadlineHours> or <CancellationDeadlineDays> from arrival.

ShowPackageRates Optional. If specified, the response will return an attribute which advise if the rate plan is a package rate or not.
MealBasisCodes Optional. A collection of one MealBasis parameter.
MealBasisCodes Optional. If specified, only rates with the requested meal basis will be returned.

PaxRooms

Mandatory. A list of the requested hotel rooms, with information on the number of Adults, Children ages, number of cots and room index.

 

Attribute

Description

PaxRoom

Mandatory.  Defines the number of Adult, Child ages, number of cots and room index.

StarRatingRange

Optional. Defines the star rating of the hotel. A match can be specified.

 

Attribute

Description

Min

Mandatory.  Minimum star rating

 

Max

Mandatory.  Maximum star rating

ExcludeChargeableItems parameter

The client can request to exclude from the response all the properties that are within the <CancellationDeadlineHours> or <CancellationDeadlineDays> specified in the SearchHotelPriceRequest. These two parameters cannot work in conjunction.

An example of a < ExcludeChargeableItems> is shown below:

<ExcludeChargeableItems>
    <CancellationDeadlineDays>5</CancellationDeadlineDays>
</ExcludeChargeableItems>

PaxRooms parameter

The client can request a number of rooms through the <PaxRooms> element. The latter is made up of a list of <PaxRoom> sub-elements, one element for each different requested room type.

An example of a <PaxRoom> element, for one room for two Adults with one extra cot and a child aged 6, is shown below:

<PaxRooms>
    <PaxRoom
        Adults = "2"
        Cots = "1"
        RoomIndex = "1">
        <ChildAges>
            <Age>6</Age>
        </ChildAges>
    </PaxRoom>
</PaxRooms>

The <PaxRoom> element can contain an Id attribute which is used to specify the room category.

The Id attribute can be used in conjunction with DestinationType = "city":

<Request>
    <Source>
        <RequestorID Client = "2556" EMailAddress = "TEST@APITEST.COM" Password = "PASS"/>
        <RequestorPreferences Country = "GB" Currency = "EUR" Language = "en">
            <RequestMode>SYNCHRONOUS</RequestMode>
        </RequestorPreferences>
    </Source>
    <RequestDetails>
<SearchHotelPricePaxRequest>
      <ItemDestination DestinationCode = "NCE" DestinationType = "city"/>
      <ItemCode>ACA</ItemCode>
      <PeriodOfStay>
        <CheckInDate>2014-08-12</CheckInDate>
        <Duration>2</Duration>
      </PeriodOfStay>
      <IncludePriceBreakdown/>
      <IncludeChargeConditions/>
      <PaxRooms>
        <PaxRoom Adults="2" Id = "001:ACA:1508:S388:497:28192"  Cots="0" RoomIndex="1"/>
      </PaxRooms>     
    </SearchHotelPricePaxRequest>
  </RequestDetails>
</Request>

Example XML Search Hotel Price Pax responses

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

 

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference = "REF_T_004_2556-401395251460033">
    <ResponseDetails Language = "en">
        <SearchHotelPricePaxResponse>
            <HotelDetails>
                <Hotel HasExtraInfo = "true" HasMap = "true" HasPictures = "true">
                    <City Code = "LON">
                        <![CDATA[London]]>
                    </City>
                    <Item Code = "ADM">
                        <![CDATA[Admiral]]>
                    </Item>
                    <LocationDetails>
                        <Location Code = "G1">
                            <![CDATA[Central]]>
                        </Location>
                        <Location Code = "08">
                            <![CDATA[Paddington]]>
                        </Location>
                    </LocationDetails>
                    <StarRating>5</StarRating>
                    <PaxRoomSearchResults>
                        <PaxRoom RoomIndex = "1">
                            <RoomCategories>
                                <RoomCategory Id = "001:ADM:4740:S2111:3274:27680">
                                    <Description>
                                        <![CDATA[Comfort King]]>
                                    </Description>
                                    <ItemPrice CommissionIndicator = "STD" 
			           CommissionPercentage = "10.00" 
			           Currency = "GBP" PackageRate="false">21.50</ItemPrice>
                                    <Confirmation Code = "OR">
                                        <![CDATA[On Request]]>
                                    </Confirmation>
                                    <Meals>
                                        <Basis Code = "B">
                                            <![CDATA[Breakfast]]>
                                        </Basis>
                                        <Breakfast Code = "F">
                                            <![CDATA[Full]]>
                                        </Breakfast>
                                    </Meals>
                                    <HotelRoomPrices>
                                        <HotelRoom>
                                            <RoomPrice Gross = "21.50"/>
                                            <PriceRanges>
                                                <PriceRange>
                                                    <DateRange>
                                                        <FromDate>2014-04-23</FromDate>
                                                        <ToDate>2014-04-24</ToDate>
                                                    </DateRange>
                                                    <Price Gross = "10.75" Nights = "2"/>
                                                </PriceRange>
                                            </PriceRanges>
                                        </HotelRoom>
                                    </HotelRoomPrices>
                                    <EssentialInformation>
                                        <Information>
                                            <Text>
                                                <![CDATA[Complimentary 5 course dinner provided.]]>
                                            </Text>
                                            <DateRange>
                                                <FromDate>2013-12-03</FromDate>
                                                <ToDate>9999-12-31</ToDate>
                                            </DateRange>
                                        </Information>
                                    </EssentialInformation>
                                    <ChargeConditions>
                                        <ChargeCondition Type = "cancellation">
                                            <Condition Charge = "true" 
				     ChargeAmount = "21.50" 
				     Currency = "GBP" 
				     FromDay = "0" 
				     ToDay = "18"/>
                                            <Condition Charge = "false" FromDay = "19"/>
                                        </ChargeCondition>
                                        <ChargeCondition Allowable = "false" Type = "amendment"/>
                                        <PassengerNameChange Allowable = "true"/>
                                    </ChargeConditions>
                                </RoomCategory>
                                <RoomCategory Id = "001:ADM:4740:S2111:18421:7926">
                                    <Description>
                                        <![CDATA[Standard Double]]>
                                    </Description>
                                    <ItemPrice CommissionIndicator = "STD" 
			            CommissionPercentage = "10.00"
			            Currency = "GBP">133.00</ItemPrice>
                                    <Confirmation Code = "OR">
                                        <![CDATA[On Request]]>
                                    </Confirmation>
                                    <Meals>
                                        <Basis Code = "N">
                                            <![CDATA[None]]>
                                        </Basis>
                                    </Meals>
                                    <HotelRoomPrices>
                                        <HotelRoom>
                                            <RoomPrice Gross = "133.00"/>
                                            <PriceRanges>
                                                <PriceRange>
                                                    <DateRange>
                                                        <FromDate>2014-04-23</FromDate>
                                                        <ToDate>2014-04-24</ToDate>
                                                    </DateRange>
                                                    <Price Gross = "66.50" Nights = "2"/>
                                                </PriceRange>
                                            </PriceRanges>
                                        </HotelRoom>
                                    </HotelRoomPrices>
                                    <EssentialInformation>
                                        <Information>
                                            <Text>
                                                <![CDATA[Complimentary 5 course dinner provided.]]>
                                            </Text>
                                            <DateRange>
                                                <FromDate>2013-12-03</FromDate>
                                                <ToDate>9999-12-31</ToDate>
                                            </DateRange>
                                        </Information>
                                    </EssentialInformation>
                                    <ChargeConditions>
                                        <ChargeCondition Type = "cancellation">
                                            <Condition Charge = "true" 
				     ChargeAmount = "133.00" 
				     Currency = "GBP" 
				     FromDay = "0" 
				     ToDay = "0"/>
                                                 <Condition Charge = "true" 
				     ChargeAmount = "66.50" 
				     Currency = "GBP" 
				     FromDay = "1" 
				     ToDay = "6"/>
                                            <Condition Charge = "false" FromDay = "7"/>
                                        </ChargeCondition>
                                        <ChargeCondition Allowable = "false" Type = "amendment"/>
                                        <PassengerNameChange Allowable = "true"/>
                                    </ChargeConditions>
                                </RoomCategory>
                            </RoomCategories>
                        </PaxRoom>
                    </PaxRoomSearchResults>
                </Hotel>
            </HotelDetails>
        </SearchHotelPricePaxResponse>
    </ResponseDetails>
</Response>

 

 

Table 1a. Hotel price pax search response – including Charge Conditions and price breakdown information

Search Hotel Price Pax 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

 

Item

The item name.

 

Attribute

Description

 

Code

The unique item code held by GTA, unique only in conjunction with the GTA city code.

 

LocationDetails

A list of locations held for the item (see below).

StarRating

The hotel’s star rating.

 

PaxRoomSearchResults

The results of the Pax and Rooms search

 

Attribute

Description

 

PaxRoom

The results of the Pax and Rooms search

 

RoomIndex

The room to which the results relate


The price related details includes the following as a list of <RoomCategory> sub-elements within a <RoomCategories> element: 

Id

 Specifies the category of room.

Description

Describes the room category.

ItemPrice

The total price of the stay.

 

Attribute

Description

 

Currency

The ISO currency code of the currency in which the ItemPrice, GrossWithoutDiscount price and the IncludedOfferDiscount are returned in.

 

 

CommissionIndicator

For clients receiving commissionable prices this indicates the level of commission given for a specific property. Can be “LOW”, “STD” or “HIGH”.

 

CommissionPercentage

The commission percentage applied to the item price.

 

NoOfferDiscount

If returned as “true” no discounts or free night offers apply.

 

IncludedOfferDiscount

The discount that is being applied to the gross price.

 

RSP

The Recommended Selling Price as advised by the hotel.

PackageRate

Specifies if the rate plan is a package rate or not. Package rates have to be sold together with other travel products and the client has the obligation to do so. Possible values are:

“true” – rate plan is a package rate

“false” – rate plan is not a package rate

 

Confirmation

Whether the requested room(s) are available immediately or on request.

 

Attribute

Description

 

Code

The unique code held by GTA (currently only ‘IM’ or ‘OR’)

 

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.

Meals

Describes the meal basis for the stay and the type of breakfast.


The price related details include the following if the parameter <IncludePriceBreakdown\> has been specified in the <SearchHotelPricePaxRequest>: 

Parameter

Description

HotelRoomPrices

A collection of one or more HotelRoom parameters.

HotelRoom

Specifies price details for one or more room codes.

RoomPrice

The price of the room code.

 

Attribute

Description

 

Gross

Indicates that the price is a gross price.

PriceRanges

A collection of one or more PriceRange parameters.

PriceRange

A collection of one or more DateRange parameters.

DateRange

The date range which the price is valid for.

FromDate

Indicates which date the price is valid from.

ToDate

Indicates which date the price is valid to.

Price

Indicates the nightly price for the dates specified in the date range.

 

Attribute

Description

 

Gross

Indicates that the price is a gross price. 

 

Nights

Specifies the number of nights the price is applied for.

Offer

The offer name.

 

Attribute

Description

 

Code

The unique offer code held by GTA

EssentialInformation

The collection of <Information> tags for the item.  Contains text and the date range to which it applies

 

Attribute

Description

 

Text

The essential information description.

In the language requested (if available).

 

DateRange

The FromDate and ToDate for the Essential Information.


Charge Conditions parameters

If the parameter <IncludeChargeConditions/> has been specified in the <SearchHotelPriceRequest> the response will include the charge conditions; this applies to all participation levels.

Please refer to the Search Charge Conditions document for the details of these parameters.

 

 


Docs Navigation