We introduceren IP whitelisting voor onze Youforce Domain API's. Deze functie beperkt de toegang tot uw API tot specifieke IP-adressen of reeksen, wat verhoogde beveiliging biedt voor uw integraties met derden.   Interesse? Neem contact op met uw Youforce-consultant om deze functie te activeren. ... View more

In deze update hebben we het filter 'ValidOn' toegevoegd aan verschillende endpoints. Dit filter maakt het mogelijk om enkel de records te verkrijgen die op een bepaalde datum geldig zijn. Zo zullen bij het endpoint voor roltoewijzing (Role Assignment) zonder dit filter alle rollen, inclusief hun start- en einddatum, getoond worden - zelfs die met een toekomstige startdatum. Dankzij het nieuwe filter kan je nu alleen de roltoewijzingen ophalen die geldig zijn op een specifieke dag. Het filter is beschikbaar in de volgende endpoints: Employments/timelines SalaryDetails/timelines extensions/person/timelines extensions/employment/timelines Bijgevoegd is een voorbeeld van hoe het filter in een API-aanroep voor Roltoewijzing kan worden gebruikt:   https://api.youforce.com/iam/v1.0/RoleAssignments?organizationUnit=912&validOn=2024-09-12 Onderstaand vindt u de outputverschillen van een API-call met en zonder het gebruik van dit filter, waarbij u een duidelijk verschil zult zien in de resultaten.             ... View more

Met het veld Reden einde dienstverband (P01113) in Beaufort wordt aangegeven op welke grond het dienstverband is beëindigd. Afhankelijk van de reden is het soms wenselijk in een Learning systeem of in een IAM systeem anders te handelen. Om dit mogelijk te maken, is het veld Termination Reason toegevoegd aan het employment endpoint in zowel de Learning als de IAM API.     ... View more

