API Update 2022-06

02-06-2022

IAM API verbeterd

Afgelopen maand is de IAM api verbeterd. Hieronder wordt een overzicht van de belangrijkste verbeteringen.

Performance & stabiliteit

alle endpoints

In het verleden kon het nog wel eens voorkomen dat de API veel tijd nodig had om de response te genererende API waardoor er soms time-outs konden ontstaan. De afgelopen maand is de architectuur van de API gewijzigd waardoor de performance API is verbeterd en minder kans op time-outs ontstaat.

Adresgegevens uitgebreid

Person en Employee endpoint

Bij de adresgegevens naast de landcode ook de naam van het land getoond. Dit betreft de naam zoals ook wordt weergegeven in Beaufort zelf.

Naam van onder andere organisatie eenheid, functie en classificatie als extra veld toegevoegd

Employee en Employment endpoint

In de endpoints Employee en Employment wordt bij de dienstverband gegevens naast een code voor functie, clasificatie, organizatie eenheid, ect ook de naam getoond.
Hierdoor wordt het eenvoudiger om vanuit één endpoint de naam in het IAM systeem op te nemen. Voor organisatie eenheid is naast de naam ook nog een extra veld met de logisch code toegevoegd.

Veld Youforce Account toegevoegd

[Person en Employee endpoint]

In de endpoints Person en Employee is een nieuw veld YouforceAccount toegevoegd. Dit betreft de rubriek P15013 Youforce gebruiker uit Beaufort. Met dit veld aangegeven voor de betreffende persoon een Youforce account is aangemaakt.
Alleen voor personen waarvoor een Youforce account is aangemaakt, kan het User endpoint gebruikt worden om de Identity terug te schrijven. Bij medewerkers zonder Youforce account zal het User endpoint een foutmelding geven.

Note:
Om van dit veld gebruik te kunnen maken, dient u wel over te zijn op de nieuwe werkwijze in Beaufort. Meer hierover kunt u lezen in de Beaufort release 2022-02

Consistentie tussen endpoints Person, Employments en Employee verbeterd

[Endpoints Employee , Person en Employment]

Het endpoint Employee is een gecombineerd van de endpoints Person & Employment. Functioneel betreft het echter dezelfde entiteiten uit Beaufort.
Het bleek echter dat in beide endpoints (Person/Employment versus Employee) niet dezelfde velden zichtbaar waren. Daardoor moest soms het employee endpoint gecombineerd worden met het Employment endpoint, terwijl beiden eigenlijk vergelijkbaar zijn.

Vanaf nu bevatten de endpoints Person & Employment dezelfde velden als het endpoint Employee en visa versa. Enige verschil tussen deze endpoints is dat bij het Employee endpoint de data gecombineerd is en bij het Person en Employment de data per entiteit gescheiden is.

Ook is het gedrag van beide endpoints vergelijkbaar. Bij de inrichting van de API wordt een bewaartermijn vastgelegd. Deze bewaartermijn bepaald hoe lang dienstverbanden nog zichtbaar zijn in de API als deze dienstverbanden uitdienst zijn. Bij de default inrichting van de API wordt deze bewaartermijn op 90 dagen ingesteld. Dat wil zeggen dat alleen de dienstverbanden worden getoond waarvoor de datum uitdienst jonger is dat de systeem datum [minus] 90 dagen. Als de datum uitdienst ouder is dan deze 90 dagen dan wordt het dienstverband niet getoond. Zowel niet in het Employment endpoint als ook niet in het Employee endpoint.

Als op basis van deze regel er geen enkele dienstverband bij een persoon is vastgelegd dan wordt ook het bijbehorende persoon record niet getoond of verwijderd beschouwd. Bij verwijderen wordt enkel het ID van de persoon getoond met een attribute IsActive = False.

Meer records per page

[alle endpoints]

Door het verbeteren van de architecture is het ook mogelijk meer records in response op te nemen. Standaard wordt bij elke endpoint maximaal 100 records terug gegeven. Mocht de tabel meer records bevatten dat wordt middels een NextLink de volgende data set aangeboden.

Vanaf deze release is het echter ook mogelijk meer dan 100 records in één paging op te vragen. Dit kan middels de parameter take toe te voegen aan de url.

Hieronder een voorbeeld waarbij 125 records per pagina wordt opgehaald.

GET https://api.youforce.com//iam/v1.0/persons?take=125

In de nextLink wordt deze page size overgenomen, zodat ook de vervolg pagina's maximaal 125 records bevat.

U kunt een page size tot maximaal 1000 records opvragen.