DIGITAAL VLAANDEREN

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

Informatie:

Voor de ontsluiting van een MAGDA 2.0 webservice, alsook het generieke proces binnen een 2.0 webservice, wordt verwezen naar Werking en gebruik MAGDA 2.0 Webservices.


Wijzigingshistoriek

Versie

Opmerking

Datum

Auteur

Status

0.1

Aanmaak gebruikershandleiding

02-11-2017

Ottevangers, Dagmar

Concept

1.0

Review Stefan van Malderen

11-04-2019

Dagmar Ottevangers

Finale versie

2.0





Situering

De dienst RegistreerDossier maakt deel uit van het DOSIS project binnen het programma Vlaanderen Radicaal Digitaal.

DOSIS centraliseert informatie over dossiers die binnen de entiteiten van de Vlaamse overheid bestaan over personen en ondernemingen. De DOSIS databank moet o.a. projecten zoals Mijn Burgerprofiel voeden en zal het mogelijk maken dat burgers of ondernemingen dossiers die over hun bestaan, kunnen consulteren en opvolgen. Projecten als Mijn Burgerprofiel zullen het ook toelaten dat vanuit een overzicht de bron van een dossier (overheidsdienst/dossierbeheerder)kan worden gecontacteerd.

Binnen het DOSIS project laat de dienst RegistreerDossier toe dat een afnemer (een dossierbeheerder) het bestaan van dossiers en het verloop ervan meldt naar de DOSIS databank. De afnemer communiceert hierbij informatie zoals status en beheerder contact gegevens.

Verwante diensten

Dienstnaam

Doel

/wiki/spaces/MDI/pages/122978384

Koppelt het resultaat terug van de laatste registratie van een bepaald dossier (bron + dossiernummer).

/wiki/spaces/MDI/pages/122978425

Laat toe dat een bron (=dossierbeheerder) één van haar dossiers uit de DOSIS databank verwijdert.

/wiki/spaces/MDI/pages/120063846

Koppelt een lijst terug met mogelijke codes en bijhorende omschrijvingen voor verschillende code-gebaseerde elementen van de RegistreerDossier vraag

/wiki/spaces/MB/pages/216007505

Geeft een overzicht van de toestand van één of meerdere Dossiers van een persoon

Gegevensbronnen


De gegevens die door deze dienst worden verwerkt, worden door MAGDA doorgestuurd naar de authentieke bron DOSIS, waar de feitelijke verwerking gebeurt. Na verwerking verkrijgt MAGDA het resultaat en stuurt dit terug naar de Afnemer.

Agentschap Informatie Vlaanderen is dan ook afhankelijk van deze externe bron voor de verwerking van de gegevens en het terugkoppelen van notificaties.

Gebruiksvoorwaarden

Vooraleer een afnemer MAGDA diensten kan gebruiken moet die de MAGDA aansluitingsprocedure doorlopen. Deze procedure zorgt ervoor dat de afnemer wordt geregistreerd als gerechtigd gebruiker van één of meerdere MAGDA diensten. De afnemer krijgt daarbij de nodige codes en richtlijnen voor het aanroepen van de diensten, waaronder een URI (unieke identificatie van de afnemer) en hoedanigheidscode (identificeert in welke context de afnemer een dienst wenst te gebruiken).

Specifiek voor de DOSIS diensten, zullen als deel van deze toelatingsprocedure ook één of meerdere Bron URIs worden toegekend – samen met het dossiernummer is de Bron identificerend voor het dossier dat wordt aangeleverd of verwijderd via de DOSIS diensten.

Een entiteit kan beheerder/eigenaar zijn van één of meerdere toepassingen/producten (=overheidsdienstverlening) waarvoor dossier-data kan worden overgemaakt aan DOSIS. Binnen DOSIS wordt elke entiteit/toepassing waarvoor dossier-gegevens worden verwerkt geïdentificeerd als een Bron. Heb je bv. twee toepassingen waarin dossiers beheerd worden en zijn de dossiernummers enkel uniek binnen de toepassing, maar niet over beide toepassingen heen, dan moet je twee bronnen registreren in DOSIS. DOSIS zal voor elke bron een namespace toekennen, bv. http://www.agentschap.be/app1 en http://www.agentschap.be/app2. Op deze manier kunnen twee verschillende dossiers met hetzelfde dossiernummer bv. BE123 uniek geïdentificeerd worden. De id van het dossier is dan immers http://www.agentschap.be/app1/BE123 en http://www.agentschap.be/app2/BE123.

Informatie:

Meer informatie over deze voorwaarden is terug te vinden op de pagina “Machtigingen en toelatingen”.


Batch

Deze webservice is eveneens beschikbaar in een batch-variant (enkel XML). Voor meer informatie: Webservice In Batch bevragen.

Prefix
Dossier.RegistreerDossier-02.00
Voorbeeld

Dossier.RegistreerDossier-02.00_20131103115553530.

Functionaliteiten