De Recruitment API speelt een belangrijke rol in het wervingsproces van moderne organisaties. Door de Recruitment API naadloos te integreren met uw bestaande recruitment systeem ontstaat een soepele overgang tussen het recruitment proces in het recruitment systeem en de onboarding is Youforce. Of het nu gaat om het aantrekken van nieuwe talent (hire), het faciliteren van de terugkeer van voormalige werknemers (re-hire), of het soepel doorvoeren van interne functiewijzigingen (Contract change), de API biedt een gestroomlijnde koppeling met HR Self Service.    Features van de API Onze API faciliteert een aantal flexibele en krachtige opties, waaronder: Specifieke endpoints: De API bieden verschillende endpoints voor specifieke taken zoals het aannemen van nieuwe medewerkers (hire), herindiensttreding (re-hire), en contractwijzigingen (contract change). Veelzijdige workflow-ondersteuning: Verschillende HRSS workflows worden ondersteund, waardoor op maat gemaakte HRSS processen gebruikt kunnen worden voor verschillende categorieën medewerkers, zoals vaste medewerkers en tijdelijk personeel of verloonde medewerkers en medewerkers niet in loopdienst, de zogenaamde PNIL-ers. Aanpasbare veldtoewijzing: Standaard en aangepaste veldtoewijzingen zorgen ervoor dat de API naadloos aansluit op uw HR Self Service configuraties, inclusief ondersteuning voor eigen rubrieken. Attachment Functionaliteit: Voeg essentiële documenten en bestanden toe aan elke HR-werkstroom, wat essentieel is voor het beheren van kandidaatdocumentatie en andere belangrijke informatie. Let op: De configuratie en inrichting van de API en HR Self Service is een ingewikkeld proces dat een diepgaande kennis van beide systemen vereist. Dit proces wordt meestal begeleid door gespecialiseerde HSS en API-consultants om te zorgen voor een nauwkeurige afstemming op uw organisatorische wensen en technische eisen.   API & Connector De integratie tussen het recruitmentsysteem en Youforce bestaat uit Youforce API en een Connector als onderdeel van het recruitmentsysteem. Onderstaand schema geeft de interactie weer tussen het recruitment systeem en de Youforce API.   Binnen de connector dient logica ontwikkeld te worden om te kunnen bepalen of een een hire of re-hire betreft. Ter ondersteuning hier is een search person endpoint beschikbaar.   Endpoint Search Person Met behulp van dit endpoint kan op basis van de volgende gegevens bepaald worden of de medewerker reeds bestaat in het Core systeem. knownAs lastNameAtBirth lastNameAtBirthPrefix birthDate birthPlace   GET https://api.youforce.com/recruitment/v1.0/persons/search Note: Het endpoint is bedoeld om te bepalen of de persoon al in het Core systeem bestaat en daarbij het persoonsnummer op te halen. Dit betekent dat er altijd één of meerdere zoekcriteria opgegeven moeten worden. Bij meer dan 10 resultaten wordt er een foutmelding gegeven en wordt verzocht de zoekcriteria meer specifiek te maken. Het endpoint zoekt altijd over de hele populatie van de klant. Dus ook oud-medewerkers en eventuele andere personen die de klant in zijn core systeem heeft opgenomen.   Endpoints hire, re-hire en contract change Afhankelijk van of het om een interne sollicitant gaat, een onbekende medewerker of een oud-medewerker, wordt een van onderstaande API calls uitgevoerd.   Het endpoint voor de nieuwe medewerker is: POST https://api.youforce.com/recruitment/v1.0/hires Het endpoint voor een nieuw dienstverband is: POST https://api.youforce.com/recruitment/v1.0/persons/{persoonscode}/contracts waarbij {persoonscode} het persoonsnummer van de bestaande medewerker is.   Het endpoint voor een change contract: POST https://api.youforce.com/recruitment/v1.0/persons/{persoonscode}/contracts/{dvb volgnr}/Adjustments waarbij {persoonscode} het persoonsnummer van de bestaande medewerker is en {dvb  volgnr} het dienstverband volgnummer dat gewijzigd moet worden.   Te starten workflow Bij de inrichting van de API wordt door de consultant per endpoint een default workflow geconfigureerd. Als er bij de aanroep van het endpoint vanuit het recruitment systeem geen specifieke workflow wordt meegegeven, dan start het systeem deze default workflow.   Echter om het mogelijk te maken om een afwijkende workflow te starten, kan het recruitment systeem bij de API call de naam van de te starten workflow in header meegeven. Uiteraard moet deze workflow wel in HR Self Service bestaan.   Medewerkergegevens De medewerkergegevens wordt bij alle endpoints in de body meegegeven. Bij een hire worden de persoonsgegevens gebruikt om een nieuw persoon te creëren. Bij een re-hire worden de gegevens gebruikt om de bestaande persoondata bij te werken. Uiteraard worden alleen velden bijgewerkt die ook in de workflow voorkomen. Een veld dat niet in de workflow zit, wordt ook niet bijgewerkt.  Voor een complete lijst van velden, zie onder bij Standaard veldtoewijzing   Attachements Bij elk van de endpoints kan het recruitment systeem ook attachments meegeven. Deze attachments gaan mee in de te starten worklfow.  Wel gelden de volgende restricties Maximaal 20 bijlagen per aanvraag Maximaal 4 MB per bijlage Totale maximale berichtomvang van 28 MB file formaat in API is CotentBase64 Ondersteunde bestandstypes zijn onder meer tekstbestanden, PDF's, Word-documenten, en afbeeldingen.   Eigen rubrieken Alle endpoints kennen ook een structuur om eigen rubrieken mee te geven.     Wijziging van standaard mapping De velden uit de API zijn standaard gemapt naar standaard velden in HR Self Service. Echter het kan voorkomen dat u in HR Self Service ervoor gekozen heeft om bepaalde standaard velden te vullen vanuit een eigen rubrieken.  Dit is soms het geval bij het veld Soort Arbeidsrelatie. In sommige gevallen wordt in HR Self Service gebruik gemaakt van een eigen rubiek, die vervolgens zorgt dat de standaard rubriek Soort Arbeidsrelatie een waarde krijgt.  Door de standaard mapping in de API, zou deze mogelijkheid vervallen. Echter bij de inrichting van de API is het mogelijk om een bepaald API veld naar een andere rubriek te mappen. Deze aanpassing kan echter alleen door de consultant gedaan worden.   Inrichting HSS worklfow n HR Self Service worden de workflows ingericht. In principe kan er gewerkt worden met de workflows uit de best practice van Visma Raet.  Wel wordt geadviseerd om een kopie van de bestaande workflow te nemen en hierin de stappen aan te passen.  Geef de workflow een herkenbare naam. Bijvoorbeeld  “YF API - Nieuwe medewerker” Vink “Uitsluiten startmenu” aan zodat de workflow niet door eindgebruikers gestart kan worden. Kies bij de workflow type voor “Standaard workflow” en niet “nieuwe medewerker”.  Geeft de 1e activiteit in de workflow altijd de naam 'Youforce API' met als knop 'verzenden'.   Standaard veldtoewijzing   API Field   Type Beaufort field lastNameAtBirth Mandatory string P00301 - Geboortenaam lastNameAtBirthPrefix optional string P00302 - Geboortenaam-voorvoegsels KnownAs Mandatory string P01003 - Roepnaam initials Mandatory string P00303 - Voorletters firstNames optional string P01002 - Voornamen gender optional number P00330 - Geslacht conversion 0 – O 1 – M 2 – V 9 - N Indien er geen gender wordt meegegeven, dan wordt standaard de waarde O gebruikt. birthDate Mandatory date P00321 -Geboorte datum birthPlace optional string P01032 - Geboorteplaats birthCountry optional string P01041 - Geboorteland Persoon titlePrefix optional string P00305 - Titulatuur voor de naam titleSuffix optional string P03937 - Titulatuur achter de naam maritalStatus optional string P00329 Burgerlijke staat lastNamePreference optional string P00304 - Gebruik achternaam lastNamePartner optional string P00390 - Partner-naam partnerNamePrefix optional string P00391 - Partner-voorvoegsels socialSecurityNumber optional string P00320 - BSN/Sofi-nummer PhoneNumberHome optional string P01027 - telefoonnr woonadres PhoneNumberMobile optional string P01036 - Telefoonnr mobiel         emailAddressPrivate Mandatory string P01034 - E-mail adres prive         homeAddress - street - number - numberAdditional - postalCode - city - country optional Street - string number - number number addition - string Postcode - string city - string Country - string Home: P01014 street P01016 number P01018 number additional P01020 postal code P01022 city P01024 country postalAddress - street - number - numberAdditional - postalCode - city - country optional Street - string number - number number addition - string Postcode - string city - string Country - string Postal: P00365 Street P00367 number P00368 number additional P00313 postal code P00308 city P00847 country         PayrollClientCode optional string P01103 - Payroll client / Opdrachtgever PayrollInstitutionCode optional string P01104 - Payroll company / Instelling hireDate Mandatory date P00322 - Datum in dienst originalHireDate optional date P00834 -Datum in dienst CAO EndDate optional date P00830 Datum Uitdienst employeeType Mandatory string P01102 - Soort arbeidsrelatie contractType optional string P08259 - Code contract (on)bepaalde tijd probationPeriodEnddate optional date P03406 -proefperiode einddatum organizationUnit Mandatory number P01106 - Hierarchische org. eenheid jobProfile Mandatory string P01107 - Primaire functie amountOfHours optional decimal P01109 - Uren per week parttimePercentage optional decimal P00404 percentage deelbetrekking salary optional decimal P01153 - Salaris hourlyRate optional decimal P01154 - nominaal uurloon payScale optional string P01151 schaal Salaris payScaleStep optional string P00326 Ancienniteit salaris payScaleAmountNo optional number P01152 Inpassingsnr salaris ... View more

