Algemeen

Bij de nieuwe MAGDA webservices wordt zoveel mogelijk gebruik gemaakt van de schema’s van de bron. Over het algemeen betekent dit dat vanuit de MAGDA XSD de XSD van de bron wordt geïmporteerd. Bij diensten die gebruik maken van KSZ als bron wordt hierbij niet alleen de result overgenomen, maar ook het status element. Dit status element is een standaard element dat in alle KSZ diensten voorkomt en wordt gebruikt om de staat van het antwoord door te geven naar de afnemer.

Visueel

Elementen

Element ../Status/		Omschrijving

Element ../Status/		Omschrijving
value		Informatie over de dataverwerking. Mogelijke waarden: NO_RESULT: Geen resultaat omdat een prevalidatie faalde NO_DATA_FOUND: Geen data gevonden. Indien de status onder een resultaat van een authentieke bron valt, slaat dit op de resultaten van die bron DATA_FOUND: Data gevonden bij minstens 1 bron of bij de authentiek bron INCOMPLETE_DATA: Onvolledige data wanneer de consultatie van één authentieke bron door een technische faling niet lukte, maar de andere bron wel resultaat heeft (met al dan niet gegevens). TECHNICAL_ERROR: Technische storing in de communicatie met de authentieke bron
code		Detail van de status in codevorm.
description		Tekstuele omschrijving van de status.
information		Dit element wordt ingevuld wanneer meer informatie moet worden toegevoegd aan de status om een bijkomende toelichting te krijgen. De gegevens in dit information element zijn afhankelijk van de status code maar ook van de specifieke dienst.
	fieldName	Omschrijving van de bijkomende toelichting
	fieldValue	Waarde van de bijkomende toelichting

Mapping naar MAGDA uitzonderingen

Daar het status element van KSZ reeds de details van de situatie doorgeeft geeft MAGDA in zijn uitzonderingen niet even gedetailleerd de situatie van het antwoord door. De mogelijke uitzonderingen worden nu bepaald door het aanwezig zijn van gegevens in het antwoord met bijbehorende opmerkingen of eventuele fouten.

De waarde van het status/value element bepaalt welke foutmelding MAGDA zal doorgeven.

KSZ status/value	MAGDA Uitzondering
KSZ status/value	Identificatie	Beschrijving
DATA_FOUND	Geen uitzondering	Antwoord met gegevens wordt teruggeven
NO_DATA_FOUND	70001	Er zijn geen gegevens gevonden voor de zoekopdracht
INCOMPLETE_DATA	70001	Er worden gegevens doorgegeven maar deze zijn niet compleet. Extra informatie is opgenomen in het Information element
NO_RESULT	70002	Er worden geen gegevens teruggegeven omwille van bepaalde foutmeldingen. vb. fouten in de vraagcriteria
TECHNICAL_ERROR	70002	Er worden geen gegevens teruggegeven omwille van technische fouten, vb. geen connectie met de achterliggende bron.

Volledigheidshalve dient vermeld te worden dat ook een 70003 uitzondering kan doorgegeven worden welke zal voorkomen bij een SOAP fault. Daar de details van de SOAP faults kunnen verschillen van dienst tot dienst wordt deze hier niet verder behandelt. Er is ook geen link tussen het status element en de uitzondering 70003, SOAP Fault.

KSZ Status Codes

KSZ gebruikt over het algemeen dezelfde status codes voor een bepaalde betekenis. Dit laat toe om een centrale lijst op te maken met alle mogelijke status codes. In de handleiding van de dienst wordt een lijst voorzien van de KSZ Status Code waarden die kunnen voorkomen. Indien afwijkingen op de onderstaande lijst voorkomen zullen deze ook in de handleiding van de dienst omschreven worden.

Value	Code	Description

Value	Code	Description
DATA_FOUND	MSG00000	Treatment successful
NO_DATA_FOUND	MSG00100	Treatment successful, but no data found at the supplier
INCOMPLETE_DATA	HAN20200	Treatment partially successful. Some sources could not be consulted due to technical issues.
NO_RESULT	MSG00005	The ssin given in request does not exist.
NO_RESULT	MSG00006	The ssin given in request is replaced
		FieldName	FieldValue
		newSSIN	[vervangende INSZ]
NO_RESULT	MSG00008	The request contains invalid data. Please check your message content. Depending on the service, Information elements are added
NO_DATA_FOUND	MSG00009	Person deceased
		FieldName	FieldValue
		deceiseDate	[overlijdensdatum]
NO_RESULT	MSG00011	The structure of the ssin given in request is invalid
NO_RESULT	MSG00012	The SSIN is not sufficiently integrated for your organization
		FieldName	FieldValue
		details	The SSIN is not integrated for the given PCSA
		ssin	ssin requested
		cbeNumber	cbe number
NO_RESULT	MSG00013	Access to this operation is not allowed with the given legalcontext and credentials.
NO_DATA_FOUND	MSG00021	The SSIN is not sufficiently integrated for the provider of the data
NO_RESULT	MSG00027	The client is not authorized to consult the requested data
		FieldName	FieldValue
		Not authorized data for given legalcontext and operation	not allowed information
NO_RESULT	MSG00028	The functionality is not available
NO_RESULT	HAN00008	The supplier does not provide any of the requested parts
NO_RESULT	SSH00042	The partner configuration is not authorized
NO_RESULT	SSH00043	Error in the list of provided specific situation
NO_RESULT	SSH00044	Missing parameter
NO_RESULT	SSH00045	The legal context is not known for the partner
NO_DATA_FOUND	SSH00047	Warning: Some errors have been found in the family composition
NO_RESULT	SSH00048	The NR response is incomplete and does not allow to calculate the right
NO_DATA_FOUND	SSH00150	Warning: Some authentic sources are not callable online
NO_RESULT	SSH00151	Some authentic sources are not callable online

MAGDA Gebruikersomgeving

KSZ Status element

Algemeen

Visueel

Elementen

Mapping naar MAGDA uitzonderingen

KSZ Status Codes

De MAGDA Gebruikersomgeving is een officiële website van de Vlaamse overheid