What is it?
With the Hotel Content API, you can use the endpoints to get robust descriptive information about a single hotel or multiple hotels. During the shopping and booking process, use the two endpoints (explained below) to inform guests about each hotel's details and to answer questions they may have about the property.
Before You Begin
- You must authenticate before you can use this API. For full instructions, see Get a Token for REST APIs.
- At any time, you can go to this API's Reference Documentation tab, where you can make test calls with the following endpoints.
How to use
This section covers the endpoints for this API and examples of how to use them.
GET details for one hotel #
This endpoint enables you to retrieve details for a hotel that you specify.
[GET] /v1/api/hotel/{id}/detailsPath Parameters
The following table describes the path parameters that you must include when you query this endpoint:
| Element | Description | Type | Required? |
|---|---|---|---|
| id | The ID of the hotel for which you want to get details. Example: 13098. | number | Yes |
Query Parameters
The following table describes the query parameters that you can include when you query this endpoint:
| Element | Description | Type | Required? |
|---|---|---|---|
| attributeCategory | You can specify one or more attribute categories. Available values are: Unknown, GeneralFacilities, LocalPolicies, Location, PhysicallyChallengedFacilities, Ratings, Safety, Settings. | array | Optional |
Note: All of the query parameters that this endpoint allows (except attributeCategory, explained above) are also allowed for the following endpoint. This endpoint also returns responses that are the same as the following endpoint. See the query parameters and response for the following endpoint for details.
GET details for multiple hotels #
This endpoint enables you to retrieve details for a list of hotels that you specify.
[GET] /v1/api/hotel/listQuery Parameters
The following table describes the elements that you can include when you query this endpoint:
| Element | Description | Type | Required? |
|---|---|---|---|
| brandId | The ID of a specific brand in Aven Hospitality's SynXis Central Reservation System (CRS), which includes the hotels for which you want to get details. Example: 12345. | number | No |
| chainId | The ID of the chain or management group of the hotels for which you want to get details. Example: 12723. | number | Yes |
| id | The IDs of the hotels for which you want to get details. Example: Include multiple hotels separated by commas, like this &id=13098,16099. | array | No |
| addressCity | The city associated with a hotel address. | string | No |
| addressState | The code of a state or province associated with an address. An ISO State/Prov code. | string | No |
| addressPostalCode | The Postal code associated with a hotel address. | string | No |
| addressCountry | The country of the address. An ISO Alpha-2 letter alpha country code. | string | No |
| destinationId | The ID associated with a destination in Aven Hospitality's SynXis Central Reservation System (CRS). | string | No |
| destinationCode | The code associated with a destination in Aven Hospitality's SynXis Central Reservation System (CRS). | string | No |
| locationLatitude | The latitude coordinate to use in the search for hotels. | number | No |
| locationLongitude | The longitude coordinate to use in the search for hotels. | number | No |
| locationRadius | The radius to use in a latitude / longitude search for hotels. | number | No |
| locationUnits | The unit of measurement for the radius. Available values are: miles, kilometers. | string | No |
| airportCode | The valid IATA airport code. | string | No |
| primaryChannel | The booking channel code from Aven Hospitality's SynXis Central Reservation System (CRS). Example: Web | string | No |
| include | Specifies the additional information that you want to include in the response. Example: Include multiple attributes separated by commas, like this &include=Transportation,Tier. Note: See the list of values below that you can use with the include parameter. | string | No |
The following is the list of values that you can use with the include parameter:
• Attributes: Return a list of attributes for the hotel.
• ChannelProperties: Return Channel properties of the hotel.
• ContactInfo: Return the contact information for the hotel.
• Currency: Return the default currency for the hotel.
• DiningOptions: Return a list of dining options for the hotel.
• Features: Return a list of property features for the hotel.
• HotelGroups: Return a list of Chains and Brands associated to the hotel.
• Images: Return a property level hotel image.
• Languages: Return a list of languages the hotel supports.
• LocationInfo: Return address, latitude/longitude and time zone information for the hotel.
• MealPlans: Return a list of meal plans for the hotel.
Note: Within MealPlans, the AvailableToAnyGuest attribute specifies whether the meal plan is available to all guests (true) or available to only certain groups of guests (false).
• MediaLibraryImages: Return the library of images.
• Messages: Return the messages and alerts.
• PaymentMethods: Return a list of payment methods the hotel supports.
• Recreations: Return a list of recreation information for the hotel.
• ReferencePoints: Return a list of reference points near the hotel.
• Services: Return a list of services for the hotel.
• Tier: Return the Hotel Tier Definition.
• Transportation: Return a list of Transportation for the hotel.
Response in JSON
{
"contentLists": {
"destinationList": [
{
"Id": "string",
"Code": "string",
"Name": "string"
}
],
"currencyList": [
{
"Code": "string",
"Name": "string",
"DecimalPlaces": 0,
"RateOfExchange": "string",
"Symbol": "string"
}
],
"croList": [
{
"Id": "string",
"Name": "string",
"Chain": {
"Id": "string"
}
}
],
"brandList": [
{
"Code": "string",
"ID": "string",
"Name": "string",
"ChainID": "string"
}
],
"languageList": [
{
"Code": "string",
"Name": "string",
"NativeName": "string"
}
],
"paymentMethodList": [
{
"Code": "string",
"Name": "string",
"Type": "AL",
"Category": "string",
"IsPassThru": true
}
],
"chainList": [
{
"Code": "string",
"ID": "string",
"Name": "string"
}
]
},
"hotelList": [
{
"ActiveDate": {
"StartDate": "2026-04-30",
"EndDate": "2026-04-30"
},
"AlertList": [
{
"Name": "string",
"Type": "BookingInfo",
"Details": {
"Description": "string",
"DetailedDescription": "string",
"Validity": {
"End": "2026-04-30",
"Start": "2026-04-30"
}
}
}
],
"Attributes": [
{
"Category": "LocalPolicies",
"Id": 0,
"Name": "string",
"Value": "string",
"DataType": "string"
}
],
"BrandList": [
{
"ID": "string",
"Default": true
}
],
"CROList": [
{
"Id": "string"
}
],
"ChainList": [
{
"ID": "string",
"Primary": true
}
],
"Channels": [
{
"Code": "string",
"Name": "string",
"ParentCode": "string",
"EnabledForDistribution": true,
"IsDefaultGroupChannel": true,
"IsChannelEnabledForGroups": true,
"Properties": {
"HotelCode": "string",
"ChainCode": "string",
"GoLiveDate": "2026-04-30"
}
}
],
"ContactDetails": {
"ContactName": "string",
"ContactNumberList": [
{
"Number": "string",
"Type": "Home"
}
],
"EmailAddress": "string",
"Website": "string"
},
"Currency": {
"Code": "string",
"Name": "string",
"Default": true
},
"DestinationList": [
{
"Id": "string"
}
],
"DiningOptionList": [
{
"Description": "string",
"Name": "string",
"OnProperty": true,
"SmokingPermitted": true,
"Distance": "string",
"Meal": {
"Breakfast": true,
"Brunch": true,
"Dinner": true,
"Lunch": true
},
"Category": [
{
"OtaCode": "string",
"OtaType": "string",
"OtaDescription": "string"
}
],
"SortOrder": 0
}
],
"Location": {
"Address": {
"AddressLine": [
"string"
],
"City": "string",
"CountryName": {
"code": "string",
"value": "string"
},
"PostalCode": "string",
"StateProv": {
"code": "string",
"value": "string"
}
},
"Latitude": "string",
"Longitude": "string",
"TimeZone": "string",
"Type": "None"
},
"LanguageList": [
{
"Code": "string",
"Default": true,
"Primary": true
}
],
"MealPlanList": [
{
"Name": "Bed and Breakfast",
"Type": "Continental",
"Chargeable": true,
"Description": "Breakfast included in all rates. Buffet Breakfast served in the main restaurant 6-10 am.",
"AvailableToAnyGuest": true
}
],
"PaymentMethodList": [
{
"Code": "string",
"Deposit": true,
"Guarantee": true,
"InUse": true,
"IsPassThru": true
}
],
"RecreationList": [
{
"Type": "string",
"OnProperty": true,
"Distance": 0,
"Note": "string",
"OtaCode": "string",
"OtaDescription": "string",
"OtaType": "string"
}
],
"ReferencePointList": [
{
"Name": "string",
"Type": "Attraction",
"Direction": "E",
"Distance": 0,
"UnitOfMeasure": "None"
}
],
"RelativeLocation": {
"AnchorLatitude": 0,
"AnchorLongitude": 0,
"Distance": 1000,
"Unit": "Kilometers",
"Orientation": "East",
"OriginalHotel": [
{
"Id": "Unknown Type: int"
}
]
},
"ServiceList": [
{
"OnProperty": true,
"Note": "string",
"Type": {
"Code": "string",
"Id": 0,
"Name": "string"
}
}
],
"PropertyFeatures": [
{
"Code": "string",
"Description": "string",
"OtaCode": "string",
"OtaDescription": "string",
"OtaType": "string"
}
],
"Status": "Open",
"TerminalList": [
{
"Code": "string",
"Type:": "Airport",
"TransportationList": [
{
"TransportationCode": "string",
"TransportationMethod": "Alternate",
"OneWay": true,
"ArrangeableByHotel": true,
"Description": "string"
}
]
}
],
"Tier": {
"Code": "string",
"Name": "string"
},
"Code": "string",
"PmsCode": "string",
"ID": 0,
"Name": "string",
"ShortName": "string",
"ImageList": [
{
"Caption": "Ocean View",
"Path": "https://hotel.cloudfront.net/imageRepo/1/OceanView.jpg",
"Description": "Restaurant with Ocean View",
"SortOrder": 1,
"MediaType": "CRS",
"MediaCategory": "Rate"
}
],
"Descriptions": [
{
"Name": "string",
"Description": "string"
}
]
}
],
"paging": {
"Size": 50,
"Start": 0,
"Total": 146
}
}Response Elements
The following table explains the elements you receive in the response.
To make the response structure easier to follow, this table prefixes every element with the object and array structure that contains it, like this: ArrayOne.ArrayTwo.ArrayThree.Element
| Element | Description | Type |
|---|---|---|
| contentLists | The object to hold all the hotel content list information. | object |
| contentLists.destinationList | The array to hold the destination list information. | array |
| contentLists.destinationList.Id | Unique ID that identifies a specific Destination in Aven Hospitality's SynXis Central Reservation System (CRS). | string |
| contentLists.destinationList.Code | Code of a destination. | string |
| contentLists.destinationList.Name | Name of a destination. | string |
| contentLists.currencyList | The array to hold the currency list information. | array |
| contentLists.currencyList.Code | The currency code in ISO 4217 three alpha format. Example: USD. | string |
| contentLists.currencyList.Name | Name of the currency. | string |
| contentLists.currencyList.DecimalPlaces | Number of decimals supported by the currency. | number |
| contentLists.currencyList.RateOfExchange | Rate of exchange for the currency. | string |
| contentLists.currencyList.Symbol | Symbol of the currency. | string |
| contentLists.croList | The array to hold the Central Reservations Office (CRO) list information. | array |
| contentLists.croList.Id | Unique ID that identifies a specific CRO in Aven Hospitality's SynXis Central Reservation System (CRS). | string |
| contentLists.croList.Name | Name of a CRO. | string |
| contentLists.croList.Chain | The object to hold the CRO list chain information. | object |
| contentLists.croList.Chain.Id | ID of the Chain that the CRO is associated with. | string |
| contentLists.brandList | The array to hold the brand list information. | array |
| contentLists.brandList.Code | Code identifying the hotel or chain brand. | string |
| contentLists.brandList.ID | Unique ID that identifies a specific brand in Aven Hospitality's SynXis Central Reservation System (CRS). | string |
| contentLists.brandList.Name | Name of a hotel or chain brand. | string |
| contentLists.brandList.ChainID | ID of the Chain that the brand is associated with. | string |
| contentLists.languageList | The array to hold the language list information. | array |
| contentLists.languageList.Code | Language code with an optional culture code. For example: en or en-us. | string |
| contentLists.languageList.Name | Name of the language. | string |
| contentLists.languageList.NativeName | Native Name for the language. | string |
| contentLists.paymentMethodList | The array to hold the payment method list information. | array |
| contentLists.paymentMethodList.Code | Standard code for the payment type. | string |
| contentLists.paymentMethodList.Name | Name of the payment type. | string |
| contentLists.paymentMethodList.Type | This is the type of the payment method. Available values are: AL, ATMDC, AX, BA, BO, CB, CC, CH, CK, DB, DC, DK, DS, EC, ER, EU, FB, GW, HI, ID, IP, JC, KB, LPC, LPP, MA, MC, MD, NB, PP, TA, TP, UP, UPE, Unknown, VI, WA, WC, XS. | string |
| contentLists.paymentMethodList.Category | Payment method category. | string |
| contentLists.paymentMethodList.IsPassThru | If this is true, the payment method is a pass-through payment method. If this is false, the payment method is not a pass-through payment method. | boolean |
| contentLists.chainList | The array to hold the chain list information. | array |
| contentLists.chainList.Code | Code that defines a hotel chain or management group in Aven Hospitality's SynXis Central Reservation System (CRS). | string |
| contentLists.chainList.ID | Unique ID that identifies a hotel chain or management group in Aven Hospitality's SynXis Central Reservation System (CRS). | string |
| contentLists.chainList.Name | Name of the hotel chain. | string |
| hotelList | The array to hold the hotel list information. | array |
| hotelList.ActiveDate | The object to hold the hotel's active date information. | object |
| hotelList.ActiveDate.StartDate | Beginning date that the hotel is active. | string |
| hotelList.ActiveDate.EndDate | Date that the hotel was terminated from CRS. | string |
| hotelList.AlertList | The array to hold the alert list information. | array |
| hotelList.AlertList.Name | Name of the alert. | string |
| hotelList.AlertList.Type | The type of the alert. Available values are: BookingInfo, Hotel, Marketing. | string |
| hotelList.AlertList.Details | The object to hold the alert list details. | object |
| hotelList.AlertList.Details.Description | Short description of the alert. | string |
| hotelList.AlertList.Details.DetailedDescription | Detailed description of the alert. | string |
| hotelList.AlertList.Details.Validity | The object to hold the validity information for the alert. | object |
| hotelList.AlertList.Details.Validity.End | End date for which the alert applies. | string |
| hotelList.AlertList.Details.Validity.Start | Start date for which the alert applies. | string |
| hotelList.Attributes | The array to hold the hotel attributes. | array |
| hotelList.Attributes.Category | Category code of the attribute. Available values are: LocalPolicies, Location, GeneralFacilities, PhysicallyChallengedFacilities, Ratings, Safety. | string |
| hotelList.Attributes.Id | CRS ID of the attribute. | integer |
| hotelList.Attributes.Name | Name of the attribute. | string |
| hotelList.Attributes.Value | Value of the attribute. | string |
| hotelList.Attributes.DataType | Data type associated to the specific attribute. | string |
| hotelList.BrandList | The array to hold the brand list information. | array |
| hotelList.BrandList.ID | Unique ID that identifies a specific brand in CRS. | string |
| hotelList.BrandList.Default | If this is true, the brand is the default brand for the hotel. If this is false, the brand is not the default brand for the hotel. | boolean |
| hotelList.CROList | The array to hold the Central Reservations Office (CRO) list information. | array |
| hotelList.CROList.Id | Unique Id that identifies a CRO or management group in Aven Hospitality's SynXis Central Reservation System (CRS). | string |
| hotelList.ChainList | The array to hold the chain list information. | array |
| hotelList.ChainList.ID | Unique ID that identifies a hotel chain or management group in CRS. | string |
| hotelList.ChainList.Primary | If this is true, the chain is the primary chain for the hotel. If this is false, the chain is not the primary chain for the hotel. | boolean |
| hotelList.Channels | The array to hold the channels information. | array |
| hotelList.Channels.Code | Channel code of the channel to which the hotel is assigned. | string |
| hotelList.Channels.Name | Display name of the channel to which the hotel is assigned. | string |
| hotelList.Channels.ParentCode | Parent channel code of the channel to which the hotel is assigned. | string |
| hotelList.Channels.EnabledForDistribution | If this is true, the channel allows channel distribution. If this is false, the channel does not allow channel distribution. | boolean |
| hotelList.Channels.IsDefaultGroupChannel | If this is true, the channel is a default group channel. If this is false, the channel is not a default group channel. | boolean |
| hotelList.Channels.IsChannelEnabledForGroups | If this is true, the channel is enabled for group bookings. If this is false, the channel is not enabled for group bookings. | boolean |
| hotelList.Channels.Properties | The object to hold the properties. | object |
| hotelList.Channels.Properties.HotelCode | The channel specific hotel code. | string |
| hotelList.Channels.Properties.ChainCode | The channel specific chain code | string |
| hotelList.Channels.Properties.GoLiveDate | The Go-Live date of the hotel for this channel. | string |
| hotelList.ContactDetails | The object to hold the hotel contact details. | object |
| hotelList.ContactDetails.ContactName | The name of the contact. | string |
| hotelList.ContactDetails.ContactNumberList | The array to hold the contact number information. | array |
| hotelList.ContactDetails.ContactNumberList.Number | Phone number for the contact. | string |
| hotelList.ContactDetails.ContactNumberList.Type | The type of contact number. Available values are: Home, Office, Mobile, Fax, Voice1. | string |
| hotelList.ContactDetails.EmailAddress | Email address for the contact. | string |
| hotelList.ContactDetails.Website | Website URL for the hotel. | string |
| hotelList.Currency | The object to hold the currency information. | object |
| hotelList.Currency.Code | The currency code in ISO 4217 three alpha format. Example: USD. | string |
| hotelList.Currency.Name | Name of the currency. | string |
| hotelList.Currency.Default | If this is true, the currency is the default currency of the hotel. If this is false, the currency is not the default currency of the hotel. | boolean |
| hotelList.DestinationList | The array to hold the destination list information. | array |
| hotelList.DestinationList.Id | Unique ID that identifies a destination or management group in CRS. | string |
| hotelList.DiningOptionList | The array to hold the dining option information. | array |
| hotelList.DiningOptionList.Description | Description of the dining option. | string |
| hotelList.DiningOptionList.Name | Name of the dining option. | string |
| hotelList.DiningOptionList.OnProperty | If this is true, the dining option is located at the hotel. If this is false, the dining option is not located at the hotel. | boolean |
| hotelList.DiningOptionList.SmokingPermitted | If this is true, smoking is permitted. If this is false, smoking is not permitted. | boolean |
| hotelList.DiningOptionList.Distance | This is the distance from the hotel to the dining option location. | string |
| hotelList.DiningOptionList.Meal | The object to hold the meal information. | object |
| hotelList.DiningOptionList.Meal.Breakfast | If this is true, Breakfast is available. If this is false, Breakfast is not available. | boolean |
| hotelList.DiningOptionList.Meal.Brunch | If this is true, Brunch is available. If this is false, Brunch is not available. | boolean |
| hotelList.DiningOptionList.Meal.Dinner | If this is true, Dinner is available. If this is false, Dinner is not available. | boolean |
| hotelList.DiningOptionList.Meal.Lunch | If this is true, Lunch is available. If this is false, Lunch is not available. | boolean |
| hotelList.DiningOptionList.Category | The array to hold the dining category information. | array |
| hotelList.DiningOptionList.Category.OtaCode | OTA code of the dining option. | string |
| hotelList.DiningOptionList.Category.OtaType | OTA code category type. | string |
| hotelList.DiningOptionList.Category.OtaDescription | Name of the OTA restaurant category. | string |
| hotelList.DiningOptionList.SortOrder | The sort order of the dining options. | integer |
| hotelList.Location | The object to hold the hotel location information. | object |
| hotelList.Location.Address | The object to hold the hotel address. | object |
| hotelList.Location.Address.AddressLine | Street-related information associated with the hotel. | array |
| hotelList.Location.Address.City | City where the hotel is located. | string |
| hotelList.Location.Address.CountryName | The object to hold the hotel country name information. | object |
| hotelList.Location.Address.CountryName.code | Country code where the hotel is located. ISO alpha-2 letter code. | string |
| hotelList.Location.Address.CountryName.value | Name of the country where the hotel is located. | string |
| hotelList.Location.Address.PostalCode | Postal code for the hotel. | string |
| hotelList.Location.Address.StateProv | The object to hold the hotel state or province information. | object |
| hotelList.Location.Address.StateProv.code | State or province where the hotel is located. ISO state or province code. | string |
| hotelList.Location.Address.StateProv.value | Name of the state or province where the hotel is located. | string |
| hotelList.Location.Latitude | Latitude coordinate for the location of the hotel. | string |
| hotelList.Location.Longitude | Longitude coordinate for the location of the hotel. | string |
| hotelList.Location.TimeZone | Time zone (UTC) in which the hotel is located. | string |
| hotelList.Location.Type | The hotel location type. Available values are: None, Airport, CityCenter, Resort, Rural, Suburban. | string |
| hotelList.LanguageList | The array to hold the language information. | array |
| hotelList.LanguageList.Code | Language code with an optional culture code. | string |
| hotelList.LanguageList.Default | If this is true, the language is the default language for the hotel. If this is false, the language is not the default language for the hotel. | boolean |
| hotelList.LanguageList.Primary | If this is true, the language is the primary language for the hotel. If this is false, the language is not the primary language for the hotel. | boolean |
| hotelList.MealPlanList | The array to hold the meal plan information. | array |
| hotelList.MealPlanList.Name | Name of the meal plan. | string |
| hotelList.MealPlanList.Type | Type of breakfast. Available values are: American, BedBreakfast, Bermuda, CaribbeanPlan, Continental, DinnerBedBreakfast, European, FamilyAmerican, FullBreakfast, Family, Modified, RoomOnly, EnglishBreakfast, AllInclusive, BuffetBreakfast, Breakfast, LightBreakfast. | string |
| hotelList.MealPlanList.Chargeable | If this is true, the meal plan is chargeable (meaning that it is not included in the room rate). If this is false, the meal plan is not chargeable (meaning that it is included in the room rate). | boolean |
| hotelList.MealPlanList.Description | This is a detailed description of the meal plan. | string |
| hotelList.MealPlanList.AvailableToAnyGuest | If this is true, the meal plan is available to all guests. If this is false, the meal plan is available to only certain groups of guests. | boolean |
| hotelList.PaymentMethodList | The array to hold the payment method information. | array |
| hotelList.PaymentMethodList.Code | Standard code for the payment type. | string |
| hotelList.PaymentMethodList.Deposit | If this is true, the payment type is accepted for a deposit. If this is false, the payment type is not accepted for a deposit. | boolean |
| hotelList.PaymentMethodList.Guarantee | If this is true, the payment type is accepted for a guarantee. If this is false, the payment type is not accepted for a guarantee. | boolean |
| hotelList.PaymentMethodList.InUse | If this is true, the payment type is active and in use by the hotel. If this is false, the payment type is not active and in use by the hotel. | boolean |
| hotelList.PaymentMethodList.IsPassThru | If this is true, the payment method is a pass through payment method. If this is false, the payment method is not a pass through payment method. | boolean |
| hotelList.RecreationList | The array to hold the recreation information. | array |
| hotelList.RecreationList.Type | Type of recreation. | string |
| hotelList.RecreationList.OnProperty | If this is true, the recreation type is on the hotel property. If this is false, the recreation type is not on the hotel property. | boolean |
| hotelList.RecreationList.Distance | Distance from the hotel to the recreation location. | number |
| hotelList.RecreationList.Note | This is a note to include additional information about the recreation. | string |
| hotelList.RecreationList.OtaCode | OTA code indicating the recreation type (HAC, REC, or RST). | string |
| hotelList.RecreationList.OtaDescription | OTA description of the recreation. | string |
| hotelList.RecreationList.OtaType | OTA code category type. | string |
| hotelList.ReferencePointList | The array to hold the reference point information. | array |
| hotelList.ReferencePointList.Name | Name of the reference point. | string |
| hotelList.ReferencePointList.Type | The type of the reference point. Available values are: Attraction, Business. | string |
| hotelList.ReferencePointList.Direction | Direction from the reference point to the property. Available values are: E, N, NE, NW, S, SE, SW, W. | string |
| hotelList.ReferencePointList.Distance | Distance from the reference point to the property. | number |
| hotelList.ReferencePointList.UnitOfMeasure | Unit of measurement. Available values are: None, Centimeters, Feet, Inches, Kilometers, Meters, Miles, Milimeters, Yards. | string |
| hotelList.RelativeLocation | The object to hold the relative location information. | object |
| hotelList.RelativeLocation.AnchorLatitude | The latitude of the amenity's location. | number |
| hotelList.RelativeLocation.AnchorLongitude | The longitude of the amenity's location. | number |
| hotelList.RelativeLocation.Distance | The amenity's distance from the Original Hotel. | int |
| hotelList.RelativeLocation.Unit | The unit of measure for the amenity's distance from the Original Hotel. Available values are: Kilometers, Miles. | string |
| hotelList.RelativeLocation.Orientation | The orientation of the location of the amenity relative to the Original Hotel. Available values are: North, NorthEast, East, SouthEast, South, SouthWest, NorthWest. | string |
| hotelList.RelativeLocation.OriginalHotel | The array to hold the Original Hotel information. | array |
| hotelList.RelativeLocation.OriginalHotel.Id | The hotel that provides the amenity for which this array defines the relative location. | int |
| hotelList.ServiceList | The array to hold the service information. | array |
| hotelList.ServiceList.OnProperty | If this is true, the service is located on the hotel property. If this is false, the service is not located on the hotel property. | boolean |
| hotelList.ServiceList.Note | This note can hold a brief description of the service or more details about the charges. | string |
| hotelList.ServiceList.Type | The object to hold the service type information. | object |
| hotelList.ServiceList.Type.Code | HAC and BUS OTA Service code value. | string |
| hotelList.ServiceList.Type.Id | The ID of the service. | integer |
| hotelList.ServiceList.Type.Name | Name of the service amenity. | string |
| hotelList.PropertyFeatures | The array to hold the property features. | array |
| hotelList.PropertyFeatures.Code | Code indicating the property feature. | string |
| hotelList.PropertyFeatures.Description | Description of the property feature. | string |
| hotelList.PropertyFeatures.OtaCode | OTA code indicating the property feature. | string |
| hotelList.PropertyFeatures.OtaDescription | OTA description of the property feature. | string |
| hotelList.PropertyFeatures.OtaType | OTA code category type. | string |
| hotelList.Status | Active status of the hotel. Available values are: Open, Inactive, Suspended, Terminated. | string |
| hotelList.TerminalList | The array to hold the terminal information. | array |
| hotelList.TerminalList.Code | Indicates the Terminal Code | string |
| hotelList.TerminalList.Type: | Indicates the Terminal Type. Available values are: Airport, Boatdock, BusTerminal, TrainStation, Unknown. | string |
| hotelList.TerminalList.TransportationList | The array to hold the transportation information. | array |
| hotelList.TerminalList.TransportationList.TransportationCode | The Transportation Code. | string |
| hotelList.TerminalList.TransportationList.TransportationMethod | The Transportation Method. Available values are: Alternate, Boat, Bus, CarRental, Limo, MetroSubway, Other, Shuttle, Taxi, Train. | string |
| hotelList.TerminalList.TransportationList.OneWay | If this is true, the transportation is a one way trip. If this is false, the transportation is not a one way trip. | boolean |
| hotelList.TerminalList.TransportationList.ArrangeableByHotel | If this is true, the hotel can arrange the transportation. If this is false, the hotel cannot arrange the transportation. | boolean |
| hotelList.TerminalList.TransportationList.Description | Description of the transportation method. | string |
| hotelList.Tier | The object to hold the hotel tier information. | object |
| hotelList.Tier.Code | The code for the tier of the hotel. | string |
| hotelList.Tier.Name | The name for the tier of the hotel. | string |
| hotelList.Code | The code to identify a specific hotel. | string |
| hotelList.PmsCode | The PMS code to identify a specific hotel. | string |
| hotelList.ID | The ID that uniquely identifies a single hotel property in CRS. | integer |
| hotelList.Name | Name of the hotel. | string |
| hotelList.ShortName | The short name of the hotel. | string |
| hotelList.ImageList | The array to hold the image information. | array |
| hotelList.ImageList.Caption | Caption of the image. | string |
| hotelList.ImageList.Path | URL to the image file. | string |
| hotelList.ImageList.Description | Description of the image (ICE Portal images only). | string |
| hotelList.ImageList.SortOrder | Specifies the sequence in which the search results are displayed. | integer |
| hotelList.ImageList.MediaType | Media type of the image. Available values are: CRS, VScape, ICE Portal. | string |
| hotelList.ImageList.MediaCategory | Media category associated to the image. | string |
| hotelList.Descriptions | The array to hold the descriptions. | array |
| hotelList.Descriptions.Name | Name related to the description. | string |
| hotelList.Descriptions.Description | Detailed description. | string |
| paging | The object to hold the API paging information. | object |
| paging.Size | Number of records to be returned in the response (0 = return all) | integer |
| paging.Start | Starting record to be returned in the response. | integer |
| paging.Total | Total number of records. | integer |