Apartment Item

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

When a breakdown of prices is required for an apartment item they will be contained within the ApartmentItem sub-element.

Response

ApartmentItem sub-element

For a response the API will return the following attributes and sub-elements allowed for an ApartmentItem sub-element:

Parameter

Description

PeriodOfStay

Specifies the period of stay.

ApartmentUnits

Specifies the apartment unit and the item supplements.  See ApartmentUnit and ItemSupplements sub-element descriptions


PeriodOfStay sub-element

The following gives a list of sub-elements for a PeriodOfStay sub-element: 

Element

Description

CheckInDate

Specifies the date of check in.

CheckOutDate

Specifies the date of check out


ApartmentUnit sub-element

The following gives a list of attributes and sub-elements for an ApartmentUnit sub-element: 

Attribute

Description

Code

Specifies the unit code for the apartment.

 

Element

Description

UnitPrice

The price information at room level. Contains the following attributes:

  • Gross.

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

  • Available – this shows as false when performing an ApartmentPriceBreakdownRequest and the unit type cannot be priced for part of the Period of Stay requested.

PriceRanges

Specifies one or more PriceRange elements – which are used to describe the breakdown of price information for a particular date range. See PriceRange definition below.


PriceRange sub-element

The following gives a list of sub-elements for a PriceRange sub-element: 

Element

Description

DateRange

The range of dates for which the price breakdown is applicable. Contains the following: -

  • FromDate – The start date for the range.
  • ToDate – The end date of the range

Price

The price information at night level. Contains the following attributes:

  • Nights – the number of consecutive nights the price is applicable.

 

Will also show: -

 

EITHER

  • Gross - the price applicable for each within the date range.

OR

  • Available=”false”

Only shows when performing an ApartmentPriceBreakdownRequest and the apartment is not available or cannot be priced for part of the Period of Stay requested.


Availability (Closed and Client Include/exclude)

Where the period of stay specified is not fully available, the duration will be split into applicable date ranges and the price breakdown given only for the available date ranges.

 For example where an Apartment Price Breakdown is requested for 29 Nov 2006 to 07 Dec 2006 and the apartment is not available between 02 Dec to 04 Dec, the price breakdown will show the following: -

  • Price breakdown for 29 Nov 2006 to 01 Dec 2006
  • 02 Dec 2006 to 04 Dec 2006 with Available=”false”
  • Price breakdown for 05 Dec 2006 to 07 Dec 2006

No price available

Where a period of stay cannot be fully priced, the duration will be split into applicable date ranges and the price breakdown given only for the date ranges where prices exist.

 For example an Apartment Price Breakdown is requested for 29 Nov 2006 to 07 Dec 2006 and no price exists for the 02 Dec, the price breakdown will show the following: -

  • Prices for 29 Nov 2006 to 01 Dec 2006
  • 02 Dec 2006 to 02 Dec 2006 with Available=”false”
  • Prices for 03 Dec 2006 to 07 Dec 2006

 

 

 

 


Docs Navigation