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 |
|---|---|---|---|---|
<HotelSearchRS> | Hotel search 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 language for text content, returned by the CRS. Default value is 'en'. Example for city name: de=Wien fr=Vienne en=Vienna | 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> | ||||
<HotelsHeader> | Hotel header information CityCode and CityName are optional, because a HotelSearch by geo location can return results in different cities. | 1 | ||
<CheckInDate/> | Check in date in ISO 8601 format (yyyy-mm-dd). This is the date the customer will arrive (check in) at the hotel. | 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. | 1 | 2001-12-31 | |
<NumberOfNights/> | Number of nights. | 0..1 | 5 | |
<CityCode/> | City code. | 0..1 | MIA | |
<CityName/> | City name. | 0..1 | Miami | |
<PostalCode/> | Postal zip code. | 0..1 | 33176 | |
<StateCode/> | State code. | 0..1 | FL | |
<CountryCode/> | Country code. | 0..1 | US | |
<ReferencePoint/> | Reference point. | 0..1 | Eiffel Tower | |
<DistanceUnit/> | Unit of measure for distances. Values are: M = Miles K = Kilometers | [M] [K] | 0..1 | M |
<NumberOfPersons> | Number of persons per room incl. children. If multiple number of rooms were requested and the backend system supports a detailed breakdown of person allocation per room you can get multiple NumberOfPersons elements with a RoomRefID per room that show how many persons/children are using the room. If that is not supported you get only one NumberOfPersons element and NumberOfChildren attribute with the sum of all persons/children in party. | 0..N | 2 | |
@RoomRefID | RoomRefID identifies the room instance where this number of persons or children is assigned to. | 0..1 | 1 | |
@NumberOfChildren | Number of children in the room. | 0..1 | ||
</NumberOfPersons> | ||||
</HotelsHeader> | ||||
<Hotels> | Hotels group | 1..N | ||
@LinkType | Type of GDS link that the hotel participates in. The value 'CacheOrSource' is generic (not provider-specific). Currently it is used by Amadeus Web Service. Possibles values are: Cache .. data from cache CacheOrSource .. data from cache or source Source .. data from source 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 GLR .. Galileo Lowest Public Rate 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 PEG .. Pegasus | [Cache] [CacheOrSource] [Source] [ASA] [ACA] [ACP] [ADY] [AIA] [GIA] [GIP] [GRM] [GBP] [GLP] [GLR] [SDC] [SOL] [WSV] [WAP] [WNP] [HRS] [HRSEXT] [HBC] [PEG] | 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. | |
<ChainCode/> | Chain code. | 0..1 | MC | |
<ChainName/> | Chain name. | 0..1 | Marriott | |
<PropertyCode/> | Property code. | 1 | MIA345 | |
<PropertyName/> | Property name. | 1 | Marriott on the sea | |
<Address/> | Address. | 0..N | 1101 NW 57th AVE, Miami FL 33121, USA | |
<Telephone/> | Hotel telephone number. | 0..1 | 305-718-4144 | |
<Fax/> | Hotel fax number. | 0..1 | 305-718-4480 | |
<CityCode/> | City code. | 0..1 | MIA | |
<CityName/> | City name. | 0..1 | Miami | |
<PostalCode/> | Postal code or zip code. | 0..1 | 33126 | |
<StateCode/> | State code. | 0..1 | FL | |
<CountryCode/> | Country code. | 0..1 | US | |
<Distance/> | Distance of the property to the airport/city center or reference point specified in the request. The unit of measurement is specified by HotelsHeader/DistanceUnit. Exact behavior is back end system specific. | 0..1 | 5 | |
<Direction/> | Direction, in which the property lies in respect to the airport/city center or reference point specified in the request. Exact behavior is back end system specific. Values are: N = North S = South E = East W = West NE = North east SE = South east NW = North west SW = South west | [N] [S] [E] [W] [NE] [NW] [SE] [SW] | 0..1 | NE |
<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..N | B | |
<Transportation/> | Transportation type. One of the legal transportation types associated with the property. Valid values are: A = Water transport 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 | [A] [B] [C] [E] [F] [H] [I] [L] [N] [O] [P] [R] [S] [T] [U] [W] | 0..1 | B |
<DepositGuaranteeHold/> | Indicated if a deposit or a guarantee or a hold is required in one of the rates for the property. Values are: Y = deposit or hold or guarantee required, N = no deposit or hold or guarantee requirement | [Y] [N] | 0..1 | Y |
<SafetyCompliance/> | Safety compliance indicating if hotel meets F.E.M.A fire-compliance regulations, as required by American government officials. Values are: Y = hotel is compliant, N = hotel is not compliant | [Y] [N] | 0..1 | Y |
<CurrencyCode> | Currency code. | 0..1 | USD | |
@NumberOfDecimals | Decimal position in fare amount. | 1 | 2 | |
</CurrencyCode> | ||||
<Rates> | Rate information group | 0..N | ||
<AvailabilityStatus/> | Availbility status indicator. Values are: A = available R = on request O = hotel is available, but not for the rates requested. Usually applies when corporate codes were sent in request but hotel does not have the requested rates available C = closed U = unknown (may occur e.g. when link to provider system is down) D = hotel not available for dates requested. Try other dates. | [A] [R] [C] [O] [U] [D] | 1 | A |
<RateCategory> | Rate category. | 0..N | ||
@Type | OTA code type. RPT .. Rate Plan Type | [RPT] | 0..1 | |
@Code | OTA code. | 0..1 | ||
@Description | Free text description. If none available the OTA code name is used. | 0..1 | ||
@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> | ||||
<SellRestriction/> | Indicates that the rate has certain restrictions at 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 | [M] [B] [H] [F] [A] | 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 | |
</Meal> | ||||
<RateCode/> | Display applicable rate code. | 0..N | STD | |
<Amount> | The room amount. | 0..2 | 5900 | |
@Qualifier | Qualifies the rate returned. Values are: Min = minimum rate Max = maximum rate Min1 = 1st lowest available rate Min2 = 2nd lowest available rate. If no qualifier, the amount is an exact value. | [Min] [Max] [Min1] [Min2] | 0..1 | Min |
</Amount> | ||||
<Tax> | Tax to be added to the Rate Amount above. Taxes can be flat amount or percentage of the rate amount above. NOTE: Future use, not yet supported in XX1 adaptors. | 0..N | ||
@Type | Idetifies whether this tax is a flat amount or percentage of the room rate. | [P] [A] | 1 | |
@Amount | Percentage or flat amount of the tax, depending on the value of the Type attribute. | 1 | ||
<Designator/> | 1 | |||
<Description/> | 0..1 | |||
</Tax> | ||||
</Rates> | ||||
<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 |
<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> | ||||
<FormOfPaymentPolicy> | Form of payment policy | 0..N | ||
@Type | OTA code type. CDT .. CardType PMT .. Payment Type | [PMT] [CDT] | 1 | |
@Code | OTA code of type PMT (payment type). Examples: 1 .. Cash 2 .. Direct bill 5 .. Credit card 7 .. Check 10 .. Central bill (Airplus) 19 .. Travel agency IATA number | 1 | ||
@Description | Free text description. If none available the OTA code name is used. | 0..1 | ||
@AcceptanceStatus | Acceptance status for this payment method U .. Unknown AF .. Accepted with Fees A .. Accepted (no fees) N .. Not accepted | [U] [AF] [A] [N] | 0..1 | |
</FormOfPaymentPolicy> | ||||
<HotelCharacteristics> | Amenities, services and features the hotel is offering. | 0..N | ||
@Type | OTA code type. ACC .. Attraction Category Code ADT .. Additional Detail Type AMC .. Available Meal Category BUS .. Business Srvc Type GRI .. Guest Room Info HAC .. Hotel Amenity Code INF .. Information Type LOC .. Location Category Codes MPT .. Meal Plan Type MRC .. Meeting Room Code PCT .. Property Class Type PET .. Pets Policy Code PHY .. Physically Challenged Feature Code RMA .. Room Amenity Type RST .. Recreation Srvc Type SEC .. Security Feature Code SEG .. Segment Category Code TRP .. Transportation Code VS .. Vendor Specific | [ACC] [ADT] [AMC] [BUS] [GRI] [HAC] [INF] [LOC] [MPT] [MRC] [PCT] [PET] [PHY] [RMA] [RST] [SEC] [SEG] [TRP] [VS] | 1 | |
@Code | OTA code. | 1 | ||
@Quantity | If necessary a quantity for an item can be specified here. | 0..1 | ||
@Description | Free text description. If none available the OTA code name is used. | 0..1 | ||
@Included | Indicates, whether this is included in the rate or not. Y .. is included in rate N .. is NOT included in rate U .. unknown | [Y] [N] [U] | 0..1 | |
@ChargeAmount | Cost amount for this item. | 0..1 | 2000 | |
<Details> | 0..N | |||
@Type | OTA code type. PRX .. Proximity | [PRX] | 1 | |
@Code | OTA code. | 1 | ||
@Description | Free text description. If none available the OTA code name is used. | 0..1 | ||
</Details> | ||||
</HotelCharacteristics> | ||||
<POIDistance> | Distance to a point of interest. Will somewhen replace DistanceToAirport. | 0..N | 5.5 | |
@POIType | Point of interest type. | [AIRPORT] [CAR RENTAL STATION] [CINEMA] [CITY CENTER] [CITY DISTRICT] [COMPANY LOCATION] [FAIR] [HIGHWAY] [LOCATION] [PETROL STATION] [SHOPPING] [SMALL TOWN] [THEATER] [TOURIST FEATURE] [TRAIN STATION] [UNKNOWN] | 1 | AIRPORT |
@POIName | Point of interest name. | 0..1 | FRANKFURT/MAIN | |
</POIDistance> | ||||
</Hotels> | ||||
<MoreHotelsToken/> | Token used to request more hotels in the subsequent hotel search request. | 0..1 | 124523467899 | |
<SimilarNameList> | ONLY Amadeus, HRS, Apollo/Galileo Pegasus: If a reference point was specified in the request, a list of reference points with similar names may be returned, if no exact match is found. However, the name matching rules are not very elaborate: a name is regarded similar as soon as (and only if) it starts with the same letter as the name requested. SimilarNameList may also return a list of exact matches for the requested name, if the matched reference points lie in or near a different city than the one requested. | 1..N | ||
<SimilarName> | Name of reference point which is similar to the reference point name requesteed. | 1 | WHITE HOUSE | |
@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 mapped 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 | |
@PointCode | A reference point code. | [APT] [ATT] [BST] [BUS] [CAR] [CNV] [CTY] [EDU] [EVT] [GRD] [HEL] [HTL] [MIL] [PAR] [PRT] [RAI] [RST] [SHO] [SPO] [TRA] | 0..1 | WCSA12677 |
</SimilarName> | ||||
<CityCode/> | City code of the city the reference point is located in or near. | 1 | WAS | |
<Address/> | Address. | 0..4 | 1101 NW 57th AVE, Miami FL 33121, USA | |
<CityName/> | City name. | 0..1 | Miami | |
<PostalCode/> | Postal code or zip code. | 0..1 | 33126 | |
<StateCode/> | 2 letter state code of the state the reference point is located in (for countries with state subdevision). | 0..1 | DC | |
<CountryCode/> | Country code. | 0..1 | US | |
<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 |
<Telephone/> | Contact telephone number. | 0..1 | 305-718-4144 | |
</SimilarNameList> | ||||
</HotelSearchRS> |
| 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