Rooms

Overview

The Rooms operation allows clients to retrieve comprehensive room list from a supplier's access that may include translations to other languages, granting you access to all the rooms configured by the Seller for a given set of credentials. The returned fields include: code, name, views, medias, etc.

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": "Rooms",
        "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 the hotel.

Overview

Sample

{
	"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"
			}
		}
	]
}

Details

The AccumulativeRoom object represents the standardized structure of the mapped room element.

Name	Type	Description
Code	String	Gets or sets the code of the room.
Area	Double	Gets or sets the area of the room.
Names	Dictionary<Iso2LanguageEnum, String>	Gets or sets the names of the room in different languages.
Descriptions	Dictionary<Iso2LanguageEnum, String>	Gets or sets the descriptions of the room in different languages.
RoomOccupancy	AccumulativeRoomOccupancy	Gets or sets the room occupancy information.
RoomOccupancy/Adults	AccumulativeMinMaxOccupancy	Accumulative occupancy for adults.
RoomOccupancy/Adults/Min	Integer	Minimum occupancy.
RoomOccupancy/Adults/Max	Integer	Maximum occupancy.
RoomOccupancy/Children	AccumulativeMinMaxOccupancy	Accumulative occupancy for children.
RoomOccupancy/Children/Min	Integer	Minimum occupancy.
RoomOccupancy/Children/Max	Integer	Maximum occupancy.
RoomOccupancy/Infants	AccumulativeMinMaxOccupancy	Accumulative occupancy for infants.
RoomOccupancy/Infants/Min	Integer	Minimum occupancy.
RoomOccupancy/Infants/Max	Integer	Maximum occupancy.
RoomOccupancy/Total	AccumulativeMinMaxOccupancy	Accumulative total occupancy.
RoomOccupancy/Total/Min	Integer	Minimum occupancy.
RoomOccupancy/Total/Max	Integer	Maximum occupancy.
Beds	List<AccumulativeBed>	Gets or sets the list of beds in the room.
Beds/NumberOfBeds	Integer	Gets or sets the number of beds.
Beds/Type	String	Gets or sets the type of bed.
Amenities	List<AccumulativeAmenity>	Gets or sets the list of amenities in the room.
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.
Medias	List<AccumulativeMedia>	Gets or sets the list of media associated with the room.
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.
Views	List<AccumulativeView>	Gets or sets the list of views from the room.
Views/Code	String	Gets or sets the code.
Views/Description	Dictionary<Iso2LanguageEnum, String>	Gets or sets the description.

---