plnnrlydevelopers

Deze referentie is alleen in het Engels. Naar het Nederlandse REST API-overzicht

Diese Referenz gibt es nur auf Englisch. Zur deutschen REST-API-Übersicht

Cette référence existe uniquement en anglais. Aller à la présentation de l'API REST en français

Esta referencia solo está en inglés. Ir a la introducción de la API REST en español

Holiday

Holiday

A holiday: a recurring named day off, such as Nieuwjaarsdag.

View as Markdown
Summary view
HolidayList, 10 fields. What a list returns by default.
Detail view
Holiday, 10 fields. The default for a single read and for every write.
Read with
api:read:holidaysandholidays::manage
Write with
api:write:holidaysandholidays::manage

A holiday carries no calendar date of its own: it is a template whose actual dates live on the free days generated from it, so the same holiday serves every year.

Used by

GETList holidays/holidaysHolidayList
POSTCreate a holiday/holidaysHoliday
GETRead a holiday/holidays/{holiday}Holiday
PATCHUpdate a holiday/holidays/{holiday}Holiday

Fields

Detail only
Only in the detail view.
Only with include
Only when you ask for it with include.
Server-assigned
Set by plnnrly, never by a request.
idinteger

Unique identifier.

namestring≤ 255

Name of the holiday, e.g. Nieuwjaarsdag.

default_monthinteger or null

Month the holiday normally falls in, 1-12. Null means the holiday moves from year to year (Easter, say), and the organisation fills the date in per year on the free day itself.

default_dayinteger or null

Day of the month the holiday normally falls on, 1-31, paired with default_month. Null means the day is not fixed.

recurrence_intervalinteger or null

How often the holiday repeats, in years: null is not recurring, 1 is yearly, and n repeats every n years.

sort_orderintegerServer-assigned

Position in the organisation's holiday list, ascending. Set by dragging holidays into order in plnnrly; the API exposes no way to reorder holidays.

free_days_countinteger≥ 0

Number of free days generated from this holiday.

created_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Creation timestamp.

updated_attimestamp (YYYY-MM-DDThh:mm:ssZ)

Last-write timestamp; use for incremental sync.

Variants

HolidayList 10 fields

What a collection returns, and what ?view=summary returns on a single record.

The same fields as the detail object.

HolidaySummary 2 fields

The embedded form: what you get when another resource carries this one and you did not include it.

Leaves out: default_month, default_day, recurrence_interval, sort_order, free_days_count, created_at, updated_at, links

HolidayLinks 2 fields

The links object on this resource.

Keys: self, free_days