Search Facility

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

The Search Facility provides the client with static data relating to facilities held within the GTA system. The API will provide a facility name along with the unique code used by GTA to identify the facility.

Example XML Search Facility request

The XML message below gives a sample of the expected elements needed by the API to execute a Search Facility 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>
		<SearchFacilityRequest FacilityType=”hotel”>
			<FacilityName></FacilityName>
      <FacilityCode></FacilityCode>
		</SearchFacilityRequest>
	</RequestDetails>
</Request>

Source parameters

Please refer to the API Architecture document.

Search Facility parameters

A Search Facility request can contain optional parameters to filter the facilities returned.  The following lists the parameters that can be specified: -

Parameters

Description

FacilityName

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

Note: Facility Names are not case sensitive.

FacilityCode

Optional. If specified the facility details for the single code will be returned.

 

Attribute

Description

 

FacilityType

Optional. Identifies the type of facility being processed. Can be one of “hotel”, “hotelroom”, “apartment” or “apartmentunit”. If not being specified hotel facilities will be returned.

Example XML Search Facility response

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

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="200002">
	<ResponseDetails Language="en">
		<SearchFacilityResponse FacilityType=”hotel”>
			<FacilityDetails>
				<Facility Code="*TE"><![CDATA[Tennis]]></ Facility >
				<Facility Code="*TA"><![CDATA[Travel agency facilities]]></Facility>
				<Facility Code="*CR"><![CDATA[Car rental facilities]]></Facility>
				<Facility Code="*BC"><![CDATA[Business centre]]></Facility>
			</FacilityDetails>
		</SearchFacilityResponse>
	</ResponseDetails>
</Response>

 Search Facility response parameters

A Search Facility response will return the following for each facility found for the request parameters: -

Parameter

Description

Facility

The facility name.

In the language requested (if available).

 

Attribute

Description

 

FacilityType

Identifies the type of facility being processed. Will be one of “apartment”, “hotel”, “apartmentunit” or “hotelroom”.

 

Code

The unique facility code held by GTA

Docs Navigation