get_custom_property

Returns value of a property. Properties can be of different types -- Planyo allows assigning custom properties to users, sites, resources and reservations. Please note that custom properties will be visible in the backend UI (for site administrators) unless the property name starts with 'hidden'. In such case the property will be usable only by the API and hidden everywhere in the UI. (click for full documentation)

type

string*

Property type (one of: site, resource, reservation, user)

id

int*

Related ID whose property is being queried (depending on type one of: site ID, resource ID, reservation ID, user ID)

name

string*

Property name

language

string

--- Afrikaans (AF)  български (BG)  Català (CA)  Čeština (CS)  Dansk (DA)  Deutsch (DE)  Eesti keel (ET)  English (EN)  Español (ES)  Føroyskt (FO)  Français (FR)  Hrvatski (HR)  Íslenska (IS)  Italiano (IT)  Kalaallisut (KL)  Lietuvių kalba (LT)  Magyar (HU)  Nederlands (NL)  Norsk (NO)  Polski (PL)  Português (PT)  Português brasileiro (BR)  Română (RO)  Suomi (FI)  Slovenčina (SK)  Slovenski (SL)  Svenska (SV)  Euskara (EU)  Ελληνικά (EL)  한국어 (KO)  日本語 (JA)  Русский (RU)  繁體中文 (TW)  Tiếng Việt (VI)  Український (UA)  ภาษาไทย (TH)  हिन्दी (HI)  اَلْعَرَبِيَّةُ (AR) 

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*

your API key - Click here to get your key

* - Pflichtfeld