Doel: Met dit sjabloon kan u eenvoudig een nieuwe diensthandleiding aanmaken in Confluence. Gebruik de onderstaande knoppen om nieuwe componenten binnen de handleiding aan te maken. To do: - Vul de onderstaande handleidingsparagrafen in - Maak o.b.v. de specificaties van de dienst relevante subpagina's aan - Verwijder lege of niet-gebruikte paragrafen & pagina's - Let op: Gebruik de volledige naam van de dienst (Domein.DienstNaam-Versie).

De dienst ‘CreeerBis 2.0’ geeft de afnemer de mogelijkheid een nieuwe BIS-persoon te creëren in de registers van KSZ. Met CreeerBis kan een nieuw INSZ worden aangemaakt met de opgegeven persoonsgegevens. De opgegeven persoonsgegevens moeten beantwoorden aan enkele minimale syntactische en semantische criteria.

Situering

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

Gegevensbronnen

De authentieke bron van de gegevens is de KSZ.

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

Gebruiksvoorwaarden

Heeft de afnemer speciale toelatingen / machtigingen nodig voor consumeren van deze dienst?

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

Is deze dienst in batchvorm beschikbaar? Zo ja, laat deze paragraaf staan met generieke informatie over batchdiensten en voeg eventueel relevante dienstspecifieke informatie toe.

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

Functionaliteiten

Ruimte voor een korte beschrijving van de functionaliteiten van deze dienst voor zover die relevant zijn?

Vraag

De request bestaat uit de creatie van een persoon. Om dit te doen is er een minimale set van persoonsgegevens nodig om door te sturen naar KSZ.

Antwoord

Het antwoord bevat:

• Of de gecreëerde persoon zoals doorgestuurd

• Of één of meerdere personen die voldoen aan de criteria van de te creëren persoon.
  Dit kan tot 50 personen bevatten.

Werking

Opties

Volgende configuratieparameters kunnen ingesteld worden in functie van de machtigingen en de wensen van de afnemer:

Zijn er specifieke parameters die ingesteld kunnen worden?

• Configuratieparameters op het MAGDA platform zijn voor deze dienst niet van toepassing

Opvraging

Van zodra de vraag (in deze dienst is dat de creatie van een persoon) 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. 

Daarna gebeurd er een controle op de gegevens om te kijken of de persoon al niet aanwezig is in de registers.

Indien er een persoon of personen gevonden worden stopt de creatie van de nieuwe persoon en worden de bestaande persoon of personen (tot maximum 50) weergegeven.
Is dit niet het geval dan wordt de gecreëerde persoon weergegeven.

Het antwoord wordt gevalideerd tegenover de XSD 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. Bij geplande onbeschikbaarheden worden de afnemers op de hoogte gebracht via mail.

Logging

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