API - Planyo Web Services - get_site_info

Planyo » Pomoc » API » get_site_info

get_site_info (version 0.2)

Description:

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

Input:

site_id int required

Planyo site ID

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

Site name

category int

Category of the site

online_payment_surcharge int

Additional charge (expressed in percent) for online payments

email string

Email address of site admin

properties array

Array whose items are site-specific properties (name => value) such as URL, address, GPS coordinates etc.

custom_resource_properties array

Array whose items are definitions of resource-specific properties (name => array(name,allowed_values,search_condition)) 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)