API - Planyo Web Services - get_site_info

You are here: Planyo » Help » API » get_site_info

get_site_info

Description:

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

Input:

site_id int optional

Planyo site ID (required only for metasite API keys)

method string required

must be set to get_site_info

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. If your API key uses a hash key, you must also include the parameters hash_key and hash_timestamp.

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

admin_id int

User ID of site admin

timezone string

Timezone of the site

default_language string

Default language of the site

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 resource properties

photos array

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

API playground:

Click here to test this function in the API playground.