Bij het inrichten van een nieuwe connectie voor een bepaald systeem, wordt vaak in overleg met de consultant een autorisatie filter voor de connectie geconfigureerd. Dit autorisatie filter zorgt ervoor dat alleen relevante medewerkers in de connectie worden opgenomen. Dit maakt het mogelijk om in een MLM-systeem uitsluitend de eigen medewerkers te betrekken. Echter dit autorisatie filter werd niet toegepast op het endpoint voor RoleAssignment. Daardoor waren voor een extern systeem alle rollen en personeelsnummers toegankelijk. Hoewel dit alleen de personeelsnummers betrof, waren dit desondanks records die door een extern systeem zouden moeten worden uitgefilterd. Om het integratieproces te stroomlijnen, wordt nu ook het autorisatie filter toegepast op het RoleAssignment endpoint. ... View more

De WIC API beschikt over een autorisatie mechanisme waarmee bepaald kan worden tot welke medewerkers en datasets een Werkbedrijf toegang heeft.  Het autorisatie mechanisme bestaat uit de volgende onderdelen:   Autorisatie op basis van API scopes Door het activeren van scopes kunnen externe systemen toegang krijgen tot één of meerdere endpoint en dataset. De scopes zijn vooraf door Visma Raet bepaald en omvatten één of meerdere endpoints, dataset en/of acties. Autorisatie op medewerkers  Met behulp van autorisaties filters kan worden bepaald welke medewerkers in de API beschikbaar komen. Met dit document willen wij u informeren over de mogelijkheden van deze autorisatievormen in de API.  Beide autorisatie mechanismes moeten door een consultant ingericht worden.     Autorisatie op basis van API scopes In de Visma developer portal zijn per API één of meerdere scopes gedefinieerd.  Door het activeren van deze scope krijgt een extern systeem toegang tot één of meerdere endpoint en/of data set. Binnen de API worden de volgende scopes onderscheiden.   Scope Omschrijving Endpoints Get_Basic Get basic data zoals medewerker- & organisatiedata GET persons GET employments GET employmentTimelines GET organizationUnits GET roleAssignments GET jobProfiles GetPrivateContactDetails Voegt de privé contactgegevens aan de endpoint Person & Employee, zoals post- en woonadres, telefoonnummer vast & mobiel en het email adres. GET persons   Dit betreft de volgende gegevens: ADRESGEVENS Home: P01014 straatnaam P01016 Huisnummer P01018 Huisnummer toev P01020 Postcode P01022 Plaatsnaam P01024 Land Postal: P00365 straatnaam P00367 huisnummer P00368 huisnummer toev P00313 postcode P00308 plaatsnaam P00847 land TELEFOONNUMMERS Home: P01027 - telefoonnr woonadres Mobile : P01036 - Telefoonnr mobiel EMAILADRES Prive: P01034 - E-mail adres privé GetSocialSecurityNumber Lezen van het Burger Service Number als een privicy gevoelig gegeven GET persons P00320 BSN nummer Get_maternitityLeave Lezen van zwangerschapverlof van medewerkers GET maternityLeave Get_sicknessLeave Lezen van ziekmeldingen van medewerkers GET sickLeave Get_leave Lezen van verlofrechten en verlofopnames van medewerkers GET leaveEntitlements GET leaveHours       Autorisatie op basis van autorisatie filters De autorisatie filters hebben betrekking op welke medewerkers zichtbaar zijn in de API. Standaard worden altijd alle medewerkers getoond in de API. Bij het activeren van de API kan een consultant filters inrichten zodat maar een beperkte groep medewerkers via de API beschikbaar komen.   Filteren in de API is mogelijk op de volgende Beaufort velden: P01102- Soort Arbeidsrelatie  P01103- Opdrachtgever  P01104- Instelling  P01110 - Code doelgroep  Een veel voorkomen filter is bijvoorbeeld op Soort Arbeidsrelatie waarbij alleen eigen medewerkers in het extern systeem opgenomen worden.  Maar ook een filter op de combinatie Opdrachtgever / Instelling geeft u de mogelijkheid om de medewerkers van één of meerdere specifieke instellingen in de API op te nemen.   Uw consultant kan u helpen bij het inrichten of wijzigen van de autorisatie filters. ... View more

