HotelList
Overview
The HotelList
method returns a comprehensive hotel list from a supplier's access to the Buyer, granting access to all the properties configured by the Seller for a given set of credentials.
There are two possible implementations: HotelListDelta
and HotelListFull
Implementations | Use case |
---|---|
HotelListDelta | Returns only the hotel codes. Additional hotel details must be retrieved separately with HotelDetails making a request for each hotel code. This approach is typically used to minimize payload size and optimize performance. |
HotelListFull | Used when the supplier returns all the information in one call |
HotelListBasicInfo | Not yet implemented. Intended to return a minimal set of hotel data (e.g., name, location). |
Request
The Request is structured to accommodate access information for the content retrieval.
Overview
The request that receives the Connector is a Task with essential information that allows it to execute the operation properly:
- Access: Represents access credentials and related information required for a connection.
- Operation: Operation to be executed.
Sample
{
"Task": {
"Access": {
"Code": 11111,
"User": "tgx",
"Password": "password",
"Urls": {
"Generic": "https://api.hotelsupplier.com/generic"
},
"Parameters": {
"maxResults": "50",
"cacheEnabled": "true",
"requestTimeout": "5000",
"preferredSupplier": "SupplierX"
}
},
"Operation": "HotelListFull",
"Languages": [ "en" ],
"Platform": "HOTELTEST",
"Supplier": "HOTELTEST",
"SupplierGroup": "HOTELTEST"
}
}
Details
The object ContentRq represents the structure of the content request as expected by the supplier.
Name | Type | Description |
---|---|---|
TaskId | Integer | Unique identifier of the task, automatically assigned by the system. |
Supplier | String | Supplier code associated with the access. |
SupplierGroup | String | Supplier group associated with the access. |
Platform | String | The platform that this supplier belongs to. |
Operation | ServiceOperationEnum | Operation to be executed. |
Timeout | String | Maximum time to wait for a supplier response before timing out.Specified as a timestamp string (e.g., "24:00:00" for 24 hours). |
Access | Access | Access information required for the operation, including API credentials, endpoints,and other integration-specific connection details. |
Access/Code | Integer | The unique code identifying the access configuration. |
Access/User | String | The username used for authentication with the supplier. |
Access/Password | String | The password used for authentication with the supplier. |
Access/ApiKey | String | The API key used for authentication or authorization. |
Access/Urls | Urls | The URLs associated with the access configuration. |
Access/Urls/Book | String | The URL used for booking operations. |
Access/Urls/Search | String | The URL used for Search operations. |
Access/Urls/Quote | String | The URL used for Quote operations. |
Access/Urls/Generic | String | A generic URL for additional operations. |
Access/Parameters | AccessParameters | Additional parameters related to the connection. |
Languages | List<Iso2LanguageEnum> | Language codes for the operation, represented as a list of ISO 639-1 2-character codes (e.g., "en", "es"). |
Response
The Response is structured to provide detailed information about supplier's hotels.
Overview
Each implementation returns a different subset of hotel information. The table below helps you determine which option is most suitable for your needs:
Implementations | Use case |
---|---|
HotelListDelta | Returns only the hotel codes. Any additional information must be retrieved from HotelDetails . |
HotelListFull | Returns all the information of the hotels (e.g., location, rooms, medias, amenities). |
HotelListBasicInfo | Not yet implemented. Intended to return a minimal set of hotel data (e.g., name, location). |
Sample
{
"Code": "BADAJOZ#5",
"NativeSupplierCode": "5",
"Name": "BADAJOZ",
"CategoryCode": "4 Estrellas",
"ChainCode": null,
"ExclusiveDeal": null,
"Location": {
"Address": "CTRA.NACIONAL V, KM 393",
"City": "BADAJOZ",
"ZipCode": "06002",
"Descriptions": null,
"Indications": null,
"Country": 67,
"Coordinates": {
"Latitude": 38.893839,
"Longitude": -7.014112
},
"MinimumDestination": {
"Code": "06",
"Available": true,
"Names": {
"en": "BADAJOZ"
}
},
"Contact": {
"Email": "badajoz@xxx.com",
"Phone": "91425891",
"Fax": "910200200",
"Web": null
},
"Airports": null,
"State": null
},
"Amenities": null,
"CardTypes": null,
"Descriptions": null,
"Medias": [
{
"Code": "50",
"Url": "http://www.images.net/infor/work/imagen/hotel_07/mapa.jpg",
"Type": 3,
"Order": 1,
"Descriptions": {
"en": "Map view"
}
},
{
"Code": "100",
"Url": "http://www.images.net/infor/work/imagen/hotel_02/M.jpg",
"Type": 3,
"Order": 2,
"Descriptions": {
"en": "External view"
}
}
],
"Rooms": [
{
"Code": "201232338",
"Names": {
"en": "Standard Single room"
},
"Descriptions": {
"en": "Standard Single room"
},
"Area": 25.0,
"RoomOccupancy": {
"Adults": {
"Min": 1,
"Max": 1
},
"Children": {
"Min": 0,
"Max": 0
},
"Infants": {
"Min": 0,
"Max": 0
},
"Total": {
"Min": 1,
"Max": 1
}
},
"Beds": {
"NumberOfBeds": 1,
"Type": "SINGLE"
},
"Amenities": [
{
"Code": "2403",
"Type": 1,
"Descriptions": {
"en": [
"Free WiFi"
]
},
"Names": {
"en": "RES"
}
},
{
"Code": "318",
"Type": 1,
"Descriptions": {
"en": [
"Balcony"
]
},
"Names": {
"en": "RES"
}
}
],
"Medias": [
{
"Code": "01",
"Url": "http://www.images.net/infor/work/imagen/hotel_room_02/M.jpg",
"Type": 1,
"Order": 1,
"Descriptions": {
"en": "Room"
}
}
],
"Views": [
{
"Code": "01",
"Description": {
"en": "Sea view"
}
}
]
}
],
"PropertyType": null,
"MandatoryFees": null,
"CheckInData": null,
"CheckOutData": null
}
Details
The AccumulativeHotel object represents the standardized structure of the mapped hotel element.
Name | Type | Description |
---|---|---|
Code | String | Hotel code. This code may have concatenated information. |
NativeSupplierCode | String | Native supplier code, without any concatenations. This code will be used to retrieve Giata information. |
Name | String | Hotel name. |
CategoryCode | String | Category code. |
ChainCode | String | Hotel chain code. |
ExclusiveDeal | Boolean | Indicates whether the hotel has an exclusive deal. |
Location | AccumulativeLocation | Location of the hotel. |
Location/Address | String | Address of the hotel. |
Location/City | String | City of the hotel. |
Location/ZipCode | String | Zip code of the hotel. |
Location/Descriptions | Dictionary<Iso2LanguageEnum, List<String>> | Dictionary containing location descriptions categorized by language. |
Location/Indications | Dictionary<Iso2LanguageEnum, List<String>> | Dictionary containing location indications categorized by language. |
Location/Country | Iso2CountryTypeEnum | Country represented by ISO alpha-2. |
Location/Coordinates | AccumulativeCoordinates | Coordinates of the hotel. |
Location/Coordinates/Latitude | Double | Latitude. |
Location/Coordinates/Longitude | Double | Longitude. |
Location/MinimumDestination | AccumulativeHotelMinimumDestination | The lowest-level destination associated with the hotel. This value should match the one returned by the Destination call. |
Location/MinimumDestination/ Code | String | Destination code. |
Location/MinimumDestination/ Available | Boolean | Indicates whether it is available to request in Search. |
Location/MinimumDestination/ Names | Dictionary<Iso2LanguageEnum, String> | Dictionary containing names categorized by language. |
Location/Contact | AccumulativeContact | Contact information of the hotel. |
Location/Contact/Email | String | Email address. |
Location/Contact/Phone | String | Phone number. |
Location/Contact/Fax | String | Fax number. |
Location/Contact/Web | String | Web address. |
Location/Airports | List<AccumulativeAirport> | Nearby airports. |
Location/Airports/IATACode | String | IATA code. |
Location/State | String | State where the hotel is located. |
Amenities | List<AccumulativeAmenity> | List of amenities. |
Amenities/Code | String | Code of the amenity. |
Amenities/Type | ApplicationAreaTypeEnum | Type of the application area. |
Amenities/Descriptions | Dictionary<Iso2LanguageEnum, List<String>> | Descriptions of the amenity, keyed by language. |
Amenities/Names | Dictionary<Iso2LanguageEnum, String> | Names of the amenity, keyed by language. |
CardTypes | List<CreditCardType> | List of accepted credit card types. |
Descriptions | AccumulativeDescriptions | Descriptions of the hotel. |
Descriptions/Pool | Dictionary<Iso2LanguageEnum, List<String>> | Dictionary containing pool descriptions categorized by language. |
Descriptions/Activities | Dictionary<Iso2LanguageEnum, List<String>> | Dictionary containing activities descriptions categorized by language. |
Descriptions/Restaurants | Dictionary<Iso2LanguageEnum, List<String>> | Dictionary containing restaurants descriptions categorized by language. |
Descriptions/General | Dictionary<Iso2LanguageEnum, List<String>> | Dictionary containing general descriptions categorized by language. |
Descriptions/Rooms | Dictionary<Iso2LanguageEnum, List<String>> | Dictionary containing room descriptions categorized by language. |
Descriptions/Amenities | Dictionary<Iso2LanguageEnum, List<String>> | Dictionary containing amenities descriptions categorized by language. |
Medias | List<AccumulativeMedia> | List of medias. |
Medias/Code | String | Code of the media. |
Medias/Url | String | URL of the media. |
Medias/Type | MediaTypeEnum | Type of the media. |
Medias/Order | String | Order of the media. Should be ordered from 1 onward. |
Medias/Descriptions | Dictionary<Iso2LanguageEnum, String> | Descriptions of the media, keyed by ISO 2 language code. |
Rooms | List<AccumulativeRoom> | List of rooms. |
Rooms/Code | String | Gets or sets the code of the room. |
Rooms/Area | Double | Gets or sets the area of the room. |
Rooms/Names | Dictionary<Iso2LanguageEnum, String> | Gets or sets the names of the room in different languages. |
Rooms/Descriptions | Dictionary<Iso2LanguageEnum, String> | Gets or sets the descriptions of the room in different languages. |
Rooms/RoomOccupancy | AccumulativeRoomOccupancy | Gets or sets the room occupancy information. |
Rooms/RoomOccupancy/Adults | AccumulativeMinMaxOccupancy | Accumulative occupancy for adults. |
Rooms/RoomOccupancy/Adults/Min | Integer | Minimum occupancy. |
Rooms/RoomOccupancy/Adults/Max | Integer | Maximum occupancy. |
Rooms/RoomOccupancy/Children | AccumulativeMinMaxOccupancy | Accumulative occupancy for children. |
Rooms/RoomOccupancy/Children/ Min | Integer | Minimum occupancy. |
Rooms/RoomOccupancy/Children/ Max | Integer | Maximum occupancy. |
Rooms/RoomOccupancy/Infants | AccumulativeMinMaxOccupancy | Accumulative occupancy for infants. |
Rooms/RoomOccupancy/Infants/ Min | Integer | Minimum occupancy. |
Rooms/RoomOccupancy/Infants/ Max | Integer | Maximum occupancy. |
Rooms/RoomOccupancy/Total | AccumulativeMinMaxOccupancy | Accumulative total occupancy. |
Rooms/RoomOccupancy/Total/Min | Integer | Minimum occupancy. |
Rooms/RoomOccupancy/Total/Max | Integer | Maximum occupancy. |
Rooms/Beds | List<AccumulativeBed> | Gets or sets the list of beds in the room. |
Rooms/Beds/NumberOfBeds | Integer | Gets or sets the number of beds. |
Rooms/Beds/Type | String | Gets or sets the type of bed. |
Rooms/Amenities | List<AccumulativeAmenity> | Gets or sets the list of amenities in the room. |
Rooms/Amenities/Code | String | Code of the amenity. |
Rooms/Amenities/Type | ApplicationAreaTypeEnum | Type of the application area. |
Rooms/Amenities/Descriptions | Dictionary<Iso2LanguageEnum, List<String>> | Descriptions of the amenity, keyed by language. |
Rooms/Amenities/Names | Dictionary<Iso2LanguageEnum, String> | Names of the amenity, keyed by language. |
Rooms/Medias | List<AccumulativeMedia> | Gets or sets the list of media associated with the room. |
Rooms/Medias/Code | String | Code of the media. |
Rooms/Medias/Url | String | URL of the media. |
Rooms/Medias/Type | MediaTypeEnum | Type of the media. |
Rooms/Medias/Order | String | Order of the media. Should be ordered from 1 onward. |
Rooms/Medias/Descriptions | Dictionary<Iso2LanguageEnum, String> | Descriptions of the media, keyed by ISO 2 language code. |
Rooms/Views | List<AccumulativeView> | Gets or sets the list of views from the room. |
Rooms/Views/Code | String | Gets or sets the code. |
Rooms/Views/Description | Dictionary<Iso2LanguageEnum, String> | Gets or sets the description. |
PropertyType | AccumulativePropertyType | Property type. |
PropertyType/Code | String | Property type code. |
PropertyType/Name | String | Property type name. |
MandatoryFees | List<AccumulativeMandatoryFee> | Mandatory fees. |
MandatoryFees/Code | String | Fee code. |
MandatoryFees/Description | String | Fee description. |
MandatoryFees/Name | String | Fee name. |
MandatoryFees/Scope | String | Fee scope. |
MandatoryFees/Duration | String | Duration of the fee. |
MandatoryFees/NetAmount | Double | Net amount of the fee. |
MandatoryFees/Currency | Currency | Currency of the fee represented by ISO_4217. |
MandatoryFees/Included | Boolean | Indicates whether the fee is included or not. |
MandatoryFees/Refund | Boolean | Indicates whether the fee is refundable or not. |
CheckInData | AccumulativeCheckData | Check-in data for the hotel. |
CheckInData/Instructions | Dictionary<Iso2LanguageEnum, String> | Dictionary containing check-in/check-out instructions categorized by language. |
CheckInData/ SpecialInstructions | Dictionary<Iso2LanguageEnum, String> | Dictionary containing special check-in/check-out instructions categorized by language. |
CheckInData/MinAge | Integer | Minimum age for check-in/check-out. |
CheckInData/BeginTime | TimeOnlyModel | Begin time for check-in/check-out. |
CheckInData/BeginTime/Time | String | Gets or sets the time. |
CheckInData/EndTime | TimeOnlyModel | Ending time for check-in/check-out. |
CheckInData/EndTime/Time | String | Gets or sets the time. |
CheckOutData | AccumulativeCheckData | Check-out data for the hotel. |
CheckOutData/Instructions | Dictionary<Iso2LanguageEnum, String> | Dictionary containing check-in/check-out instructions categorized by language. |
CheckOutData/ SpecialInstructions | Dictionary<Iso2LanguageEnum, String> | Dictionary containing special check-in/check-out instructions categorized by language. |
CheckOutData/MinAge | Integer | Minimum age for check-in/check-out. |
CheckOutData/BeginTime | TimeOnlyModel | Begin time for check-in/check-out. |
CheckOutData/BeginTime/Time | String | Gets or sets the time. |
CheckOutData/EndTime | TimeOnlyModel | Ending time for check-in/check-out. |
CheckOutData/EndTime/Time | String | Gets or sets the time. |