Mijn Communities
Help

File API en SIVI documenten, hoe op te zetten en te testen.

16-11-2022 15:25 (Bijgewerkt op 17-12-2024)
  • 0 Antwoorden
  • 2 kudos
  • 1585 Weergaven

Veel arbodiensten gebruiken een eigen systeem om terugkoppelingsdocumenten op te stellen. Deze documenten zijn bedoeld voor betrokkenen binnen de klantorganisatie.

Om deze terugkoppelingsdocumenten ook in Verzuim Management beschikbaar te krijgen, is het nodig om deze documenten handmatig in te voeren. Dit leidt echter tot dubbele invoer van de documenten en is bovendien foutgevoelig. Om deze dubbele invoer én eventuele fouten te voorkomen, is de SIVI documenten interface ontwikkeld.

 

Bij gebruikmaking van SIVI documenten leveren de arbodiensten de bestanden geautomatiseerd aan Visma Raet, via een beveiligde verbinding. Deze bestanden worden gekoppeld aan in Verzuim Management bestaande acties die zijn ingericht met een verwijzing naar de Identificatie document soort van SIVI.

 

Het aanleveren van de bestanden aan Visma Raet gebeurt via onze File API, de werking van de File API is hier gedocumenteerd.

 

De pagina Getting Started beschrijft hoe je een access token opvraagt en via Publishers/Multipart upload staat de API call beschreven die zorgt voor de upload. 

 

Het bestand is het door SIVI voorgeschreven (XML)format versie 2020, de XML-bestandsnaam moet bij insturen via de File API voldoen aan het volgende formaat:

 

DO-XXXXXXXXXXXXXXX_YYYYMMDDHHMMSSFFF.xml

of

DO-XXXXXXXXXXXXXXX_YYYYMMDDHHMMSSFF.xml

of

DO-XXXXXXXXXXXXXXX_YYYYMMDDHHMMSS.xml

 

Voorbeelden: 

DO-Tussentijdse evaluatie_20180622010203444.xml

DO-Evaluatie n.a.v. gesprek 1_20180622010203444.xml

 

Toelichting:

Onderdeel

inhoud

DO-

Vaste waarde

XXXXXXXXX

Vrij in te vullen waarde. Variabel, minimaal 1 positie, maximaal 160 posities. Toegestane waarden: 

    • alfa numeriek: A-Z, a-z, 0-9.
    • punten.
    • spaties

_

Vast waarde, scheidingsteken

YYYY

Jaar, 4 posities

MM

Maand, 2 posities

dd

Dag, 2 posities

HH

Uur, 2 posities

MM

Minuut, 2 posities

SS

Seconden, 2 posities

FF of FFF

Milliseconden 0, 2 of 3 posities

.xml

Vaste waarde, extensie

 

Om het bestand via een File API-call te versturen naar Visma Raet dient businessTypeID 124000 gebruikt te worden in de call. Dit businessTypeID staat in Youforce voor de SIVI Documenten en dient samen met de bestandsnaam als metadata worden toegevoegd aan de API call. Een voorbeeld van de API-call:

 

WeslyvanHorssen_0-1718106498364.png

 

Je kan de upload testen door gebruik te maken van onderstaande API-credentials
API Key: VRA_fileapi_4001401_uploadsivi
Secret Key: F0m9N5kbdXB4xEPQTkQRpd76H4JZw6CYoJQbskQ9zAJDdtu8WalC687ozkjoZ6tm
TenantID: f556855c-a0c4-42c7-88f1-98bf5b209393

 

Met onderstaande variabelen in het SIVI document-XML-bestand voor een succesvolle test-verwerking:

      
<IdInzndr>ArbodienstX/IdInzndr>
<IdOntvngr>Visma - Raet</IdOntvngr>


 <HndlsnmOrg>RAET SIVI TEST</HndlsnmOrg>
<IdWrkgvrArbdnst>test12345test</IdWrkgvrArbdnst>
<AansltnrGeguitwlngArbdnst>6431</AansltnrGeguitwlngArbdnst>
<Lhnr>999999999999</Lhnr>

<SrtDocumentCd>999</SrtDocumentCd>
<SrtDocumentOms>Overig</SrtDocumentOms>
<KenmerkZendPartij>ArbodienstX</KenmerkZendPartij>
 

<IdWrknmr>1945</IdWrknmr>
<IdDnstvbnd>1</IdDnstvbnd>
<PersNr>1945</PersNr>
<VrzmgvlId>1945 1 1809</VrzmgvlId>
<DatEerstVrzmdg>2022-05-24</DatEerstVrzmdg>
 

Wanneer de File API een 201 (Created) teruggeeft dan is de upload succesvol geweest, neem met Visma Raet contact op om samen te controleren of het document daadwerkelijk is toegevoegd aan het verzuimdossier van de betreffende medewerker (persoonsnummer 1945, verzuimdossier 24-05-2022), een specifieke bestandsnaam van het document (<Bestandsnm>) helpt bij de controle.