Search Sightseeing Price

The Search Sightseeing Price provides the client with the ability to search for and price available sightseeing items through the API.

Example XML Search Sightseeing Price request

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

 

<?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>
		<SearchSightseeingPriceRequest>
			<ItemDestination DestinationType="city" DestinationCode="AMS" />
			<ImmediateConfirmationOnly />
			<TourDate>2003-11-11</TourDate>
            <NumberOfAdults>3</NumberOfAdults>
			<Children>
				<Age>5</Age>
			       <Age>10</Age>
			</Children>
                    <TypeCodes>
                    <TypeCode>AR</TypeCode>
                    <TypeCode>CR</TypeCode>
             </TypeCodes>
                    <CategoryCode>CS</CategoryCode>
                <IncludeChargeConditions/>
                 <IncludeRecommended/>
		</SearchSightseeingPriceRequest>
	</RequestDetails>
</Request>

Table 7. Search sightseeing price request.

Source parameters

Please refer to the API Architecture document.

Search Sightseeing Price attributes/parameters

A Search Sightseeing Price request can contain attributes/parameters to filter the sightseeing items returned.

The request can contain the following attributes/parameters:

A Search Sightseeing Price request can contain attributes/parameters to filter the sightseeing items returned.

The request can contain the following attributes/parameters:

Parameters

Description

ItemDestination

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

ImmediateConfirmationOnly

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

ItemName

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

Note: Item names are not case sensitive.

ItemCode

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

TourDate

Mandatory. The start date of the sightseeing tour.

NumberOfAdults

Mandatory. This will contain the number of adults to be included in the price for sightseeing item(s). Must be in the range 1 to 9 inclusive.

Children

Optional. Defines a list of <Age> elements for the children’s ages, which must be between 2 and 18 inclusive. If any of the children is under the age of 16 then at least one adult must be specified; the total number of adults and children must not exceed 9.

TypeCodes

Optional. Define a list of TypeCodes elements. If specified the price for the sightseeingtype requested will be returned.

CategoryCode

Optional. Only single CategoryCode can be specified. If specified the price for the  sightseeingcategory will be returned.

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.

IncludeRecommended

Optional. If specified GTA recommended hotels will be indicated.

RecommendedOnly

 Optional. If specified only GTA recommended

 sightseeing will be returned.


Children parameter

The client can request a number of children through the <Children> parameter. It is made up of a list of <Age> sub-elements, one element for each child required. 

An example of a <Children> element, for two children, is shown below:

<Children>
    <Age>10</Age>
    <Age>12</Age>
</Children>

TypeCodes  parameter

The client can request a number of TypeCode parameter. It is made up of a list of <TypeCode> sub-elements, one element for each TypeCode required.

An example of a <TypeCodes> element, for two different <TypeCode>, is shown below:

<TypeCodes>
    <TypeCode>AR</TypeCode>
    <TypeCode>CR</TypeCode>
</TypeCodes>

Example XML Search Sightseeing Price response

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

<?xml version="1.0" encoding="UTF-8" ?>
<Response ResponseReference="1479_1203_TOKEN">
	<ResponseDetails Language="en">
		<SearchSightseeingPriceResponse>
			<SightseeingDetails>
				<Sightseeing HasExtraInfo="true"   
                            DeparturePointRequired="true"  
                            Recommended="true">
					<City Code="AMS"><![CDATA[ Amsterdam ]]> </City>
					<Item Code="HOLL02-GTA03"><![CDATA[Amsterdam Candlelight Cruise ]]>
					</Item>
			<Duration><![CDATA[ 2 hrs]]></Duration>
<AdditionalInformation>
		<Information>><![CDATA[ Children under the age of 07 are not allowed to join this tour.]]></Information>
</AdditionalInformation>
	<TourOperations>
		<TourOperation>
			<TourLanguages>
				<TourLanguage Code="E" LanguageListCode="XE"><![CDATA[English]]></TourLanguage>
				<TourLanguage Code="G" LanguageListCode="XE"><![CDATA[German]]></TourLanguage>
				<TourLanguage Code="F" LanguageListCode="XE"><![CDATA[French]]></TourLanguage>
				<TourLanguage Code="I" LanguageListCode="XE"><![CDATA[Italian]]></TourLanguage>
		</TourLanguages>
					<ItemPrice Currency="GBP">69.00</ItemPrice>
					<Confirmation Code="OR"><![CDATA[On Request]]></Confirmation>
		</TourOperation>
	<TourOperation>
			<TourLanguages>
				<TourLanguage Code="S" LanguageListCode="XE"><![CDATA[Spanish]]></TourLanguage>
						</TourLanguages>
					<ItemPrice Currency="GBP">69.00</ItemPrice>
					<Confirmation Code="IM"><![CDATA[ AVAILABLE ]]></Confirmation>
		</TourOperation>
