Learning API - Release Notes

[#1]

• 2020-08-20 - API enhancements
• 2020-08-19 - Employee endpoint includes also address details and original hire date
• 2020-07-01 - Learning API Controlled available
• 2021-03-23 - Uploading certificates for HRCB customers is available
• 2021-03-29 - Job family code in job profile
• 2021-04-08 - Performance improvements
• 2021-04-16 - Job familiy reference list is available
• 2021-05-05 - Fixed issue with the changedUntil parameter
• 2022-03-16 Communication Language added as part of employee data
• 2024-02-27 Manager person code added as part of Organizational Unit
• 2025-03-04 Backup manager id and backup manager person code added as part of Organizational Unit

2020-08-20 - API enhancements

The following enhancements are now available:

Record versions (validFrom / validUntil) in all endpoints

With this release we we support record version in every endpoint. Even if the the Core system doesn’t support record versioning, like HR Core Beaufort, we add default value for the validFrom and ValidUntil attributes. The default for ValidFrom is '0001-01-01' and the default validUntil is '9999-12-31'.

Delete flag for delete records

If a record is deleted in the core system, a isDelete= true attribute is set in the API. Based on this information you can delete the record as well in your own system.

Delete means that the whole entity is deleted and not just one version.

"id": "907624",
"isDeleted": true,
"shortName": "907624"
} ]]>

Note:

• Delete means that we delete the whole record and not just a version.

ID attribute in Job profile was missing

In the Job Profile endpoint an ID was missing. In this release we add the ID field to the Job Profile as well. For Job profile the ID and shortName contains both the same value.

Example of the ID and the validFrom and validUntil in the Job profile endpoint

{ "id": "723912",
"shortName": "723912",
"fullName": "Business Analyst",
"jobFamily": "Software",
"validFrom": "0001-01-01",
"validUntil": "9999-12-31"
}
] ]]>

Manager in organization Unit endpoint (HRCB Business only)

For HR Core Business the manager was missing in the organization unit endpoint. In this release we add the manager field to the organization unit endpoint.

Note:

• For HR Core Beaufort the manager is part of the endpoint role assignment with role type = MGR

UserUID for Single Sign On as part of the employee endpoint

In this release we add the userUID as part of the employee endpoint. The userUID can be used for the Single Sign On solution of Visma Raet.

{
"id": "79500",
"personCode": "79500",
"initials": "HJB",
"firstNames": "Herbert Jacob Bert",
"knownAs": "Herbert",
"lastName": "Robles",
"lastNameAtBirth": "Robles",
"nameAssembleOrder": "E",
"gender": "Male",
"birthDate": "1989-03-02",
"deceased": false,
"userUID": "3d89f34f-9fd8-41c4-8d63-09051a470591",
"employments": [
{
"employmentCode": "1",
"hireDate": "2020-01-01",
"employmentType": "005",
"originalHireDate": "2020-01-01",
"jobProfile": "8302",
"organizationUnit": "1867",
"workingAmount": {
"amountOfWork": 36,
"unitOfWork": "Hours",
"periodOfWork": "Week"
}
}
],
"validFrom": "1900-01-01",
"validUntil": "9999-12-31"
}]]>

2020-08-19 - Employee endpoint includes also address details and original hire date

The address details and the original hire date are also added to the employee endpoint.

"id": "79505",
"personCode": "79505",
"initials": "J",
"firstNames": "Jos",
"knownAs": "Josje",
"lastName": "Janssens",
"lastNameAtBirth": "Janssens",
"nameAssembleOrder": "E",
"gender": "Female",
"addresses": [
{
"type": "Home",
"street": "Computerweg",
"houseNumber": "99",
"postalCode": "3822CM",
"city": "AMERSFOORT",
"country": "NED"
},
{
"type": "Postal",
"street": "Computerweg",
"houseNumber": "99",
"postalCode": "3822CM",
"city": "AMERSFOORT",
"country": "NED"
}
]]>

2020-07-01 - Learning API Controlled available

The Learning API is controlled available. The API supports endpoints for:

• Getting employee data from HR Core systems like HR Core Beaufort and HR Core Business

• Upload diplomas or certificates to the Personal File System of Visma Raet (Personeelsdossier)

2021-03-23 -  Uploading certificates for HRCB customers is available

Uploading certificates in the Learning API was previously working only for HR Core Beaufort customers. Now is also available for HRCB customers.

2021-03-29 -  Job family code in job profile

The job family code is now available as part of the job profile data.

2021-04-08 -  Performance improvements

Performance improvements in queries.

2021-04-16 - Job familiy reference list is available

The endpoint for getting the job family reference list is available.

2021-05-05 -  Fixed issue with the changedUntil parameter

The changedAfter parameter can be used now without the changedUntil parameter. Search with the changedUntil parameter is working now without the changeAfter parameter.

2022-03-16 Communication Language added as part of employee data

The communication language is now available as part of the employee data.

2024-02-27 Manager person code added as part of Organizational Unit

The manager person code is now available as part of the organizational unit data.

 

2025-03-04 Backup manager id and backup manager person code added as part of Organizational Unit

The backup manager id and backup manager person code are now available as part of the organizational unit data.

Please read the documentation and the FAQ if you have questions about “How to use this API”.