Algemeen

De inhoud van het antwoord bestaat uit een ConsultPaymentsResponse object. Daaronder zit een status, ssin en result object. Het status object bevat de gegevens over de kwaliteit van het resultaat of mogelijke foutmeldingen van de bron. Het ssin object heeft attributen die aangeven of de ssin uit de vraag vervangen of geannuleerd is. Het result object bevat het antwoord op de vraag.

XSD Visueel

Detail

Opmerking:

Het antwoord bestaat standaard uit Context, Referte en Antwoord zoals beschreven in het document Gebruik Magda Webservices 02.00. Verder zal enkel aandacht besteed worden aan het specifieke Antwoord element.

Antwoord in detail

Element ../ConsultPaymentsResponse					Opmerkingen
status					Zie Status element hieronder
ssin					INSZ waarop gezocht is
	@canceled				Indien dit attribuut ingevuld is zal het “true” bevatten en duidt het aan dat het INSZ geannuleerd is. De opvragingen zullen uitgevoerd worden.
	@replacedBy				Indien dit attribuut ingevuld is betekent het dat de INSZ dat opgegeven is in de vraag vervangen is. Dit attribuut bevat dan het nieuwe INSZ. Merk op dat de dienst zal blokkeren op vervangen nummers. De afnemer dient dan een nieuwe vraag te stellen met het nieuw INSZ uit dit attribuut.
results					Het resultaat van de opzoeking
	dgphResult				Het resultaat van DGPH
		status			Status van het resultaat van DGPH
		payments			groepering van de betalingen
			payment		Gegevens van de betaling
				yearMonth	De maand waarop de tegemoetkoming aan personen met een handicap werd betaald. Dit gegeven is relevant voor bepaling IVT/IT-uitkering. Formaat = JJJJ-MM
				amount	Het maandelijks bedrag van de tegemoetkoming aan personen met een handicap. Bedrag met twee decimalen.
				cancelledPayment	Is het bedrag van de uitbetaling geschorst? Tijdens de opsluiting in de gevangenis of bij opname in een instelling van sociaal verweer wordt de betaling van de uitkering geschorst. Wanneer de persoon met een handicap in een instelling verblijft op kosten van een openbare dienst of van de sociale zekerheid wordt de integratietegemoetkoming slechts voor 72% uitbetaald. De persoon met een handicap dient zowel overdag als ’s nachts in de instelling te verblijven, hij mag bovendien niet geplaatst zijn in een gezin en de opname in een instelling moet minstens drie opeenvolgende maanden bedragen. Mogelijke waarden: 0 = neen; 1 = ja
	vsbResult				Het resultaat van VSB. Op dit moment geeft VSB nog geen gegevens door over betalingen. Dit element is voorzien voor toekomstige toepassingen
		status			Zie Status element hieronder
		payments			groepering van de betalingen
			payment		Gegevens van de betaling
				yearMonth	De maand waarop de tegemoetkoming aan personen met een handicap werd betaald. Dit gegeven is relevant voor bepaling THAB-uitkering. Formaat = JJJJ-MM
				amount	Het maandelijks bedrag van de tegemoetkoming aan personen met een handicap. Bedrag met twee decimalen.
				canceledPayment	Is het bedrag van de uitbetaling geschorst? Mogelijke waarden: 0 = neen; 1 = ja
	irisCareResult				Het resultaat van IrisCare.
		status			Zie Status element hieronder
		payments			groepering van de betalingen
			payment		Gegevens van de betaling
				yearMonth	De maand waarop de tegemoetkoming aan personen met een handicap werd betaald. Dit gegeven is relevant voor bepaling THAB-uitkering. Formaat = JJJJ-MM
				amount	Het maandelijks bedrag van de tegemoetkoming aan personen met een handicap. Bedrag met twee decimalen.
				canceledPayment	Is het bedrag van de uitbetaling geschorst? Mogelijke waarden: 0 = neen; 1 = ja
	niccinResult				Het resultaat van NICCIN.
		status			Zie Status element hieronder
		payments			groepering van de betalingen
			payment		Gegevens van de betaling
				yearMonth	De maand waarop de tegemoetkoming aan personen met een handicap werd betaald. Dit gegeven is relevant voor bepaling THAB-uitkering. Formaat = JJJJ-MM
				amount	Het maandelijks bedrag van de tegemoetkoming aan personen met een handicap. Bedrag met twee decimalen.
				canceledPayment	Is het bedrag van de uitbetaling geschorst? Mogelijke waarden: 0 = neen; 1 = ja
	mdgResult				Het resultaat van MDG.
		status			Zie Status element hieronder
		payments			groepering van de betalingen
			payment		Gegevens van de betaling
				yearMonth	De maand waarop de tegemoetkoming aan personen met een handicap werd betaald. Dit gegeven is relevant voor bepaling THAB-uitkering. Formaat = JJJJ-MM
				amount	Het maandelijks bedrag van de tegemoetkoming aan personen met een handicap. Bedrag met twee decimalen.
				canceledPayment	Is het bedrag van de uitbetaling geschorst? Mogelijke waarden: 0 = neen; 1 = ja

