Voor de ontsluiting van een MAGDA 2.0 webservice, alsook het generieke proces binnen een 2.0 webservice, wordt verwezen naar Werking en gebruik MAGDA 2.0 Webservices.
Deze webservice is eveneens beschikbaar in een batch-variant (enkel XML).
Hiervoor moet men de Service-XSD gebruiken en niet de Webservice. Door de Service-XSD te gebruiken zijn er meerdere vragen mogelijk in één bestand. De vraag-bestanden worden op de MAGDA FTP geplaatst in een afnemer specifieke folder. Deze folder wordt tijdens het aansluitingsproces toegekend.
Als prefix voor de batchbestanden wordt de volgende standaard gebruikt:
<Domein>.<Dienstnaam>-<Versienummer>_<tijdstip>.xml, naamgeving in camelcase, met versienummer zonder punt.
INSZ: het INSZ van de persoon (kind of begunstigde) waarvoor Vlaamse Groeipakket gegevens opgevraagd worden
Periode/BeginMaand: begin maand van de referentie periode waarop gezocht moet worden
Periode/EindeMaand: optionele einde maand van de referentie periode waarop gezocht moet worden; indien er geen einde maand wordt opgegeven in de vraag criteria, dan wordt hiervoor de systeem datum gebruikt.
Bronnen/Bron: optionele lijst van bronnen die de afnemer wenst te consulteren; indien niet opgegeven, worden alle bronnen geconsulteerd waarvoor de afnemer gemachtigd is
Antwoord
Het antwoord van de webservice bestaat uit:
Referte: de referte zoals opgegeven in de vraag
Afhankelijk van de verwerking een Inhoud blok met één of meerdere KindVoordeel elementen met hierin de kinderbijslag gegevens afkomstig van de authentieke bronnen die geconsulteerd werden
De eventuele (business) uitzonderingen
Werking
Aandachtspunten
Opties
Volgende configuratieparameters kunnen ingesteld worden in functie van de machtigingen en de wensen van de afnemer:
Configuratieparameters op het MAGDA platform zijn voor deze dienst niet van toepassing
Opvraging
Responsetijden & Beschikbaarheid
Opmerking:
De MAGDA response tijden zijn heel sterk afhankelijk van de response tijden van de bron. Als de brongegevens heel traag worden aangeleverd kan het MAGDA antwoord niet snel worden aangeleverd.
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.