Search Hotel Price

The Search Hotel Price 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 incorrect prices or an error.

Example XML Search Hotel Price request

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

 

<?xml version="1.0" encoding="UTF-8" ?>
<Request>
   	<Source>
	   <RequestorID Client="123456" EMailAddress="client@net.com" Password="xxx" />
	   <RequestorPreferences Language="en" Currency="GBP" Country="GB">
		   <RequestMode>SYNCHRONOUS</RequestMode>
	   </RequestorPreferences>
	</Source>
	<RequestDetails>
	   <SearchHotelPriceRequest>
	      	<ItemDestination DestinationType="city" DestinationCode="AMS" />
		<ImmediateConfirmationOnly />
		<PeriodOfStay>
		     <CheckInDate>2003-09-30</CheckInDate>
			  <Duration>4</Duration>
		</PeriodOfStay>
             <IncludeRecommended/>
             <IncludePriceBreakdown/>
             <IncludeChargeConditions/>
             <ExcludeChargeableItems>
              <CancellationDeadlineHours>72</CancellationDeadlineHours>
             </ExcludeChargeableItems>
             <ShowPackageRates/>
              <MealBasisCodes>
              <MealBasis>N</ MealBasis>
              </MealBasisCodes>
             <Rooms>
		  <Room Code="DB" NumberOfRooms="1">
			<ExtraBeds>
				<Age>5</Age>
			</ExtraBeds>
		  </Room>
		  <Room Code="TB" NumberOfCots="2">
			<ExtraBeds>
				<Age>10</Age>
			</ExtraBeds>
		  </Room>
		  <Room Code="SB" />
	      </Rooms>
	      <StarRating MinimumRating="true">3</StarRating>
	      <LocationCode>G1</LocationCode>
	      <FacilityCodes>
		     <FacilityCode>*AC</FacilityCode>
		     <FacilityCode>*LS</FacilityCode>
	      </FacilityCodes>
	      <OrderBy>pricelowtohigh</OrderBy>
	      <NumberOfReturnedItems>10</NumberOfReturnedItems>
	   </SearchHotelPriceRequest>
	</RequestDetails>
</Request>

 

Table 1. Hotel price search request at city level

<?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>
	   <SearchHotelPriceRequest>
	      <ItemDestination 
			DestinationType="geocode" 
			Latitude="35.009118" 
           Longitude="135.788068" 
			RadiusKm="5"/>
	      <ImmediateConfirmationOnly />
	      <PeriodOfStay>
		     <CheckInDate>2003-09-30</CheckInDate>
		     <Duration>4</Duration>
	      </PeriodOfStay>
         <IncludeRecommended/>
         <IncludePriceBreakdown/>
         <IncludeChargeConditions/>
         <Rooms>
		<Room Code="DB" NumberOfRooms="1">
			<ExtraBeds>
				<Age>5</Age>
			</ExtraBeds>
		</Room>
		<Room Code="TB" NumberOfCots="2">
			<ExtraBeds>
				<Age>10</Age>
			</ExtraBeds>
		</Room>
		<Room Code="SB" />
	   </Rooms>
	   <StarRating MinimumRating="true">3</StarRating>
	   <LocationCode>G1</LocationCode>
	   <FacilityCodes>
		     <FacilityCode>*AC</FacilityCode>
		     <FacilityCode>*LS</FacilityCode>
	    </FacilityCodes>
	    <OrderBy>pricelowtohigh</OrderBy>
	    <NumberOfReturnedItems>10</NumberOfReturnedItems>
	  </SearchHotelPriceRequest>
    </RequestDetails>
</Request>

Table 1.b. Hotel price search request by geocode