</TourOperations>
				</Sightseeing>
				<Sightseeing HasExtraInfo="true" HasFlash="true">
					<City Code="AMS"><![CDATA[ Amsterdam ]]> </City>
					<Item Code="HOLL02-GTA04"><![CDATA[City Tour with Rijksmuseum]]>
					</Item>
			<Duration><![CDATA[ 3 hrs 30 mins]]></Duration>
      <SightseeingTypes>
   	             <SightseeingType Code="RS"><![CDATA[Sightseeing Tours]]></SightseeingType>
      </SightseeingTypes>
   	         <SightseeingCategories>
          <SightseeingCategory Code="CS"><![CDATA[CDATA[City Sightseeing]]></SightseeingCategory>
          <SightseeingCategory Code="MU"><![CDATA[CDATA[Music]]></SightseeingCategory>   
</SightseeingCategories>
<PleaseNote>The tour has live guided English commentary and headphone commentary in a choice of languages</PleaseNote>
	<TourOperations>
		<TourOperation>
			<TourLanguages>
				<TourLanguage Code="E" LanguageListCode="XT"><![CDATA[English]]></TourLanguage>
				<TourLanguage Code="G" LanguageListCode="XT"><![CDATA[German]]></TourLanguage>
				<TourLanguage Code="F" LanguageListCode="XT"><![CDATA[French]]></TourLanguage>
		</TourLanguages>
					<ItemPrice Currency="GBP">71.25</ItemPrice>
					<Confirmation Code="OR"><![CDATA[On Request]]></Confirmation>
					<SpecialCode Code"FC"><![CDATA[First Class]]></Confirmation>
					<TourOperation>
					<TourOperation>
			<TourLanguages>
				<TourLanguage Code="S"><![CDATA[Spanish]]></TourLanguage>
						</TourLanguages>
					<ItemPrice Currency="GBP">101.25</ItemPrice>
					<Confirmation Code="IM"><![CDATA[ AVAILABLE ]]></Confirmation>
                      <EssentialInformation>
						<Information>
							<Text><![CDATA[2 Vouchers are required for this service. 1 for Gondola ride and the other for dinner at the Restaurant. Pls ensure that you print 2 vouchers on confirmation of service.]]></Text>
							<DateRange>
								<FromDate>0001-01-01</FromDate>
								<ToDate>9999-12-31</ToDate>
							</DateRange>
						</Information>
					</EssentialInformation>
				< TourOperation >
					</TourOperations>
				</Sightseeing>
			</SightseeingDetails>
		</SearchSightseeingPriceResponse>
	</ResponseDetails>
</Response>

Table 8. Search sightseeing price response.

Search Sightseeing Price response parameters

The <SightseeingDetails> element can have zero or more <Sightseeing> sub-elements. Each <Sightseeing> element can have the following attributes/parameters: 

Attribute

Description

HasExtraInfo

If set to 'true' there is a report available for the item that can be retrieved through a SearchItemInformationRequest.

HasFlash

If set to 'true' a flash presentation for the hotel is available that can be retrieved through a SearchItemInformationRequest or a SearchLinkRequest.

DeparturePointRequired

If set to 'true' a departure point is required when making a booking for this sightseeing event.

Recommended

If set to ‘true’ the item is a recommended item.

 

Attribute

Description

HasExtraInfo

If set to 'true' there is a report available for the item that can be retrieved through a SearchItemInformationRequest.

HasFlash

If set to 'true' a flash presentation for the hotel is available that can be retrieved through a SearchItemInformationRequest or a SearchLinkRequest.

DeparturePointRequired

If set to 'true' a departure point is required when making a booking for this sightseeing event.

Recommended

If set to ‘true’ the item is a recommended item.

 

Attribute

Description

HasExtraInfo

If set to 'true' there is a report available for the item that can be retrieved through a SearchItemInformationRequest.

HasFlash

If set to 'true' a flash presentation for the hotel is available that can be retrieved through a SearchItemInformationRequest or a SearchLinkRequest.

DeparturePointRequired

If set to 'true' a departure point is required when making a booking for this sightseeing event.

Recommended

If set to ‘true’ the item is a recommended item.

 

Attribute

Description

HasExtraInfo

If set to 'true' there is a report available for the item that can be retrieved through a SearchItemInformationRequest.

HasFlash

If set to 'true' a flash presentation for the hotel is available that can be retrieved through a SearchItemInformationRequest or a SearchLinkRequest.

DeparturePointRequired

If set to 'true' a departure point is required when making a booking for this sightseeing event.

Recommended

If set to ‘true’ the item is a recommended item.


TourOperation parameters

Element

Description

 

TourLanguages

A list of <TourLanguage> elements giving the available languages for sightseeing item.

 

ItemPrice

The total price of the sightseeing item, as per the request.

 

Confirmation

Whether the item is available immediately or on request.

 

SpecialItem

The Special Item code.

 

 

Attribute

Description

 

Code

The special code applicable for this <TourOperation> with a description.


TourLanguage parameters

Element

Description

TourLanguage

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

 

Attribute

Description

 

Code

The GTA language code

 

LanguageListCode

The GTA language list code.


Charge Conditions parameters

If the parameter <IncludeChargeConditions/> has been specified in the <SearchSightseeingPriceRequest> the response will include the charge conditions.

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

 

 

 

 

 

 

 

 

 

 

 

Docs Navigation