Apartment Item

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

For bookings the specifics of an apartment item will be contained within the ApartmentItem sub-element.

Request

The following gives a list of the attributes and sub-elements allowed for a ApartmentItem sub-element within a request:

Parameter	Description
PeriodOfStay	Mandatory. Specifies the period of stay.
UnitCode	Mandatory. Specifies the GTA apartment unit code. This code represents the unit type, e.g. suite, within a property.
NumberOfCots	Optional. If specified must be either 1 or 2.
ArrivalDate	Mandatory. Specifies the arrival date to the apartment.
PaxIds	Mandatory. Specifies the list of one or more passengers for the room. See the PaxIds definition for further details.

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

Parameter	Description
PeriodOfStay	Specifies the period of stay. See PeriodOfStay definition below.
UnitCode	Specifies the GTA apartment unit code. This code represents the unit type, e.g. suite, within a property.
Meals	Specifies the meal information. See Meals definition below.
PaxIds	Specifies the list of one or more passengers for the room. See the PaxIds definition for further details.

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

Element	Description
CheckInDate	Specifies the date of check in.
CheckOutDate or Duration	Specifies the date of check out OR the Duration of stay

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

Element

Description

Basis

The meal description. Contains the following attribute: -

Breakfast

The breakfast description. Contains the following attribute: -

version 3 as of 9 months ago by WW Technical Support