API Playground - get_simplified_daily_restrictions

get_simplified_daily_restrictions


Use this function if you need to get daily restrictions for a range of dates (max 2 years). This function is mostly used for accommodations in order to convert the restrictions defined in seasonal settings and in time-related settings to restrictions understood by channel managers. Note that Planyo is capable of having more restrictions which will not be returned by this function, e.g. the ones defined in Pricing Manager checking for a wide number of conditions (using the UNAVAILABILITY MESSAGE values instead of prices). (click for full documentation)

resource_id

ID of the resource. Pass null if you want info for all resources to be returned. In this case and if using a metasite API key, you'll need to pass the site id in the site_id parameter.

site_id

Required only for metasite API keys and when resource_id is null. Otherwise skip this parameter.

start_date

Start date of the period

end_date

End date of the period

return_blocked_days

Set to true if the output should include the restriction 'is_blocked' for the blocked periods. Important: blocked periods are only a part of unavailable periods. Use the function get_resource_usage to get availability information. Blocked periods are simply vacations defined for the entire site or for all units of the resource on the Resource vacations page. Vacations added for single time units on the Availability calendar page will not be treated as blocked days.

language

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

* - required field