Beschrijving Antwoord (GeefDossiers-02.00)
Visueel
Detail
Het antwoord bevat een standaard Context zoals beschreven in het document Gebruik Magda Webservices 02.00. Verder zal dan ook enkel aandacht besteed worden aan het specifieke Antwoord element.
Antwoord
Het antwoord zelf bestaat uit één of meerdere Dossiers gevonden.
Een antwoord kan ook enkel bestaan uit een Uitzondering, maar kan ook een combinatie zijn van Uitzondering en Dossier element(en).
Een Antwoord element bevat altijd een Referte.
Visueel
Detail
Element | Opmerkingen |
Referte | De code die de originele Vraag identificeert. Deze wordt in het Antwoord overgenomen uit het Referte element van de Vraag en vormt daarmee de koppeling in de Vraag-Antwoord ketting. |
Inhoud | Response inhoud. |
Uitzonderingen | Container element voor 1 of meer Uitzonderingen. Dit element is alleen aanwezig indien minstens één Uitzondering aangemaakt werd. Uitzonderingen kunnen bestaan naast gevonden Dossiers. |
Dossier
Indien minstens één Dossier gevonden is, dan bestaat het Inhoud element (zie boven) en deze bevat het Dossiers element. Dit element is een container voor 1 of meer Dossier elementen. Elk Dossier element bevat een lijst van DossierMutaties.
Visueel
Detail
Element | Opmerkingen |
Dossiers | Lijst met Dossiers die voldoen aan de criteria uit het request. Dit element is verplicht indien het Inhoud element aanwezig is. |
Dossier | Gegevens over een Dossier dat voldoet aan de criteria uit het request. |
DossierMutaties | Lijst van dossier mutaties per Dossier. Deze lijst van DossierMutatie elementen representeert de historiek van een Dossier. |
DossierMutatie | Een DossierMutatie representeert een toestand van het Dossier tijdens diens levenscyclus. Dit kan een statusovergang zijn, maar ook een wijziging in één of meer van de gegevens van een Dossier. |
DossierMutatie
Een DossierMutatie is een extensie op het DossierType en representeert de toestand van een Dossier op een bepaald moment in de tijd. Om dit gegeven te capteren is het element Periode toegevoegd.
Een Dossier heeft altijd minstens één DossierMutatie.
Visueel
Detail
Element | Opmerkingen |
Identificatie | Identificatie van het dossier op basis van een URI (bron) en dossiernummer |
Identificatie/Bron | URI van de dossierbeheerder/toepassing waarbinnen de aangeleverde dossier-gegevens bestaan |
Identificatie/ | De unieke referentie van het specifieke dossier bij de Bron |
Naam | De titel van het Dossier |
DatumModificatie | Datum en tijdstip van de laatste dossierwijziging. Verplicht in geval van een dossier van het type DossierStatus |
StreefDatum | De datum waarop verwacht wordt dat de volgende stap (statuswijziging) in het Dossier zal of zou moeten plaatsvinden. Dit kan in bepaalde gevallen bepaald worden door een wettelijke termijn (van een fase of status) |
Status | De actuele 'stand van zaken' van een dossier, uitgedrukt door middel van de geüniformeerde 'Generieke Vlaamse Status'-code die bestaat uit de som van 2 velden: een fase (StatusVlaamsFase) + een status (StatusVlaamsCode) binnen die fase. Voor beide velden is er een Codetabel. Verder bevat het Status gegeven ook datum en tijdstip van de laatste status wijziging en optioneel de afnemer interne statussen van het dossier. Dit complex type wordt in detail van het Status element verder beschreven. |
Type | Het type van dossier. Mogelijke waarden zijn:
Voor mogelijke waarden zie Codetabellen Antwoord verder op deze pagina |
Producten | Een lijst van één of meerdere producten (=overheidsdienstverlening) waarop het dossier betrekking heeft |
Producten/Product | Een code uit de Interbestuurlijke producten- en dienstencatalogus (IPDC) |
Beheerder | De contact- en adresgegevens van de dossierbeheerder. Dit complex type wordt in detail van Beheerder element beschreven |
ExtraInformatie | Vrije extra informatie over het dossier |
Doorverwijzing | Link (URI) naar een applicatie waar er meer informatie over het dossier beschikbaar is |
Subjecten | Een lijst van Personen (of ondernemingen, vestigingen, of andere soorten 'subjecten') betrokken in het dossier. Dit complex type wordt in Detail van Subjecten element beschreven |
Subjecten/Subject | Een persoon (of onderneming, vestiging, of ander soort 'subject') betrokken in het dossier |
Eigenschappen | Lijst van een drietal "vlaggen" bij een Dossier |
Eigenschappen/ | Aanduiding of het dossier vertrouwelijk is en enkel door bevoegde ambtenaren geraadpleegd kan worden |
Eigenschappen/ | Aanduiding of het dossier publiek is en door iedereen geraadpleegd mag worden |
Eigenschappen/ | Aanduiding of het dossier niet-raadpleegbaar mag zijn door DOSISraadpleger en wettelijk vertegenwoordiger |
Periode | Geldigheidsperiode van een dossiermutatie |
Detail van element: Status
Visueel
Detail
Element | Opmerkingen |
Code | De Vlaamse StatusCode |
Fase | De Vlaamse StatusFase |
EDRL | De Europese dienstenrichtlijnstatus |
Details | Een lijst van interne statussen van het dossier |
Details/Detail | Een interne status van het dossier |
DatumModificatie | Datum en tijdstip van de laatste statuswijziging |
Actie | Aanduiding of de huidige status impliceert dat er actie van burger of onderneming nodig is en indien ja, welke actie |
Actie/ActieNodig | Aanduiding dat de huidige status impliceert dat er actie van burger of onderneming nodig is |
Actie/Omschrijving | Omschrijving van de uit te voeren actie. Verplicht indien er actie nodig is |
StreefDatum | De streefdatum voor het beëindigen van de huidige status |
Detail van element: Beheerder
Visueel
Detail
Element | Opmerkingen |
Contact | De contactgegevens van de dossierbeheerder |
Adres | Het adres van de dossierbeheerder |
Detail van het element: Subject
Een persoon (of onderneming, vestiging, of ander soort 'subject') betrokken in het dossier.
Visueel
Detail
Element | Opmerkingen |
Rol | Op dit moment zijn 2 rollen voorzien:
Andere rollen zijn mogelijk in de toekomst |
Type | Op dit moment zijn 2 types voorzien:
Andere types zijn mogelijk in de toekomst |
Sleutel | De sleutel van de subject (INSZ-nummer voor PERS, ondernemingsnummer voor OND) |
Detail van generiek type: Periode
Een Periode is een tijdspanne gemarkeerd door een begindatum en een einddatum. Beide datums zijn "inclusief"; met andere woorden, een periode moet gelezen worden als "van…t/m…".
MAGDA kent zowel een Periode met een verplichte einddatum als een Periode met een optionele einddatum; in de context van Dossiers wordt de Periode met optionele einddatum gebruikt.
Zowel de begindatum als de einddatum hebben structureel een datum- en een tijdelement.
Visueel
Detail
Element | Opmerkingen |
Begin | De begindatum van de periode |
Begin/Datum | Het datumgedeelte van de begindatum |
Begin/Tijd | Een eventuele tijdsaanduiding van de begindatum |
Einde | De einddatum van de periode |
Einde/Datum | Het datumgedeelte van de einddatum |
Einde/Tijd | Een eventuele tijdsaanduiding van de einddatum |
Detail van generiek type: Contact
Visueel
Detail
Element | Opmerkingen |
Naam | De naam van de contactpersoon |
Dienst | De dienst van de contactpersoon – ofwel een Omschrijving, ofwel een WegwijsID element |
Dienst/Omschrijving | De omschrijving van de dienst van de contactpersoon |
Dienst/WegwijsID | Het WegwijsID van de dienst van de contactpersoon |
Het emailadres van de contactpersoon | |
Telefoon | Het telefoonnummer van de contactpersoon |
GSM | Het GSM-nummer van de contactpersoon |
Fax | Het faxnummer van de contactpersoon |
Website | De website van de contactpersoon |
Detail van generiek type: Adres
Visueel
Detail
Element | Opmerkingen |
Straat | De straat van het adres |
Straat/Code | De RR-code van de straat |
Straat/Naam | De straatnaam |
Huisnummer | Het huisnummer |
Busnummer | Het busnummer |
Gemeente | De gemeente van het adres |
Gemeente/NISCode | De code van de gemeente in NIS formaat. Het formaat van gemeentecodes heeft 5 cijfers |
Gemeente/Postcode | De postcode van de gemeente |
Gemeente/Naam | De naam van de gemeente |
Land | Het land van het adres |
Land/ISOCode | De landcode in ISO formaat |
Land/NISCode | De landcode in NIS formaat. Het formaat van landcodes heeft 3 cijfers |
Land/Naam | De naam van het land |
Codetabellen Antwoord
Element | Code |
../Dossier/Type | https://test.dosis.dev-vlaanderen.be/api/help/codelijst?codelijst=TypeDossier |
../Status/Code | https://beta.dosis.dev-vlaanderen.be/api/help/codelijst?codelijst=StatusVlaamsCode |
../Status/Fase | https://beta.dosis.dev-vlaanderen.be/api/help/codelijst?codelijst=StatusVlaamsFase |
../Status/EDRL | https://test.dosis.dev-vlaanderen.be/api/help/codelijst?codelijst=StatusEDRL |
../Subject/Rol | Betrokkene of Aanvrager |
../Subject/Type | PERS of OND |
../Product |
Op deze pagina
- 1 Visueel
- 2 Detail
- 2.1 Antwoord
- 2.2 Dossier
- 2.3 DossierMutatie
- 2.4 Codetabellen Antwoord
In deze handleiding
Met vragen kunt u steeds terecht bij de MAGDA Service Desk.
Voor vragen of opmerkingen kan u de MAGDA helpdesk contacteren
De MAGDA Gebruikersomgeving is een officiële website van de Vlaamse overheid
uitgegeven door Digitaal Vlaanderen