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 |
|---|---|---|---|---|
<HotelAvailabilityRS> | Hotel availability response 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 | ||
<InfoGroup> | Error and information group | 0..1 | ||
<ForInfo> | Information group | 0..N | ||
@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. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
@Code | A code to uniquely identify a specific type of ForInfo message. Currently not returned for most ForInfo messages. | 0..1 | I00001 | |
@Lang | ISO language code. A two letter code as defined by ISO-639-1. | 0..1 | de | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
</ForInfo> | ||||
<Error> | Error group | 0..N | ||
@ErrorType | Type of error. | 1 | Air | |
@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. | |
@SourceRef | PNR Record Locator associated to Source attribute. | 0..1 | ||
<Code/> | Error code or equipment type code. | 1 | 0104 (error code), 747 (equipment code) | |
<Text/> | Information text or error text. | 1..N | Free flow text. Example: Invalid flight number | |
<UnderlyingError> | Errors of the backend system can be returned here. | 0..N | ||
@Code | error code of the backend system. | 0..1 | ||
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</UnderlyingError> | ||||
</Error> | ||||
<BackOffice> | Generic back office response container. Serves as a placeholder for any context specific content. | 0..1 | ||
</BackOffice> | ||||
</InfoGroup> | ||||
<Hotel> | Hotel information group | 1 | ||
@LinkType | Type of GDS link that the hotel participates in. Possibles values are: ASA = Amadeus standard access ACA = Amadeus complete access ACP = Amadeus complete access plus ADY = Amadeus dynamic access AIA = Amadeus independent access GIA = Galileo inside availability link GIP = Galileo inside shopper participant GRM = Galileo roommaster only participant GLP = Galileo link partner GBP = Galileo Best Available Rate participant SDC = Sabre direct connect sell SOL = Sabre other link type WSV = Worldspan hotel source vendor WAP = Worldspan hotel select vendor access plus WNP = Worldspan hotel select vendor non-access plus HRS = HRS internal hotels HRSEXT = HRS external hotels HBC = Booking.com direct access hotels | [ASA] [ACA] [ACP] [ADY] [AIA] [GIA] [GIP] [GRM] [GLP] [GBP] [SDC] [SOL] [WSV] [WAP] [WNP] [HRS] [HRSEXT] [HBC] | 1 | GRM |
@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. | |
<CheckInDate/> | Check in date in ISO 8601 format (yyyy-mm-dd). This is the date the customer will arrive (check in) at the hotel. | 0..1 | 2001-12-25 | |
<CheckOutDate/> | Check out date in ISO 8601 format (yyyy-mm-dd). This is the date the customer will depart(check out) the hotel. | 0..1 | 2001-12-31 | |
<NumberOfNights/> | Number of nights. | 0..1 | 5 | |
<NumberOfPersons/> | Number of adults. Will be 1 or 2. | [1] to [2] | 0..1 | 1 |
<ChainCode/> | Chain code. | 0..1 | MC | |
<ChainName/> | Chain name. | 0..1 | Marriott | |
<PropertyCode/> | Property code. | 0..1 | MIA345 | |
<PropertyName/> | Property name. | 0..1 | Marriott on the sea | |
<Address/> | Address. | 0..1 | 1101 NW 57th AVE, Miami FL 33121, USA | |
<CityCode/> | City code. | 0..1 | MIA | |
<CityName/> | City name. | 0..1 | Miami | |
<StateCode/> | State code. | 0..1 | FL | |
<CountryCode/> | Country code. | 0..1 | US (United States) | |
<Location> | Location of the hotel. Values are: A = Airport B = Beach C = City Centre D = Downtown E = East of city F = Freetext location description N = North of city O = Ouside Airport R = Resort S = South of city T = Airport Terminal U = Suburb W = West of city Y = Country | [A] [B] [C] [D] [E] [F] [N] [O] [R] [S] [T] [U] [W] [Y] | 0..1 | B |
@Description | Freetext location description. | 0..1 | ||
</Location> | ||||
<Transportation/> | Transportation type. One of the legal transportation types associated with the property. Values are: A = Rail B = Bus C = Courtesy car F = Free transportation provided by the hotel L = Limo N = Any transportation O = Check with hotel P = Public transportation R = Rental car T = Taxi U = Courtesy bus W = Walking distance | [A] [B] [C] [F] [L] [N] [O] [P] [R] [T] [U] [W] | 0..1 | B |
<TaxIndicator/> | Indicates if tax is included in the rate returned. Values are: Y = tax is included, N = tax is not included. | [Y] [N] | 0..1 | N |
<SafetyCompliance/> | Safety compliance indicating if hotel meets F.E.M.A fire-compliance regulations, as required by American government officials. Valid values: Y = hotel is compliant N = hotel is not compliant | [Y] [N] | 0..1 | Y |
<CurrencyCode> | Currency code of the currency, in which all curreny amount values are returned. This will either be a default currency or the alternate currency specified in the request (if any). | 1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<VendorMessage/> | Vendor marketing message. | 0..1 | THIS IS A QUALITY PERFORMER HOTEL | |
<AAARating/> | DEPRECATED. DO NOT USE. WILL BE REMOVED FROM SCHEMA JAN 2010. USE HotelRating INSTEAD. AAA Rating. Blank if no rating exists. Value from 1 to 5. | 0..1 | 5 | |
<Media> | Holds reference to multi media content such as pictures, videos, etc. for this hotel property. | 0..N | ||
<Url/> | Hyperlink defining the location of the referenced media (e.g. location of a JPG file). | 1 | ||
<Width> | Width of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Width> | ||||
<Height> | Height of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Height> | ||||
<Type> | Type of media content. For value 'OTA' the attributes @Type and @Code contain the media type information. Values other than 'OTA' are deprecated. Values: OTA image webcam video logo gallery 360 (panorama view) | [OTA] [image] [webcam] [360] [video] [logo] [map] [gallery] | 1 | OTA |
@Type | OTA code type. CTT .. Content Code PIC .. Picture Category Code | [CTT] [PIC] | 0..1 | |
@Code | OTA code. | 0..1 | 16 | |
@Description | Free text description. If none available the OTA code name is used. | 0..1 | Streaming video | |
</Type> | ||||
<Preview> | Preview of the referenced media content (e.g. thumbnail of the picture). | 0..N | ||
<Url/> | Hyperlink defining the location of the referenced media (e.g. location of a JPG file). | 1 | ||
<Width> | Width of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Width> | ||||
<Height> | Height of media content in specified units. | 1 | ||
@Unit | Unit used to specify dimensions of media content. | [px] [mm] | 1 | mm (millimeter) px (pixel) |
</Height> | ||||
<Type> | Type of media content. For value 'OTA' the attributes @Type and @Code contain the media type information. Values other than 'OTA' are deprecated. Values: OTA image webcam video logo gallery 360 (panorama view) | [OTA] [image] [webcam] [360] [video] [logo] [map] [gallery] | 1 | OTA |
@Type | OTA code type. CTT .. Content Code PIC .. Picture Category Code | [CTT] [PIC] | 0..1 | |
@Code | OTA code. | 0..1 | 16 | |
@Description | Free text description. If none available the OTA code name is used. | 0..1 | Streaming video | |
</Type> | ||||
</Preview> | ||||
<Description> | Media content description (e.g. exterior view). | 0..1 | ||
@Type | OTA code type. PIC .. Content Code | [PIC] | 0..1 | |
@Code | OTA code. | 0..1 | 3 | |
@Description | OTA code name. | 0..1 | Pool view | |
</Description> | ||||
<Caption/> | Title for the media. | 0..1 | Exterior | |
</Media> | ||||
<HotelRating> | Rating of this hotel. Note that this element will eventually supercede the AAARating element definition. The latter will be deprecated soon. | 0..N | NTM3 CROWN | |
@RatingSystem | Identifies the rating system used to rate the hotel. Values are: AAA .. AAA Diamond rating AA .. Automobile Association Star Rating AMA .. Amadeus C24 .. check24 CRC .. CorporateRatesClub EAN .. Expedia EHB .. eHotelBar EHS .. eHotelStars EHT .. eHotel GUESTS .. Guest rating HBC .. Booking.com rating HRS .. Hotel Reservation System 'stars' rating JVW .. Jonview rating LSR .. Local Star Rating MIC .. Michelin MOB .. Mobil Hotel Star NTM .. North Star Media 'crown' rating OHG .. Official Hotel Guide TPA .. Tripadvisor VDR .. Verband Deutsches Reisemanagement UNK .. unknown | [AAA] [AA] [AMA] [C24] [CRC] [EAN] [EHB] [EHS] [EHT] [GUESTS] [HBC] [HRS] [JVW] [LSR] [MIC] [MOB] [NTM] [OHG] [TPA] [VDR] [UNK] | 0..1 | |
@RatingType | The category type, the rating applies to. AVG ... average UNK ... unknown COF ... comfort factor ATM ... hotel atmosphere FOR ... friendliness of reception SOE ... service of hotel employees HFA ... hotel facilities RFA ... room facilities RSI ... room size SAN ... sanitary equipment CLE ... cleanliness BFQ ... breakfast quality REQ ... restaurant quality WEL ... wellness PKG ... package VAL ... price value | [AVG] [UNK] [COF] [ATM] [FOR] [SOE] [HFA] [RFA] [RSI] [SAN] [CLE] [BFQ] [REQ] [WEL] [PKG] [VAL] | 0..1 | |
@RatingPersonType | The person type this rating is based on. AVG ... average UNK ... unknown PRI ... private BUS ... business GRP ... group CON ... conference YCP ... young couple ECP ... elder couple FSC ... family with small children FOC ... family with older children | [AVG] [UNK] [PRI] [BUS] [GRP] [CON] [YCP] [ECP] [FSC] [FOC] | 0..1 | |
</HotelRating> | ||||
<Latitude/> | Degree of latitude. Values range from -90 to +90 Positive values refer to latitudes north, negative values to latitudes south of the equator. | [-90] to [90] | 0..1 | -49.9856 |
<Longitude/> | Degree of longitude. Values range from -180 to +180 Positive values refer to longitudes east, negative values to longitudes west of the zero (Greenwich) meridian. | [-180] to [180] | 0..1 | -123.87611 |
</Hotel> | ||||
<Rooms> | Rooms information group | 1..N | ||
@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. | |
<BookingCode/> | The booking code for this rate which is used at sell time. | 1 | A1SRA8 | |
<AvailabilityStatus/> | Availbility status indicator. Values are: A = Available R = on request C = closed | [A] [R] [C] | 1 | A |
<RateCategory> | Rate category. Possible values: ASN = Association CCO = Customer Contract CLB = Club CON = Convention COR = Corporate DAY = Day room EXC = Exclusive 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] [CCO] [CLB] [CON] [COR] [DAY] [EXC] [FAM] [GOV] [MIL] [NEG] [PKG] [PRO] [RAC] [SPE] [SRS] [STP] [TUR] [TVL] [WKD] [ASN] [CLB] [CON] [COR] [DAY] [FAM] [GOV] [MIL] [NEG] [PKG] [PRO] [RAC] [SPE] [SRS] [STP] [TUR] [TVL] [WKD] [] | 0..N | GOV If RateCategory PKG package attributes can specify further details on the package. For other RateCategories rebates can apply which are further detailed by rebate attributes. |
@RebateAmount | Amount for the rebate, depending on the rebate type. Examples: 500 for A 7.5 for P 2 for N | 0..1 | ||
@RebateAmountType | Type of the price. P - percentage A - amount N - number of free nights | [A] [N] [P] | 0..1 | |
@RebateType | Name of the rebate. | 0..1 | corporate | |
@PackageName | Name of the package. | 0..1 | Business FLAT II | |
@PackageType | Type of the package. | 0..1 | season | |
@PackageDescription | freetext description of the package. | 0..1 | Business FLAT II: inclusive of full breakfast buffet, wireless internet, free non-alcoholic drinks from the minibar, upon availability: upgrade and early check-in / late check-out | |
</RateCategory> | ||||
<RoomTypeCode/> | Room type. | 1 | A1S | |
<RoomTypeDescription/> | Room type description. | 0..1 | Deluxe single | |
<RateCode/> | Display rate code. | 1 | STD | |
<RateDescription/> | Rate code description. | 0..1 | Standard | |
<Amount> | The amount of the daily rate. | 1 | 5900 | |
</Amount> | ||||
<Deposit/> | Deposit requirements. Deposit is a more restrictive type of guarantee, where a certain amount can be taken from credit card by the vendor. - Advantage: offers with deposit requirement are cheaper in most cases. - Disadvantage: In case of a cancellation this deposit amount can not be refunded, but this depends on cancellation policy. If a deposit is required, you need to specify a PNRCreateRQ/CompletePNRElements/Itinerary/Hotel/SupplementalInformation/PaymentGuarantee with attribute Type='D'. Values are: Y = deposit required N = deposit not required | [Y] [N] | 0..1 | N |
<Guarantee/> | Guarantee requirements. To guarantee a reservation. Credit cards specified for guarantee are only validated but not used for any payment. If a guarantee is required, you need to specify a PNRCreateRQ/CompletePNRElements/Itinerary/Hotel/SupplementalInformation/PaymentGuarantee with attribute Type='G'. Values are: Y = guarantee required N = guarantee not required | [Y] [N] | 0..1 | N |
<Hold/> | Hold requirements. Indicated the hold time which is the late check in time not requireing a guarantee. Valid values from 12 to 24. | [12] to [24] | 0..1 | 18 |
<RateChange/> | Rate change indicator determines if the rate changes during the length of stay. Values are: Y = Rate changes N = No change over the period | [Y] [N] | 0..1 | N |
<CommissionIndicator/> | Indicates of rate is commissionable or not. Values are: Y = rate is commissionable N = rate is not commissionable | [Y] [N] | 0..1 | Y |
<SellRestriction/> | Indicates that the rate has certain restrictions ay sell time. Values are: Y = sell restrictions apply N = no sell restriction | [Y] [N] | 0..1 | N |
<Meal> | Specifies if rate includes a meal or a breakfast. Values are: M = meal B = breakfast H = halfboard F = fullboard A = all inclusive U = unknown | [M] [B] [H] [F] [A] [U] | 0..1 | M |
@PriceAmount | Amount for the meal. | 0..1 | 500 | |
@PriceType | Type of the price. I - inclusive E - exclusive U - unknown | [I] [E] | 0..1 | |
@VendorCode | Vendor Code | 0..1 | ||
@Description | Freetext description. The returned language is determined based on the following priority on available data: 1. requested language 2. english 3. any available | 0..1 | ||
</Meal> | ||||
<CancelPolicy/> | Specifies if a cancel policy exist. Values are: Y = Policy exist N = no cancellatioon policy Note that if value is set to Y then some additional information can be provided in the CancelPolicyInfo section. However, more detailed description is available via HotelInformationRQ/RS. | [Y] [N] | 0..1 | N |
<CancelPolicyInfo> | This section contains information about cancellation "deadlines" - how many day s in advance PRIOR to arrival or what time on the day of arrival a reservation must be cancelled to avoid penalties. Note that this section is supported by Sabre only at this time. Note also that HotelInformationRQ/RS can be used to retrieve detailed information about a room rate. | 0..1 | ||
<CancelBefore> | This option shows how many days PRIOR to arrival date or hours prior to hotel defined check-in time limit on the desired date of arrival the reservation must be cancelled in order to avoid penalties. | 1 | 5 | |
@Unit | 1 | |||
</CancelBefore> | ||||
<CancelByTime/> | This option shows the time of the arrival date (check-in) by which the reservation must be cancelled in order to avoid penalties. | 1 | 16:00 | |
<NoCancel/> | Value set to 'Y' shows that the rate cannot be cancelled. Applies usually to certain rates with deposit requirement where full payment is required in advance and the reservation cannot be cancelled. Usually means that the amounts paid are non-refundable. In such cases it is recommended to see results of HotelInformationRQ/RS. | 1 | Y | |
<Text/> | Information text or error text. | 0..N | Free flow text. Example: Invalid flight number | |
</CancelPolicyInfo> | ||||
<RateAccess> | Rate access code. This is a special code corresponding to a negotiated rate. | 0..N | IBM | |
@CDNumber | Corporate discount number. | 0..1 | 23124 | |
</RateAccess> | ||||
<TotalAmount/> | Total amount for booked rate for the complete booking period (may include taxes, fees, surcharges). | 0..1 | 25000 | |
</Rooms> | ||||
<MoreRoomsToken/> | Token used to request more rooms following a hotel availability response. This token number can be sent back to Galileo in a subsequent hotel availability request. | 0..1 | RTDBSGRT | |
</HotelAvailabilityRS> |
| 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