Search Item Information

The Search Item Information provides the client with varying levels of static information relating to apartment, hotel and sightseeing items held within the GTA system. The client will be allowed to request various “bundles” of pre-defined information by specifying the appropriate parameters.

Example XML Search Item Information request

The XML message below gives a sample of the expected elements needed by the API to execute a Search Item Information Request for hotels.

<?xml version="1.0" encoding="UTF-8"?>
<Request>
  <Source>
<RequestorID 	Client="123456" 	
			EMailAddress="clientName@client.co.uk" 
			Password="clientPassword" />
    <RequestorPreferences Language="en">
	<RequestMode>ASYNCHRONOUS</RequestMode>
    </RequestorPreferences>
  </Source>
	<RequestDetails>
		<SearchItemInformationRequest ItemType="hotel">
			<ItemDestination DestinationType="city" DestinationCode="AMS" />
			<ItemCode>APO</ItemCode>
		</SearchItemInformationRequest>
	</RequestDetails>
</Request>

Source parameters

Please refer to the API Architecture document.

Search Item Information attributes/parameters

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

Attribute

Description

ItemType

Mandatory. Identifies the type of item being processed. Must be one of “apartment”, “hotel” or “sightseeing” or “transfer”.

 

Parameters

Description

ItemDestination

Mandatory. Used to return all items within the specified destination type (“area” or “city”) and destination code.

LocationCode

Optional. Used to return all items within the specified location code.

ItemName

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

Note: Item names are not case sensitive.

ItemCode

Mandatory for SYNCHRONOUS requests.

Optional for ASYNCHRONOUS requests.

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.

Search Apartment Information sub-parameters

If the item type specified is “apartment”, then the following optional search parameters can be specified: -

Parameter

Description

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.

FacilityCodes

Used to return all apartment items that offer the specified facility(s).

Search Hotel Information sub-parameters

If the item type specified is “hotel”, then the following optional search parameters can be specified: -

Parameter

Description

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.

FacilityCodes

Used to return all hotel items that offer the specified facility(s).

Search Sightseeing Information sub-parameters

If the item type specified is “sightseeing”, then the following optional search parameters can be specified: -

Parameter

Description

TypeCodes

Optional. Can contain one or several TypeCode elements.

TypeCode

Optional. If specified only sightseeing tours that match the selected type code will be returned.

CategoryCode

Optional. If specified only sightseeing tours that match the selected category code will be returned.

DateRange

The FromDate and ToDate for the sightseeing item.

Search Transfer Information sub-parameters

 None.

Example XML Search Item Information response

Note

The API will be responsible for the level of information returned to the client. This will be determined as part of the contractual agreement with GTA and subsequently set up as system parameters within the GTA system.

The XML message below gives a sample of that given by the API in response to a Search Item Information Response.

