Loket.nl REST API Data Model
AbsenceByAbsenceId |
Details of an Absence__Activity name :__ GetAbsenceByAbsenceIdGet the details of an Absence
Catalog: LoketNlRest
Schema: Absence
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/absences/{absenceId}
Insert loket.nl (REST) API URL: /providers/employers/employees/absences/{absenceId}
Update loket.nl (REST) API URL: /providers/employers/employees/absences/{absenceId}
Delete loket.nl (REST) API URL: /providers/employers/employees/absences/{absenceId}
Field Selection Method: NotRequired
Base Path: content
Select loket.nl (REST) API Operation: get /providers/employers/employees/absences/{absenceId}
Table Function Parameters
The following parameters can be used to control the behaviour of the table function AbsenceByAbsenceId. 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 |
|---|---|---|---|---|
absenceId |
guid |
☑ |
|
The unique identifier of an absence |
Table Function Columns
The columns of the table function AbsenceByAbsenceId are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
accidentType_key |
int32 |
|
☐ |
The key of the accident type. Possible values can be aquired via the metadata endpoint. |
accidentType_value |
string(50) |
|
☐ |
Description of the accident type. |
actionToBeTakenByOccupationalHealthAndSafetyService_key |
int32 |
|
☐ |
The key of the desired action to be taken by the occupational health and safety service. Possible values can be aquired via the metadata endpoint. |
actionToBeTakenByOccupationalHealthAndSafetyService_value |
string(50) |
|
☐ |
Description of the desired action to be taken by the occupational health and safety service. |
caseManager_function |
string(50) |
|
☐ |
Function of the case manager. |
caseManager_name |
string(25) |
|
☐ |
Name of the case manager for reintegration. |
caseManager_organization |
string(70) |
|
☐ |
Function of the case manager. |
caseManager_phoneNumber |
string(15) |
|
☐ |
The phone number of the employee. |
causeOfAbsence_key |
int32 |
|
☐ |
The key of the cause of the absence. Possible values can be acquired via the metadata endpoint |
causeOfAbsence_value |
string(50) |
|
☐ |
Description of the cause of the absence. |
comments |
string(4000) |
|
☐ |
Free text field to register any relevant information. |
contactInformation_city |
string(24) |
|
☐ |
City of the address |
contactInformation_country_isoCode |
string(2) |
|
☐ |
The ISO 3166-1 alpha-2 value for the country |
contactInformation_country_key |
int32 |
|
☐ |
The key for the country. Posible values can be aquired via the metadata endpoint |
contactInformation_country_value |
string(50) |
|
☐ |
The name of the country |
contactInformation_endDate |
datetime |
|
☐ |
end date of the contact information |
contactInformation_furtherIndication_key |
int32 |
|
☐ |
The key of the further indication. Posible values can be aquired via the metadata endpoint |
contactInformation_furtherIndication_value |
string |
|
☐ |
The description of the further indication, the posible values are "WW" and "AB" |
contactInformation_houseNumber |
int32 |
|
☐ |
House number of the address |
contactInformation_houseNumberAddition |
string(4) |
|
☐ |
An addition to further specify the house/door/postbox. For example used to specifty a room of floor number in addition to the house number. |
contactInformation_locationType_key |
int32 |
|
☐ |
The key of the location type. Posible values can be aquired via the metadata endpoint |
contactInformation_locationType_value |
string(50) |
|
☐ |
Description of location type |
contactInformation_name |
string(70) |
|
☐ |
name of the institute for the contact information. |
contactInformation_phoneNumber |
string(15) |
|
☐ |
The phone number to contact the employee on. |
contactInformation_postalCode |
string(9) |
|
☐ |
The postal code of the address |
contactInformation_startDate |
datetime |
|
☐ |
start date of the contact information |
contactInformation_street |
string(24) |
|
☐ |
Streetname of the address |
expectedDateOfChildbirth |
datetime |
|
☐ |
Bevallingsdatum |
expectedDuration_key |
int32 |
|
☐ |
The key of the expected duration of the absence. Possible values can be acquired via the metadata endpoint. |
expectedDuration_value |
string(50) |
|
☐ |
Description of the expected duration of the absence. |
expectedEndDateOfMaternityLeave |
datetime |
|
☐ |
verwachte datum einde zwangerschapsverlof |
hasMobilityIssue |
boolean |
|
☐ |
This field indicates whether the Employee has an issue limiting its mobility. |
hoursWorkedOnFirstDayOfAbsence |
int64 |
|
☐ |
The number of hours worked on the first day of the absence. |
id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
isDisruptedEmploymentRelationship |
boolean |
|
☐ |
Indicates whether the employement relationship between employee and employer is disrupted. |
isHospitalised |
boolean |
|
☐ |
Betreft het een ziekenhuisopnamen |
isRecoveredWithinTwoWeeks |
boolean |
|
☐ |
This field indicates whether the Employee is (expected) recoverd within two weeks, relating to a full recovery. |
isThirdPartyLiability |
boolean |
|
☐ |
This field is related to `accidentType`. When `accidentType` is specified, this field indicates whether a third party is liable for the accident. |
isWorkRelatedIllness |
boolean |
|
☐ |
Beroepsziekte |
progress_currentIncapacityPercentage |
int64 |
|
☐ |
percentage of not being able to work |
progress_endOfAbsence_date |
datetime |
|
☐ |
The last day of the absence. |
progress_endOfAbsence_reason_key |
int32 |
|
☐ |
The key of the reason why the absence is ended. Possible values can be aquired via the metadata endpoint. |
progress_endOfAbsence_reason_value |
string(50) |
|
☐ |
Description of the reason why the absence ended. |
progress_startDate |
datetime |
|
☐ |
start dat of the incapacityPercentage |
reintegration_dateOfFinalizingPlanOfAction |
datetime |
|
☐ |
The day on which a plan of action (for return to normal work) was finalized. |
reintegration_reintegrationGoal_key |
int32 |
|
☐ |
The key for the reintegration goal. Related to the Wet Verbetering Poortwachter. |
reintegration_reintegrationGoal_value |
string(50) |
|
☐ |
The name of the country |
25-05-2022 14:15 Version 22.1.46-BETA+3385
