IAM API - Release Notes & highlights

[#1]

• 04-09-2024: fix retention time
• 12-06-2023: property "Reason For Termination Of Employment" added to Employees endpoint
• 19-05-2023: property "Reason For Termination Of Employment" added to Employments endpoint
• 05-04-2023: property language added to Employees endpoint
• 15-06-2022: property Enddate added to Employees endpoint
• 12-05-2022: change of description of user endpoint
• 29-04-2022:User endpoint
• 01-01-2022:New endpoint: Companies

04-09-2024: fix retention time

On 04-09-2024 a fix will be deployed to solve an issue in het clean up of data in the IAM API.

Within the IAM API, the retention time for data is configured per customer. For most customers, this is 90 days, but this can be different per customer.

Contract and employee data older then 90 days will be cleaned up in the API platform after this retention time and will not delivered anymore in the IAM API. Note: this has no effect on the data in HR Core.

We noticed that the clean up of data outside retention time was not working properly for a couple of months. Employees out of service and old contract-time slices out of retention time, were still delivered.

With the fix of 4-9-2024, the data outside retention is cleaned up correctly and data in IAM API is delivered correctly.

This concerns the endpoints: Employees, Employments and Persons.

12-06-2023: property "Reason For Termination Of Employment" added to Employees endpoint

Employees endpoint - The property ReasonForTerminationOfEmployment is added to the Employments part of the Employees endpoint. 

Endpoint documentation is updated.

Note, we will not reload your data currently for this change. If you want to use this new property, please request a reload of the data.

19-05-2023: property "Reason For Termination Of Employment" added to Employments endpoint

Employments endpoint - The property ReasonForTerminationOfEmployment is added to the Employments endpoint. 

Endpoint documentation is updated.

05-04-2023: property language added to Employees endpoint

Employees endpoint - The property language is added to the Employees endpoint. 

Endpoint documentation is updated.

15-06-2022: property Enddate added to Employees endpoint

Employees endpoint - Employees endpoint hold employee as well as employment data. In the Employments section, the property Enddate is added. Swagger and endpoint documentation is  also updated.

12-05-2022: change of description of user endpoint

User endpoint - The description of employeeId reference has changed. The employeeId does references to the PersonCode of the employee, not to the mutKey of the employee. 

https://api.youserve.nl/iam/v1.0/users(employeeId=12345)

Old text:

• employeeId - The unique id assigned to an employee. This id is available in the Employees endpoint with the property id.

New:

• employeeId - The unique id assigned to an employee. This value is available in the Employees endpoint with the property PersonCode.

The description of the user endpoint : IAM User endpoint.

29-04-2022: User endpoint

The description of the user endpoint is added to the documentation: IAM User endpoint.

01-01-2022: New endpoint: Companies

For more detailed information on the endpoint please refer to below documentation: Companies endpoint.