Search Hotel Group

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

The Search Hotel Group request provides the client with a file which will group together hotel codes where multiple GTA codes exist for different room categories at the same hotel.  

All requests will need to be sent in a SYNCHRONOUS mode; any requests send in n ASYNCHRONOUS mode will return an error.

Example XML Search Hotel Group request

The XML message below gives a sample of the expected elements required by the API to execute a Search Hotel Group request:

 

<?xml version="1.0" encoding="UTF-8"?>
<Request>
       <Source>
         <RequestorID Client="123456" 
                      EMailAddress="clientName@client.co.uk" 
                      Password="clientPassword"/>
             <RequestorPreferences Language="en">
		       <RequestMode>SYNCHRONOUS</RequestMode>    
             </RequestorPreferences>
       </Source>
	<RequestDetails>
		<SearchHotelGroupRequest>
		<ItemDestination DestinationType="city" DestinationCode="lon"/>
			<ItemName/>
		</SearchHotelGroupRequest>
	</RequestDetails>
</Request>

Source parameters

Please refer to the API Architecture document.

Search Hotel Group attributes/parameters

A Search Hotel Group request can contain optional attributes/parameters to filter the    items returned. The following list the attributes/parameters that can be specified:                             

Element

Description

CountryCode

Optional. Identifies the country where the hotel is based. This element cannot be used in conjunction with the ItemDestination element. Either the CountryCode or the ItemDestination Code must be entered in the request.

ItemDestination

Optional. Identifies the destination where the hotel is based. This element cannot be used in conjunction with the CountryCode element. Either the CountryCode or the ItemDestination Code must be entered in the request.

 

Attribute      

Description

 

 DestinationType

Mandatory if ItemDestination is entered. Identifies the type “city” or “area”.

 

 DestinationCode

Mandatory if ItemDestination is entered. Identifies the GTA city or area code.

Element

Description

 ItemName

 Optional. Identifies the name of the item.

 Example XML Search Hotel Group response

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

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference= "REF_8-1223996838473">
    <ResponseDetails Language="en">
        <SearchHotelGroupResponse>
            <GroupHotelDetails>
                <GroupDetails>
                    <Country Code=“GB”><![CDATA[United Kingdom]]></Country>
                    <City Code="LON"><![CDATA[London]]></City>
                    <HotelGroup Code="ATHE">Athenaeum</HotelGroup>
                    <GroupItem PrimaryHotel="true">
                        <Item Code="ATH1"><![CDATA[ATHENAEUM]]></Item>
                        <RoomCategory>Standard</RoomCategory>
                    </GroupItem>
                    <GroupItem>
                        <Item Code="ATH2"><![CDATA[ATHENAEUM (EXECUTIVE)]]></Item>
                        <RoomCategory>Executive</RoomCategory>
                    </GroupItem>
                    <GroupItem>
                        <Item Code="ATH3"><![CDATA[ATHENAEUM (PARKVIEW)]]></Item>
                        <RoomCategory>Parkview</RoomCategory>
                    </GroupItem>
                </GroupDetails>
                <GroupDetails>
                    <Country Code="GB"><![CDATA[United Kingdom]]></Country>
                    <City Code="LON"><![CDATA[London]]></City>
                    <HotelGroup Code="COU">Courthouse</HotelGroup>
                    <GroupItem PrimaryHotel="true">
                        <Item Code="COU6"><![CDATA[COURTHOUSE KEMPINSKI]]></Item>
                        <RoomCategory>Standard</RoomCategory>
                    </GroupItem>
                    <GroupItem> 
                        <Item Code="COUA"><![CDATA[CH KEMPINS(STATE KING)]]></Item>
                        <RoomCategory>State King</RoomCategory>
                    </GroupItem>
                </GroupDetails>
            </GroupHotelDetails>
        </SearchHotelGroupResponse>
    </ResponseDetails>
</Response>

 

Search Hotel Group response standard attributes/parameters

A Search Hotel Group response will return the following for each item found for the request parameters:

Element

Description

 GroupHotelDetails

The details of the hotel groups.

 GroupDetails

The details of a specific hotel group.

 Country

The country where the hotel group is based.

 

Attribute      

Description

 

Code

The ISO code of the country.

 City

The city where the hotel is based.

 

Attribute      

Description

 

Code

The GTA code of the city.

HotelGroup

The name of the hotel group.

 

Attribute      

Description

 

Code

The GTA code of the hotel group.

GroupItem

The details of a specific hotel within the group.

 

Attribute      

Description

 

PrimaryHotel

If ‘true” it identifies the primary hotel assigned to the group. This should be used to retrieve item information.

Item

The name of the group hotel.

 

Attribute      

Description

 

Code

The code of the group hotel.

RoomCategory

The category of the room.

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Docs Navigation