Search Item Information response standard attributes/parameters

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="200005">
	<ResponseDetails Language="en">
		<SearchItemInformationResponse ItemType="hotel">
			<ItemDetails>
				<ItemDetail>
					<City Code="AMS"><![CDATA[Amsterdam]]></City>
					<Item Code="APP"><![CDATA[Apple Inn]]></Item>
					<LocationDetails>
						<Location Code="G1"><![CDATA[Central]]></Location>
			       <Location Code="G3"><![CDATA[Station]]></Location>
			       <Location Code="04"><![CDATA[Museumsplein/Leidesplein]]></Location>
					</LocationDetails>
					<HotelInformation>
						<AddressLines>
				<AddressLine1><![CDATA[KONINGINNEWEG 93]]></AddressLine1>
				<AddressLine2><![CDATA[1075 CJ AMSTERDAM]]></AddressLine2>
				<AddressLine3><![CDATA[NETHERLAND]]></AddressLine3>
				<Telephone><![CDATA[31-20-6627894]]></Telephone>
				<Fax><![CDATA[31-20-6755235]]></Fax>
				<EmailAddress><![CDATA[info@apple-inn.nl]]></EmailAddress>
				<WebSite><!{CDATA[www.apple-inn.nl]]></WebSite>
						</AddressLines>
						<StarRating>2</StarRating>
						<Reports>
				<Report Type="location"><![CDATA[Located in an exclusive residential area in the south of Amsterdam, 12 minutes walk to the Museumplein and Leidseplein.]]></Report>
						</Reports>
						<Facilities>
		<Facility Code="*LS"><![CDATA[Small sized lobby]]></Facility>
		<Facility Code="*EC"><![CDATA[Earliest check-in]]></Facility>
						</Facilities>
					</HotelInformation>
				</ItemDetail>
				<ItemDetail>
					<City Code="AMS"><![CDATA[Amsterdam]]></City>
				 	<Item Code="MER3"><![CDATA[Meridien Apollo]]></Item>
				 	<LocationDetails>
				 	 	<Location Code="G1"><![CDATA[Central]]></Location>
			       <Location Code="04"><![CDATA[Museumsplein/Leidesplein]]></Location>
				 	</LocationDetails>
				  	<HotelInformation>
				  		<AddressLines>
				<AddressLine1><![CDATA[APOLLOLAAN 2]]></AddressLine1>
				<AddressLine2><![CDATA[NL 1077 AMSTERDAM]]></AddressLine2>
				<AddressLine3><![CDATA[NETHERLANDS]]></AddressLine3>
				<Telephone><![CDATA[31-20-6627544]]></Telephone>
				<Fax><![CDATA[31-20-6754535]]></Fax>
				<EmailAddress><![CDATA[info@gt.com]]></EmailAddress>
				<WebSite><!{CDATA[http://www.gt.com/]]></WebSite>
						</AddressLines>
				  		<StarRating>2</StarRating>
					<Reports>
<Report Type="location"><![CDATA[Located in an exclusive residential area in the south of Amsterdam, 12 minutes walk to the Museumplein and Leidseplein.]]>
</Report>
<Report Type="exterior"><![CDATA[A traditional building, built in 1899.]]>
</Report>
					</Reports>
					<Facilities>
		<Facility Code="*LS"><![CDATA[Medium sized lobby]]></Facility>
		<Facility Code="*EC"><![CDATA[Check-in at 14:00]]></Facility>
		<Facility Code="*PT"><![CDATA[Porterage 24 hour]]></Facility>
		<Facility Code="*RS"><![CDATA[Rooms service 24 hour]]></Facility>
		<Facility Code="*CP"><![CDATA[CarParking]]></Facility>
		<Facility Code="*SH"><![CDATA[Shop]]></Facility>
		<Facility Code="*CR"><![CDATA[Car Rental]]></Facility>
		<Facility Code="*BS"><![CDATA[Baby sitting]]></Facility>
		<Facility Code="*LY"><![CDATA[Laundry facilities]]></Facility>
		<Facility Code="*BQ"><![CDATA[Boutique]]></Facility>
					</Facilities>
					</HotelInformation>
				</ItemDetail>
			</ItemDetails>
		</SearchItemInformationResponse>
	</ResponseDetails>
</Response>

 

Attribute

Description

ItemType

Identifies the type of item being processed. Will be “apartment”, “hotel”, “sightseeing” or “transfer”.

A Search Item Information response will return the following for each item found for the request parameters: -

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

 

LocationDetails

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

The standard item parameters will be followed by the corresponding detailed item information: - 

Item type

Parameter

Apartment

ApartmentInformation (see corresponding section)

Hotel

HotelInformation (see corresponding section)

Sightseeing

SightseeingInformation (see corresponding section)

Transfer

TransferInformation (see corresponding section)

LocationDetails parameters

Location

The location name.

In the language requested (if available).

 

Attribute

Description

 

Code

The unique location code held by GTA

Apartment Information Search Response

Address Lines

The Address Details will be held within the <AddressLines> parameter and can contain up to six lines of detail. The following gives a sample of the XML to be returned.

<AddressLines>
    	<AddressLine1><![CDATA[129-131 BLD HAUSSMANN]]></AddressLine1>
    	<AddressLine2><![CDATA[F-75008X]]></AddressLine2>
    	<AddressLine3><![CDATA[PARIS]]></AddressLine3>
    	<AddressLine4><![CDATA[FRANCE]]></AddressLine4>
       <Telephone><![CDATA[32-1-6627894]]></Telephone>
       <Fax><![CDATA[33-1-6755235]]></Fax>
       <EmailAddress><![CDATA[info@hotel.com]]></EmailAddress>           
       <WebSite><![CDATA[www.abc-hotel.com]]></WebSite>
</AddressLines>

Parameter

Description

AddressLine1 to 4

The address line(s).

Telephone

The telephone number of the apartment.

Fax

The fax number of the apartment.

EmailAddress

The email address of the apartment

WebSite

The website of the apartment

Star Rating

The apartment star rating will be held within the <StarRating> parameter. The following gives a sample of the XML to be returned.

<StarRating>2</StarRating>

Category

The apartment category will be held within the <Category> parameter. The following gives a sample of the XML to be returned.

<Category><![CDATA[Grade 4 Apartment]]> </Category>

Area Details

The following area details could be included within the Apartment Area Details: -

Distance to Airport(s)

Distance to Metro

Distance to the beach

Distance to Station

Distance to Bus Stop

Distance to Fair Site


The Area Details will be held within the <AreaDetails> parameter and each occurrence of area detail to be reported will be held within its own <AreaDetail> parameter. The following gives a sample of the XML to be returned.

<AreaDetails>
  	<AreaDetail><![CDATA[Location: Central]]></AreaDetail>
  	<AreaDetail><![CDATA[25 kms to the airport (london heathrow)]]></AreaDetail>
  	<AreaDetail><![CDATA[60 kms to the airport (london Gatwick)]]></AreaDetail>
  	<AreaDetail><![CDATA[4 minute walk to the nearest metro station (greenpark)]]></AreaDetail>
  	<AreaDetail><![CDATA[2 km to the nearest station (Victoria)]]></AreaDetail>
  	<AreaDetail><![CDATA[1 minute walk to the nearest bus stop)]]></AreaDetail>
  </AreaDetails>

Apartment Units

The Apartment Units will be held within the <ApartmentUnits> parameter and each occurrence of an accommodation type will be held within its own <ApartmentUnit> parameter. The following gives a sample of the XML to be returned.

<ApartmentUnits>
	<ApartmentUnit Code="SB" Sleeps="2">
		<ApartmentUnitName><![CDATA[Studio - Standard]]></ApartmentUnitName>
		<ApartmentUnitRooms>
          		<UnitRoom Code="DB" Quantity="1"><![CDATA[Double]]></UnitRoom>
		</ApartmentUnitRooms>
		<ApartmentUnitFacilities>
	  		<Facility Code="*AC"><![CDATA[Air conditioning]]></Facility>
	  		<Facility Code="*TV"><![CDATA[TV]]></Facility>
	  		<Facility Code="*LD"><![CDATA[Laundry]]></Facility>
 		</ApartmentUnitFacilities>
  	</ApartmentUnit>
</ApartmentUnits>
 

Atribute

Description

Code

The unique apartment unit code held by GTA

Sleeps

The maximum occupancy.

 

Parameter

Description

ApartmentUnitName

The apartment unit name.

In the language requested (if available).

ApartmentUnitRooms

The room make up for the apartment unit.

ApartmentUnitFacilities

The facilities available for the apartment unit.

Reports

The following report types could be included within the Apartment Reports: -

Location

Exterior

Lobby

Accom

General

Key Drop

Direction

The Report Details will be held within the <Reports> parameter and each occurrence of a report will be held within its own <Report> parameter. The following gives a sample of the XML to be returned.

<Reports>
<Report Type="location"><![CDATA[The hotel is located in a lively and elegant area on the famous Boulevard Haussman, home to the famous department stores and close to the Opera and Champs Elysees. It is 2 minutes walk from the nearest metro station.]]></Report>
<Report Type="exterior"><![CDATA[The building is a large, traditional Parisian town house, in keeping with the architecture of the surrounding area.]]></Report>
<Report Type="lobby"><![CDATA[The lobby is bright and cheerful, with modern decoration, attractive wood panelled walls and colourful plants.]]></Report>
<Report Type="accom"><![CDATA[The apartments and studios are in good condition. They are bright, and tastefully decorated in classic style. The kitchenettes are modern and well equipped with oven, microwave and a dishwasher. A homely feel has been created with comfortable furniture, attractive drapes and paintings on the walls.]]></Report>
<Report Type="general"><![CDATA[This is a 4 star residence and a good first class property. The apartments are very pleasant and offer a comfortable stay in a good location in Paris.(]]></Report>
</Reports> 

Attribute

Description

Type

The type of Apartment Report.

The KeyDrop report should not be displayed within the apartment information, but only on the voucher as the phone number advised should not be used by for any other purpose.

Facilities

The Apartment Facilities will be held within the <Facilities> parameter and each occurrence of a apartment facility will be held within its own <Facility> parameter. The following gives a sample of the XML to be returned.

	<Facilities>
		<Facility Code="*LS"><![CDATA[Medium sized lobby]]></Facility>
		<Facility Code="*CP"><![CDATA[CarParking]]></Facility>
		<Facility Code="*SH"><![CDATA[Shop]]></Facility>
		<Facility Code="*LY"><![CDATA[Laundry facilities]]></Facility>
		<Facility Code="*BQ"><![CDATA[Boutique]]></Facility>
	</Facilities>

Attribute

Description

Code

The facility code held by GTA.

Links

The Apartment Links will be held within the <Links> parameter which can contain sub-parameters for map and image links. The following gives a sample of the XML to be returned. See Search Link for details.

<Links>
	<MapLinks>
	     <MapLink><![CDATA[http://maps-dynamic.imageserver.com/maps.asp?SITEID=8&CTY=AMS&PANITM=ACC&COID=2&CAT=HOT
]]></MapLink>
	</MapLinks>
	<ImageLinks>
		<ImageLink Height="214" Width="360">
			<Text><![CDATA[Exterior]]></Text>
			<ThumbNail><![CDATA[ http://images.is.com/HH/.jpg]]></ThumbNail>
		<Image><![CDATA[ http://images.is.com/HH/Nonchain/amsapp01.jpg]]>
		</Image>
		</ImageLink>
	</ImageLinks>
<Links>

 Important Notes

 Any important notes will be held within the <ImportantNotes> parameter and each occurrence of an important note will be held within its own <ImportantNote> parameter. The following gives a sample of the XML to be returned.

<ImportantNotes>

              <ImportantNote><![CDATA[ Check In Days - Saturday/Sunday]]></ImportantNote>

              <ImportantNote><![CDATA[ Check Out Days - Monday]]></ImportantNote>

              <ImportantNote><![CDATA[ Car essential]]></ImportantNote>

       </ImportantNotes>

Hotel Information Search Response

Address Lines

 The Address Details will be held within the <AddressLines> parameter and can contain up to six lines of detail. The following gives a sample of the XML to be returned.

<AddressLines>
    		<AddressLine1><![CDATA[KONINGINNEWEG 93]]></AddressLine1>
    		<AddressLine2><![CDATA[1075 CJ]]></AddressLine2>
    		<AddressLine3><![CDATA[AMSTERDAM]]></AddressLine3>
      <AddressLine4><![CDATA[NETHERLAND]]></AddressLine4>
      <Telephone><![CDATA[32-20-6627894]]></Telephone>
      <Fax><![CDATA[32-20-6755235]]></Fax>
       <EmailAddress><![CDATA[info@hotel.com]]></EmailAddress>
       <WebSite><![CDATA[www.abc-hotel.com]]></WebSite>
  		  </AddressLines>

Parameter

Description

AddressLine1 to 4

The address line(s).

Telephone

The telephone number of the hotel.

Fax

The fax number of the hotel.

EmailAddress

The email address of the hotel

WebSite

The website of the hotel

Star Rating

 The hotel star rating will be held within the <StarRating> parameter. The following gives a sample of the XML to be returned.

<StarRating>2</StarRating>

Category

The hotel category will be held within the <Category> parameter. The following gives a sample of the XML to be returned.

<Category><![CDATA[3 Star, Superior Tourist Class Modern Hotel]]> </Category>

Area Details

The following area details could be included within the Hotel Area Details: -

Distance to Airport(s)

Distance to Metro

Distance to Station

Distance to Bus Stop

Distance to Fair Site


The Area Details will be held within the <AreaDetails> parameter and each occurrence of area detail to be reported will be held within its own <AreaDetail> parameter. The following gives a sample of the XML to be returned.

<AreaDetails>
  	<AreaDetail><![CDATA[3 kms to city centre]]></AreaDetail>
  	<AreaDetail><![CDATA[13 kms to the nearest airport (amsterdam)]]></AreaDetail>
  	<AreaDetail><![CDATA[1 minute walk to the nearest metro station (rai)]]></AreaDetail>
  	<AreaDetail><![CDATA[2 km to the nearest station (world trade centre)]]></AreaDetail>
  	<AreaDetail><![CDATA[5 minute walk to the nearest bus stop]]></AreaDetail>
  	<AreaDetail><![CDATA[2 km to the nearest fair site (rai)]]></AreaDetail>
  </AreaDetails>

Reports

The following report types could be included within the Hotel Reports: -

Location

Rooms

Restaurant

Exterior

Lobby

General

Apartments

Inclusive

Please Note

 The Report Details will be held within the <Reports> parameter and each occurrence of a report will be held within its own <Report> parameter. The following gives a sample of the XML to be returned.

<Reports>
<Report Type="location">
	<![CDATA[Located in an exclusive residential area in the south of Amsterdam, 	12 minutes walk to the Museumplein and Leidseplein.]]>
</Report>
<Report Type="exterior">
	<![CDATA[A traditional building, built in 1899.]]>
</Report>
</Reports>

Attribute

Description

Type

The type of Hotel Report.

Room Categories

The Room Categories will be held within the <RoomCategories> parameter and each occurrence of a hotel room category will be held within its own <RoomCategory> parameter. The following gives a sample of the XML to be returned.

<RoomCategories>
	<RoomCategory Id = "002:HIL1">
		<Description><![CDATA[Standard]]></Description>
		<RoomDescription>The medium sized bedrooms are typical Hilton style 		with two double beds in each twin room. All the rooms were renovated 		in 2001 with modern furnishings in Italian style and strong, 			contrasting colours. The white tiled bathrooms are also in very good 		condition and the rooms offer all the facilities and the high 			standards that one would expect from a 5 star Hilton 					hotel.</RoomDescription>
	</RoomCategory>
	<RoomCategory Id = "002:HILTON:HL:04988:XXX:XXX:A02">
		<Description><![CDATA[King Junior Suite]]></Description>
	</RoomCategory>
	<RoomCategory Id = "002:HILTON:HL:04988:XXX:XXX:A10">
		<Description><![CDATA[Standard Double]]></Description>
	</RoomCategory>
	<RoomCategory Id = "002:HILTON:HL:04988:XXX:XXX:A09">
		<Description><![CDATA[Executive King]]></Description>
		<RoomDescription>The very large Executive King bedrooms are very 			comfortably furnished. There is a mini-audio system in each room. The 		bathrooms are fitted to a very high standard.</RoomDescription>
	</RoomCategory>
	<RoomCategory Id = "002:HILTON:HL:04988:XXX:XXX:A03">
		<Description><![CDATA[Presidential Suite]]></Description>
	</RoomCategory>
</RoomCategories>

Parameter

Description

RoomCategories

A collection of one or more RoomCategory parameters.

RoomCategory

Specifies the room category details.

 

Attribute

Description

 

Id

Specifies the category ID. 

Parameter

Description

Description

Short description of the room category. 

RoomDescription

Describes the room category. May not be returned for all categories.  

The <RoomCategories> parameter is  dependent on the client’s Participation Level:

  • Participation Level – None

Parameter is not returned

  • Participation Level – 1

Parameter is returned

  • Participation Level – 2

Parameter is returned

Room Types

 The Room Types will be held within the <RoomTypes> parameter and each occurrence of a hotel room type will be held within its own <RoomType> parameter. The following gives a sample of the XML to be returned.

	<RoomTypes RoomCount="212">
		<RoomType Code="SB"><![CDATA[Single room]]></RoomType>
		<RoomType Code="DB"><![CDATA[Double room]]></RoomType>
		<RoomType Code="TB"><![CDATA[Twin room]]></RoomType>
	</RoomTypes> 

Attribute

Description

Code

The room type code held by GTA.

Facilities

 The Hotel Facilities will be held within the <Facilities> parameter and each occurrence of a hotel facility will be held within its own <Facility> parameter. The following gives a sample of the XML to be returned.

<Facilities>
		<Facility Code="*LS"><![CDATA[Medium sized lobby]]></Facility>
		<Facility Code="*EC"><![CDATA[Earliest check-in at 14:00]]></Facility>
		<Facility Code="*PT"><![CDATA[Porterage 24 hour]]></Facility>
		<Facility Code="*RS"><![CDATA[Rooms service 24 hour]]></Facility>
		<Facility Code="*CP"><![CDATA[CarParking]]></Facility>
		<Facility Code="*SH"><![CDATA[Shop]]></Facility>
		<Facility Code="*CR"><![CDATA[Car Rental]]></Facility>
		<Facility Code="*BS"><![CDATA[Baby sitting]]></Facility>
		<Facility Code="*LY"><![CDATA[Laundry facilities]]></Facility>
		<Facility Code="*BQ"><![CDATA[Boutique]]></Facility>
	</Facilities>
 

Attribute

Description

Code

The facility code held by GTA.

Room Facilities

 The Hotel Room Facilities will be held within the <RoomFacilities> parameter and each occurrence of a hotel room facility will be held within its own <Facility> parameter. The following gives a sample of the XML to be returned.

<RoomFacilities>
		<Facility Code="*T1"><![CDATA[Television]]></Facility>
		<Facility Code="*M1"><![CDATA[In-house movie]]></Facility>
		<Facility Code="*D1"><![CDATA[Direct dial phone]]></Facility>
		<Facility Code="*H1"><![CDATA[Hairdryer]]></Facility>
		<Facility Code="*V1"><![CDATA[Voltage 220v]]></Facility>
	</RoomFacilities>

Attribute

Description

Code

The facility code held by GTA.

Links

 The Hotel Links will be held within the <Links> parameter which can contain sub-parameters for map and image links. The following gives a sample of the XML to be returned. See Search Link for details.

<Links>
	<MapLinks>
<MapLink><![CDATA[http://maps-dynamic.imageserver.com/maps.asp?SITEID=8&CTY=AMS&PANITM=ACC&COID=2&CAT=HOT
]]></MapLink>
	</MapLinks>
	<ImageLinks>
		<ImageLink Height="214" Width="360">
			<Text><![CDATA[Exterior]]></Text>
		<ThumbNail><![CDATA[ http://is.com/HH/Nonchainth/amsapp01.jpg]]>
		</ThumbNail>
		<Image><![CDATA[ http://is.com/HH/Nonchain/amsapp01.jpg]]></Image>
		</ImageLink>
	</ImageLinks>
	<RichMediaLinks>			        		
		<RichMediaLink>http://vfmii.com/ids=77381</RichMediaLink>
   	</RichMediaLinks>
 <Links>

GeoCodes

 The GeoCodes will be held within the <GeoCodes> parameter which contains sub-parameters for <Latitude> and <Longitude>. The following gives a sample of the XML to be returned.

<GeoCodes>
       <Latitude>40.764300000000000</Latitude>
                 <Longitude>-73.98900000000000</Longitude>
    </GeoCodes>

 Sightseeing Information Search Response

 Tour Summary

 The Tour Summary will be held within the <TourSummary> parameter. The following gives a sample of the XML to be returned.

<TourSummary>
	<![CDATA[A full day excursion through scenic countryside to Mount Fuji and Hakone, 	returning to Tokyo by bullet train.]]>
</TourSummary>

Duration

 The duration will be held within the <Duration> parameter. The following gives a sample of the XML to be returned. 

<Duration><![CDATA[12 hrs]]></Duration>

SightseeingTypes

The Types will be held within the <SightseeingTypes> parameter and each occurrence of a type will be held within its own <SightseeingType> parameter. The following gives a sample of the XML to be returned.

<SightseeingTypes>
	<SightseeingType Code="RS"><![CDATA[Sightseeing Tours]]></SightseeingType>
	<SightseeingType Code="CR"><![CDATA[Sightseeing Cruises]]></SightseeingType>
</SightseeingTypes>

Parameter

Description

SightseeingTypes

The collection of <SightseeingType> tags.

SightseeingType

The sightseeing type, in the language requested (if available).

 

Attribute

Description

 

Code

The unique sightseeing type code held by GTA.

SightseeingCategories

The Category will be held within the <SightseeingCategories> parameter and each occurrence of a type will be held within its own <SightseeingCategory> parameter. The following gives a sample of the XML to be returned.

<SigthseeingCategories>
  	<SightseeingCategory Code="FA"><![CDATA[Fashion]]></SightseeingCategory>
  	<SightseeingCategory Code="MU"><![CDATA[Music]]></SightseeingCategory>
  	<SightseeingCategory Code="SP"><![CDATA[Sport]]></SightseeingCategory>
</SigthseeingCategories> 

Parameter

Description

SightseeingCategories

The collection of <SightseeingCategory> tags.

SightseeingCategory

The sightseeing category, in the language requested (if available).

 

Attribute

Description

 

Code

The unique sightseeing category code held by GTA.

The Tour

The Tour description will be held within the <TheTour> parameter. The following gives a sample of the XML to be returned.

<TheTour><![CDATA[This tour starts with a drive through the scenic countryside to Mt. Fuji. A Western-style lunch is provided half way up the mountain at the Hotel Highland Resort. Then you will be driven on to Hakone and after that you take a cruise on Lake Ashi. We then take the Aerial Cable Way to Mount Komagatake. After a brief stop at Hotel Kowaki, the tour proceeds into Odawara to board a bullet train for Tokyo.]]></TheTour>

Includes

The Includes information will be held within the <Includes> parameter. The following gives a sample of the XML to be returned.

<Includes><![CDATA[Cruise on Sydney Harbour, 3 course 'a la carte dining', sparkling and still wines, beer, tea and coffee.]]></Includes>

 Please Note

The Please Note will be held within the <PleaseNote> parameter. The following gives a sample of the XML to be returned.

PleaseNote><![CDATA[Some walking is involved as half the tour is by luxury coach and the other half on foot.]]></ PleaseNote>

Departure Points

The Departure Points will be held within the <DeparturePoint> parameter. The following gives a sample of the XML to be returned. 

DeparturePoints><![CDATA[Rijksmuseum - Leidseplein - City Hall - Central Station - Anne Frank Hs./ Prinsengracht - Rijksmuseum]]></ DeparturePoints>

Additional Information

 If Additional Information exists for the tour it will be held within the <AdditionalInformation> parameter. The following gives a sample of the XML to be returned.

<AdditionalInformation><![CDATA[Pick up from hotels can be arranged with the supplier directly. This tour is operated in air conditioned vehicles.]]></AdditionalInformation>

Tour Operations

 The tour operating details will be held within the <TourOperations> parameter and each occurrence of a tour operation to be reported will be held within its own < TourOperation> parameter. The following gives a sample of the XML to be returned.

<TourOperations>
	<TourOperation>
		<TourLanguages>
			<TourLanguage Code="E" LanguageListode="XE"><![CDATA[English]]>
			</TourLanguage>
			<TourLanguage Code="G" LanguageListode="XE"><![CDATA[German]]>
			</TourLanguage>
			<TourLanguage Code="K" LanguageListode="XE"><![CDATA[Korean]]>
			</TourLanguage>
			<TourLanguage Code="M" LanguageListode="XE"><![CDATA[Mandarin]]>
			</TourLanguage>
			<TourLanguage Code="S" LanguageListode="XE"><![CDATA[Spanish]]>
			</TourLanguage>
		</TourLanguages>
		<Commentary><![CDATA[Audio]]></Commentary>
		<DateRange>
			<FromDate>2003-01-01</FromDate>
			<ToDate>2003-12-31</ToDate>
		</DateRange>
		<Frequency><![CDATA[Daily]]></Frequency>
		<Departures>
			<Departure>
				<Time>09.00</Time>
				<DeparturePoint Code="XXX">
					<![CDATA[Hamamatsucho Bus Terminal]]>
				</DeparturePoint>
		     		<AddressLines>
    		     	<AddressLine1><![CDATA[Dorland House]]></AddressLine1>
    		     	<AddressLine2><![CDATA[14-20 Lower Regent Street]]></AddressLine2>
    		     	<AddressLine3><![CDATA[London]]></AddressLine3>
			<AddressLine4><![CDATA[SW1Y 4PH]]></AddressLine4>
  		  		</AddressLines>
         			<Telephone><![CDATA[44-7976-1191]]></Telephone>
			</Departure>
		</Departures>
       		<OverrideText>
         		<TourSummary><![CDATA[A full day excursion through scenic 					countryside to Mount Fuji and Hakone, returning to Tokyo by 				express train.]]>
			</TourSummary>
            		<TheTour><![CDATA[This tour starts with a drive through the 				scenic countryside to Mt. Fuji. A Western-style lunch is 					provided half way up the mountain at the Hotel Highland Resort. 				Then you will be driven on to Hakone and after that you take a 				ruise on Lake Ashi. We then take the Aerial Cable Way to Mount 				Komagatake. After a brief stop at Hotel Kowaki, the tour 					proceeds into Odawara to board an express train for 						Tokyo.]]>
			</TheTour>
            		<Includes><![CDATA[Cruise on Sydney Harbour, buffet lunch, 					sparkling and still wines, beer, tea and coffee.]]>
			</Includes>
            		<PleaseNote><![CDATA[Some walking is involved and during the 				rainy season a rain coat and umbrella are required.]]>
			</PleaseNote>
            		<DeparturePoints><![CDATA[Rijksmuseum - Leidseplein - City Hall 				- Central Station - Rijksmuseum]]>
			</ DeparturePoints>
            		<AdditionalInformation><![CDATA[Pick up from hotels is not 					available for this period. This tour is operated in air 					conditioned vehicles.]]>	
			</AdditionalInformation>
        	</OverrideText>
	</TourOperation>
</TourOperations> 

Parameter

Description

TourLanguages

A list of languages in which the tour operates.

Commentary

The description of the commentary.

DateRange

The FromDate and ToDate for the event.

Frequency

The frequency of the tour.

Departures

The list of departures available held within a separate <Departure>. See below for further details

OverrideText

The override text (if it exists) for the applicable date range. See below for further details.

 Departures

The Departures Details will be held within the <Departure> parameters with the following choice of sub-parameters:

Parameter

Description

Time

The departure time or list of departure times.

FirstService

The time of the first departure.

LastService

The time of the last departure.

Intervals

At what time interval the tour runs.

 

Attribute

Description

DeparturePoint

Code

The GTA departure point code.

Description

Description of the departure point.

AddressLines

See below for details

Telephone

The telephone number of the supplier.

AddressLines

 The Address Details will be held within the <AddressLines> parameter and can contain up to 4 lines of detail. The following gives a sample of the XML to be returned.

<AddressLines>
    		<AddressLine1><![CDATA[Dorland House]]></AddressLine1>
    		<AddressLine2><![CDATA[14-20 Lower Regent Street]]></AddressLine2>
    		<AddressLine3><![CDATA[London]]></AddressLine3>
       <AddressLine4><![CDATA[SW1Y 4PH]]></AddressLine4>
</AddressLines>

Parameter

Description

AddressLine1 to 4

The address line(s).

 Override Text

 If any override text exists for the tour this will be held within the <OverrideText> parameter which contains sub-parameters for the individual tour information parameters (please also see sections 9.6.1, 9.6.5, 9.6.6, 9.6.7, 9.6.8 and 9.6.9). The following gives a sample of the XML to be returned.

<OverrideText>
  	<TourSummary><![CDATA[A full day excursion through scenic countryside to Mount Fuji 	and 	Hakone, returning to Tokyo by express train.]]></TourSummary>
    	<TheTour><![CDATA[This tour starts with a drive through the scenic countryside to Mt. 	Fuji. A Western-style lunch is provided half way up the mountain at the Hotel 	Highland Resort. Then you will be driven on to Hakone and after that you take a 	cruise on Lake Ashi. We then take the Aerial Cable Way to Mount Komagatake. After a 	brief stop at Hotel Kowaki, the tour proceeds into Odawara to board an express train 	for Tokyo.]]></TheTour>
    	<Includes><![CDATA[Cruise on Sydney Harbour, buffet lunch, sparkling and still wines, 	beer, tea and coffee.]]></Includes>
    	<PleaseNote><![CDATA[Some walking is involved and during the rainy season a rain coat 	and umbrella are required.]]></PleaseNote>
    	<DeparturePoints><![CDATA[Rijksmuseum - Leidseplein - City Hall - Central Station - 	Rijksmuseum]]></ DeparturePoints>
    	<AdditionalInformation><![CDATA[Pick up from hotels is not available for this period. 	This tour is operated in air conditioned vehicles.]]></AdditionalInformation>
</OverrideText>

Closed Dates

If Closed Dates exist for the tour these will be held within the <ClosedDates> parameter which contains sub-parameters for the individual dates this tour is not operating on. The following gives a sample of the XML to be returned.

<ClosedDates>
   <ClosedDate>2004-12-25</ClosedDate>
   <ClosedDate>2004-12-26</ClosedDate>
   <ClosedDate>2005-01-01</ClosedDate>
</ClosedDates>

 Link

The Sightseeing Links will be held within the <Links> parameter which can contain sub-parameters for image and flash links. The following gives a sample of the XML to be returned. See Search Link for details.

<Links>
   	<ImageLinks>
      		<ImageLink Height="270" Width="360">
         		<ThumbNail><![CDATA[http://images.gta-travel.com/LONBATE01-					GTA012.GTA01.jpg]]>
         		</ThumbNail>
      			<Image><![CDATA[http://images.gta-travel.com/RS/Images/GB/LONBATE01-			GTA012.GTA01.jpg]]>
      			</Image>
      		</ImageLink>
   	</ImageLinks>
   	<FlashLinks>
      		<FlashLink><![CDATA[http://images.gta-travel.com/LONBATE01-GTA013.swf]]>
      		</FlashLink>
   	</FlashLinks>
</Links>

Transfer Information response parameters

PickUpDetails parameters

Elements

Description

PickUp

The pick up name in the language requested (if available).

 

Attribute

Description

 

Code

The GTA pick up code.

 

Elements

Description

City, Area or

Airport

Depending on the type of pick up, a city, area or airport name will be output in the language requested (if available).

 

Attribute

Description

 

Code

The GTA code associated with the name.

 

Elements

Description

PickUpPoints 

A list  of  PickUpPoint  held for the item.

  PickUpPoints  parameters

PickUpPoint

The pick up name in the language requested (if available).

 

Attribute

Description

 

Code

The GTA pick up code.

 

City

The city code where the PickUpPoint is located.

DropOffDetails parameters

Elements

Description

DropOff

The drop off name in the language requested (if available).

 

Attribute

Description

 

Code

The GTA drop off code.

 

Elements

Description

City, Area or

Airport

Depending on the type of drop off, a city, area or airport name will be output in the language requested (if available).

 

Attribute

Description

 

Code

The GTA code associated with the name.

Approximate Transfer Time

The approximate transfer time will be held within the <ApproximateTransferTime> parameter. The following gives a sample of the XML to be returned.

 

<ApproximateTransferTime><![CDATA[1 hour 30 Minutes ]]></ApproximateTransferTime>

 

 Links

The Transfer Links (i.e. Sightseeing Ideas) will be held within the <Links> parameter which can contain sub-parameters for flash links. The following gives a sample of the XML to be returned. See Search Link for details.

 

<Links>
<FlashLinks>
	<FlashLink><![CDATA[ http://maps.mapserver.com/TN/GB/EDIAFSLDH2.swf]]>
	</FlashLink>
	<FlashLink><![CDATA[ http://maps.mapserver.com/TN/GB/EDIAFSLDH3.swf]]>
	</FlashLink>
</FlashLinks>
</Links>

Description

The transfer description will be held within the <Description> parameter. The following gives a sample of the XML to be returned.

<Description><![CDATA[Transfer from Edinburgh Airport to hotel with driver speaking the local language.]]></Description>

Meeting Point

The meeting point information will be held within the <MeetingPoint> parameter. The following gives a sample of the XML to be returned.

<MeetingPoint><![CDATA[In the arrivals hall]]></MeetingPoint>

Transfer Conditions

The transfer conditions will be held within the <TransferConditions> parameter and each occurrence of a transfer condition to be reported will be held within its own

<TransferCondition> parameter. The following gives a sample of the XML to be returned.

<TransferConditions>
<TransferCondition><![CDATA[Tips are not included, these are at your discretion.]]>	</TransferCondition>
<TransferCondition><![CDATA[Waiting time is 1 hour after the actual arrival time. After this time the vehicle will be released.]]
</TransferCondition>
</TransferConditions>

Transfer Type

The transfer type will be held within the <TransferType> parameter. The following gives a sample of the XML to be returned.

<TransferType Code=”PT”><![CDATA[Private Transfer]]></TransferType>

Docs Navigation