v3

latestOpenAPI 3.1.02026-07-311,0939714.5 MB
Calendar

List available hours per employment (for calendar)

Activity name : <a href="https://developer.loket.nl/Activities/GetCalendarAvailableHoursByEmployerId" target="_blank">GetCalendarAvailableHoursByEmployerId</a>

For a calendar, this endpoint returns the availability of an employment expressed as a pattern for both odd and even weeks. Note that multiple patterns can be active in the time period that is requested using the query parameter startDate and endDate. While multiple patterns can be returned, on any date only one pattern is active. The patterns do not overlap.

The available hours for a day are determined by the bi-weekly work pattern (as defined in the Working Hours resource) if such a work pattern is present for the employment. If no bi-weekly work pattern is present and the employment is NOT an on-call employment than the number of standard hours (either shiftHours or deviatingHoursPerWeek) is equally divided over the working days within each week (Monday through Friday).

This endpoint only returns objects for which the employment meets the filter settings set at the user level. Note that filter settings are set for a user <-> employer <-> client combination.

get/v2/providers/employers/{employerId}/employees/employments/calendar/availablehours

Path parameters

employerIdstring uuid required

The unique identifier of the employer

Query parameters

filterstring
Example:cancellationPeriodTimeUnit.key eq 4

Filter the collection

orderBystring
Example:-companyName,address.houseNumber

Order the collection on one or more fields

pageNumberinteger
Example:2

Specifies which page should be returned

pageSizeinteger
Example:20

Specifies the number of objects per page

startDatestring date required

A valid date (yyyy-MM-dd). First day of the timebox for which calendar data will be collected.

endDatestring date required

A valid date (yyyy-MM-dd). Last day of the timebox for which calendar data will be collected.

Headers

Authorizationstring required
Example:Bearer <TOKEN>

A valid Bearer token for authorizing the request.

Acceptstring required
Example:application/json;version=2018-01-01

The accept header is used to influence what type of output is returned and in most cases the version of the output

Response

OK