<?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>
	   <SearchHotelPriceRequest>
	      <ItemDestination 
			DestinationType="geocode" 
			WestLongitude="-0.92" 
           SouthLatitude="51.52"
           EastLongitude="-0.1"
			NorthLatitude="51.53"/>
	      <ImmediateConfirmationOnly />
	      <PeriodOfStay>
		     <CheckInDate>2003-09-30</CheckInDate>
		     <Duration>4</Duration>
	      </PeriodOfStay>
             <IncludeRecommended/>
             <IncludePriceBreakdown/>
             <IncludeChargeConditions/>
             <ExcludeChargeableItems>
                <CancellationDeadlineDays>14</CancellationDeadlineDays>
             </ExcludeChargeableItems>
             <Rooms>
		     	<Room Code="DB" NumberOfRooms="1">
			    	<ExtraBeds>
				   <Age>5</Age>
			    	</ExtraBeds>
			</Room>
			<Room Code="TB" NumberOfCots="2">
				<ExtraBeds>
				   <Age>10</Age>
				</ExtraBeds>
			</Room>
		       <Room Code="SB" />
		</Rooms>
		<StarRating MinimumRating="true">3</StarRating>
		<LocationCode>G1</LocationCode>
		<FacilityCodes>
		     <FacilityCode>*AC</FacilityCode>
		     <FacilityCode>*LS</FacilityCode>
		</FacilityCodes>
		<OrderBy>pricelowtohigh</OrderBy>
		<NumberOfReturnedItems>10</NumberOfReturnedItems>
	   </SearchHotelPriceRequest>
     </RequestDetails>
</Request>

Table 1.c. Hotel price search request by bounding box

<?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>
	   <SearchHotelPriceRequest>
	      	<ItemDestination DestinationType="city" DestinationCode="AMS" />
            <ItemCodes>
               <ItemCode>ACO</ItemCode>
               <ItemCode>BEL</ItemCode>
               <ItemCode>COM</ItemCode>
             </ItemCodes>
		<PeriodOfStay>
		     <CheckInDate>2003-09-30</CheckInDate>
			  <Duration>4</Duration>
		</PeriodOfStay>
             <IncludeRecommended/>
             <IncludePriceBreakdown/>
             <IncludeChargeConditions/>
             <ExcludeChargeableItems>
              <CancellationDeadlineHours>72</CancellationDeadlineHours>
             </ExcludeChargeableItems>
             <Rooms>
		  <Room Code="DB" NumberOfRooms="1">
			<ExtraBeds>
				<Age>5</Age>
			</ExtraBeds>
		  </Room>
		  <Room Code="TB" NumberOfCots="2">
			<ExtraBeds>
				<Age>10</Age>
			</ExtraBeds>
		  </Room>
		  <Room Code="SB" />
	      </Rooms>
	      	   </SearchHotelPriceRequest>
	</RequestDetails>
</Request>

Table 2.d.  Hotel price search request for multiple item codes

Source parameters

Please refer to the API Architecture document.

Search Hotel Price attributes/parameters

A Search Hotel 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”,“city” “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 or area code  when destination type is “city” or “area”

 

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.

Note: Item names are not case sensitive.

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. This parameter will only be available for clients on participation level 2 or above.

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. This parameter will only be available for clients on participation level 2 or above .

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

Rooms

Mandatory. A list of the requested hotel rooms, with information on the number of rooms, the number of cots and the ages of any extra children staying in.

StarRating

Optional. Defines the star rating of the hotel. A match or a minimum value can be specified.

 

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.

OrderBy

Optional. If specified (“pricelowtohigh” or “pricehightolow”) all items will be returned in the chosen order. If not specified all items will be returned in alphabetical item code order.

NumberOfReturnedItems

Optional. If specified only the number of items requested will be returned. Normally that would be the first x number of items returned in alphabetical code order, but if this parameter is used in conjunction with the <OrderBy> parameter only the cheapest x items or the most expensive x items will be returned.

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>

Rooms parameter

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

An example of a <Room> element, for one double room with one extra cot and an extra child bed, is shown below:

 

			<Room Code="DB" NumberOfRooms="1" NumberOfCots="1">
				<ExtraBeds>
					<Age>5</Age>
				</ExtraBeds>
			</Room>

 

The <Room> element can contain an Id attribute which is used to specify the room category. This is an optional attribute and is dependent on the client’s Participation Level: 

  • Participation Level – None

Must not be entered.

  • Participation Level – 1

