API - Planyo Web Services - get_ical_feed_url

Ti trovi qui: Planyo » Aiuto » API » get_ical_feed_url

get_ical_feed_url

Description:

Use this function to get the URL of an iCal feed for a metasite, site, resource or selected resources. You can also filter the iCal feed by the value of a reservation form item. See the list_all parameter if you'd like to make a single call and get feeds for all of your resources.

Input:

site_id int optional
Planyo site ID. Used only for metasite API keys and only if the feed should be limited to a single site
resource_id int optional
You can limit the feed to a single resource using this parameter.
list_all bool optional
You can set this parameter to true if you want the output to include feed URLs for each individual resource and for the entire site/metasite
resource_property_filter string optional
You can filter the resources included in the feed by passing a custom resource property
resource_property_value string optional
If resource_property_fiter is used, you should pass the resource property value here
form_item_filter string optional
You can filter the reservations included in the feed by a value of a form item
form_item_value string optional
If form_item_filter is used, you should pass the form item value here
template int optional
You can specify one of the templates defined by you
include_vacations bool optional
Set this to true if resource vacations should be included in the feed. Note: you can also use a special value all for this parameter in order to also include vacations imported from external sources such as iCal feeds and Google Calendar (via extensions)
past_days int optional
Limit past events to the ones starting at most X days ago.
future_days int optional
Limit future events to the ones starting at most in X days
unit_name string optional
When resource_id is specified, you can additionally limit the feed to a single unit name. Note that this should be a valid unit name for the resource.
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:

url string
iCal feed URL

API playground:

Click here to test this function in the API playground.