om een gepersonaliseerde navigatie te krijgen.
om een gepersonaliseerde navigatie te krijgen.
De recruitment API is uitgebreid met aantal nieuwe endpoints voor het aannemen kandidaat uit een recruitment systeem. Vanuit het proces worden de volgende situaties ondersteund:
In de API wordt voor een aangenomen medewerker een workflow in HR Self Service gestart. Afhankelijk van bovenstaande situatie kunnen dat andere workflows zijn. Ook is het mogelijk om bij het aannemen van de kandidaat attachements mee te geven.
API & Connector
De integratie tussen Youforce en het recruitment systeem is een complex proces waarbij interactie tussen het Recruitment systeem en de recruitment API vereist is. In onderstaand schema worden deze interactie tussen beide systemen weergegeven.
Belangrijk om te vermelden is dat de recruitment API enkel een single tenant omgeving ondersteunt. Dat wil zeggen dat het niet mogelijk is de recruitment API te gebruiken als je in Beaufort en HR Self Service meerdere klanten in één database heb samengevoegd.
Endpoint search Person
Hiervoor biedt de API een endpoint waarmee het recruitment systeem kan zoeken of de betreffende kandidaat als persoon bestaat in het HR Core systeem. Velden waarop gezocht kan worden zijn:
Het endpoint is:
GET https://api.youforce.com/recruitment/v1.0/persons/search
Note:
De endpoints new hire, new contract en contract change
Op basis van het feit of het om een nieuwe of een bestaand persoon gaat wordt het endpoint voor een nieuwe hire of een nieuw contract opgestart.
Het endpoint voor de hire is:
POST https://api.youforce.com/recruitment/v1.0/hires
Het endpoint voor een re-hire is:
POST https://api.youforce.com/recruitment/v1.0/persons/xxxx/contracts
waarin xxxx het persoonsnummer van de bestaande medewerker is.
Het endpoint voor een change contract:
POST https://api.youforce.com/recruitment/v1.0/persons/xxxx/contracts/yyy/Adjustments
waarin xxxx het persoonsnummer van de bestaande medewerker is en yyy het dienstverband volgnummer.
De endpoints werken asynchroon. Dat wil zeggen dat een POST eerst intern in de API wordt weggeschreven en op de achtergrond een workflow start. De POST call geeft dan ook enkel een ID teruggeeft. Dit ID kan gebruikt worden om via een status endpoint, de status van de API call en de workflow informatie op te vragen.
De endpoints die gebruikt kunnen worden om de status op te vragen zijn:
GET https://api.youforce.com/recruitment/v1.0/hires/zzzz-zzzzz-zzzz/status
waarin zzzz-zzzzz-zzzz het ID van de API call is
GET https://api.youforce.com/recruitment/v1.0/persons/xxxx/contracts/zzzz-zzzzz-zzzz/status
waarin xxx de persoonscode is en zzzz-zzzzz-zzzz het ID van de API call is
Te starten workflow
Default workflow: Indien in de header van de API call geen workflow wordt meegegeven, dan wordt de workflow gestart zoals die bij de configuratie door de API consultant is ingericht.
Specifiek workflow: Bij de API call kan ook een workflow meegegeven worden. Bijvoorbeeld om onderscheid te maken tussen een Nieuwe verloonde medewerker of een Inhuurkracht (PNIL).
De header X-Raet-Workflow stuurt welke workflow wordt gestart.
De medewerker gegevens
Voor zowel de hire en re-hire wordt de medewerker data in de body meegegeven.
Bij een hire worden de persoonsgegevens gebruikt om een nieuwe persoon te creëren.
Bij de Re-hire worden de persoonsgegevens gebruikt om bestaande gegevens bij te werken. Bijvoorbeeld als de medewerker sinds zijn laatste uitdiensttreding is verhuisd.
De API werkt met een standaard mapping tussen de API en de Beaufort rubrieken. Eventueel kan de API consultants afwijkende mapping voor specifieke rubrieken vastleggen. Bijvoorbeeld als u een eigen rubriek gebruikt voor het vastleggen van de soort arbeidsrelatie.
Eigen rubrieken
Naast dat de consultant de mapping van de velden kan aanpassen, is het ook mogelijk om extra rubrieken in de API mee te geven. Hiervoor dient u wel de rubrieksnummers uit HR Self Service te gebruiken en dient het een PS of DV rubriek te zijn.
De extra rubrieken kunnen in de body meegegeven worden als customFields.
"customFields":
[
{"fieldCode": "B12071", "fieldValue": "BE56363123456788"},
{"fieldCode": "B12081", "fieldValue": "BBRUBEBB"}
]
Attachements
Bij zowel de hire, re-hire en contract changes endpoint kan naast de medewerker data ook één of meerdere attachements toegevoegd worden.
Hierbij geldt wel de volgende restricties:
Voor het toevoegen van de attachements kan een sectie files aan de API call toegevoegd worden met de volgende informatie:
"files":
[
{"name": "Application letter.txt",
"category": "Demo",
"contentBase64": "VGhpcyBpcyBhIHRlc3Q="
},
{"name": "curriculum vitae.txt",
"category": "Demo",
"contentBase64": "VGhpcyBpcyBhIHRlc3Q="
}
]
Verdere informatie
Meer technische informatie is te vinden op Youforce API Documentation. Daar vindt u de swagger documentatie en een link naar een postman collectie met voorbeeld.
Copyright 2019 Visma Community. All right reserved.