Optional.

  • Participation Level – 2.

Optional.

The Id attribute can only be used in conjunction with DestinationType = "city" and not with DestinationType = "area"

 

<?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>
	  <SearchHotelPriceRequest>
	     <ItemDestination DestinationType="city" DestinationCode="AMS" />
         <ImmediateConfirmationOnly/>      
		  <ItemCode>ACO</ItemCode>
		 <PeriodOfStay>
		    <CheckInDate>2003-09-30</CheckInDate>
			<Duration>4</Duration>
		 </PeriodOfStay>
        <IncludeRecommended/>
        <IncludePriceBreakdown/>
        <Rooms>		     
           <Room Code="DB" Id="001:ACO:29302:S30665:47301:148086" NumberOfRooms="1" />			    
		 </Rooms>
		 <StarRating MinimumRating="true">3</StarRating>
		 <LocationCode>G1</LocationCode>
		 <FacilityCodes>
		    <FacilityCode>*AC</FacilityCode>
			<FacilityCode>*LS</FacilityCode>
		 </FacilityCodes>
		 <OrderBy>pricelowtohigh</OrderBy>
		 <NumberOfReturnedItems>10</NumberOfReturnedItems>
	   </SearchHotelPriceRequest>
	</RequestDetails>
</Request>

Table 2. Hotel price search request. (Participation Level 1/2 or above)

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 Price Request.       

 

<?xml version="1.0" encoding="UTF-8" ?>
<Response ResponseReference="1479_1203_TOKEN">
    <ResponseDetails Language="en">
	<SearchHotelPriceResponse>
	    <HotelDetails>
		  <Hotel HasExtraInfo="true" HasMap="true" HasPictures="true"
                                 Recommended = "true">
			<City Code="AMS"><![CDATA[ Amsterdam ]]></City>
			<Item Code="AME"><![CDATA[ AMERICAN ]]></Item>
			<LocationDetails>
			    <Location Code="G1"><![CDATA[ Central  ]]></Location>
			</LocationDetails>
			<StarRating>5</StarRating>
			<Meals>
			    <Basis Code="B"><![CDATA[ breakfast ]]> </Basis>
			    <Breakfast Code="H"><![CDATA[ Hot Buffet ]]> </Breakfast>
			</Meals>
			<ItemPrice Currency="GBP">2185.00</ItemPrice>
			<Confirmation Code="IM"><![CDATA[ AVAILABLE ]]></Confirmation>
                      <EssentialInformation>
		          <Information>
			   	 <Text><![CDATA[Complimentary dinner provided. ]]></Text>
				 <DateRange>
				      <FromDate>0001-01-01</FromDate>
				      <ToDate>9999-12-31</ToDate>
				 </DateRange>
			   </Information>
			</EssentialInformation>
		   </Hotel>
	     </HotelDetails>
	 </SearchHotelPriceResponse>
    </ResponseDetails>
</Response>

 

Table 3a. Hotel price search response – flat structure (no Participation Level).

 

<?xml version="1.0" encoding="UTF-8" ?>
<Response ResponseReference="1479_1203_TOKEN">
    <ResponseDetails Language="en">
	<SearchHotelPriceResponse>
	    <HotelDetails>
		  <Hotel HasExtraInfo="true" HasMap="true" HasPictures="true"
                                 Recommended = "true">
			<City Code="AMS"><![CDATA[ Amsterdam ]]></City>
			<Item Code="AME"><![CDATA[ AMERICAN ]]></Item>
			<LocationDetails>
			    <Location Code="G1"><![CDATA[ Central  ]]></Location>
			</LocationDetails>
			<StarRating>5</StarRating>
                    <HotelRooms>
			    <HotelRoom Code="TB" 
                                   Id="001:AME"
                                   NumberOfRooms="1" 
                                   ExtraBed="true"
                                   SharingBedding="false"/>
		       </HotelRooms>
			<Meals>
			    <Basis Code="B"><![CDATA[ breakfast ]]> </Basis>
			    <Breakfast Code="H"><![CDATA[ Hot Buffet ]]> </Breakfast>
			</Meals>
			<ItemPrice Currency="GBP">2185.00</ItemPrice>
			<Confirmation Code="IM"><![CDATA[ AVAILABLE ]]></Confirmation>
            <EssentialInformation>
		      <Information>
			   	 <Text><![CDATA[Complimentary dinner provided. ]]></Text>
				 <DateRange>
				      <FromDate>0001-01-01</FromDate>
				      <ToDate>9999-12-31</ToDate>
				 </DateRange>
			   </Information>
			</EssentialInformation>
		   </Hotel>
	     </HotelDetails>
	 </SearchHotelPriceResponse>
    </ResponseDetails>
