Document toolboxDocument toolbox


DIGITAAL VLAANDEREN

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.
Dit element bevat de gevonden Dossiers en is alleen aanwezig indien effectief minstens één Dossier gevonden werd.

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.

<Antwoord> <Referte>10552</Referte> <Inhoud> <Dossiers> <Dossier> <DossierMutaties> <DossierMutatie> (Mutatie Dossier A) </DossierMutatie> <DossierMutatie> (Mutatie Dossier A) </DossierMutatie> </DossierMutaties> </Dossier> <Dossier> <DossierMutaties> <DossierMutatie> (Mutatie Dossier B) </DossierMutatie> </DossierMutaties> </Dossier> <Dossier> <DossierMutaties> <DossierMutatie> (Mutatie Dossier C) </DossierMutatie> </DossierMutaties> </Dossier> </Dossiers> </Inhoud> </Antwoord>

 

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/
Dossiernummer

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:

  • DossierStatus: dossier met een status

  • Verwijzing:  verwijzing naar een dossier of een cluster van dossiers, zonder status

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)
Voor mogelijke waarden zie Codetabellen Antwoord verder op deze pagina

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/
Vertrouwelijk

Aanduiding of het dossier vertrouwelijk is en enkel door bevoegde ambtenaren geraadpleegd kan worden

Eigenschappen/
Publiek

Aanduiding of het dossier publiek is en door iedereen geraadpleegd mag worden

Eigenschappen/
IsNietRaadpleegbaar

Aanduiding of het dossier niet-raadpleegbaar mag zijn door DOSISraadpleger en wettelijk vertegenwoordiger

Periode

Geldigheidsperiode van een dossiermutatie
Dit generieke type wordt Detail van het generiek type Periode verder beschreven

<DossierMutatie> <Identificatie> <Bron>STL</Bron> <Dossiernummer>2017_SO_01234567890</Dossiernummer> </Identificatie> <Naam>Studietoelagen 2017-2018 Test dosis Test dosis</Naam> <DatumModificatie>2018-06-15T14:13:39.000+02:00</DatumModificatie> <Status>…</Status> <Type>Financieel voordeel</Type> <Producten> <Product>686</Product> </Producten> <Beheerder>…</Beheerder> <ExtraInformatie>Extra informatie</ExtraInformatie> <Doorverwijzing>https://loket-dev-studietoelagen.vlaanderen.be/dossier</Doorverwijzing> <Subjecten>…</Subjecten> <Eigenschappen> <Vertrouwelijk>0</Vertrouwelijk> <Publiek>0</Publiek> <IsNietRaadpleegbaar>0</IsNietRaadpleegbaar> </Eigenschappen> <Periode>…</Periode> </DossierMutatie>

Detail van element: Status

Visueel

Detail

Element

Opmerkingen

Code

De Vlaamse StatusCode
Voor mogelijke waarden verder onder Codetabellen Antwoord

Fase

De Vlaamse StatusFase
Voor mogelijke waarden zie verder onder Codetabellen Antwoord

EDRL

De Europese dienstenrichtlijnstatus
Voor mogelijke waarden zie verder onder Codetabellen Antwoord

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

<Status> <Code>INGEDIEND</Code> <Fase>Samenstelling</Fase> <Details> <Detail>We hebben uw aanvraag ontvangen.</Detail> </Details> <DatumModificatie>2018-06-15T14:13:39.000+02:00</DatumModificatie> </Status>

Detail van element: Beheerder

Visueel

Detail

Element

Opmerkingen

Contact

De contactgegevens van de dossierbeheerder
Dit generieke type wordt in detail beschreven in Detail van generiek type: Contact

Adres

Het adres van de dossierbeheerder
Dit generiek type wordt in detail beschreven in Detail van generiek type: Adres

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:

  • Betrokkene

  • Aanvrager

Andere rollen zijn mogelijk in de toekomst

Type

Op dit moment zijn 2 types voorzien:

  • PERS: persoon

  • OND: onderneming

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

Email

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

https://overheid.vlaanderen.be/informatie-vlaanderen/producten-diensten/wegwijs-producten-en-diensten-ipdc



Op deze pagina 


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