# CalendarAvailableCalendarHoursByEmployerId
List available hours per employment (for calendar)
__Activity name :__ GetCalendarAvailableHoursByEmployerId
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.
Select loket.nl (REST) API URL: /providers/employers/{employerId}/employees/employments/calendar/availablehours
Insert loket.nl (REST) API URL: /providers/employers/{employerId}/employees/employments/calendar/availablehours
Update loket.nl (REST) API URL: /providers/employers/{employerId}/employees/employments/calendar/availablehours
Delete loket.nl (REST) API URL: /providers/employers/{employerId}/employees/employments/calendar/availablehours
Select loket.nl (REST) API Operation: get /providers/employers/{employerId}/employees/employments/calendar/availablehours
- Catalog: `LoketNlRest`
- Schema: `Calendar`
- Field Selection Method: NotRequired
- Base Path: `_embedded[*].calendar[*]`
This is a read-only table function. The loket.nl (REST) API may not support changing the data or the Invantive SQL driver for loket.nl (REST) does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the loket.nl (REST) API.
## Parameters of Table Function
| Name | Data Type | Required | Default Value | Documentation |
|---|:---:|:---:|:---:|---|
| `employerId` | `guid` | ☑ | | The unique identifier of the employer |
| `endDate` | `datetime` | ☑ | | A valid date (yyyy-MM-dd). Last day of the timebox for which calendar data will be collected. |
| `startDate` | `datetime` | ☑ | | A valid date (yyyy-MM-dd). First day of the timebox for which calendar data will be collected. |
## Columns of Table Function
The columns of the table function `CalendarAvailableCalendarHoursByEmployerId` are shown below. Each column has an SQL data type.
| Name | Data Type | Label | Required | Documentation |
|---|:---:|---|:---:|---|
| `department_code` | `int32` | | ☐ | |
| `department_description` | `string` | | ☐ | |
| `department_key` | `guid` | | ☐ | The unique identifier of an object (GUID/UUID) |
| `employee_formattedName` | `string(82)` | | ☐ | Formatted name of the employee based on the value of `howToFormatLastName` |
| `employee_id` | `guid` | | ☐ | The unique identifier of an object (GUID/UUID) |
| `employment_id` | `guid` | | ☐ | The unique identifier of an object (GUID/UUID) |
| `endDate` | `datetime` | | ☐ | The last day of the period for which availability information is available. |
| `startDate` | `datetime` | | ☐ | The first day of the period for which availability information is available. |