GET
/
timmi-settings
/
api
/
working-time-arrangements
/
{workingTimeArrangementId}
/
collective-schedules
/
{collectiveScheduleId}

Path Parameters

workingTimeArrangementId
integer
required

The unique identifier of the Working Time Arrangement.

Required range: x > 0
collectiveScheduleId
integer
required

The unique identifier of the Collective Schedule for this Working Time Arrangement.

Response

200 - application/json

A Collective Schedule describes the employees' expected working hours over a week.

It comes in two shapes:

  • "Single Week": Working hours are identical every week.
  • "Odd / Even Weeks": Working hours depend on the oddness of the week.
id
integer
required

The unique identifier of this Collective Schedule.

Required range: x > 0
workingTimeArrangementId
integer
required

The unique identifier of the Working Time Arrangement this Collective Schedule belongs to.

Required range: x > 0
pattern
object
required

The Pattern this Collective Schedule implements. Depends on the Shape.

splitsHalfDays
boolean
required

Should half-days be discriminated? In other words, should shifts belong to half days rather than just the day itself?

startsOn
string | null

The date (included) from which this Collective Schedule is applicable. Must be left null for the very first Collective Schedule of a Working Time Arrangement.

endsOn
string | null

The date (included) from which this Collective Schedule is no longer applicable. Is null for the last Collective Schedule of a Working Time Arrangement. Can not be modified as its equal to the day before the next applicable Collective Schedule for this Working Time Arrangement.