Search Apartment Price

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

The Search Apartment Price provides the client with the ability to search for and price available apartment units through the API.

Example XML Search Apartment request

The XML message below gives a sample of the expected elements needed by the API to execute an Search Apartment Price request.

<?xml version="1.0" encoding="UTF-8" ?>
<Request>
	<Source>
		<RequestorID Client="123456" EMailAddress="clientName@client.co.uk" Password="clientPassword" />
		<RequestorPreferences Language="en" Currency="GBP">
			<RequestMode>SYNCHRONOUS</RequestMode>
		</RequestorPreferences>
	</Source>
	<RequestDetails>
		<SearchApartmentPriceRequest>
			<ItemDestination DestinationType="area" DestinationCode="LON" />
			<ImmediateConfirmationOnly />
			<PeriodOfStay>
				<CheckInDate>2003-08-30</CheckInDate>
				<Duration>14</Duration>
			</PeriodOfStay>
			<Occupancy>
            	<NumberOfAdults>3</NumberOfAdults>
	           	<Children>
    	       		<Age>5</Age>
	           		<Age>10</Age>
       	    	</Children>
            	<NumberOfCots>1</NumberOfCots>
			</Occupancy>
			<StarRating>3</StarRating>
			<LocationCode>G1</LocationCode>
           <PropertyTypeCode>A</PropertyTypeCode>
			<FacilityCodes>
				<FacilityCode>*DM</FacilityCode>
				<FacilityCode>*PT</FacilityCode>
			</FacilityCodes>
		</SearchApartmentPriceRequest>
	</RequestDetails>
</Request> 

Table 5 Apartment price search request.

Source parameters

Please refer to the API Architecture document.

Search Apartment Price parameters

For the purpose of this document the use of the term “apartment” or “resort” is equivalent to an apartment complex and each apartment has units that can be reserved.

The following sub-elements are part of the <SearchApartmentPriceRequest> element:

Element

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.

PeriodOfStay

Mandatory. Defines the check-in day and either the check-out day or the duration of stay.

Occupancy

Mandatory. Defines the combination of adults, children and requested cots for the stay.

StarRating

Optional. Defines the apartment’s star rating. A match or a minimum value can be specified.

LocationCode

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

PropertyTypeCode

Optional. If specified only properties of this type will be returned. PropertyTypeCodes available at the moment are:

  • A=Apartment
  • V=Villa

FacilityCodes

Optional. A list of <FacilityCode> elements specifying requested facilities at the apartment complex, e.g. swimming pool, tennis courts etc.


Occupancy element

The <Occupancy> element can have the following sub-elements:

Element

Description

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. A list of <Age> elements specifying the children’s ages, which must be between 2 and 18 inclusive.

NumberOfCots

Optional. The number of required cots, up to a maximum value of 2 inclusive.


Example XML Search Apartment Price response

The XML message below gives a sample of that given by the API in response to an Search Apartment Price request.

