PostEmploymentByEmployeeId_Messages |
Create employment for existing employee__Activity name :__ PostEmploymentByEmployeeIdCreate an additional employment for an already existing employee.Please note that the creation of an Employment is not RESTful by design.In Loket, when a new Employee is created it will have to be created including its underlying Employment and its accessory resources. This specific endpoint is relevant in the following scenario: there is already an Employee with at least one Employment, and one wishes to create an additional Employment for that currently existing Employee. When successfully calling this endpoint, an Employment with its accessory resources will be created.__Metadata :__ * Possible options (metadata) for generic fields of the type "metadata" can be acquired (GET) by adding `/metadata` to the URL.* Possible options dependent on a specific payrollAdministration can be acquired by adding `/metadata/payrolladministration/{payrollAdministrationId}` to the url.* Possible options for payGrade can be acquired by adding `metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}` to the url.A `payGrade` has time based values dictating the wage for a given period. These values can be acquired by performing another metadata request by adding `/metadata/payrolladministration/{payrollAdministrationId}/payscale/{payScaleKey}/paygrade/{payGradeKey}` to the url. This endpoint has the optional parameter "date" that may be used to specifying a measure date.__Defaults :__ Default values for a new object can be acquired by adding `/defaults` to the URL. Default values that are dependent on the selected payroll administration can be acquired by adding `../providers/employers/employees/employments/defaults/payrolladministration/{payrollAdministrationId}` to the URL.__NonPayrollAdministrations__ For nonPayrollAdministrations the equivalent metaData-endpoints are also available as described above. Also, a defaults endpoint is available for the nonPayrollAdministration. Please note that this requires `../nonpayrolladministrations/{nonPayrollAdministrationId}` in the path.
Catalog: LoketNlRest
Schema: CreateEmployment
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}/employments
Insert loket.nl (REST) API URL: /providers/employers/employees/{employeeId}/employments
Update loket.nl (REST) API URL: /providers/employers/employees/{employeeId}/employments
Delete loket.nl (REST) API URL: /providers/employers/employees/{employeeId}/employments
Field Selection Method: NotRequired
Base Path: messages[*]
Select loket.nl (REST) API Operation: post /providers/employers/employees/{employeeId}/employments
Table Function Parameters
The following parameters can be used to control the behaviour of the table function PostEmploymentByEmployeeId_Messages. 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 PostEmploymentByEmployeeId_Messages are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
---|---|---|---|---|
code |
int32 |
|
☐ |
Identifying code for the message |
currentPage |
int64 |
|
☐ |
Current page returned in the response |
description |
string |
|
☐ |
Describes the message |
id_1 |
guid |
|
☐ |
The unique identifier of an object (GUID/UUID) |
id |
guid |
|
☐ |
In some cases when the message may relate to a specific entity, or specific group of entities, this field provides the identifier of that entity |
pageSize |
int64 |
|
☐ |
Number of records in the response |
RESULT |
string |
|
☐ |
Outcome of operation as single plain text column. |
totalPages |
int64 |
|
☐ |
Number of pages available |
totalSize |
int64 |
|
☐ |
Total number of records, taking into account the given filter. |
type |
string |
|
☐ |
Indication of the type of message.See [the general documentation for more information](./#section/Response/Messages) |
version_obsoleteDate |
datetime |
|
☐ |
The date (can be null) on which the `resourceVersion` is no longer supported/available |
version_resourceVersion |
datetime |
|
☐ |
The resource version of the object in the response |
25-05-2022 14:15 Version 22.1.46-BETA+3385