Hotel Amenities
Hotel:/HotelSearchModifiers @ReturnAmenities
Hotel:/Amenities/Amenity
Hotel amenities for a property can include property features such as such as pool, restaurant, high-speed internet, or transportation to hotel, as well as room/rate features such as refrigerators and cable TV.
Amenities are returned for properties in Hotel Search responses. Availability of specific types of amenity data may vary by provider and supplier/aggregator.
Implementation by Provider
See Implemented Transactions for provider functionality specific to each transaction.
Provider |
Implementation |
---|---|
Galileo (1G) |
Supports /HotelSearchModifiers @ReturnAmenities. Supports /HotelSearchModifiers/Amenities. |
Apollo (1V) |
Supports /HotelSearchModifiers @ReturnAmenities. Supports /HotelSearchModifiers/Amenities. |
Worldspan (1P) |
Supports /HotelSearchModifiers @ReturnAmenities. Supports /HotelSearchModifiers/Amenities. |
Schema
- HotelSearchAvailabilityReq
- HotelSearchAvailabilityRsp
- HotelDetailsReq
- HotelDetailsRsp
- HotelCreateReservationReq
- HotelCreateReservationRsp
Request
Hotel Search requests can be modified to:
- Include or exclude amenity data from the response using @ReturnAmenities
- Request specific amenities as modifiers for the property response using /Amenities
Include or Exclude Amenity Data from the Response
If /HotelSearchModifiers @ReturnAmenities is set to:
- "True", available hotel amenities are for each property are returned in the response.
- "False" (default), hotel amenities are not returned in the response.
@ReturnAmenities applies to Galileo (1G), Apollo (1V), and Worldspan (1P).
Request Specific Amenities
Specific Amenity types can be used as search parameters for hotel properties using /HotelSearchModifiers/Amenities/Amenity.
- @AmenityType is either:
- HA = (default) Hotel Property Amenity, such as Wi Fi or Express Check-In. This subcategory is currently supported by Universal API, but not in the provider systems.
- RA = Room Amenity, such as Refrigerator or Connecting Rooms. This subcategory is currently supported by Universal API, but not in the provider systems.
- @Code uses either:
- OTA (Open Travel Alliance) Amenities codes (AVT).
See Encode/Decode Amenities for details on obtaining coded or decoded amenities.
Amenity search modifiers apply to Galileo (1G), Apollo (1V), and Worldspan (1P).
Response
Hotel amenities may initially be returned in the Hotel Search response in, and subsequently in Hotel Rate and Rule and Hotel Booking responses. The amount and type of amenity data varies by supplier/aggregator and provider.
If a search priority is not set specified in the request for hotel search modifiers, hotel amenities default as seventh in priority for matching hotel property options.
Encoding/Decoding Amenities
Encode/decode values for both types of amenity codes can be obtained using UniversalRecordRetrieveReq @Type="HotelAmenities". See Reference Data Retrieve for more information about encode/decode and amenity subcategories.
In Util.xsd OTA codes are returned. Certain subcategories of amenities can also be requested for encode/decode values.
The type of codes used vary by schema version and provider:
- Galileo, Apollo, and Worldspan
Uses OTA (Open Travel Alliance) Amenities codes (AVT). In Util.xsd, OTA codes are returned.
Implemented Transactions
HotelSearchAvailability(Asynch)Req/HotelSearchModifiers @ReturnAmenities
HotelSearchAvailability(Asynch)Req/HotelSearchModifiers/Amenities/Amenity
HotelSearchAvailability(Asynch)Rsp/HotelSearchResult/HotelProperty/Amenities/Amenity
The Hotel Search allows optional return of amenities for Galileo, Apollo, and Worldspan using @ReturnAmenities.
Amenities can be specified as search parameters using /HotelSearchModifiers/Amenities/Amenity @Code. Support for Galileo, Apollo, and Worldspan.
For all providers, amenities are returned in /HotelProperty/Amenities/Amenity.
HotelDetailsReq/HotelProperty/Amenities/Amenity
HotelDetailsRsp/RequestedHotelDetails/HotelProperty/Amenities/Amenity
Amenities from the Hotel Search can be optionally duplicated in the subsequent Hotel Rate and Rule Search or Hotel Description request, but are not required in the request.
For all providers, amenities are returned in /HotelProperty/Amenities/Amenity.
HotelCreateReservationReq/HotelProperty/Amenities/Amenity
HotelCreateReservationResponse/UniversalRecord/HotelReservation/HotelProperty/Amenities/Amenity
Amenities from the Hotel Rate and Rule Search can be optionally duplicated in the subsequent Hotel Booking request, but are not required in the request.
For all providers, amenities are returned in /HotelProperty/Amenities/Amenity.