De Youforce Suite is uitgebreid met een nieuwe API voor sociale werkbedrijven. Deze API is speciaal ontworpen om beter aan te sluiten bij systemen voor de uitvoering van de Participatiewet en de Wet Sociale werkvoorziening. De API biedt alle noodzakelijke informatie om Youforce effectief te gebruiken als het primaire HR-systeem voor de registratie van alle medewerkers, waarbij de API zorgt voor de integratie met een cliëntvolgsysteem dat voldoet aan de wettelijke eisen van de Participatiewet en de WSW. De kernfunctionaliteiten van deze API omvatten: Medewerker Data: Mogelijkheden voor het ophalen van gedetailleerde gegevens over medewerkers, wat essentieel is voor zowel het beheer van human resources als het volgen van cliënten binnen de wettelijke kaders. Organisatiestructuur & Roltoewijzing: Biedt endpoints die inzicht geven in de hiërarchie en structurele opbouw van een organisatie, samen met de koppeling van rollen aan specifieke medewerkers. Deze informatie is cruciaal voor het begrijpen van de verantwoordelijkheden binnen een organisatie, alsook voor het toewijzen van cliënten aan specifieke casemanagers of begeleiders. Werkpatronen & Afwezigheid: Functionaliteit voor het bijhouden van de werkschema's van medewerkers, evenals eventuele afwezigheid door ziekte of verlof. Deze aspecten zijn belangrijk voor rapportage in het kader van de wet- & regelgeving zoals vastgelegd in de Participatiewet en de WSW   Extensie API Tevens is het mogelijk om de API uit te breiden via een extensie API, waarmee aanvullende gegevens uitgewisseld kunnen worden. Dit biedt flexibiliteit en zorgt ervoor dat de API kan worden aangepast aan de specifieke behoeften van elke organisatie.   Autorisatie Wanneer de API wordt geactiveerd, wordt in samenspraak met een API-consultant bepaald welke endpoints beschikbaar komen op basis van scopes. Daarnaast kan een autorisatiefilter worden geconfigureerd om nauwkeurig te bepalen welke medewerkers in de API worden opgenomen.   Technische informatie Technische informatie, zoals swagger documentatie en een voorbeeld postman collectie is terug te vinden op de Youforce API Documentation    ... View more

