invantive documentation
Invantive Support ForumsLog In / Sign Up

EmployeeByEmployeeId: Loket.nl REST itgen_loketnl_employeebyemployeeid_plural

read only REST

  • Catalog: LoketNlRest
  • Schema: Employee
  • Label: itgen_loketnl_employeebyemployeeid_plural

Details of an employee Activity name : GetEmployeeByEmployeeId

Get the details of a single employee

Can only retrieve data.

API Source

  • Endpoint: /providers/employers/employees/{employeeId}
  • Operation: get /providers/employers/employees/{employeeId}

Parameters

Name Data Type Required Default Documentation
employeeId `` The unique identifier of the employee

Table Columns

The columns of the table EmployeeByEmployeeId are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert and update.

Name Data Type Label Required Marks Documentation
address_city varchar2(24) City City of the address
address_country_isoCode varchar2(2) Country ISO-code The ISO 3166-1 alpha-2 value for the country
address_country_key int32 Country Key The key for the country. Possible values can be aquired via the metadata endpoint
address_country_value varchar2(50) Country Value The name of the country
address_furtherIndication_key int32 Address Further Indication Key The key of the further indication ('nadere aanduiding'). Possible values can be aquired via the metadata endpoint
address_furtherIndication_value varchar2 Address Further Indication Value The description of the further indication ('nadere aanduiding'), the possible values are "WW" and "AB"
address_houseNumber int32 House Number House number of the address
address_houseNumberAddition varchar2(4) House Number Addition 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 varchar2(35) Location The location like to further specify the address
address_postalCode varchar2(9) Postal Code The postal code of the address, only nullable if country is not The Netherlands (NL).
address_street varchar2(24) Street Streetname of the address
contactInformation_businessEmailAddress varchar2(255) itgen_loketnl_contactinformation_businessemailaddress The business e-mail address of the employee.
contactInformation_businessMobilePhoneNumber varchar2(15) itgen_loketnl_contactinformation_businessmobilephonenumber The business mobile phone number of the employee.
contactInformation_businessPhoneNumber varchar2(15) itgen_loketnl_contactinformation_businessphonenumber The business phone number of the employee.
contactInformation_emailAddress varchar2(255) Contact Information Email Address The e-mail address of the employee.
contactInformation_faxNumber varchar2(15) Contact Information Fax Number The fax number to contact this individual
contactInformation_mobilePhoneNumber varchar2(15) itgen_loketnl_contactinformation_mobilephonenumber The mobile phone number of the employee.
contactInformation_phoneNumber varchar2(15) Contact Information Phone Number The phone number of the employee.
deviatingPostalAddress_city varchar2(24) Deviating Postal Address City City of the address
deviatingPostalAddress_country_isoCode varchar2(2) Deviating Postal Address Country ISO-code The ISO 3166-1 alpha-2 value for the country
deviatingPostalAddress_country_key int32 Deviating Postal Address Country Key The key for the country. Possible values can be aquired by the metadata endpoint
deviatingPostalAddress_country_value varchar2(50) Deviating Postal Address Country Value The name of the country
deviatingPostalAddress_furtherIndication_key int32 Deviating Postal Address Further Indication Key The key of the further indication. Possible values can be aquired by the metadata endpoint
deviatingPostalAddress_furtherIndication_value varchar2 Deviating Postal Address Further Indication Value The description of the further indication, the possible values are "WW" and "AB"
deviatingPostalAddress_houseNumber int32 Deviating Postal Address House Number House number of the address
deviatingPostalAddress_houseNumberAddition varchar2(4) Deviating Postal Address House Number Addition 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 varchar2(35) Deviating Postal Address Location The location like to further specify the address
deviatingPostalAddress_postalCode varchar2(9) Deviating Postal Address Postal Code The postal code of the address, only nullable if country is not The Netherlands (NL).
deviatingPostalAddress_street varchar2(24) Deviating Postal Address Street Streetname of the address
employeeNumber int32 Employee Number The employee number to uniquely identify an employee within an employer
exclusionFromAbsenceStatus char itgen_loketnl_exclusionfromabsencestatus Indicates whether the employee is excluded for any information of absence
id guid ID The unique identifier of an object (GUID/UUID)
identityDocument_documentIdentification varchar2 itgen_loketnl_identitydocument_documentidentification
identityDocument_typeOfDocument_key int32 itgen_loketnl_identitydocument_typeofdocument_key The key for the type of document. Possible values can be aquired via the metadata endpoint
identityDocument_typeOfDocument_value varchar2(50) itgen_loketnl_identitydocument_typeofdocument_value Description of the type of document
personalDetails_aowDate datetime itgen_loketnl_personaldetails_aowdate 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 itgen_loketnl_personaldetails_civilstatus_key
personalDetails_civilStatus_value varchar2(50) itgen_loketnl_personaldetails_civilstatus_value
personalDetails_dateOfBirth datetime Date of Birth The date of birth
personalDetails_dateOfDeath datetime itgen_loketnl_personaldetails_dateofdeath The date of death
personalDetails_firstName varchar2(28) First Name The first name, given name, forename or Christian name as part of a persons personal name.
personalDetails_formattedName varchar2(82) itgen_loketnl_personaldetails_formattedname Formatted name of the employee based on the value of howToFormatLastName
personalDetails_gender_key int32 itgen_loketnl_personaldetails_gender_key
personalDetails_gender_value varchar2(50) itgen_loketnl_personaldetails_gender_value
personalDetails_howToFormatLastName_key int32 itgen_loketnl_personaldetails_howtoformatlastname_key
personalDetails_howToFormatLastName_value varchar2(50) itgen_loketnl_personaldetails_howtoformatlastname_value
personalDetails_initials varchar2(6) Initials The initials
personalDetails_lastName varchar2(25) Last Name The last name, family name or surname as part of a persons personal name.
personalDetails_lastNamePartner varchar2(25) Last Name Partner The last name of the employee's partner.
personalDetails_nationality_key int32 Nationality Key The key for the nationality. Possible values can be aquired via the metadata endpoint
personalDetails_nationality_value varchar2(50) Nationality Value Description of the nationality
personalDetails_photo varchar2 Photo 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 varchar2(24) itgen_loketnl_personaldetails_placeofbirth The place of birth
personalDetails_prefix varchar2(10) Prefix The prefix to the last name
personalDetails_prefixPartner varchar2(10) Prefix Partner The prefix to the last name of the employee's partner.
personalDetails_title_key int32 Title Key
personalDetails_title_value varchar2(50) Title Value
revokeEmployeeSelfServiceAccessOn datetime itgen_loketnl_revokeemployeeselfserviceaccesson The date on which the Employee will be automatically blocked.
statusEmployeeSelfService_key int32 itgen_loketnl_statusemployeeselfservice_key
statusEmployeeSelfService_value varchar2(50) itgen_loketnl_statusemployeeselfservice_value
travel_travelDistanceToWork int32 itgen_loketnl_travel_traveldistancetowork The one way distance in meters the employee has to travel to work.
travel_travelDistanceToWorkInKm double itgen_loketnl_travel_traveldistancetoworkinkm The one way distance in kilometers the employee has to travel to work.

Release Notes

What changed per release in the tables, columns, attributes and capabilities of the driver: