MLM API - Release Notes 2021-01

[#1]

• Field “fullTimeWorkingAmount”
• System HR Core Business
• System HR Core Online (BO4)
• Extra field “Meerling” endpoint Maternity Leaves
• Extra filter on active & inactive sickness records
• Extra filter option based on ‘level’

 

Field “fullTimeWorkingAmount”

We’ve improved the field “fullTimeWorkingAmount”, which indicates the full-time hours per period within a specific company. For example 40 or 36 hours per week.
This field was already correctly shown in the endpoint:

Endpoint /companies

[
 {
 "validFrom": "2021-01-12T19:49:43.484Z",
 "validUntil": "2021-01-12T19:49:43.484Z",
 "extensions": [
 {
 "key": "string",
 "value": "string"
 }
 ],
 "id": "string",
 "code": "string",
 "name": "string",
 "totalWorkAmount": "40",
 "establishmentCountry": "string",
 "isDeleted": true,
 "address": {
 "street": "string",
 "houseNumber": "string",
 "houseNumberAddition": "string",
 "postalCode": "string",
 "city": "string",
 "country": "string"
 },
 "mailingAddress": {
 "boxNumber": "string",
 "postalCode": "string",
 "cityTown": "string"
 }
 }
]

We’ve corrected the position in the different body responses of other endpoints. Until Dec-2020 the field “fullTimeWorkingAmount” was part of the Person data details. However, the values of this specific field belong to contracts/employments. So, that’s why we’ve added the field to the endpoints:

Endpoint /contracts

{
 "validFrom": "2021-01-12T19:51:10.147Z",
 "validUntil": "2021-01-12T19:51:10.147Z",
 "extensions": [
 {
 "key": "string",
 "value": "string"
 }
 ],
 "id": "string",
 "isDeleted": true,
 "employeeCode": "string",
 "personId": "string",
 "contractCode": "string",
 "originalHireDate": "2021-01-12T19:51:10.147Z",
 "dischargeDate": "2021-01-12T19:51:10.147Z",
 "hireDate": "2021-01-12T19:51:10.147Z",
 "company": "string",
 "employmentType": "string",
 "contractType": "string",
 "jobProfile": "string",
 "organizationUnit": "string",
 "fullTimeWorkingAmount": 0,
 "phoneNumbers": [
 {
 "type": "string",
 "number": "string"
 }
 ],
 "emailAddresses": [
 {
 "type": "string",
 "address": "string"
 }
 ],
 "workingAmount": {
 "amountOfWork": 0,
 "unitOfWork": "string",
 "periodOfWork": "string"
 }
 }

Endpoint /employees

{
 "validFrom": "2021-01-12T19:52:29.217Z",
 "validUntil": "2021-01-12T19:52:29.217Z",
 "extensions": [
 {
 "key": "string",
 "value": "string"
 }
 ],
 "id": "string",
 "personCode": "string",
 "isDeleted": true,
 "initials": "string",
 "firstNames": "string",
 "knownAs": "string",
 "lastNameAtBirth": "string",
 "lastNameAtBirthPrefix": "string",
 "lastName": "string",
 "lastNamePrefix": "string",
 "nameAssembleOrder": "string",
 "partnerName": "string",
 "partnerNamePrefix": "string",
 "titlePrefix": "string",
 "titleSuffix": "string",
 "gender": "string",
 "birthDate": "2021-01-12T19:52:29.217Z",
 "deceasedDate": "2021-01-12T19:52:29.217Z",
 "nationalIdentificationNumber": "string",
 "userUID": "string",
 "phoneNumbers": [
 {
 "type": "string",
 "number": "string"
 }
 ],
 "emailAddresses": [
 {
 "type": "string",
 "address": "string"
 }
 ],
 "addresses": [
 {
 "type": "string",
 "streetName": "string",
 "houseNumber": "string",
 "houseNumberAddition": "string",
 "postalCode": "string",
 "city": "string",
 "country": "string"
 }
 ],
 "contracts": [
 {
 "validFrom": "2021-01-12T19:52:29.217Z",
 "validUntil": "2021-01-12T19:52:29.217Z",
 "extensions": [
 {
 "key": "string",
 "value": "string"
 }
 ],
 "id": "string",
 "isDeleted": true,
 "employeeCode": "string",
 "personId": "string",
 "contractCode": "string",
 "originalHireDate": "2021-01-12T19:52:29.217Z",
 "dischargeDate": "2021-01-12T19:52:29.217Z",
 "hireDate": "2021-01-12T19:52:29.217Z",
 "company": "string",
 "employmentType": "string",
 "contractType": "string",
 "jobProfile": "string",
 "organizationUnit": "string",
 "fullTimeWorkingAmount": 0,
 "phoneNumbers": [
 {
 "type": "string",
 "number": "string"
 }
 ],
 "emailAddresses": [
 {
 "type": "string",
 "address": "string"
 }
 ],
 "workingAmount": {
 "amountOfWork": 0,
 "unitOfWork": "string",
 "periodOfWork": "string"
 }
 }
 ]
 }

System HR Core Business

The values related to these HRCB clients were “0” until December 2020.
In January 2021 we’ve improved the extraction of these values.

System HR Core Online (BO4)

The values related to these BO4 clients were empty until December 2020.
We’ve improved the data extraction from BO4 system and the calculation behind it. Now the field “fullTimeWorkingAmount” will show the correct values from BO4.

Extra field “Meerling” endpoint Maternity Leaves

For both core systems HRCB and HR Core Online (BO4) we’ve added the field “multipleBirthIndication” to the endpoint Maternity Leaves.
In case more than one child is expected, this can be defined in both core systems (field name in core systems: Meerling).
Value “true” indicates that Multiple births are expected for this specific Maternity Leave case.

Endpoint Maternity Leaves

{
 "id": "string",
 "isDeleted": true,
 "personId": "string",
 "contractId": "string",
 "reportingDate": "2021-01-12T19:36:56.808Z",
 "startDate": "2021-01-12T19:36:56.808Z",
 "firstWorkingDay": "2021-01-12T19:36:56.808Z",
 "probableDeliveryDate": "2021-01-12T19:36:56.808Z",
 "actualDeliveryDate": "2021-01-12T19:36:56.808Z",
 "multipleBirthIndication": true,
 "extensions": [
 {
 "key": "string",
 "value": "string"
 }
 ]
 }

Extra filter on active & inactive sickness records

For the endpoint /sickleaves there an additional (optional) filter available. The extra parameter is could be added while fetching all sickness records within a tenant/client.

By default, the base URL of this endpoint will expose all available sickness records (active & inactive) within the specific client data set.

By adding the active filter to the base URL of this endpoint, the response output will only show the current active records corresponding to this client.
For example :

https://api.raet.com/mlm/sickleaves?active=true

Extra filter option based on ‘level’

For the endpoints /valuelists & /jobprofiles we’ve made it possible to execute an extra (optional) filter on the exposed data records.
The body responses of both endpoints already expose a field “level”, which indicates the level this Job Profile or Valuelist is configured in the core system, for example, “client”, “company” or “system” level.

By default the base URLs of these endpoints will expose all available jobprofile & valuelist records within the specific client data set.

Example endpoint /jobprofiles

{
 "validFrom": "2018-10-17",
 "validUntil": "9999-12-31",
 "extensions": [
 {
 "key": "null",
 "value": "null"
 }
 ],
 "id": "AA123",
 "fullName": "receptionist",
 "level": "company",
 "companyCode": "20114",
 "isDeleted": false
}

By adding the level filter to the base URL of these two endpoints, the response output will only show the records corresponding to this level.
For example :

https://api.raet.com/mlm/jobprofiles?level=Company