De WFM api is uitgebreid met een nieuw endpoint voor het ophalen van het werkpatroon uit HR Core Beaufort. Dit endpoint komt overeen met het werkpatroon uit de verlofmodule van HR Core Beaufort.   De data uit het endpoint is afkomstig van het scherm werkpatroon werknemer:   Het endpoint   GET https://api.youforce.com/wfm/v1.0/workPatterns?personCode=100001     ... View more

Om het mogelijk te maken om de registratie van aan- en afwezigheid volledig in Beaufort te doen en het tijdregistraties systeem enkel te gebruiken voor de verantwoording van de (gewerkte) uren, is het werkrooster aan de WFM ap toegevoegd. Samen het de endpoints voor verlof en ziekte, is dit endpoint de basis voor een goede tijdregistratie.   De data voor dit nieuwe endpoint employment work schedule komt van het volgende scherm uit Beaufort:         Het endpoint  GET https://api.youforce.com/wfm/v1.0/employmentworkSchedules     Historie & toekomst beperkt beschikbaar. Het endpoint geeft het werkrooster tot maximaal 1 jaar in de toekomst weer. Indien u in Beaufort voor meer jaren vooruit het rooster heeft gegenereerd, dan worden alleen de records getoond die binnen binnen één jaar vanaf de systeem datum vallen.   Ook worden de oudere records op basis van de historical days setting terug gegeven. Dit is een setting die bij implementatie wordt bepaald. Standaard wordt uitgegaan van een 90 dagen historie. Deze periode kan in overleg met uw API consultant aangepast worden. Echter de bewaartermijn kan niet langer zijn dan 1 jaar.  Na één jaar worden automatisch alle oude record uit de API verwijderd. ... View more

Het endpoint Sickleave in HR Core Beaufort biedt nu uitgebreidere informatie over ziekteregistraties van medewerkers. Voorheen werd alleen de ingangsdatum van een ziekteperiode getoond. Vanaf deze update wordt ook de einddatum van het ziekteverlof weergegeven, rechtstreeks afkomstig uit HR Core Beaufort. Deze toevoeging maakt het sluiten van ziekteperiodes eenvoudiger en overzichtelijker.   GET https://api.youforce.com/wfm/v1.0/sickleaves     ... View more

