The room listing method returns a list of detailed room information for a specific property. Each item has the same information as the Room Info method.

Table of Contents

1. URL Endpoint
2. Method Parameters
3. JSON Response Schema
4. JSON Response Example

URL Endpoint

/room/{propertycode}

Method Parameters

NAME	TYPE	RANGE / SET	REQUIRED	DEFAULT	EXAMPLE	NOTES
active	boolean		NO	true	&active=0	Set to false to get the list of inactive rooms. Only active rooms are returned by default
min_pers	integer	1-∞	NO	-	&min_pers=2	Return rooms with minimum persons greater than or equal to the specified value
max_pers	integer	1-∞	NO	-	&max_pers=3	Return rooms with maximum persons less than or equal to the specified value
max_adults	integer	1-∞	NO	-	&max_adults=2	Return rooms with maximum adults less than or equal to the specified value
children_allowed	boolean		NO	-	&children_allowed=1

JSON Response Schema

{
	"method": "https://rest.reserve-online.net/room/DEMO"
	"http_method": "GET",
	"http_code": 200,
	"error_code": "OK",
	"error_msg": "",
	"params": [],
	"data":{
		"rooms":[
			{
				"code":STRING, // Room code
				"name":STRING, // Room name
				"unit_type":STRING, // Unit type, e.g. room, villa, apartment etc.
				"license_number":STRING, // Local licence ID for rentals (null if empty)
				"description":STRING, // Room HTML description
				"sort_order":INTEGER, // Sorting order (null if empty)
				"capacity": {
					"min_pers":INTEGER, // Minimum persons
					"max_pers":INTEGER, // Maximum persons
					"max_adults":INTEGER, // Maximum adults
					"max_infants":INTEGER, // Maximum infants
					"children_allowed":BOOLEAN, // Children allowed flag
					"count_infant":BOOLEAN // Count infants towards max capacity
				}
				"active":BOOLEAN, // Indicates if room is active
				"amenities":STRING[], // A list of room amenities
				"photos":[
					{
						"title":STRING, // Photo Title
						"xsmall":URL, // Photo url - Extra small size 
						"small":URL, // Photo url - Small size 
						"medium":URL, // Photo url - Medium size 
						"large":URL, // Photo url - Large size
					}
				],
				"location": { (exists only if room type has geo coordinates defined)
					"lat":DECIMAL, // Room geo location latitude
					"lon":DECIMAL, // Room geo location longitude
					"name":STRING, // Room location name (City/Town/Other. null if not defined)
					"address":STRING, // Room address (null if not defined)
					"zip":STRING // Room zip code (null if not defined)
				}
			}
		]
	}
}
	

JSON Response Example