Loket.nl REST API Data Model
LeaveByLeaveId |
A single leave entry__Activity name :__ GetLeaveByLeaveIdReturns one leave entry (either addition or subtraction).
Catalog: LoketNlRest
Schema: Leave
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/employees/employments/leave/{leaveId}
Insert loket.nl (REST) API URL: /providers/employers/employees/employments/leave/{leaveId}
Update loket.nl (REST) API URL: /providers/employers/employees/employments/leave/{leaveId}
Delete loket.nl (REST) API URL: /providers/employers/employees/employments/leave/{leaveId}
Field Selection Method: NotRequired
Base Path: content
Select loket.nl (REST) API Operation: get /providers/employers/employees/employments/leave/{leaveId}
Table Function Parameters
The following parameters can be used to control the behaviour of the table function LeaveByLeaveId. 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 |
|---|---|---|---|---|
leaveId |
guid |
☑ |
|
The unique identifier of the leave |
Table Function Columns
The columns of the table function LeaveByLeaveId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
comment |
string(4000) |
|
☐ |
|
endDate |
datetime |
|
☐ |
The end date of the leave requested (last day of the leave) |
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 |
leaveType_balanceExceedsYear |
boolean |
|
☐ |
Indicates whether the balance at the end of the year for this leave type carries over to the next year. |
leaveType_key |
int32 |
|
☐ |
The key for the leave type. |
leaveType_value |
string |
|
☐ |
The description for the leave type. Note that leave types can be overridden at the employer level. In these cases the description at the employer level takes precedence over the default description of the leave type. |
numberOfUnits |
double |
|
☐ |
The number of leave units requested |
origin_leavePolicy_id |
guid |
|
☐ |
The unique identifier (a GUID/UUID) |
origin_leavePolicy_leaveUnitType_key |
int32 |
|
☐ |
The key for the leave unit Type. |
origin_leavePolicy_leaveUnitType_value |
string |
|
☐ |
The description for the leave unit type |
origin_leavePolicy_value |
string |
|
☐ |
The description of the leave regulation. |
origin_meansOfCreation_key |
int32 |
|
☐ |
The key for the means of creation |
origin_meansOfCreation_value |
string |
|
☐ |
The description for the leave unit type |
relatedLeave_id |
guid |
|
☐ |
The unique identifier (a GUID/UUID) |
relatedLeaveRequest_id |
guid |
|
☐ |
The unique identifier (a GUID/UUID) |
startDate |
datetime |
|
☐ |
The start date of the leave requested |
unitType_key |
int32 |
|
☐ |
The key for the unit type |
unitType_value |
string |
|
☐ |
The description for the unit type |
13-05-2022 15:37 Version 22.1.40-BETA+3374
