Please enable JavaScript to view this site.

Navigation: Schema: LinkedEmployers > Tables

LinkedEmployersByUserId

List of employers linked to the user__Activity name :__ GetLinkedEmployersByUserIdList of employers accessible by the user

Catalog: LoketNlRest

Schema: LinkedEmployers

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/users/{userId}/employers

Insert loket.nl (REST) API URL: /providers/employers/users/{userId}/employers

Update loket.nl (REST) API URL: /providers/employers/users/{userId}/employers

Delete loket.nl (REST) API URL: /providers/employers/users/{userId}/employers

Field Selection Method: NotRequired

Base Path: _embedded[*]

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

Table Function Parameters

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

userId

guid

 

The unique identifier of an user

 

Table Function Columns

The columns of the table function LinkedEmployersByUserId 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_houseNumber

int32

 

House number of the address

address_postalCode

string(9)

 

The postal code of the address

address_street

string(24)

 

Streetname of the address

branch_key

int32

 

The key of the branch. Possible values can be aquired via the metadata endpoint

branch_value

string(50)

 

Description of the branch. Branch is only available in Dutch

companyName

string(70)

 

Name of the company

contact_name

string(50)

 

Name of the contact of the employer

contact_phoneNumber

string(15)

 

The general phone number of the employer

contactInformation_phoneNumber

string(15)

 

The telephone number of the employer

employerLogo

string

 

The location of the logo of the employer. 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.

id

guid

 

The unique identifier of an object (GUID/UUID)

providerLogo

string

 

This logo is displayed in the interface of loket.nl. if null no deviating logo is present and the normal provider logo should be used (aquire the URL to the logo via ../v2/providers)

providerSettings_administrationNumber

string(15)

 

A free field that is most commonly used to store the Debtors Number the provider uses for the employer. This field is used as a key field in some of the existing SOAP webservices.

providerSettings_groupCode

int32

 

The groupcode is used for grouping employers. It is used for filtering output and processes (only include employers in group 40 in this report).

 

25-05-2022 14:15 Version 22.1.46-BETA+3385