LOloket
Calendar

List leave per employment (for calendar)

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

This endpoint return the leave calendar items for each employment. Please note: this endpoint only will return calendar items based on leave of the type 'opname'.

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/leave

Request

  • Base URL
    https://api.loket.nl
  • URL
    https://api.loket.nl/v2/providers/employers/{employerId}/employees/employments/calendar/leave
  • Auth
    none required

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

totalSizeinteger

Total number of records, taking into account the given filter.

pageSizeinteger

Number of records in the response

totalPagesinteger

Number of pages available

currentPageinteger

Current page returned in the response

Example response

{
  "totalSize": 650,
  "pageSize": 250,
  "totalPages": 3,
  "currentPage": 2,
  "version": {
    "resourceVersion": "2018-12-31"
  },
  "messages": [
    {
      "type": "Warning",
      "description": "<some warning>",
      "id": "904d6856-6034-4624-bcbc-886188c115c5",
      "code": 12
    }
  ],
  "_embedded": [
    {
      "employment": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "incomeRelationshipNumber": 12
      },
      "employee": {
        "id": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "formattedName": "Wiel - van Bergen S.L. van de",
        "firstName": "Susan"
      },
      "department": {
        "key": "b14acd0d-75d7-4fc8-8b22-4a3924585cab",
        "code": 2,
        "description": "Verkoop"
      },
      "calendar": [
        {
          "startDate": "2019-01-01",
          "endDate": "2019-01-05"
        }
      ]
    }
  ]
}

Changes

No recorded changes to this operation across all 6 revisions of this API.