Eigen rubrieken met de Extensions API

[#1]

Alle Youforce API's zoals de IAM API, Learning API, ect tonen een vaste set aan rubrieken. Voor iedere API is deze vaste set beschreven met daarbij het bron-veld uit HRCoreOnline.

Via de Extensions API, die als een extra API bij een Youforce API geactiveerd wordt, is het mogelijk Eigen rubrieken' (E-rubrieken) of bepaalde standaard HRCoreOnline-velden (toegewezen aan verzameltabel DPIA032), op het niveau van de persoon (PS) en dienstverband (DV) aan de API toe te voegen. 

Eigen rubrieken 

Hieronder een voorbeeld van een Eigen rubriek wat toe te voegen is aan de Extensions API. De gegevenssoort moet of PS - Persoon of DV - Dienstverband zijn en het moet gaan om een 'Stam gegeven'.

Standaard-rubrieken

Het standaard HRCoreOnline-veld moet zijn toegewezen aan tabel DPIA032. De gegevenssoort moet of PS - Persoon of DV - Dienstverband zijn en het moet gaan om een 'Stam gegeven'.

Toets dit zelf door in HRCoreOnline de rubriek-eigenschappen op te vragen van het benodigde veld.
Een voorbeeld van een Standaard-rubriek wat toe te voegen is aan de Extensions API. 

Dit betekent dat standaard ingedeelde Raet HRCoreOnline-velden niet kunnen worden toegevoegd en ook niet de velden die op een 'ander niveau' worden vastgelegd in de HRCoreOnline-applicatie, denk aan velden bij een ziekmelding, verlofaanvraag of bij een organisatorische eenheid et cetera. Dit soort velden zijn opgenomen in de standaard set van de Youforce API mits het veld past bij de doelbinding van de betreffende API.

De extensions API heeft per API twee endpoint waar het veld aan toegevoegd kan worden:

Gecombineerd met een API, bijvoorbeeld de IAM api.

• api.youforce.com/extensions/v1.0/IAM/persons 
• api.youforce.com/extensions/v1.0/IAM/employments

De Extensions API toont:

• de persoonscode;
• bij een dienstverband-rubriek het dienstverbandnummer;
• rubrieknummer uit HRCoreOnline;
• de veldnaam (fieldNameAlias, deze kies je zelf, daarover later meer);

de waarde, bij velden met een 'tabel' toont de API de waarde en omschrijving (description).

Zie hieronder voor een voorbeeld op Persoonsniveau en dienstverband niveau:  

 

Eerst afstemmen met de partij die Youforce API gebruikt

De Extentions API is te gebruiken in combinatie met een andere Youforce API. Raadpleeg altijd vooraf bij de partij die de Youforce API gebruikt of zij ook kunnen koppelen met de Extensions API en stem met die partij ook de extra velden af. Het is niet ondenkbaar dat de ontvangende partij een aanpassing moet doen in hun koppeling op de Youforce API.

 

Extensions API is een product-afname

Neem contact op met de Customer Success Manager om de Extensions API als product af te nemen.

 

Hoe kan je hier als klant gebruik van maken

Omdat de Extensions API alleen gebruikt kan worden met de nieuwe Developer portal zal de houder van de API-applicatie een nieuwe applicatie moeten aanmaken (met vanzelfsprekend ook de 'Youforce Extensions API'): Instructie Visma Developer portal 

Visma|Raet stemt de nieuwe Developer portal af met haar partners maar de afstemming over de extra velden zal je zelf met de ontvangende partij moeten doen.

Wanneer de API-applicatie is aangemaakt dien je als klant een 4ME-ticket aan te maken met daarin de volgende informatie:

• ClientID van de API-applicatie of als het gaat om een Visma|Raet-partner de naam van de partner;
• HRCoreOnline-rubrieknummer met de gewenste veldnaam zoals deze terug moet komen in de API.
• De tekst dat het gaat om 'inrichting van de Extensions API, bestemd voor API Consultancy'

Kies binnen 4ME voor Youforce (Portal) en de tegel Request for information.

Visma|Raet zal de velden toevoegen en de status via het ticket bijhouden. Je zal zelf de ontvangende partij moeten informeren. 

De aanvraag is vanuit Visma|Raet ook afgerond op het moment dat de velden zijn toegevoegd aan de API, desgewenst controleren/testen van de uitbreiding in de applicatie van de andere partij zal je zelf moeten afstemmen met de ontvangende partij.