Algemeen
De inhoud van het antwoord bestaat uit een ConsultAttestResponse 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 | 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 vererking zal verder gaan met het oude INSZ. De afnemer dient eventueel een nieuwe vraag te stellen met het nieuw INSZ uit dit attribuut. | ||||||
attest | Indien de status/value ‘DATA_FOUND’ is zal het attest gevonden zijn voor het kwartaal en de persoon en aanwezig zijn in het request. | ||||||
attestationIdentification | |||||||
yearQuarter | Het jaar-kwartaal waarvoor het attest geldt. Formaat [1-2]\d{3}Q(1|2|3|4). | ||||||
creationDate | De datum waarop het attest werd aangemaakt. | ||||||
attestationId | Het id van het attest. | ||||||
attestationVersion | Een incrementerend versienummer per nieuwe instantie van het attest. | ||||||
attestationStatus | De status origineel, wijziging of annulatie:
Bij annulatie zijn er geen sociale risico’s (meer) aanwezig. | ||||||
temporaryAttest | Dit veld is aanwezig wanneer de attestationID, version en status niet gekend zijn. Het betreft hier dan een nog niet geattesteeerd attest voor het lopende trimester. | ||||||
allowances | De uitkering(en) waarop dit attest betrekking hebben. | ||||||
allowance | |||||||
period | |||||||
beginDate | Startdatum van de periode | ||||||
endDate | Einddatum van de periode | ||||||
initialStartDate | Begindatum van de arbeidsongeschiktheid | ||||||
exitCode | Code voor het beëindigen van de arbeidsongeschikheid. | ||||||
payments | Dit betreft de informatie over de mogelijke betalingen verbonden aan deze uitkering | ||||||
payment | |||||||
document | Type van boekhoudkunding document. | ||||||
incapacityCategory | Code die bediende-categorie bepaalt. | ||||||
familySituation | Code die gezinstoestoestand van de titularis bepaalt. | ||||||
allowanceCategory | Code die het type uitkering, betaald aan de titularis, bepaalt. | ||||||
allowanceCode | Code de de aard van uitkering, betaald aan de titularis, bepaalt. | ||||||
period | Betalingsperiode. | ||||||
beginDate | Startdatum van de uitgekeerde periode | ||||||
endDate | EindDatum van de uitgekeerde period | ||||||
amount | Bedrag (bruto belastbaar bedrag) gestort aan / teruggevorderd van de titularis. Kan dus ook negatief zijn. Bedrag in euro (met decimalen voor de eurocenten). (optioneel voor filtering doeleinde, bij NIC wel steeds aanwezig) | ||||||
days | Aantal vergoede dagen. Kan negatief zijn (terugvordering). (optioneel voor filtering doeleinde, bij NIC wel steeds aanwezig in choice tussen days en hours) | ||||||
hours | Aantal vergoede uren. Decimaal en kan negatief zijn (terugvordering). (optioneel voor filtering doeleinde, bij NIC wel steeds aanwezig in choice tussen days en hours) | ||||||
Status
Overzicht
Zie eerst de volledige omschrijving van het status element op KSZ Status Element.
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 | |
MSG00021 | The SSIN is not sufficiently integrated for the provider of the data. | ||
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 | ||
Quarter | The quarter requested lies before the limit of 2004Q1 | ||
Quarter | The quarter requested lies in the future. | ||
MSG00011 | The structure of the ssin given in request is invalid | ||
MSG00012 | The SSIN is not sufficiently integrated for your organization | ||
MSG00013 | Access to this operation is not allowed with the given legalcontext and credentials. | ||
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
<ssin replacedBy="INSZ-B" canceled="true">INSZ-A</ssin>
Codetabellen Antwoord
Zie Codetabellen Antwoord (SocZek.GeefArbeidsongeschiktheid-01.00)
