API - Planyo Web Services - get_resource_info

Planyo » Pomoc » API » get_resource_info

get_resource_info (version 0.2)

Description:

Returns information for given resource, including photos and resource-specific properties defined in the admin panel in: Site settings / Custom property manager

Input:

resource_id int required

ID of the resource

version float optional

you can optionally specify the version of the API that you're using. Use the value of latest or simply skip this parameter to use the latest API version. The latest version is: 0.2

language string optional

by specifying a 2-letter (ISO 639-1) language code (all capital letters e.g. EN, DE, FR, ES, IT) you can change the language of the text values returned

api_key string required

your API key - Click here to get your key

Output:

name string

Resource name

quantity int

Number of units available

site_id int

Planyo site ID

confirmation_type ConfirmationType

Reservation approval mode

category int

Category of the resource

sharing_mode SharingMode

Resource's sharing mode

start_hour int

Resource is available on working days from this time (ignore for day-based resources)

end_hour int

Resource is available on working days until this time (ignore for day-based resources)

start_quarters Quarters

Allowed start quarters (ignore for day-based resources)

time_unit TimeUnit

Base time unit of the resource (day-based, hour-based or quarter-based)

unit_price string

Price of one unit (returned as float) or URL for custom pricing

currency string

Currency in which prices are expressed

is_overnight_stay bool

True for over-night rentals (e.g. hotels, vacation homes)

max_quantity_per_rental int

Max. quantity allowed for a single reservation

properties array

Array whose items are resource-specific properties (name => value) defined in the admin panel in: Site settings / Custom property manager

photos array

Array whose items are named arrays with following keys: id (unique photo ID), path (URL of the photo), title (optional title)