Tabular overview of all nodes, which may occur in this message. See legend below for description of table columns.
Note: Some sibling elements or complete sub-trees of the hierarchy may be defined as mutually exclusive alternative choices. This information cannot be expressed in this tabular overview. Please refer to schema diagram for a graphical representation of the message schema.
| Node | Description | Values | Occurs | Example |
|---|---|---|---|---|
<HotelAvailabilityRQ> | Hotel availability request root element | 1 | ||
@version | Version number. | 0..1 | 1.0 | |
@Lang | ISO language code. A two letter code as defined by ISO-639-1. This code specifies the requested language for text content. Default value is 'en'. | 0..1 | ||
<SaleInfo> | Sale information group | 0..1 | ||
<CityCode/> | City code. | 0..1 | MIA | |
<CountryCode/> | Country code. | 0..1 | US | |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
</SaleInfo> | ||||
<ChainCode> | Hotel chain code. | 0..1 | HH | |
@Source | Identifies the source of this element. In other words where the content originates from. Not limited to GDS, applicable to direct connect as well. | 0..1 | 1A, 1V, or other. | |
</ChainCode> | ||||
<PropertyCode/> | Property code. | 1 | 002343 | |
<CheckInDate/> | Check in date in ISO 8601 format (yyyy-mm-dd). | 1 | 2001-12-25 | |
<CheckOutDate/> | Check out date in ISO 8601 format (yyyy-mm-dd). | 1 | 2001-12-25 | |
<NumberOfNights/> | Number of nights. | 1 | 1 | |
<CityCode/> | City code. | 1 | MIA | |
<NumberOfPersons/> | Number of persons. This cannot be more than 2 in any GDS. For HRS: - the number of adults per room must be specified (up to 4). - children must be specified in Children element, not allowed to be included here Values are: 1 = Single room 2 = Double room HRS only: 3 = Double room with additional bed (3 adults) 4 = Double room with 2 additional beds (4 adults) | [1] [2] [3] [4] | 1 | 1 |
<Children> | Group of child elements defining age and bedding type (optional) for each child. | 0..1 | ||
<Child> | Child elements - one per requested child. | 1..N | ||
@RoomRefID | Specify an ID that is unique within this XML message to identify a unique instance of a room where you want to assign a specific number of persons or children to. If no RoomRefID is specified and NumberOfRooms is greater than 1 then the same number of persons/children per room is applied. | 0..1 | R1 | |
<Age/> | Age of child in years (allowed values are 0-17). The age should be specified for the date of the hotel checkin. | [0] to [17] | 1 | |
<ExtraBed/> | Defines if child will need its own bed ('Y') or sleep in parents bed ('N'). If omitted no extra bed is required. | [Y] [N] | 0..1 | |
</Child> | ||||
</Children> | ||||
<AlternateCurrencyCode/> | Desired alternate currency. Used if another currency, than the currency corresponding to the city, is requested. | 0..1 | GBP | |
<HotelOptions> | Hotel options group | 0..1 | ||
<NumberOfRooms/> | Number of rooms. | 0..1 | 2 | |
<RoomType/> | Room type code. The code consists of three parameters: room category, number of beds and bed type. | 0..1 | A1K | |
<RateCode/> | Rate code. | 0..1 | RAC | |
<BedType/> | Bed type code. Values are: D = double K= king P = pullout Q = queen R = run of the house S = single T = twin W = waterbed | [D] [K] [P] [Q] [R] [S] [T] [W] | 0..1 | K |
<RateAccess/> | Rate access code. This is a special code corresponding to a negotiated rate. | 0..N | IBM | |
<RateCategory/> | Rate category. Values are: ASN = Association CLB = Club CON = Convention COR = Corporate DAY = Day room FAM = Family GOV = Government MIL = Military NEG = Negotiated PKG = Package PRO = Promotional RAC = Standard RAC SPE = Special SRS = Senior citizen STP = Stopover TUR = Tour TVL = Travel industry WKD = Weekend | [ASN] [CLB] [CON] [COR] [DAY] [FAM] [GOV] [MIL] [NEG] [PKG] [PRO] [RAC] [SPE] [SRS] [STP] [TUR] [TVL] [WKD] | 0..3 | GOV |
<RateRange> | Rate range group | 0..1 | ||
<Lowest/> | Lowest rate in a range search. | 1 | 100 | |
<Highest/> | Highest rate in a range search. | 1 | 200 | |
</RateRange> | ||||
<CDNumber/> | Corporate Discount number | 0..1 | ||
</HotelOptions> | ||||
<MoreRoomsToken/> | Token used to request more rooms following a previous hotel availability response. This token number is sent back in the previous hotel availability response. | 0..1 | RTDBSGRT | |
</HotelAvailabilityRQ> |
| Column | Description |
|---|---|
| Node | Name of message node (element or attribute). Nodes in bold type are mandatory, if their parent element occurs in the message. Point mouse cursor at table cell to view complete XPath. |
| Description | Description of meaning and usage of the node. |
| Values | List of predefined values (each in square brackets) or range of values ("[a] to [z]") allowed for the node, if formally defined in the schema. |
| Occurs | Minimum and maximum number of times the node must/may occur, if its parent element occurs in the message. Examples: 0..3 Node is optional and may occur up to 3 times. 1..N Node must occur at least one (mandatory) and may occur any number of times. 2 Node must occur exactly twice. |
| Example | Example value for the node. |
XML Schema documentation generated with XX/1 server