De webservice GeefDossierKBI 1.0 stelt de gebruiker in staat om op basis van een INSZ (Rijksregisternummer) de gegevens rond het inburgeringsdossier op te vragen. 

Situering

Deze webdienst kadert binnen het domein Inburgering van het MAGDA platform.

Verwante diensten

Gegevensbronnen

De oorspronkelijke bron van deze gegevens is KBI.

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

Gebruiksvoorwaarden

Om gebruik te kunnen maken van deze dienst dient men een machtiging te hebben die toegang geeft tot deze gegevens en een aansluitingsprocedure te doorlopen.

Batch

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

Functionaliteiten

Met de webservice GeefDossierKBI 1.0 kan de gebruiker op basis van een INSZ (Rijksregisternummer) de gegevens rond het inburgeringsdossier opvragen. 

Vraag

De gebruiker dient te beschikken over het INSZ nummer van de betrokken persoon om deze dienst te kunnen bevragen.

Antwoord

Het antwoord van de dienst bestaat uit het inburgeringsdossier zoals gekend bij KBI. 

Werking

Aandachtspunten

• Ook al betreft het hier een 01.00 versie, deze webservice volgt volledig de MAGDA 2.0 standaarden

• Deze webservice is wat betreft MAGDA een pure Gateway-dienst. Dit houdt in dat MAGDA enkel instaat voor authenticatie, autorisatie, personen inschrijvingscontrole en filtering

Wat betreft het inhoudelijke wordt verwezen naar de documentatie aangeboden door KBI zelf.

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

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. 
De vraag wordt dan doorgestuurd naar de webservice van KBI waar naar de gevraagde gegevens gezocht wordt. 
Worden er geen gegevens gevonden verkrijgt men een gepaste foutmelding (30001 – Geen gegevens gevonden). In het geval het INSZ in de vraag bij KBI gekend is bekomt men een KBIDossier in het antwoord. 
Het antwoord wordt nogmaals gevalideerd waarna het aan de afnemer ter beschikking gesteld wordt. Afhankelijk van de machtigingen worden er al dan niet gegevens uit het antwoord gefilterd.

Responsetijden & Beschikbaarheid

De webservice op het MAGDA platform is 24 uur op 24 en 7 dagen op 7 beschikbaar. Deze webservice is afhankelijk van KBI als bron. 
Bij geplande onbeschikbaarheden worden de afnemers op de hoogte gebracht.

Logging

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

Op deze pagina

Binnen deze handleiding

Omgevingsinformatie

Verwante diensten