De afnemer (een dossierbeheerder) zal berichten (vraag-elementen) aanleveren met informatie over het bestaan en/of de voortgang van een dossier.  In essentie bevat een bericht volgende informatie:

  • Identificatie: de bron van het dossier (= beheerder/toepassing) en het dossiernummer.
  • Eén of meerdere producten (=overheidsdienstverlening) waarop het dossier betrekking heeft - hiervoor wordt gebruik gemaakt van de Interbestuurlijke producten- en dienstencatalogus (IPDC).
  • Informatie over de status van het dossier. De statusinformatie bevat een op Vlaams niveau gestandaardiseerde Fase en Status, datum en tijdstip van de laatste status wijziging en optioneel de afnemer interne statussen van het dossier.
  • Eén of meerdere subjecten waarop het dossier betrekking heeft (dit kunnen zowel natuurlijke als rechtspersonen zijn).
  • Een URL die doorverwijst naar het elektronische dossier of de website van de dossierbeheerder.
  • Informatie over de toegangsrechten die nodig zijn om de detail informatie van het dossier te mogen raadplegen.

De contactgegevens van de dossierbeheerder.



Werking

Aandachtspunten

De dienst RegistreerDossier laat toe dat een afnemer (een dossierbeheerder) het bestaan van dossiers en het verloop ervan meldt naar de DOSIS databank.

De verwerking van de aangeleverde dossiers bij DOSIS gebeurt asynchroon: na een initiële validatie worden de gegevens op een queuing-systeem geplaatst vanwaar ze worden opgepikt door een ander proces dat de feitelijke verwerking doet. Een bron (dossierbeheerder) die dossiergegevens aanlevert aan DOSIS krijgt dus niet in real-time een bevestiging van de goede verwerking van die gegevens (of eventuele fouten). Dit houdt in dat gebruikers van de RegistreerDossier-dienst expliciet moeten opvragen of hun aangeleverde gegevens al dan niet goed zijn verwerkt. Daartoe stelt MAGDA twee andere diensten ter beschikking: GeefResultaatRegistratie en GeefUitzonderingenRegistraties.

Voor meer informatie over de algemene DOSIS werking en de afhankelijkheden zie 5 DOSIS totaalproces.

Opties

Gebruik van RegistreerDossier in combinatie met GeefRegistratie

Een afnemer/bron die de aangeleverde registraties wenst te valideren via de GeefResultaatRegistratie moet dit doen voor elke RegistreerDossier, vooraleer een volgende registratie voor hetzelfde dossier, en daarbij rekening houdend met het feit dat het resultaat van een registratie niet onmiddellijk beschikbaar is. In het slechtste geval zal men dus een volgende registratie moeten uitstellen tot bevestiging is verkregen van de vorige registratie. Het risico bestaat namelijk dat wanneer een afnemer meerdere opeenvolgende registraties doorgeeft voor eenzelfde dossier, en het resultaat pas opvraagt op een later tijdstip, dat die dan niet wordt geïnformeerd over mogelijke problemen met één of meerdere van de doorgestuurde registraties – de GeefResultaatRegistratie dienst geeft slechts uitsluitsel over de verwerking van de laatste in de rij. Deze werkwijze kan dus leiden tot een onvolledige status-historiek in de DOSIS databank.

Gebruik van RegistreerDossier in combinatie met GeefUitzonderingenRegistratie

In principe biedt de GeefUitzonderingenRegistraties webservice de mogelijkheid om voor snel evoluerende dossiers meerdere registraties te doen zonder zich te bekommeren over de verwerking ervan, en pas later in een apart proces na te gaan of er registraties waren die niet konden worden verwerkt, en die dan verbeterd opnieuw door te sturen. Probleem hier is echter dat de teruggekoppelde uitzonderingen wel aangeven aan welk dossier zij zijn gerelateerd, maar niet aan welke specifieke registratie. Een bron die de aangeleverde registraties wenst te valideren via deze GeefUitzonderingenRegistraties moet dus zelf een systeem voorzien dat in staat is om teruggekoppelde uitzonderingen te koppelen aan individuele registraties binnen een dossier (bvb op basis van de gerapporteerde tijdstippen).

Responsetijden & Beschikbaarheid

Opmerking:

De MAGDA response tijden zijn heel sterk afhankelijk van de response tijden van de bron. Als de brongegevens heel traag worden aangeleverd kan het MAGDA antwoord niet snel worden aangeleverd. 

Logging

De opvragingen die gebeuren via deze webservice worden bewaard zoals beschreven op de pagina "MAGDA logging".

Ondersteunde talen

MAGDA ondersteunt de Nederlandse taal.

Indien in de brongegevens de Nederlandse tekst niet beschikbaar is voor een bepaald element zal de eerste vertaling van de tekst in de brongegevens gebruikt worden, onafhankelijk van de taal waarin dit gegeven beschikbaar is.

Op deze pagina

Binnen deze handleiding

Omgevingsinformatie

Functioneel DomeinDossier
ClassificatieGevoelige persoonsgegevens


  • No labels