Loket.nl REST API Data Model
LeaveRequestsForEmployer |
List of leave requests for the employees of an employer__Activity name :__ GetLeaveRequestsByEmployerIdReturns a list of leave requests for the employments of the employer
Catalog: LoketNlRest
Schema: LeaveRequest
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.
Select loket.nl (REST) API URL: /providers/employers/{employerId}/employees/employments/leaverequests
Insert loket.nl (REST) API URL: /providers/employers/{employerId}/employees/employments/leaverequests
Update loket.nl (REST) API URL: /providers/employers/{employerId}/employees/employments/leaverequests
Delete loket.nl (REST) API URL: /providers/employers/{employerId}/employees/employments/leaverequests
Field Selection Method: NotRequired
Base Path: _embedded[*]
Select loket.nl (REST) API Operation: get /providers/employers/{employerId}/employees/employments/leaverequests
Table Function Parameters
The following parameters can be used to control the behaviour of the table function LeaveRequestsForEmployer. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be treated using their default values.
Value specification by position is done by listing all values from the first to the last needed value. For example with `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.
Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.
Name |
Data Type |
Required |
Default Value |
Documentation |
|---|---|---|---|---|
employerId |
guid |
☑ |
|
The unique identifier of the employer |
Table Function Columns
The columns of the table function LeaveRequestsForEmployer are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
commentEmployee |
string(4000) |
|
☐ |
The comment left by the employee |
commentHandler |
string(4000) |
|
☐ |
The comment left by the person handling the leave request |
currentlyAvailableUnits |
double |
|
☐ |
The number of leave units (of the leaveType for this leave request) available to the employment.This value can be negative. |
endDate |
datetime |
|
☐ |
The end date of the leave requested (last day of the leave) |
handledBy_formattedName |
string |
|
☐ |
preformated user name for displaying. <lastname>", "<initials>" "<prefix> |
handledBy_id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
handledBy_initials |
string(6) |
|
☐ |
The initials of the user |
handledBy_lastName |
string(25) |
|
☐ |
The last name of the user |
handledBy_prefix |
string(10) |
|
☐ |
The prefix of the user |
handledTime |
datetime |
|
☐ |
The date and time the leave request was handled |
id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
isAccrual |
boolean |
|
☐ |
Indicates whether the request is for accrual of leave.- false will result in a reduction of the employee's leave entitlement- true will result in an increase of the employee's leave entitlement |
leaveRequestStatus_key |
int32 |
|
☐ |
|
leaveRequestStatus_value |
string |
|
☐ |
|
leaveType_key |
int32 |
|
☐ |
|
leaveType_value |
string |
|
☐ |
|
numberOfUnits |
double |
|
☐ |
The number of leave units requested |
startDate |
datetime |
|
☐ |
The start date of the leave requested |
submittedBy_dateOfBirth |
datetime |
|
☐ |
The date of birth |
submittedBy_employeeNumber |
int32 |
|
☐ |
The employee number to uniquely identify a employee within a employer. |
submittedBy_firstName |
string(28) |
|
☐ |
The first name of the employee |
submittedBy_formattedName |
string(82) |
|
☐ |
Formatted name of the employee based on the value of `howToFormatLastName` |
submittedBy_id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
submittedBy_initials |
string(6) |
|
☐ |
The initials of the employee |
submittedBy_lastName |
string(25) |
|
☐ |
The last name of the employee |
submittedBy_lastNamePartner |
string(25) |
|
☐ |
The last name of the partner of the employee |
submittedBy_photo |
string |
|
☐ |
A photo of the employee to use as a avatar/profile picture. The last part of the returned endpoint is the version of the logo this allows users to cache the image. Changing the value of the version will not influence the output. |
submittedBy_prefix |
string(10) |
|
☐ |
The prefix of the employee |
submittedBy_prefixPartner |
string(10) |
|
☐ |
The prefix of the partner of the employee |
submittedOn |
datetime |
|
☐ |
The time the leave request was submitted |
unitType_key |
int32 |
|
☐ |
The key for the unit type |
unitType_value |
string |
|
☐ |
The description for the unit type |
25-05-2022 14:15 Version 22.1.46-BETA+3385
