This method returns all available information for the property, including room types, facilities, photos, etc.

Table of Contents

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

URL Endpoint

/property/{propertycode}

Method Parameters

NAME	TYPE	RANGE / SET	REQUIRED	DEFAULT	EXAMPLE	NOTES
include	string	billing_info	NO		&include=billing_info	Use this parameter to include additional fields/objects in the response. Currently only "billing_info" is supported, and only for B2B API accounts.

JSON Response Schema

{
  "method": "http://rest.reserve-online.net/property/DEMO",
  "http_method": "GET",
  "http_code": 200,
  "error_code": "OK",
  "error_msg": "",
  "params": [],
  "data": {
    "code":STRING, // Property code 
    "name":STRING, // Property name
    "type":STRING, // Property type (empty if not defined)
    "rating":INTEGER,  // Property rating (empty if not defined)
    "currency":ISO 4217, // Property default currency code
    "description":STRING, // Property description (HTML text, empty if not defined)
    "general_terms":STRING,  // Property general terms and conditions (HTML text, empty if not defined)
    "directions":STRING,  // Property location directions (HTML text, empty if not defined)
    "license_number":STRING,  // Property license number (empty if not defined)
    "url":URL, // Property website url (empty if not defined)
    "bookurl":URL, // Property booking engine url (empty if not defined)
    "contact": {
      "tel":STRING, // Property telephone number (empty if not defined)
      "fax":STRING, // Property fax number (empty if not defined)
      "email":STRING, // Property email (empty if not defined)
      "skype":STRING // Property skype account (empty if not defined)
    },
    "location": {
      "lat":DECIMAL, // Property geo location latitude (empty if not defined)
      "lon":DECIMAL, // Property geo location longitude (empty if not defined)
      "utc_offset":INTEGER, // Property UTC offset in hours
      "timezone":STRING, // Property timezone name
      "name":STRING, // Property location name (empty if not defined)
      "address":STRING, // Property address (empty if not defined)
      "zip":STRING, // Property zip code (empty if not defined)
      "country":ISO 3166-1-alpha-2 // Property country code
    },
    "children": {
      "allowed":BOOLEAN,, // Indicates if bookings with children are allowed for this property 
      "age_from":INTEGER, // Minimum child age threshold (inclusive, empty if not defined) 
      "age_to":INTEGER, // Maximum child age threshold (exclusive, empty if not defined) 
      "policy":STRING // Children policy short description (empty if not defined)
    },
    "settings": {
      "nights_min":INTEGER, // Minimum nights allowed for a booking
      "nights_max":INTEGER, // Maximum nights allowed for a booking
      "rooms_max":INTEGER // Maximum number of rooms allowed in a booking
    },
    "operation": {
      "checkout_time":STRING, // Property checkout time (empty if not defined)
      "checkin_time":STRING, // Property checkin time (empty if not defined)
      "open_from":ISO 8601, // Property season opening date (empty if not defined)
      "open_to":ISO 8601 // Property season closing date (empty if not defined)
    },
    "rooms": [ // List of property rooms 
      {
        "code":STRING, // Room code
        "name":STRING, // Room name
        "url":URL // API URL for room info request
      }
    ],
    "facilities":STRING[], // List of property facilities
    "photos": [
      {
        "title":STRING, // Photo title (empty if not defined)
        "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
      }
    ],
    "logourl":URL, // Property logo image url (empty if not defined)
    "billing_info": { Only when param "include=billing_info" has been used. Any field with null value is ommited.
      "cmp_name": STRING,
      "cmp_address": STRING,
      "cmp_location": STRING,
      "cmp_vat": STRING,
      "cmp_registration": STRING,
      "cmp_tax_office": STRING,
      "cmp_country": STRING,
      "non_vat": BOOLEAN // Indicates if the property is non-VAT registered. If false, field is ommited,
      "principal_name": STRING,
      "principal_email": STRING,
      "principal_position": STRING,
      "principal_tel": STRING,
      "contact_name": STRING,
      "contact_position": STRING,
      "contact_email": STRING,
      "contact_tel": STRING
    }
  }
}
    

JSON Response Example