API Update 2022-10

[#1]

De afgelopen periode zijn de volgende verbeteringen in de API doorgevoerd.

Learning API 

Nieuw endpoints Person & Employment ter vervanging van Employees endpoint
Endpoints: Persons  and Employments; Employees endpoint deprecated
Het het huidige employee endpoint is een samengesteld endpoint dat zowel de persoons- als dienstverbandgegevens van medewerkers bevat. Afgelopen jaar is gebleken dat het combineren van deze data de complexiteit van het endpoint heeft verhoogd en de performance en stabiliteit achter blijft op de door ons gestelde eisen.
We hebben dan ook besloten om het employee endpoint te splitsen in een endpoint met de persoonsgegevens en een endpoint met de dienstverbandgegevens. 

Hiervoor hebben wij 2 nieuwe endpoints aan de learning API toegevoegd, te weten het endpoint Persons en het endpoint Employments. Beide endpoint bevatten alle gegevens uit het employees endpoint die horen tot de respectievelijk de persoon of het bijbehorende dienstverband. 
Het huidige Employee endpoint blijft voorlopig bestaan, echter het endpoint zal niet verder uitgebreid worden. Nieuwe velden of andere verbeteringen zullen enkel in de nieuwe endpoint voor Persons en Employments doorgevoerd worden.

Wij adviseren u om nieuwe koppelingen te baseren op de endpoints Persons en Employments en geen gebruik meer te maken van het Employee endpoint. Op termijn zal het huidige employee endpoint komen te vervallen. 

IAM API

Person & Employment ter vervanging van Employees endpoint

Ook in de IAM api hebben wij naast het Employees endpoint een endpoint Persons en Employments beschikbaar. Deze Persons endpoint en Employments endpoint bevatten alle velden die ook in het employees endpoint voor respectievelijk persoon en dienstverband zitten.

Het huidige Employee endpoint blijft voorlopig bestaan, echter het endpoint zal niet verder uitgebreid worden. Nieuwe velden of andere verbeteringen zullen enkel in het endpoint voor Persons en Employments doorgevoerd worden.
Wij adviseren u om nieuwe koppelingen te baseren op de endpoints Persons en Employments en geen gebruik meer te maken van het Employees endpoint. Op termijn zal het huidige employees endpoint komen te vervallen. 

autorisatie filters

De IAM api is uitgebreid met autorisatie mechanisme.  Op basis van dit autorisatie mechanisme kan de API consultant bij Visma Raet een autorisatie filter inrichten. Dit autorisatie filter zorgt ervoor dat het externe systeem alleen die medewerkers in de API te zien krijgt die voldoen aan het filter. Zo kunt u bijvoorbeeld ervoor kiezen om alleen interne medewerkers op basis van het veld Soort Arbeidsrelatie in de IAM api te laten opnemen.
De consultant kan deze een autorisatie filter inrichten op basis van de volgende velden:

• P01103 CEA-nummer / Payroll Client Code   
• P01104 Instelling nummer / Payroll Institution Code 
• P01102 Soort arbeidsrelatie / Employment type 
• P01110 Code doelgroep / Classification 
• P05041 Learning API

Raadpleeg uw customer succes manager als u in contact wilt komen met de API consultant voor het inrichten van deze filters.