Update 19-04-2024 Op vrijdag 19 april is het certificaat op onze server api.youforce.com vervangen. Het nieuwe certificaat is geldig tot 4 mei 2025 en vervangt het oude certificaat op de server.      Bericht van 15-04-2024 Wij willen u informeren dat het huidige certificaat voor de URL api.youforce.com op 23 april 2024 verloopt. Deze week zal dit certificaat worden vervangen door een nieuwe versie, waarbij de volgende fingerprint wordt toegepast: 2581422998C313AAFCA55D948ECCA393EF9E5197.   Indien u in uw IT-landschap een controle heeft ingesteld voor dit certificaat, willen wij u vriendelijk verzoeken om deze te updaten naar de nieuwe versie zodra deze beschikbaar is. Dit zorgt ervoor dat uw systemen correct blijven functioneren zonder onderbrekingen als gevolg van het verlopen certificaat.   ... View more

De MLM API is uitgebreid met een nieuw endpoint Payroll Clients. Dit endpoint komt overeen met de referentie tabel Opdrachtgever uit HR Core Beaufort.   GET https://api.youforce.com/mlm/v1.0/payrollClients   Hieronder een voorbeeld van het endpoint en het bijbehorende HR Core Beaufort scherm.       ... View more

De recruitment API is uitgebreid met een nieuw endpoint employmentTypes. Dit endpoint komt overeen met de referentie tabel Soort Arbeidsrelatie uit Beaufort.   GET https://api.youforce.com/recruitment/v1.0/employmentTypes   Onderstaand een voorbeeld van de API en het bijbehorende HR Core Beaufort scherm.          ... View more

Het endpoint JobProfile is uitgebreid met de volgende velden:   type costUnit costType  Deze velden komen overeen met de HR Core Beaufort velden functie type, kostendrager en kostensoort.       Deze velden zijn beschikbaar in alle API's waar het endpoint jobProfile beschikbaar is. ... View more

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:   Aannemen nieuwe medewerker van een nog onbekende persoon, waarbij zowel een nieuw persoon als dienstverband wordt aangemaakt.  De zogenaamde new hire. Aannemen van een medewerker die eerder indienst is geweest, waarbij de persoonsgegevens geactualiseerd kunnen worden en er een nieuwe contract aangemaakt kan worden. De zogenaamde new contract. Aannemen van een interne medewerker waarbij de medewerker via een interne sollicatie is aangenomen en het bestaande contract wordt aangepast. De zogenaamde contract adjustment.   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: knownAs lastNameAtBirth lastNameAtBirthPrefix birthDate birthPlace Het endpoint is:   GET https://api.youforce.com/recruitment/v1.0/persons/search Note: Het endpoint is bedoeld om te bepalen of de persoon al in het Core systeem bestaat en daarbij het persoonsnummer op te halen. Dit betekent dat er altijd één of meerdere zoekcriteria opgegeven moeten worden. Bij meer dan 10 resultaten wordt er een foutmelding gegeven en wordt verzocht de zoekcriteria meer specifiek te maken. Het endpoint zoekt altijd over de hele populatie van de klant. Dus ook oud-medewerkers en eventuele andere personen die de klant in zijn core systeem heeft opgenomen   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: Maximaal 20 attachments per kandidaat Maximale file size is 4 mb per bestand Maximale bericht omvang (data + bestanden) is 28 mb De volgende bestandstypen worden ondersteund: Simpele tekst bestanden zonder opmaak (text/plain) Pdf documenten (application/pdf) MS Word documenten DOCX formaat (vanaf 2007) (application/vnd.openxmlformats-officedocument.wordprocessingml. document) MS Word documenten (pre-2007) (application/msword) Open document formaat bijvoorbeeld van OpenOffice en LibreOffice (application/vnd.oasis.opendocument.text) Diverse soorten images (image/*) Voor het toevoegen van de attachements kan een sectie files aan de API call toegevoegd worden met de volgende informatie: Name : De file name (maximaal 150 tekens lang). Category(optional) : De label of category indien dit in HRSS in geconfigureerd. contentBase64 : Het bestand in Base64 formaat   "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.         ... View more