The room listing method return 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

{
  "method": "http://rest.reserve-online.net/room/DEMO",
  "http_method": "GET",
  "http_code": 200,
  "error_code": "OK",
  "error_msg": "",
  "params": [],
  "data": {
    "rooms": [
      {
        "code": "JSUI",
        "name": "Junior Suite",
        "unit_type": "room",
        "license_number": null,
        "description": "",
        "sort_order": 1,
        "capacity": {
          "min_pers": 1,
          "max_pers": 3,
          "max_adults": 2,
          "max_infants": 1,
          "children_allowed": true,
          "count_infant": false
        },
        "active": true,
        "amenities": [
          "Air Conditioning",
          "Alarm Clock",
          "Central Heating",
          "Closet",
          "Coffee Facilities",
          "Daily Maid Service",
          "Direct dial telephone",
          "Iron & Ironing Board",
          "Mountain View",
          "Music",
          "Non-smoking rooms available",
          "Private Balcony",
          "Razor Plug",
          "Refrigerator",
          "Wake-up Call",
          "Wi-Fi Internet Access (free of charge)",
          "Writing Desk"
        ],
        "photos": [
          {
            "title": "",
            "xsmall": "https://cdn.webhotelier.net/photos/w=90:h=60:q=90/demo-jsui/L127612.jpg",
            "small": "https://cdn.webhotelier.net/photos/h=90:q=90/demo-jsui/L127612.jpg",
            "medium": "https://cdn.webhotelier.net/photos/w=390/demo-jsui/L127612.jpg",
            "large": "https://cdn.webhotelier.net/photos/w=1920/demo-jsui/L127612.jpg"
          },
          {
            "title": "",
            "xsmall": "https://cdn.webhotelier.net/photos/w=90:h=60:q=90/demo-jsui/L256291.jpg",
            "small": "https://cdn.webhotelier.net/photos/h=90:q=90/demo-jsui/L256291.jpg",
            "medium": "https://cdn.webhotelier.net/photos/w=390/demo-jsui/L256291.jpg",
            "large": "https://cdn.webhotelier.net/photos/w=1920/demo-jsui/L256291.jpg"
          },
          {
            "title": "",
            "xsmall": "https://cdn.webhotelier.net/photos/w=90:h=60:q=90/demo-jsui/L256296.jpg",
            "small": "https://cdn.webhotelier.net/photos/h=90:q=90/demo-jsui/L256296.jpg",
            "medium": "https://cdn.webhotelier.net/photos/w=390/demo-jsui/L256296.jpg",
            "large": "https://cdn.webhotelier.net/photos/w=1920/demo-jsui/L256296.jpg"
          }
        ]
      },
      {
        "code": "FML",
        "name": "Family  Room",
        "unit_type": "room",
        "license_number": null,
        "description": "<p>Our Family Room provides bathtub, shower, balcony, hair dryer, satellite tv, music broadcast, direct telephone, central air conditioning, minibar, safe, and hardwood floors are available.</p>\n",
        "sort_order": 2,
        "capacity": {
          "min_pers": 2,
          "max_pers": 4,
          "max_adults": 3,
          "max_infants": 1,
          "children_allowed": true,
          "count_infant": false
        },
        "active": true,
        "amenities": [
          "Bath Amenities",
          "Bathrobes and Slippers",
          "Bathroom with Steam Cabin",
          "Beach Towels",
          "Bottle of Wine",
          "Cable-Satellite TV",
          "CD/DVD Player",
          "Ceiling Fan",
          "Central Heating",
          "Closet",
          "Coffee Facilities",
          "Writing Desk"
        ],
        "photos": [
          {
            "title": "",
            "xsmall": "https://cdn.webhotelier.net/photos/w=90:h=60:q=90/demo-fml/L127613.jpg",
            "small": "https://cdn.webhotelier.net/photos/h=90:q=90/demo-fml/L127613.jpg",
            "medium": "https://cdn.webhotelier.net/photos/w=390/demo-fml/L127613.jpg",
            "large": "https://cdn.webhotelier.net/photos/w=1920/demo-fml/L127613.jpg"
          }
        ]
      },
      {
        "code": "REG",
        "name": "Regular suite",
        "unit_type": "room",
        "license_number": null,
        "description": "",
        "sort_order": 3,
        "capacity": {
          "min_pers": 1,
          "max_pers": 2,
          "max_adults": 2,
          "max_infants": 0,
          "children_allowed": true,
          "count_infant": false
        },
        "active": true,
        "amenities": [
          "Air Conditioning",
          "Alarm Clock",
          "Athens Sightseeing ",
          "Bath Amenities",
          "Hairdryer",
          "Iron & Ironing Board",
          "Mini-Bar",
          "Safe Deposit Box",
          "Sea view",
          "Television"
        ],
        "photos": []
      },
      {
        "code": "FRM",
        "name": "Fantasy Room",
        "unit_type": "room",
        "license_number": null,
        "description": "",
        "sort_order": 4,
        "capacity": {
          "min_pers": 1,
          "max_pers": 2,
          "max_adults": 2,
          "max_infants": 0,
          "children_allowed": true,
          "count_infant": false
        },
        "active": true,
        "amenities": [
          "Bathrobes and Slippers",
          "Bathroom with Jacuzzi",
          "DVD Player",
          "Electronic Locks",
          "External Jacuzzi",
          "Fireplace",
          "Full-length Mirror",
          "Fully equipped kitchenette",
          "Garden View",
          "Guest Laundry",
          "Outdoor Jacuzzi",
          "Pool towels",
          "Weight scale",
          "Wi-Fi Internet Access (at cost)"
        ],
        "photos": []
      },
      {
        "code": "DEL",
        "name": "Deluxe Suite",
        "unit_type": "room",
        "license_number": null,
        "description": "",
        "sort_order": 5,
        "capacity": {
          "min_pers": 1,
          "max_pers": 5,
          "max_adults": 5,
          "max_infants": 2,
          "children_allowed": true,
          "count_infant": false
        },
        "active": true,
        "amenities": [
          "Air Conditioning",
          "Alarm Clock",
          "Bathroom with Jacuzzi",
          "Cable-Satellite TV",
          "Central Heating",
          "Fireplace",
          "Safe Deposit Box",
          "Sea view",
          "Wake-up Call"
        ],
        "photos": [
          {
            "title": "",
            "xsmall": "https://cdn.webhotelier.net/photos/w=90:h=60:q=90/demo-del/L192633.jpg",
            "small": "https://cdn.webhotelier.net/photos/h=90:q=90/demo-del/L192633.jpg",
            "medium": "https://cdn.webhotelier.net/photos/w=390/demo-del/L192633.jpg",
            "large": "https://cdn.webhotelier.net/photos/w=1920/demo-del/L192633.jpg"
          },
          {
            "title": "",
            "xsmall": "https://cdn.webhotelier.net/photos/w=90:h=60:q=90/demo-del/L192634.jpg",
            "small": "https://cdn.webhotelier.net/photos/h=90:q=90/demo-del/L192634.jpg",
            "medium": "https://cdn.webhotelier.net/photos/w=390/demo-del/L192634.jpg",
            "large": "https://cdn.webhotelier.net/photos/w=1920/demo-del/L192634.jpg"
          }
        ]
      },
      {
        "code": "VILLA",
        "name": "Villa Test",
        "unit_type": "room",
        "license_number": "ABC12345",
        "description": "",
        "sort_order": null,
        "capacity": {
          "min_pers": 1,
          "max_pers": 10,
          "max_adults": 6,
          "max_infants": 2,
          "children_allowed": true,
          "count_infant": false
        },
        "active": true,
        "amenities": [],
        "photos": []
      }
    ]
  }
}