<?xml version="1.0" encoding="UTF-8" ?>
<Response ResponseReference="REF_1499-4809-871997555167364">
	<ResponseDetails Language="en">
		<SearchApartmentPriceResponse>
			<ApartmentDetails>
				<Apartment HasExtraInfo="true">
					<City Code="LHR">
						<![CDATA[London Heathrow]]>
					</City>
					<Item Code="BER1">
						<![CDATA[BERKELEY PARK]]>
					</Item>
					<LocationDetails>
						<Location Code="G2"><![CDATA[Airport]]></Location>
					</LocationDetails>
					<StarRating>4</StarRating>
					<PeriodOfStay>
						<CheckInDate>2004-01-01</CheckInDate>
						<Duration>7</Duration>
					</PeriodOfStay>
                  <EssentialInformation>
						<Information>
							<Text><![CDATA[ Rates are inclusive of return airport    transfers and all non-motorised watersports. ]]></Text>
							<DateRange>
								<FromDate>0001-01-01</FromDate>
								<ToDate>9999-12-31</ToDate>
							</DateRange>
						</Information>
					</EssentialInformation>
					<ApartmentUnits>
						<ApartmentUnit Code="SB" Sleeps="2">
							<ApartmentUnitName>
								<![CDATA[Studio]]>
							</ApartmentUnitName>
							<Meals>
								<Basis Code="B">
									<![CDATA[breakfast]]>
								</Basis>
								<Breakfast Code="C ">
									<![CDATA[Continental]]>
								</Breakfast>
							</Meals>
							<UnitPrice Currency="GBP">735.00</UnitPrice>
							<Confirmation Code="OR">
								<![CDATA[On Request]]>
							</Confirmation>
						</ApartmentUnit>
						<ApartmentUnit Code="1C" Sleeps="4">
							<ApartmentUnitName>
								<![CDATA[1 Bedroom]]>
							</ApartmentUnitName>
							<Meals>
								<Basis Code="B">
									<![CDATA[breakfast]]>
								</Basis>
								<Breakfast Code="C ">
									<![CDATA[Continental]]>
								</Breakfast>
							</Meals>
							<UnitPrice Currency="GBP">945.00</UnitPrice>
							<Confirmation Code="OR">
								<![CDATA[On Request]]>
							</Confirmation>
						</ApartmentUnit>
					</ApartmentUnits>
				</Apartment>
				<Apartment HasExtraInfo="true" HasMap="true" HasPictures="true">
					<City Code="LON">
						<![CDATA[London]]>
					</City>
					<Item Code="ASC1">
						<![CDATA[ASCOTT MAYFAIR]]>
					</Item>
					<LocationDetails>
						<Location Code="G1">
							<![CDATA[Central]]>
						</Location>
					</LocationDetails>
					<StarRating>5</StarRating>
					<PeriodOfStay>
						<CheckInDate>2004-01-01</CheckInDate>
						<Duration>7</Duration>
					</PeriodOfStay>
					<ApartmentUnits>
						<ApartmentUnit Code="SB" Sleeps="2">
							<ApartmentUnitName>
								<![CDATA[Studio]]>
							</ApartmentUnitName>
							<Meals>
								<Basis Code="B">
									<![CDATA[breakfast]]>
								</Basis>
								<Breakfast Code="C ">
									<![CDATA[Continental]]>
								</Breakfast>
							</Meals>
							<UnitPrice Currency="GBP">1771.00</UnitPrice>
							<Confirmation Code="IM">
								<![CDATA[AVAILABLE]]>
							</Confirmation>
						</ApartmentUnit>
						<ApartmentUnit Code="1A" Sleeps="2">
							<ApartmentUnitName>
								<![CDATA[1 Bedroom]]>
							</ApartmentUnitName>
							<Meals>
								<Basis Code="B">
									<![CDATA[breakfast]]>
								</Basis>
								<Breakfast Code="C ">
									<![CDATA[Continental]]>
								</Breakfast>
							</Meals>
							<UnitPrice Currency="GBP">2245.25</UnitPrice>
							<Confirmation Code="IM">
								<![CDATA[AVAILABLE]]>
							</Confirmation>
						</ApartmentUnit>
					</ApartmentUnits>
				</Apartment>
			</ApartmentDetails>
		</SearchApartmentPriceResponse>
	</ResponseDetails>
</Response>

Table 6 Apartment price search response.

Search Apartment Price response parameters

The search on apartment/resort availability will return a list of <Apartment> elements. Each <Apartment> element can have the following attributes/sub-elements: 

Attribute

Description

HasExtraInfo

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

HasMap

If set to 'true' a local map for the resort is available that can be retrieved through a SearchItemInformationRequest or a SearchLinkRequest.

HasPictures

If set to 'true' there are pictures available for the resort that can be retrieved through a SearchItemInformationRequest or a SearchLinkRequest.

HasImportantInfo

If set to 'true' there is important information for the resort, that should be checked before a booking request is made:

* Information on mandatory check in days will be returned   through a SearchApartmentPriceRequest and SearchItemInformationRequest.

* Information on mandatory check out days will be returned through a SearchItemInformationRequest.

* Information on fixed stay will be returned through a SearchApartmentPriceRequest and SearchItemInformationRequest.

* Information on whether a car is essential to reach the property will be returned through a SearchItemInformationRequest.

* Information on key drop will be returned through a SearchItemInformationRequest.

Please note only one or several of the above could apply.

 

Element

Description

City

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

 

Attribute

Description

 

Code

The unique city code held by GTA

 

Element

Description

City

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

 

Attribute

Description

 

Code

The unique city code held by GTA

 

Element

Description

City

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

 

Attribute

Description

 

Code

The unique city 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.

LocationDetails parameters

Location

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

 

Attribute

Description

 

Code

The unique location code held by GTA


CheckInDays parameters

The <CheckInDays> element defines a list of check-in days (<CheckInDay> sub-element) for the resort. If there are no restrictions the element is not present for the apartment. 

CheckInDay

The check-in day description in the language requested (if available).

 

Attribute

Description

 

Code

A number in the range 1-7 for Monday – Sunday, respectively.


ApartmentUnit 

An <ApartmentUnit> element can have the following sub-elements.

Attribute

Description

Code

The GTA unit code.

Sleeps

The maximum occupancy.

 

Element

Description

ApartmentUnitName

The name of the unit.

Meals

Describes the meal basis for the stay and the type of breakfast.

UnitPrice

The price of the unit, as per the request.

Confirmation

Whether the unit is available immediately or on request.

 

 

 

 


 

 

 

 

 

 


Docs Navigation