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 |
|---|---|---|---|---|
<HotelSearchRQ> | Hotel search request root element | 1 | ||
@version | Version number. | 0..1 | 1.0 | |
@Timeout | Timeout value in seconds. All results, received from backend within that time period will be returned. | 0..1 | ||
@AvailableOnly | Selects whether only inventory with available rooms for requested parameters should show up (default is 'Y'). | [Y] [N] | 0..1 | |
@RefundableOnly | Selects whether only hotels with refundable room rates should show up (default is 'N'). | [Y] [N] | 0..1 | |
@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 | ||
@NumberOfAlternates | Maximum number of options requested. The service will collect options until this number is reached or the provider returns no more options (whatever happens first). The resulting set of options will be returned to the client. CAUTION: Depending on the value this can be a time consuming transaction! Values are: Either a positive integer value identifying the number of requested options or 'ALL' to retrieve all of them. | 0..1 | ||
@DisplayPreference | Result order preference. This controls, how results are ordered by GDS/CRS, before the number of results is filtered, which is specified by NumberOfAlternates. LP ... lowest price HP .. highest price (AmadeusWS, HRS, CRC only) SD ... shortest distance LD .. longest distance (CRC, HRS only) C .. contracted first (CRC, ehotel only) Only supported by ehotel, Amadeus, CRC are some strings constructed to represent the sort criteria char by char in precedence order. Meaning of the lowercase letters is: 'c' .. contracted first, 'p' .. price asc, 'd' .. distance asc, 'r' .. ranking desc. When using uppercase letters 'C', 'P', 'D', 'R' instead, then the sort order is inverted. | 0..1 | cPdr Only CRC has an even more special sort order feature (see pattern with 'L'). Example: Ld2cp;10cp;cp Default value is 'LP' except for Amadeus where unsorted results are the default. | |
<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> | ||||
<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. | 0..1 | 1 | |
<CityCode> | City or airport code. | 1 | LON | |
@Radius | Radius around the specified location, within which results should be included. | 0..1 | 2 | |
@DistanceUnit | Unit of distance in which Radius is specified. Values: M = Miles K = Kilometers Defaults to kilometers, if left out. | [M] [K] | 0..1 | K |
</CityCode> | ||||
<GeoCoded> | Geographical position information. Allows search by geographical longitude and latitude and to define a search radius around the specified geo location. For Amadeus it is mandatory to additionaly specify the country the coordinates point to using HotelOptions/CountryCode. | 1 | ||
@Radius | Radius around the specified location, within which results should be included. | 0..1 | 2 | |
@DistanceUnit | Unit of distance in which Radius is specified. Values: M = Miles K = Kilometers Defaults to kilometers, if left out. | [M] [K] | 0..1 | M |
<Longitude/> | Degree of longitude. Values range from -180 to +180 using decimal fractions. Positive values refer to longitudes east, negative values to longitudes west of the zero (Greenwich) meridian. | [-180] to [180] | 1 | -123.87611 |
<Latitude/> | Degree of latitude. Values range from -90 to +90 using decimal fractions. Positive values refer to latitudes north, negative values to latitudes south of the equator. | [-90] to [90] | 1 | -49.98569 |
</GeoCoded> | ||||
<Address> | Address element should contain at least one attribute. Supported only by AmadeusWS. | 1 | ||
@PropertyName | Property name. | 0..1 | The Sheraton at the Park | |
@AddressLine | Free form text postal address line. | 0..1 | 420 LINCOLN RD | |
@CityName | City name. When specifying CityName, CountryCode must be provided too. | 0..1 | Miami | |
@ZipCode | Zip code. | 0..1 | 33176 | |
@StateCode | US State code. | 0..1 | FL | |
@CountryCode | ISO 2-letter country code. | 0..1 | US | |
@Radius | Radius around the specified location, within which results should be included. | 0..1 | 2 | |
@DistanceUnit | Unit of distance in which Radius is specified. Values: M = Miles K = Kilometers Defaults to kilometers, if left out. | [M] [K] | 0..1 | M |
</Address> | ||||
<NumberOfPersons> | Number of persons per room incl. children. If /HotelSearchRQ/HotelOptions/NumberOfRooms is greater than 1 then different allocations per room can be defined here if the backend system supports it. Therefore use RoomRefID attribute to specify the number of the room that the NumberOfPersons should apply to. E.g. - NumberOfRooms=2 - NumberOfPersons=2 for RoomRefID=1 and - NumberOfPersons=3 for RoomRefID=2 In combination with Children/Child elements, that can also be assigned to different rooms you can specify different number of persons and childs for each of multiple rooms. | 1..N | 1 | |
@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 | |
</NumberOfPersons> | ||||
<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 | ||
<HotelCharacteristics> | All types of amenities, services and features a hotel should or must have. | 0..N | ||
@Type | OTA code type. ACC .. Attraction Category Code AMC .. Available Meal Category Codes ARC .. Architectural Style Code BUS .. Business Srvc Type HAC .. Hotel Amenity Code LOC .. Location Category Codes MPT .. Meal Plan Type MRC .. Meeting Room Code PCT .. Property Class Type PHY .. Physically Challenged Feature Code RST .. Recreation Srvc Type SEC .. Security Feature Code TRP .. Transportation Code | [ACC] [AMC] [ARC] [BUS] [HAC] [LOC] [MPT] [MRC] [PCT] [PHY] [RST] [SEC] [TRP] | 1 | |
@Code | OTA code. | 1 | ||
@Required | Specifies, whether requested characteristic is an optional or mandatory requirement for listed hotels. If not specified it is handled as optional requirement. | [Y] [N] | 0..1 | |
</HotelCharacteristics> | ||||
<RoomCharacteristics> | All types of amenities, services and features a room should or must have. | 0..N | ||
@Type | OTA code type. BED .. Bed Type RMA .. Room Amenity Type | [BED] [RMA] | 1 | |
@Code | OTA code. | 1 | ||
@Required | Specifies, whether requested characteristic is an optional or mandatory requirement for listed hotels. If not specified it is handled as optional requirement. | [Y] [N] | 0..1 | |
</RoomCharacteristics> | ||||
<Amenity> | DEPRECATED: Will be replaced by HotelCharacteristics and RoomCharacteristics in future. Amenity code. Restrict the availability to only those hotels that have the specified facility. Values are: ADA = ADA accessible ADT = Adult only hotel AIR = Air conditioning BAB = Baby-sitting BAR = Bar BEA = Beach BFT = Breakfast BLC = Rooms with Balcony BRB = Barber BTY = Beauty parlor BUS = Business center CAR = Car rental CAS = Casino CCG = Concierge CHD = Children's program COF = Coffee shop CON = Convention center DIS = Disco ECO = ECO Friendly Certified Indicator ELE = Elevator ENT = Entertainment EXC = Currency exchange EXE = Executive floor FAM = Family plan FAX = Fax facility in room FSP = Full service spa on property GIF = Gift shop GOL = Golf HAD = Hair dryer HAI = Hairdresser HAN = Handicap HEA = Health club HSI = HighSpeed Internet HYP = Hypoallergenic rooms ICE = Ice machine ICT = In room Coffee/Tea ISW = Indoor pool JAC = Jacuzzi KIT = Kitchen LAU = Laundry service LOU = Lounge MAS = Massage MEE = Meeting rooms MIN = Mini-bar in room MOV = Movie channels NAT = No Adult Channels offered on television system NON = Non-smoking rooms OSW = Outdoor pool PAR = Parking PCH = PC hook-up in room PET = Pets accepted PHA = Pharmacy PHO = Phone direct dial PLF = Free local calls PTR = Public transportation adjacent RES = Restaurants RFG = Refrigerator in room R24 = 24 hour room service ROO = Room service RSF = In Room Safe RST = Restricted room access SAF = Safe deposit box SAU = Sauna SEC = Secretarial SFR = Smoke-free property SIG = Sightseeing SIO = Ski-in / ski-out property SMK = Smoking rooms available SNO = Snow skiing SOL = Solarium SPA = Spa STL = Shuttle service SWI = Swimming pool TEL = Television TEN = Tennis VAL = Valet parking WAT = Water sports WCR = WC WET = Wet bar WFM = Free WIFI in meeting rooms WFP = Free WIFI in public spaces WFR = Free WIFI in room WOM = Women guest rooms WTR = Property utilizes a water purification system | 0..3 | SWI | |
@Priority | Searches hotel options according to the priority number assigned, 01 being the highest priority, 02 second highest, etc. This is exclusive to Galileo only. | 0..1 | 01 | |
</Amenity> | ||||
<ReferencePoint> | Reference point group For Amadeus the search by ReferencePoint must be further restricted by specifying either CountryCode or CityCode. If CityCode is used, only hotels associated to the specified CityCode will be returned. | 0..1 | ||
@Priority | Searches hotel options according to the priority number assigned, 01 being the highest priority, 02 second highest, etc. This is exclusive to Galileo only. | 0..1 | 01 | |
@CodeType | Code used for the Category (OTA-Code or VS). Values: REF .. Reference Point Category Code IPC .. Index Point Code VS .. Vendor Specific | [REF] [IPC] [VS] | 0..1 | REF |
@Category | Code value for the category. The OTA code "REF" is preferred (Reference Point Category Code). For further categories OTA-IPC is used. For the remaining categories VS codes can be used. CodeType and Category are related to the formerly usual 3-letter-codes as follows: REF 1 .. APT (Airport) IPC 16 .. ATT (Attraction) REF 8 .. BST (Bus Station) IPC 17 .. BUS (Business Location) IPC 18 .. CAR (Car Rental Location) IPC 19 .. CNV (Convention Center) REF 10 .. CTY (City) REF 12 .. EDU (Educational) IPC 21 .. EVT (Event) REF 22 .. GRD (Ground Transport) IPC 14 .. HEL (Heliport) IPC 11 .. HTL (Hotel) IPC 23 .. MIL (Military Bases) REF 25 .. PAR (Park / Recreational Area) IPC 25 .. PRT (Port) REF 34 .. RAI (Rail Station) IPC 26 .. RST (Resorts / Ski Area) REF 30 .. SHO (Shopping Center) REF 31 .. SPO (Sports) IPC 29 .. TRA (Transportation Points) If Category is left out, will search PointName in all categories of reference points. | 0..1 | 31 | |
<PointName/> | Reference point name selected by the customer. | 1 | London Eye | |
<PointCode/> | Reference point code. | 1 | WCSA12677 | |
<Distance> | Distance from the reference point. | 0..1 | 10 | |
@Unit | Distance unit. Values are: M = Miles K = Kilometers | [M] [K] | 1 | M |
</Distance> | ||||
<Direction/> | Direction from reference point. Values are: N = North S = South E = East W = West NE = Northeast NW = Northwest SE = Southeast SW = Southwest | [N] [S] [E] [W] [NE] [NW] [SE] [SW] | 0..1 | NE |
</ReferencePoint> | ||||
<PropertyName> | Property name. | 0..1 | The Sheraton at the Park | |
@Priority | Searches hotel options according to the priority number assigned, 01 being the highest priority, 02 second highest, etc. This is exclusive to Galileo only. | 0..1 | 01 | |
</PropertyName> | ||||
<PropertyType> | Property type. OTA Property type codes (PCT) supported in future. Legacy values: H = Hotel M = Motel S = Suites C = Condo R = Resort For HRS additionally: B = Beach K = Castle D = Design G = Golf L = Luxury S = Ski W = Wellness | 0..1 | M | |
@Priority | Searches hotel options according to the priority number assigned, 01 being the highest priority, 02 second highest, etc. This is exclusive to Galileo only. | 0..1 | 01 | |
</PropertyType> | ||||
<HotelCategory/> | Hotel category used to restrict the availability to hotels in a specific category. The default is all. Valid values (in order of descending significance) are: L = Luxury class F = First class C = Comfort S = Standard class T = Tourist class | [L] [F] [C] [S] [T] | 0..N | F |
<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> | ||||
<RoomType> | Room type code. The code consists of three parameters: room category, number of beds and bed type. | 0..1 | A1K | |
@Priority | Searches hotel options according to the priority number assigned, 01 being the highest priority, 02 second highest, etc. This is exclusive to Galileo only. | 0..1 | 01 | |
</RoomType> | ||||
<RateCategory> | Rate category. | 0..N | ||
@Type | OTA code type. RPT .. Rate Plan Type VS .. Vendor specific Non-OTA Code | [RPT] [VS] | 1 | |
@Code | OTA or vendor specific code. | 1 | ||
@Priority | Searches hotel options according to the priority number assigned, 01 being the highest priority, 02 second highest, etc. This is exclusive to Galileo only. | 0..1 | 01 | |
</RateCategory> | ||||
<RateRange> | Rate range group | 0..1 | ||
@Priority | Searches hotel options according to the priority number assigned, 01 being the highest priority, 02 second highest, etc. This is exclusive to Galileo only. | 0..1 | 01 | |
<Lowest/> | Lowest rate in a range search. | 1 | 100 | |
<Highest/> | Highest rate in a range search. | 1 | 200 | |
</RateRange> | ||||
<Location> | Location of the hotel. OTA Location codes (LOC) supported in future. Legacy values are: A = Airport B = Beach C = City Centre D = Downtown E = East of city N = North of city O = Ouside Airport R = Resort S = South of city T = Airport Terminal U = Suburb W = West of city Y = Country side | 0..1 | D | |
@Priority | Searches hotel options according to the priority number assigned, 01 being the highest priority, 02 second highest, etc. This is exclusive to Galileo only. | 0..1 | 01 | |
</Location> | ||||
<Transportation> | Transportation type. One of the legal transportation types associated with the property. Valid values are: A = Water tranportation B = Bus C = Courtesy car E = Rail or express train F = Free transportation provided by the hotel H = Helicopter I = Plane L = Limousine N = Any transportation O = Check with hotel P = Public transportation R = Rental car S = Subway underground T = Taxi U = Courtesy bus W = Walking distance | 0..1 | B | |
@Priority | Searches hotel options according to the priority number assigned, 01 being the highest priority, 02 second highest, etc. This is exclusive to Galileo only. | 0..1 | 01 | |
</Transportation> | ||||
<SafetyCompliance> | Safety compliance code. Used to determine which hotels meet F.E.M.A fire-compliance regulations, as required by American government officials. Default is Y (compliant). Y = hotel is compliant N = hotel is not compliant | [Y] [N] | 0..1 | Y |
@Priority | Searches hotel options according to the priority number assigned, 01 being the highest priority, 02 second highest, etc. This is exclusive to Galileo only. | 0..1 | 01 | |
</SafetyCompliance> | ||||
<ChainCode> | Hotel chain code. | 0..N | HH | |
@Priority | Searches hotel options according to the priority number assigned, 01 being the highest priority, 02 second highest, etc. This is exclusive to Galileo only. | 0..1 | 01 | |
</ChainCode> | ||||
<CityName/> | City name. When specifying CityName, CountryCode must be provided too. | 0..1 | Miami | |
<ZipCode/> | Zip code. | 0..1 | 33176 | |
<Address/> | Free form text postal address line. | 0..1 | 420 LINCOLN RD Supported for HRS only (CityName element must be specified additionally). | |
<StateCode/> | US State code. Sabre requires state code for search by reference point. | 0..1 | FL | |
<CountryCode/> | ISO 2-letter country code. | 0..1 | US | |
<NumberOfRooms/> | Number of rooms. If not specified 1 room is default. | 0..1 | 2 | |
<HotelList> | List of specific hotel properties for which availability should be checked. | 0..1 | ||
@ReturnAlternates | If set to 'Y', alternate properties which are not part of the list will be returned also. Values are: Y .. Yes N .. No Default: N | [Y] [N] | 0..1 | |
<Hotel> | 1..N | |||
<ChainCode/> | Hotel chain code. | 0..1 | HH | |
<PropertyCode/> | Property code. | 1 | 002343 | |
</Hotel> | ||||
</HotelList> | ||||
<RateAccess> | Rate access code. This is a special code corresponding to a negotiated rate. | 0..N | IBM | |
@Priority | Searches hotel options according to the priority number assigned, 01 being the highest priority, 02 second highest, etc. This is exclusive to Galileo only. | 0..1 | 01 | |
</RateAccess> | ||||
</HotelOptions> | ||||
<MoreHotelsToken> | Token used to request more hotels (to be used only in XX/1 sessioned mode). This element is a string reference to a previous result set and should be copied from the response to the subsequent request for more hotels in the same XX/1 session. | 0..1 | 124523467899 or Y. | |
</MoreHotelsToken> | ||||
</HotelSearchRQ> |
| 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