Loket.nl REST API Data Model
OrganizationalEntityByOrganizationalEntityId |
Details of an organizational entity__Activity name:__ GetOrganizationalEntityByOrganizationalEntityIdGet the details of organizational entity
Catalog: LoketNlRest
Schema: OrganizationalEntity
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/organizationalentities/{organizationalEntityId}
Insert loket.nl (REST) API URL: /providers/employers/employees/employments/organizationalentities/{organizationalEntityId}
Update loket.nl (REST) API URL: /providers/employers/employees/employments/organizationalentities/{organizationalEntityId}
Delete loket.nl (REST) API URL: /providers/employers/employees/employments/organizationalentities/{organizationalEntityId}
Field Selection Method: NotRequired
Base Path: content
Select loket.nl (REST) API Operation: get /providers/employers/employees/employments/organizationalentities/{organizationalEntityId}
Table Function Parameters
The following parameters can be used to control the behaviour of the table function OrganizationalEntityByOrganizationalEntityId. 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 |
|---|---|---|---|---|
organizationalEntityId |
guid |
☑ |
|
The unique identifier of the organizational entity |
Table Function Columns
The columns of the table function OrganizationalEntityByOrganizationalEntityId 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) |
deviatingFunctionDescription |
string(50) |
|
☐ |
The deviating function description of the employment. This description deviates from the value of the `function` field. |
deviatingFunctionGroup |
string(5) |
|
☐ |
The deviating function group description of the employment. Only applies when a deviating function description is defined. |
distributionUnit_code |
int32 |
|
☐ |
|
distributionUnit_description |
string |
|
☐ |
|
distributionUnit_key |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
endDate |
datetime |
|
☐ |
The end date of the entity. The date is up to and including. |
function_description |
string(50) |
|
☐ |
|
function_group |
string(5) |
|
☐ |
|
function_key |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
id |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
internalTelephoneExtensionNumber |
string(15) |
|
☐ |
The phone number of the standard working location (standplaats) for the employment. |
placeOfEmployment |
string(24) |
|
☐ |
The standard working location (standplaats) for the employment. |
standardFunction_category |
int32 |
|
☐ |
|
standardFunction_code |
string(6) |
|
☐ |
|
standardFunction_key |
int32 |
|
☐ |
|
standardFunction_value |
string |
|
☐ |
|
startDate |
datetime |
|
☐ |
The start date of the entity.A (linked chain)[./#section/Data/Date-chains] is maintained within this resource. |
13-05-2022 15:37 Version 22.1.40-BETA+3374
