Algemeen
De afnemer stelt een vraag op met hierin al zeker volgende verplichte elementen:
- INSZ: het INSZ van de persoon van wie de gegevens gewenst zijn
- Periode: een begin- en einddatum waarbinnen de loopbaanonderbreking gegevens gevraagd worden.
De werking kan in grote lijnen opgedeeld worden in twee delen:
- Of een bron (of bronnen) wordt opgegeven in de vraag
- Of er wordt geen bron opgegeven in de vraag
Daarbij worden ook nog verschillende functionele / autorisatie validaties uitgevoerd op de vraag zelf.
Bron opgegeven in vraag
Wordt een bron opgegeven in de vraag – de afnemer kan tot vier verschillende bronnen opgegeven – worden enkel die bronnen opgeroepen, natuurlijk indien deze toegelaten zijn voor de afnemer.
Geeft de afnemer een niet toegelaten bron op, dan verkrijgt die een gepaste foutmelding.
Mag de afnemer de opgegeven bron oproepen, dan wordt zijn vraag doorgestuurd naar de opgegeven bron.
Geen bron opgegeven in vraag
Werd door de afnemer geen bron opgegeven in de vraag, dan worden al de voor hem toegelaten bronnen opgeroepen.
Geen periode opgegeven in vraag
Werd door de afnemer geen periode opgegeven in de vraag, dan wordt voor bron ‘Vlaanderen’ de volledige loopbaan opgevraagd. Voor andere bronnen gebeurt dit niet en wordt een gepaste foutmelding teruggegeven.
Periode opgegeven in vraag
Werd door de afnemer een periode opgegeven in de vraag, dan worden door zowel KSZ als WSE alle loopbaanonderbrekingen die minstens één dag in het gevraagde interval hebben liggen teruggegeven.
Visueel:
Als de rode lijn het zoekinterval representeert, en de blauwe lijnen de beschikbare voorkomens van loopbaanonderbrekingen, dan worden de volgende loopbaanonderbrekingen teruggegeven: B, C, D, F, G en H.
Functionele / autorisatie validaties
Op de vraag gebeuren enkele functionele validaties:
- Indien het INSZ niet voldoet aan de 97-controle: 20002
- Indien de begindatum niet kleiner is of gelijk aan de einddatum: 20003
De hier beschreven autorisatie validaties hebben enkel betrekking op bron-elementen / bron autorisaties:
Validatie | Foutcode |
|---|---|
Heeft een afnemer in de vraag een bron opgegeven waarvoor geen toelating is, dan wordt de verwerking gestopt, ook al bevindt er zich in de vraag een andere bron waarvoor wel toelating is. Indien er meerdere niet-toegelaten bronnen in de vraag opgenomen waren, wordt er toch maar één uitzondering aangemaakt. | 40006 |
Is voor de afnemer geen bron geconfigureerd in de routeringtabel wordt fout 60011 op niveau 2 aangemaakt. De verwerking wordt stopgezet. | 60011 |
Wordt eenzelfde bron meer dan één keer opgegeven in vraag, dan stopt de verwerking en wordt uitzondering 30032 gegeven op niveau 3. | 30032 |
Oproepen achterliggende bronnen
In onderstaande tabel bevinden zich de vier mogelijke bronnen die aangeroepen kunnen worden.
Bron | Via | Achterliggende dienst |
|---|---|---|
RVA | KSZ | CareerBreaks consult |
Vlaanderen | WSE | GeefLoopbaanonderbrekingen 02.00 |
Brussel | KSZ | CareerBreaks consult |
Wallonie | KSZ | CareerBreaks consult |
De bronnen RVA, Brussel en Wallonië zijn niet rechtstreeks door MAGDA ontsloten maar worden via KSZ oproepen.
De MAGDA webservice zal elke achterliggende bron apart oproepen waarna de antwoorden gebundeld worden.
Bundeling antwoorden
Algemeen
Een belangrijke functie van de webservice is het bundelen van de antwoorden uit de verschillende opgeroepen bronnen. Op deze manier verkrijgt men de gegevens uit Vlaanderen, RVA, Wallonië en/of Brussel in eenzelfde formaat. Op basis van het element Bron kan men dan afleiden wie de beheerder is van de gegevens.
Bij het aanroepen van meerdere bronnen is het natuurlijk mogelijk dat een bron geen gegevens heeft, een timeout geeft, een technische fout optreedt, … .
In dat geval zal de webservice steeds de toch ontvangen loopbaanonderbreking gegevens teruggeven met, per bron waarbij de anomalie opgetreden is, een duidelijke uitzondering.
Voorbeelden
<Inhoud> <Loopbaanonderbrekingen> <Loopbaanonderbreking> <Bron>Vlaanderen</Bron> <Dossiernummer>000001</Dossiernummer> <INSZ>00000000001</INSZ> … <BedragMaandelijksUitkering>99999999999999999</BedragMaandelijksUitkering> </Loopbaanonderbreking> <Loopbaanonderbreking> <Bron>RVA</Bron> <INSZ>00000000001</INSZ> … <BedragMaandelijksUitkering>99999999999999999</BedragMaandelijksUitkering> </Loopbaanonderbreking> </Loopbaanonderbrekingen> </Inhoud>
Resultaat: Er wordt één Inhoud-element aangemaakt met een Loopbaanonderbrekingen-element. Elk Loopbaanonderbreking vanuit de bronnen wordt hierin opgenomen.
<Antwoord> <Inhoud> <Loopbaanonderbrekingen> <Loopbaanonderbreking> <Bron>Vlaanderen</Bron> <Dossiernummer>000001</Dossiernummer> <INSZ>00000000001</INSZ> <Periode> <Begin>2001-01-05</Begin> <Einde>20001-05-01</Einde> </Periode> ... <BedragMaandelijksUitkering>99999999</BedragMaandelijksUitkering> </Loopbaanonderbreking> </Loopbaanonderbrekingen> </Inhoud> <Uitzonderingen> <Uitzondering> <Identificatie>30001</Identificatie> <Oorsprong>MAGDA</Oorsprong> <Type>FOUT</Type> <Tijdstip> <Datum>0000-00-00</Datum> <Tijd>00:00</Tijd> </Tijdstip> <Diagnose>Geen gegevens gevonden</Diagnose> <Omstandigheid>Foutcode van KSZ</Omstandigheid> <Annotaties> <Annotatie> <Naam>Bron</Naam> <Waarde>RVA</Waarde> </Annotatie> </Annotaties> </Uitzondering> </Uitzonderingen> </Antwoord>
Resultaat: Er wordt één Inhoud-element aangemaakt met een Loopbaanonderbrekingen-element. Elk Loopbaanonderbreking vanuit de bronnen wordt hierin opgenomen.
<Antwoord> <Uitzonderingen> <Uitzondering> <Identificatie>30001</Identificatie> <Oorsprong>WSE</Oorsprong> <Type>FOUT</Type> <Tijdstip> <Datum>0000-00-00</Datum> <Tijd>00:00</Tijd> </Tijdstip> <Diagnose>Geen gegevens gevonden</Diagnose> <Annotaties> <Annotatie> <Naam>Bron</Naam> <Waarde>Vlaanderen</Waarde> </Annotatie> </Annotaties> </Uitzondering> <Uitzondering> <Identificatie>30001</Identificatie> <Oorsprong>MAGDA</Oorsprong> <Type>FOUT</Type> <Tijdstip> <Datum>0000-00-00</Datum> <Tijd>00:00</Tijd> </Tijdstip> <Diagnose>Geen gegevens gevonden</Diagnose> <Annotaties> <Annotatie> <Naam>Bron</Naam> <Waarde>RVA</Waarde> </Annotatie> </Annotaties> </Uitzondering> <Uitzondering> <Identificatie>30001</Identificatie> <Oorsprong>MAGDA</Oorsprong> <Type>FOUT</Type> <Tijdstip> <Datum>0000-00-00</Datum> <Tijd>00:00</Tijd> </Tijdstip> <Diagnose>Geen gegevens gevonden</Diagnose> <Annotaties> <Annotatie> <Naam>Bron</Naam> <Waarde>Wallonie</Waarde> </Annotatie> </Annotaties> </Uitzondering> <Uitzondering> <Identificatie>30001</Identificatie> <Oorsprong>MAGDA</Oorsprong> <Type>FOUT</Type> <Tijdstip> <Datum>000-00-00</Datum> <Tijd>00:00</Tijd> </Tijdstip> <Diagnose>Geen gegevens gevonden</Diagnose> <Annotaties> <Annotatie> <Naam>Bron</Naam> <Waarde>Brussel</Waarde> </Annotatie> </Annotaties> </Uitzondering> </Uitzonderingen> </Antwoord>
Resultaat: een Antwoord-element wordt aangemaakt zonder Inhoud-element, er worden 4 Uitzondering-elementen aangemaakt.
Bundeling antwoorden
Algemeen
Een belangrijke functie van de webservice is het bundelen van de antwoorden uit de verschillende opgeroepen bronnen. Op deze manier verkrijgt men de gegevens uit Vlaanderen, RVA, Wallonië en/of Brussel in eenzelfde formaat. Op basis van het element Bron kan men dan afleiden wie de beheerder is van de gegevens.
Bij het aanroepen van meerdere bronnen is het natuurlijk mogelijk dat een bron geen gegevens heeft, een timeout geeft, een technische fout optreedt, … .
In dat geval zal de webservice steeds de toch ontvangen loopbaanonderbreking gegevens teruggeven met, per bron waarbij de anomalie opgetreden is, een duidelijke uitzondering.
Voorbeelden
<Inhoud> <Loopbaanonderbrekingen> <Loopbaanonderbreking> <Bron>Vlaanderen</Bron> <Dossiernummer>000001</Dossiernummer> <INSZ>00000000001</INSZ> … <BedragMaandelijksUitkering>99999999999999999</BedragMaandelijksUitkering> </Loopbaanonderbreking> <Loopbaanonderbreking> <Bron>RVA</Bron> <INSZ>00000000001</INSZ> … <BedragMaandelijksUitkering>99999999999999999</BedragMaandelijksUitkering> </Loopbaanonderbreking> </Loopbaanonderbrekingen> </Inhoud>
Resultaat: Er wordt één Inhoud-element aangemaakt met een Loopbaanonderbrekingen-element. Elk Loopbaanonderbreking vanuit de bronnen wordt hierin opgenomen.
<Antwoord> <Inhoud> <Loopbaanonderbrekingen> <Loopbaanonderbreking> <Bron>Vlaanderen</Bron> <Dossiernummer>000001</Dossiernummer> <INSZ>00000000001</INSZ> <Periode> <Begin>2001-01-05</Begin> <Einde>20001-05-01</Einde> </Periode> ... <BedragMaandelijksUitkering>99999999</BedragMaandelijksUitkering> </Loopbaanonderbreking> </Loopbaanonderbrekingen> </Inhoud> <Uitzonderingen> <Uitzondering> <Identificatie>30001</Identificatie> <Oorsprong>MAGDA</Oorsprong> <Type>FOUT</Type> <Tijdstip> <Datum>0000-00-00</Datum> <Tijd>00:00</Tijd> </Tijdstip> <Diagnose>Geen gegevens gevonden</Diagnose> <Omstandigheid>Foutcode van KSZ</Omstandigheid> <Annotaties> <Annotatie> <Naam>Bron</Naam> <Waarde>RVA</Waarde> </Annotatie> </Annotaties> </Uitzondering> </Uitzonderingen> </Antwoord>
Resultaat: Er wordt één Inhoud-element aangemaakt met een Loopbaanonderbrekingen-element. Elk Loopbaanonderbreking vanuit de bronnen wordt hierin opgenomen.
Op deze pagina
Binnen deze handleiding
