Apartment Price Breakdown

This module is being phased out and will no longer be supported in our new platform

The Apartment Price Breakdown provides the client with a price breakdown for a given apartment. The client must specify search parameters to identify the price breakdown required. 

Example XML Apartment Price Breakdown request

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

<?xml version="1.0" encoding="UTF-8"?>
<Request>
	<Source>
		<RequestorID Client="1483" EMailAddress="M@C.IE" Password="m" />
		<RequestorPreferences Language="en" Currency="GBP">
			<RequestMode>SYNCHRONOUS</RequestMode>
		</RequestorPreferences>
	</Source>
	<RequestDetails>
		<ApartmentPriceBreakdownRequest>
			<City>LON</City>
			<Item>ONE</Item>
			<PeriodOfStay>
				<CheckInDate>2006-11-07</CheckInDate>
				<Duration>10</Duration>
			</PeriodOfStay>
			<ApartmentUnit Code="1C" NumberOfCots="1"/>
			<ItemSupplements>
				<ItemSupplement Code="WF" Quantity="2"/>
				<ItemSupplement Code="FC" Quantity="1"/>
			</ItemSupplements>
		</ApartmentPriceBreakdownRequest>
	</RequestDetails>
</Request>
Source parameters

Please refer to the API Architecture document.

Apartment Price Breakdown parameters

This request will be used to retrieve the apartment price breakdown for the given search criteria. The following sub-elements must be specified: 

Parameters

Description

City

Mandatory. Specifies the city for the Item.

Item

Mandatory. Specifies the item (apartment) for which the price breakdown is required.

PeriodOfStay

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

ApartmentUnit

Mandatory. Apartment unit type required.  Optional attribute number of cots.

ItemSupplements

Optional.  Include supplements for the price breakdown.  There can be multiple supplements for an item.


Example XML Apartment Price Breakdown response

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

<?xml version="1.0" encoding="UTF-8"?>
<Response ResponseReference="34567">
	<ResponseDetails Language="en">
		<ApartmentPriceBreakdownResponse>
				<ItemCity Code="LON"><![CDATA[London]]></ItemCity>
				<Item Code="ONE"><![CDATA[ONE THIRTY QUEENSGATE]]></Item>
				<ItemPrice Currency="GBP" Gross="1678.25" Available="false" />
				<ApartmentItem>
					<PeriodOfStay>
						<CheckInDate>2006-12-02</CheckInDate>
						<CheckOutDate>2006-12-09</CheckOutDate>
					</PeriodOfStay>
					<ApartmentUnits>
						<ApartmentUnit Code="1C">
							<UnitPrice Code="1678.25" />
							<PriceRanges>
								<PriceRange>
									<DateRange>
										<FromDate>2006-12-02</FromDate>
										<ToDate>2006-12-09</ToDate>
									</DateRange>
									<Price Nights="7" Gross="239.75" />
								</PriceRange>
							</PriceRanges>
						</ApartmentUnit>
						<ItemSupplements>
							<ItemSupplement Code="WF" Price="15.50" Quantity="2">
								<![CDATA[Welcome Food Basket]]>
							</ItemSupplement>
						</ItemSupplements>
					</ApartmentUnits>
				</ApartmentItem>
		</ApartmentPriceBreakdownResponse>
	</ResponseDetails>
</Response>

Apartment Price Breakdown response parameters

The API will return the following Booking level sub-elements:

Element

Description

ItemCity

The city name, the Code attribute specifies the GTA city code for the item.

Item

The item name, the Code attribute specifies the GTA code for the item.

ItemPrice

The booking item price information. Contains the following attributes:

  • Currency – the currency ISO code of the price information.
  • Gross.

NOTE: If the Available=”false” attribute is shown this price shows the total for the days for which the corresponding rooms can be priced.

  • Available – this shows as false when performing an ApartmentPriceBreakdownRequest and the apartment is not available or cannot be priced for part of the Period of Stay requested.

ApartmentItem

Apartment item details. See Apartment Item section.

Docs Navigation