Status

Status in detail

Per bron is een Status element voorzien

Zie de volledige omschrijving van het status element op KSZ Status Element.

Dienst specifieke status codes

Naast het Status/Value element geeft de de waarde van de Status/Code meer details over de foutmelding. Daarnaast kunnen ook Informatie elementen worden meegegeven die nog verder details geven.

De informatie in deze tabel opgenomen komt van de bron en is niet in het beheer van MAGDA.

Value	Code	Description
DATA_FOUND	MSG00000	Treatment successful
NO_DATA_FOUND	MSG00100	Treatment successful, but no data found at the supplier
NO_DATA_FOUND	MSG00021	The SSIN is not sufficiently integrated for the provider of the data
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.
	MSG00006	The ssin given in request is replaced
	MSG00008	The request contains invalid data. Please check your message content. Information elementen kunnen aanwezig zijn
		FieldName	FieldValue
		Invalid Period : endDate in the future	endDate
		Invalid Period : beginDate in the future	beginDate
		Invalid Period : enddate before begindate	endDate lies before beginDate
		Invalid Period	endDate lies before beginDate
		Invalid Criteria : Nothing asked	No asked elements
		Invalid Criteria	None of the requested elements are available for the requested source VSB. VSB only provides evolutionOfRequest and rights.
	MSG00011	The structure of the ssin given in request is invalid
	MSG00012	The SSIN is not sufficiently integrated for your organization Information elementen kunnen aanwezig zijn
		FieldName	FieldValue
		details	The SSIN is not integrated for the given PCSA
		ssin	ssin requested
		cbeNumber	cbe number
	MSG00013	Access to this operation is not allowed with the given legalcontext and credentials.
	MSG00027	The client is not authorized to consult the requested data
		FieldName	FieldValue
		Not authorized data for given legalContext and operation	not allowed information

Status codes onder results element

Dit status element geeft het resultaat terug van de opvraging van de specifieke authentieke bron (enkel DGPH op dit moment).

De informatie in deze tabel opgenomen komt van de bron en is niet in het beheer van MAGDA.

Value	Code	Description
DATA_FOUND	MSG00000	Treatment successful
NO_DATA_FOUND	MSG00100	Treatment successful, but no data found at the supplier
NO_DATA_FOUND	MSG00021	The SSIN is not sufficiently integrated for the provider of the data
TECHNICAL_ERROR	MSG00002	Error in communication with the destination/supplier. Information elementen kunnen aanwezig zijn
		FieldName	FieldValue
		Schema validation error on response from backend	[the schema validation error]
		SoapFault received from backend	[information on the soapfault from backend]
		Unexpected response from backend	[information on the unexpected response]

SSIN (INSZ) - normaal, vervangen en/of geannuleerd

INSZ is bestaand en actief

Hierbij zal het INSZ worden doorgegeven samen met de eventueel gevonden resultaten

<ssin>INSZ-A</ssin>

INSZ is bestaand en geannuleerd

Een aanduiding wordt meegegeven dat het INSZ is geannuleerd. De opvraging zal echter gedaan worden en de eventueel gevonden resultaten zullen worden doorgegeven

<ssin canceled="true">INSZ-A</ssin>

INSZ is bestaand en vervangen

Het INSZ is vervangen door INSZ-B. Dit nieuw INSZ wordt doorgegeven in het @replaceBy attribuut. Er zullen geen resultaten worden doorgegeven en de opvraging dient gedaan te worden met het nieuw INSZ. In het status element zal een code MSG00006 aanwezig zijn

<ssin replacedBy="INSZ-B">INSZ-A</ssin>

INSZ is bestaand en vervangen. Het nieuw INSZ is geannuleerd

Daar het INSZ vervangen is zal de dienst ook blokkeren en geen resultaten doorgeven. In het status element zal een code MSG00006 aanwezig zijn

Codetabellen Antwoord

Er worden geen codetabellen gebruikt in het antwoord.

Op deze pagina

1 Algemeen
2 XSD Visueel
3 Detail
- 3.1 Antwoord in detail
4 Status
5 SSIN (INSZ) - normaal, vervangen en/of geannuleerd
6 Codetabellen Antwoord

Binnen deze handleiding

Met vragen kunt u steeds terecht bij de MAGDA Service Desk.

MAGDA Gebruikersomgeving

Beschrijving Antwoord (GeefBetalingenHandicap-03.00)