API - Planyo Web Services - get_unit_property

Jesteś tutaj: Planyo » Pomoc » API » get_unit_property

get_unit_property

Description:

Returns value of a custom unit property. Unit properties can have different values at different dates/times (e.g. odometer reading at rental start/end) and so the values are always retrieved for a specific time.

Input:

resource_id int required

ID of the resource

unit string optional

Unit name. If left empty, the value set should be treated as concerning the entire resource.

property string required

Name of the property to retrieve

time DateTime optional

Date and time for the unit property value. It can be in the past, present or in the future. If left empty, then the current date/time will be used

method string required

must be set to get_unit_property

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:

value string

Property value. NULL is returned if property is not found

API playground:

Click here to test this function in the API playground.