</Response>

Table 4b. Hotel price search response – flat structure with Id attribute (Participation Level 1).

 

<HotelDetails>
	<Hotel HasExtraInfo="true" HasMap="true" HasPictures="true">
		<City Code="PAR"><![CDATA[Paris]]></City>
		<Item Code="HAU"><![CDATA[HAUTEVILLE OPERA]]></Item>
		<LocationDetails>
			<Location Code="G1"><![CDATA[Central]]></Location>
			<Location Code="29"><![CDATA[Gare du Nord/Gare de l'Est/St Lazare]]></Location>
			<Location Code="09"><![CDATA[09e Arrondissement]]></Location>
		</LocationDetails>
		<StarRating>3</StarRating>
		<HotelRooms>
			<HotelRoom Code="TB" NumberOfRooms="1" ExtraBed="true"/>
		</HotelRooms>
		<RoomCategories>
			<RoomCategory Id="002:HILTON:HL:04988:AHD:GTA:A05">
				<Description><![CDATA[Queen Deluxe]]></Description>
				<ItemPrice Currency="GBP"
                          CommissionIndicator="LOW"
                          NoOfferDiscount="true"
                                 RSP="597.50">589.25</ItemPrice>
				<Confirmation Code="IM"><![CDATA[AVAILABLE]]></Confirmation>
               <SharingBedding>true</SharingBedding>
				<Meals>
					<Basis Code="N"><![CDATA[Room only]]></Basis>
				</Meals>
			</RoomCategory>
			<RoomCategory Id="002:HILTON:HL:04988:AHD:GTA:A0M">
				<Description><![CDATA[Junior Suite]]></Description>
				<ItemPrice Currency="GBP"
                                     CommissionIndicator="HIGH"
                                     NoOfferDiscount="true">988.25</ItemPrice>
				<Confirmation Code="IM"><![CDATA[AVAILABLE]]></Confirmation>
                           <SharingBedding>false</SharingBedding>
				<Meals>
					<Basis Code="N"><![CDATA[Room only]]></Basis>
				</Meals>
			</RoomCategory>
			<RoomCategory Id="002:HILTON:HL:04988:AHD:GTA:A06">
				<Description><![CDATA[King Executive]]></Description>
				<ItemPrice Currency="GBP"
                                      CommissionIndicator="STD"
                                      NoOfferDiscount="true">846.25</ItemPrice>
				<Confirmation Code="IM"><![CDATA[AVAILABLE]]></Confirmation>
				<SharingBedding>true</SharingBedding>
                           <Meals>
					<Basis Code="N"><![CDATA[Room only]]></Basis>
				</Meals>
			</RoomCategory>
		</RoomCategories>
	</Hotel>
</HotelDetails>

 

Table 3c. Hotel price search response – With room categories (Participation Level 2 or above).

 

<HotelDetails>
	<Hotel HasExtraInfo="true" HasMap="true" HasPictures="true">
		<City Code="PAR"><![CDATA[Paris]]></City>
		<Item Code="HAU"><![CDATA[HAUTEVILLE OPERA]]></Item>
		<LocationDetails>
			<Location Code="G1"><![CDATA[Central]]></Location>
		</LocationDetails>
		<StarRating>3</StarRating>
		<HotelRooms>
			<HotelRoom Code="TB" NumberOfRooms="1" ExtraBed="true"/>
		</HotelRooms>
		<RoomCategories>
			<RoomCategory Id="002:HILTON:HL:04988:AHD:GTA:A05">
				<Description><![CDATA[Queen Deluxe]]></Description>
				<ItemPrice Currency="GBP"
                                     CommissionIndicator="HIGH"
                                     NoOfferDiscount="true">589.25</ItemPrice>
				<Confirmation Code="IM"><![CDATA[AVAILABLE]]></Confirmation>
                           <SharingBedding>true</SharingBedding>
				<Meals>
					<Basis Code="N"><![CDATA[Room only]]></Basis>
				</Meals>
                           <EssentialInformation>
                                <Information>
                                    <Text>
                                        <![CDATA[Complimentary 5 course dinner provided.]]>
                                    </Text>
                                    <DateRange>
                                        <FromDate>0001-01-01</FromDate>
                                        <ToDate>9999-12-31</ToDate>
                                    </DateRange>
                                </Information>
                            </EssentialInformation>
			</RoomCategory>
			<RoomCategory Id="002:HILTON:HL:04988:AHD:GTA:A0M">
				<Description><![CDATA[Junior Suite]]></Description>
				<ItemPrice Currency="GBP"
                                     CommissionIndicator="LOW"
                                     NoOfferDiscount="true">988.25</ItemPrice>
				<Confirmation Code="IM"><![CDATA[AVAILABLE]]></Confirmation>
                           <SharingBedding>false</SharingBedding>
				<Meals>
					<Basis Code="N"><![CDATA[Room only]]></Basis>
				</Meals>
                           <EssentialInformation>
                                <Information>
                                    <Text><![CDATA[Free upgrade from Junior Suite to Executive Suite.]]></Text>
                                    <DateRange>
                                        <FromDate>2014-02-01</FromDate>
                                        <ToDate>2014-02-28</ToDate>
                                    </DateRange>
                                </Information>
                            </EssentialInformation>
			</RoomCategory>
			<RoomCategory Id="002:HILTON:HL:04988:AHD:GTA:A06">
				<Description><![CDATA[King Executive]]></Description>
				<ItemPrice Currency="GBP"
                                      CommissionIndicator="STD"
                                      NoOfferDiscount="true">846.25</ItemPrice>
				<Confirmation Code="IM"><![CDATA[AVAILABLE]]></Confirmation>
				<SharingBedding>true</SharingBedding>
                           <Meals>
					<Basis Code="N"><![CDATA[Room only]]></Basis>
				</Meals>
			</RoomCategory>
		</RoomCategories>
	</Hotel>
</HotelDetails>

 

Table 3d. Hotel price search response – With room categories (Participation Level 2 or above) and Essential Information

 

<HotelDetails>
	<Hotel HasExtraInfo="true" HasMap="true" HasPictures="true">
		<City Code="LON"><![CDATA[London]]></City>
		<Item Code="ABC"><![CDATA[ABCONE]]></Item>
		<LocationDetails>
			<Location Code="G1"><![CDATA[Central]]></Location>
			</LocationDetails>
		<StarRating>3</StarRating>
		<HotelRooms>
			<HotelRoom Code="DB" NumberOfRooms="1"/>
		</HotelRooms>
		<RoomCategories>
			<RoomCategory Id="001:ABC:29302:S30665:47301:148086">
				<Description><![CDATA[Standard]]></Description>
				<ItemPrice CommissionIndicator="STD" Currency="GBP" CommissionPercentage="10.0">283.50</ItemPrice>
				<Confirmation Code="IM"><![CDATA[AVAILABLE]]></Confirmation>
                           <SharingBedding>true</SharingBedding>
				<Meals>
				      <Basis Code="B"><![CDATA[Breakfast Included]]></Basis>
                                 <Breakfast Code="C"><![CDATA[Continental]]></Breakfast>
				</Meals> 
                      <HotelRoomPrices>
                       <HotelRoom Code="DB">
                         <RoomPrice Gross="283.50">
                           <PriceRanges>
                            <PriceRange>
                              <DateRange>
                               <FromDate>2009-10-01<FromDate>
                               <ToDate>2009-10-03<ToDate>
                               </DateRange>
                               <Price Gross="94.50" Nights="3"/>
                              <PriceRange>
                             <PriceRanges>
                           <HotelRoom>
                          <HotelRoomPrices>
			</RoomCategory>
		</RoomCategories>
	</Hotel>
</HotelDetails>

 

Table 4c. Hotel price search response – With room categories (Participation Level 2 or above) and including price breakdown information

<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>
			</LocationDetails>
		<StarRating>5</StarRating>
		<HotelRooms>
			<HotelRoom Code="DB" NumberOfRooms="1"/>
		</HotelRooms>
		<RoomCategories>
			<RoomCategory Id="001:ADM2:4740:S2111:3274:7928">
				<Description><![CDATA[Deluxe Room Ocean View]]></Description>
				<ItemPrice CommissionIndicator="STD" Currency="GBP" CommissionPercentage="10.0" PackageRate="false">283.50</ItemPrice>
				<Confirmation Code="IM"><![CDATA[AVAILABLE]]></Confirmation>
                           <SharingBedding>true</SharingBedding>
				<Meals>
				      <Basis Code="B"><![CDATA[Breakfast Included]]></Basis>
                                 <Breakfast Code="C"><![CDATA[Continental]]></Breakfast>
				</Meals> 
                      <HotelRoomPrices>
                       <HotelRoom Code="DB">
                         <RoomPrice Gross="283.50">
                           <PriceRanges>
                            <PriceRange>
                              <DateRange>
                               <FromDate>2009-10-01<FromDate>
                               <ToDate>2009-10-03<ToDate>
                               </DateRange>
                               <Price Gross="94.50" Nights="3"/>
                              <PriceRange>
                             <PriceRanges>
                           <HotelRoom>
                          <HotelRoomPrices>
                    <ChargeConditions>
		          <ChargeCondition Type="cancellation">
		           <Condition Charge="true" 
                            ChargeAmount="283.50">
                            Currency="GBP" 
                            FromDate="2009-10-01" 
                            ToDate="2009-10-01" 
		             <Condition Charge="false" FromDate="2009-10-02"/>
		      </ChargeCondition>
		      <ChargeCondition Type="amendment">
		             <Condition Allowable="false" 
                            FromDate="2009-10-01" 
                            ToDate="2009-10-03" 
                           </Condition>
		              <Condition Charge="true"
                            ChargeAmount = "94.5"
                            Currency="GBP"
                            FromDate="2009-10-01" 
                            ToDate="2009-10-01"
                           </Condition Charge = "false" FromDate="2009-10-02"/>
		         </ChargeCondition>
                   <PassengerNameChange Allowable="true"
               </ChargeConditions>
			</RoomCategory>
		</RoomCategories>
	</Hotel>
</HotelDetails>

Table 5c. Hotel price search response – With room categories (Participation Level 2 or above) and including charge conditions and package rate

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

 

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.

 

HotelRooms

The hotel room code.

Level 0: This is returned only if an extra bed or cot is within    the request.

Level 1 and above: Output

 

Attribute

Description

 

Code

Room Code held by GTA.

 

Id

Specifies the category of room. This is an optional attribute dependant on the client’s Participation Level: -

Level 0: Not output

Level 1 and above: Output

 

ExtraBed

If “true” a child will be accommodate in the room.

 

NumberOfCots

Specifies the number of cots requested.

 

NumberOfExtraBeds

Specifies the number of children requested.

 

NumberOfRooms

Specifies the number of rooms requested.

 

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.

 

The price related details includes the following either as a flat structure (below Participation Level 2) or 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 <SearchHotelPriceRequest>; this applies to Participation Level 2 or above only: 

Parameter

Description

HotelRoomPrices

A collection of one or more HotelRoom parameters.

HotelRoom

Specifies price details for one or more room codes.

 

Attribute

Description

 

Code

Specifies the GTA room code for the hotel.

RoomPrice

The price of the room code.

 

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.

 

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.

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.


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