Please enable JavaScript to view this site.

Navigation: » No topics above this level «

EmployeeByEmployeeId

Details of an employee__Activity name :__ GetEmployeeByEmployeeIdGet the details of a single employee

Catalog: LoketNlRest

Schema: Employee

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/{employeeId}

Insert loket.nl (REST) API URL: /providers/employers/employees/{employeeId}

Update loket.nl (REST) API URL: /providers/employers/employees/{employeeId}

Delete loket.nl (REST) API URL: /providers/employers/employees/{employeeId}

Field Selection Method: NotRequired

Base Path: content

Select loket.nl (REST) API Operation: get /providers/employers/employees/{employeeId}

Table Function Parameters

The following parameters can be used to control the behaviour of the table function EmployeeByEmployeeId. 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

employeeId

guid

 

The unique identifier of the employee

 

Table Function Columns

The columns of the table function EmployeeByEmployeeId are shown below. Each column has an SQL data type.

Name

Data Type

Label

Required

Documentation

address_city

string(24)

 

City of the address

address_country_isoCode

string(2)

 

The ISO 3166-1 alpha-2 value for the country

address_country_key

int32

 

The key for the country. Posible values can be aquired via the metadata endpoint

address_country_value

string(50)

 

The name of the country

address_furtherIndication_key

int32

 

The key of the further indication ('nadere aanduiding'). Posible values can be aquired via the metadata endpoint

address_furtherIndication_value

string

 

The description of the further indication ('nadere aanduiding'), the posible values are "WW" and "AB"

address_houseNumber

int32

 

House number of the address

address_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.

address_location

string(35)

 

The location like to further specify the address

address_postalCode

string(9)

 

The postal code of the address, only nullable if country is not The Netherlands (NL).

address_street

string(24)

 

Streetname of the address

contactInformation_businessEmailAddress

string(255)

 

The business e-mail address of the employee.

contactInformation_businessMobilePhoneNumber

string(15)

 

The business mobile phone number of the employee.

contactInformation_businessPhoneNumber

string(15)

 

The business phone number of the employee.

contactInformation_emailAddress

string(255)

 

The e-mail address of the employee.

contactInformation_faxNumber

string(15)

 

The fax number to contact this individual

contactInformation_mobilePhoneNumber

string(15)

 

The mobile phone number of the employee.

contactInformation_phoneNumber

string(15)

 

The phone number of the employee.

deviatingPostalAddress_city

string(24)

 

City of the address

deviatingPostalAddress_country_isoCode

string(2)

 

The ISO 3166-1 alpha-2 value for the country

deviatingPostalAddress_country_key

int32

 

The key for the country. Possible values can be aquired by the metadata endpoint

deviatingPostalAddress_country_value

string(50)

 

The name of the country

deviatingPostalAddress_furtherIndication_key

int32

 

The key of the further indication. Possible values can be aquired by the metadata endpoint

deviatingPostalAddress_furtherIndication_value

string

 

The description of the further indication, the posible values are "WW" and "AB"

deviatingPostalAddress_houseNumber

int32

 

House number of the address

deviatingPostalAddress_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.

deviatingPostalAddress_location

string(35)

 

The location like to further specify the address

deviatingPostalAddress_postalCode

string(9)

 

The postal code of the address, only nullable if country is not The Netherlands (NL).

deviatingPostalAddress_street

string(24)

 

Streetname of the address

employeeNumber

int32

 

The employee number to uniquely identify an employee within an employer

exclusionFromAbsenceStatus

boolean

 

Indicates whether the employee is excluded for any information of absence

id

guid

 

The unique identifier of an object (GUID/UUID)

identityDocument_documentIdentification

string

 

 

identityDocument_typeOfDocument_key

int32

 

The key for the type of document. Posible values can be aquired via the metadata endpoint

identityDocument_typeOfDocument_value

string(50)

 

Description of the type of document

personalDetails_aowDate

datetime

 

The date when, according to Dutch law, the person has the right to a state pension. The value is generated by the system based on the date of birth.

personalDetails_civilStatus_key

int32

 

 

personalDetails_civilStatus_value

string(50)

 

 

personalDetails_dateOfBirth

datetime

 

The date of birth

personalDetails_dateOfDeath

datetime

 

The date of death

personalDetails_firstName

string(28)

 

The first name, given name, forename or Christian name as part of a persons personal name.

personalDetails_formattedName

string(82)

 

Formatted name of the employee based on the value of `howToFormatLastName`

personalDetails_gender_key

int32

 

 

personalDetails_gender_value

string(50)

 

 

personalDetails_howToFormatLastName_key

int32

 

 

personalDetails_howToFormatLastName_value

string(50)

 

 

personalDetails_initials

string(6)

 

The initials

personalDetails_lastName

string(25)

 

The last name, family name or surname as part of a persons personal name.

personalDetails_lastNamePartner

string(25)

 

The last name of the employee's partner.

personalDetails_nationality_key

int32

 

The key for the nationality. Posible values can be aquired via the metadata endpoint

personalDetails_nationality_value

string(50)

 

Description of the nationality

personalDetails_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.

personalDetails_placeOfBirth

string(24)

 

The place of birth

personalDetails_prefix

string(10)

 

The prefix to the last name

personalDetails_prefixPartner

string(10)

 

The prefix to the last name of the employee's partner.

personalDetails_title_key

int32

 

 

personalDetails_title_value

string(50)

 

 

revokeEmployeeSelfServiceAccessOn

datetime

 

The date on which the Employee will be automatically blocked.

statusEmployeeSelfService_key

int32

 

 

statusEmployeeSelfService_value

string(50)

 

 

travel_travelDistanceToWork

int32

 

The one way distance in metres the employee has to travel to work.

 

13-05-2022 15:37 Version 22.1.40-BETA+3374