Situering

Deze pagina beschrijft het gebruik en de werking van de webservice GeefLeefloonperiodes 2.0 zoals deze door Digitaal Vlaanderen op het MAGDA platform aangeboden wordt. Het doel van deze webservice is het beschikbaar stellen van de periodes waarin een persoon recht heeft op een leefloon.

Verwante diensten

RegistreerInschrijving en -Uitschrijving 2.0:

Om deze webservice te kunnen gebruiken moet er eerst een inschrijving in het MAGDA inschrijvingsrepertorium voor personen aangemaakt worden.
De inschrijvingen kunnen toegevoegd via de webservice RegistreerInschrijving 2.0.
Voor het verwijderen van een inschrijving kan de RegistreerUitschrijving 2.0 webservice gebruikt worden.

Gegevensbronnen

De leveranciers van de gegevens zijn de OCMW’s, maar de gegevens worden ter beschikking gesteld door de Kruispuntbank Sociale Zekerheid (KSZ).

Meer informatie over hoe deze bronnen gebruikt worden in de opbouw van het antwoord vindt u onder Opvraging.

Overlap inschrijvingscontrole

Naast de standaard actieve inschrijving is deze dienst ook beschikbaar met overlap inschrijvingscontrole. Hierbij wordt een periode uit de vraag vergeleken met de periode die gebruikt is bij de Repertorium.RegistreerInschrijving-02.00 dienst. Er moet minimaal 1 dag overlap zijn tussen beide periodes. Bij een actieve inschrijvingscontrole dient het INSZ actief te zijn in het inschrijvingsrepertorium op het moment van verwerking van de vraag.

Begin- en eindatum van de periode uit de vraag

Volgende elementen worden gebruikt als begin- en einddatum

Open

Gebruiksvoorwaarden

Afnemers moeten aan volgende voorwaarden voldoen om deze webservice te mogen gebruiken:

• Toelating tot het MAGDA platform

• Machtiging van de kamer sociale zekerheid en gezondheid

Batch

Deze webservice is eveneens beschikbaar in een batch-variant (enkel XML).

De XSD voor de batch wordt op een dusdanige manier opgemaakt dat deze een oneindig aantal vragen aan kan. Als prefix voor de batch wordt GLPD voorgesteld.

Deze webservice is eveneens beschikbaar in een batch-variant (enkel XML). Voor meer informatie: Webservice In Batch bevragen.

Functionaliteiten

De webservice GeefLeefloonperiodes 2.0 laat de afnemers van het MAGDA platform toe om de periodes waarbinnen een persoon recht heeft (of had) op een leefloon, op te halen en dit op basis van het INSZ van deze persoon en een periode.

Eens de afnemer de request gelanceerd heeft, wordt de vraag doorgestuurd naar de KSZ. MAGDA ontvangt het antwoord en transformeert dit naar een Leefloonperiode. Afhankelijk van de verkregen machtigingen wordt er een bepaalde operatie aangestuurd en kunnen bepaalde gegevens al dan niet worden gefilterd.

Het volledig attest is niet opvraagbaar via deze webservice. Enkel de periodes waarbinnen de persoon leefloon getrokken heeft komen terug in het antwoord. Afhankelijk van de machtiging verkrijgt men ook de OCMW’s die het leefloon toegekend heeft of de leeflooncategorie.

Werking

Opvraging

Van zodra de vraag gesteld is, wordt er een XSD-validatie uitgevoerd. Is de ontvangen vraag XML niet geldig tegenover het schema, dan stopt de verwerking en wordt een foutmelding aangemaakt, anders gaat de verwerking verder. Na de XSD-validatie vinden de nodige authenticatie- en autorisatiecontroles plaats, bijvoorbeeld de inschrijvingscontrole.

Hierna vindt er een functionele validatie plaats van de vraag (bijvoorbeeld checksum 97 op het INSZ). Nadien zal de webservice achterliggend de webservice bij KSZ bevragen met de voor de afnemer geldige operatie.

Ontvangt de webservice een antwoord – hetzij de leefloonperiodes, hetzij een foutcode – wordt dit gevalideerd en omgezet in een MAGDA XML formaat. Het antwoord wordt nogmaals gevalideerd waarna het aan de afnemer ter beschikking gesteld wordt.

Responsetijden & Beschikbaarheid

De webservice op het MAGDA platform is 24 uur op 24 en 7 dagen op 7 beschikbaar. De beschikbaarheid van de gegevens is echter volledig afhankelijk van KSZ die in principe 24/7 beschikbaar zijn.

Bij geplande onbeschikbaarheden van KSZ of MAGDA worden de afnemers op de hoogte gebracht via mail. Bij een onverwachte onbeschikbaarheid wordt in het mate van het mogelijk een mail uitgestuurd (dit is als Digitaal Vlaanderen zelf op de hoogte gebracht wordt).

Logging

De opvragingen die gebeuren via deze webservice worden bewaard zoals beschreven op de pagina "MAGDA logging".

Ondersteunde talen

MAGDA ondersteunt de Nederlandse taal.

Indien in de brongegevens de Nederlandse tekst niet beschikbaar is voor een bepaald element zal de eerste vertaling van de tekst in de brongegevens gebruikt worden, onafhankelijk van de taal waarin dit gegeven beschikbaar is.

Op deze pagina

Binnen deze handleiding

Omgevingsinformatie

Verwante diensten