API - Planyo Web Services - get_weekly_schedule

Estás aquí: Planyo » Ayuda » API » get_weekly_schedule



Use this function to get a listing of all weekly vacations of a resource (or all resources; see the resource_id parameter) or to get a listing of all working hours during the week.


resource_id int optional
ID of the resource whose availability will be returned. If checking availability for the entire site, you can skip this parameter. In such case, set the site id in the site_id parameter but only when using a meta site API key
return_available int required
If you set it to 1, then all available time ranges (working hours) will be returned. If you set it to 0, then unavailable time ranges (vacations / periods of unavailability) will be returned.
method string required
must be set to get_weekly_schedule
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.


periods array
All requested periods (working hours or vacations; based on the parameter return_available) with the following keys: weekday (integer; 1=monday .. 7=sunday), start (hour:minute), end (hour:minute).

API playground:

Click here to test this function in the API playground.