| Info | ||
|---|---|---|
| ||
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. |
| Excerpt | ||
|---|---|---|
| ||
Dit document beschrijft het gebruik en de werking van de dienst GeefCodelijst, zoals deze door Agentschap Informatie Vlaanderen op het MAGDA platform aangeboden wordt. De beschrijving is toegespitst op de online (SOAP) versie van de dienst. MAGDA biedt echter ook een batch versie aan van deze dienst. Voor beide versies is het formaat van het bericht (XSD) identiek, met uitzondering van het aantal ‘vragen’ dat is toegelaten: bij de SOAP versie is slechts 1 vraag toegelaten, bij batch zijn meerdere vragen toegelaten. |
Wijzigingshistoriek
Versie | Opmerking | Datum | Auteur | Status |
|---|---|---|---|---|
0.1 | Aanmaak gebruikershandleiding | 10-10-2017 | Ottevangers, Dagmar | Concept |
1.0 | Revisie n.a.v. opmerkingen Sven Pletinckx | 08-11-2017 | Dagmar Ottevangers | Finale versie |
Situering
De dienst GeefCodelijst maakt deel uit van het DOSIS project binnen het programma Vlaanderen Radicaal Digitaal.
DOSIS centraliseert informatie over dossiers die binnen de één van de entiteiten van de Vlaamse overheid bestaan over personen en ondernemingen.. De DOSIS databank moet projecten zoals het Burgerprofiel voeden en zal het mogelijk maken dat burgers of ondernemingen de dossiers die over hun bestaan kunnen consulteren en opvolgen, en eventueel vanuit dat overzicht de bron van een dossier (overheidsdienst/dossierbeheerder) kunnen contacteren.
Deze dossiers worden door de verscheidene entiteiten/dossierbeheerders overgemaakt naar DOSIS d.m.v. de webservice RegistreerDossier. Sommige van de gegevens die daarbij worden aangeleverd moeten worden gecodeerd. De dienst GeefCodelijst laat toe dat een dossierbeheerder up-to-date lijsten opvraagt van de beschikbare codes voor de verschillende dossier gegevens.
Verwante diensten
RegistreerDossier : 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 dossiertype. Sommige van die gegevens moeten worden uitgedrukt aan de hand van codes.
GeefResultaatRegistratie : Koppelt het resultaat terug van de laatste registratie van een bepaald dossier (bron + dossiernummer).
VerwijderDossier : Laat toe dat een bron (=dossierbeheerder) één van haar dossiers uit de DOSIS databank verwijdert.
GeefDossiers : Geeft een overzicht van de toestand van één of meerdere Dossiers van een persoon
GeefUitzonderingenRegistraties : Koppelt informatie terug van alle niet-succesvolle verwerkingen van registraties voor een bepaalde bron (=dossierbeheerder). Te gebruiken voor validatie van RegistreerDossier.
Gegevensbronnen
Meer informatie over hoe deze bronnen gebruikt worden in de opbouw van het antwoord vindt u onder Opvraging.
| Note | ||
|---|---|---|
| ||
Agentschap Informatie Vlaanderen is afhankelijk van de externe bron(nen) voor de kwaliteit en de aanlevering van de gegevens. |
Gebruiksvoorwaarden
De gegevens die door deze dienst worden verwerkt, worden door MAGDA doorgestuurd/verkregen naar/van de (authentieke) bron DOSIS, waar de feitelijke verwerking gebeurt.
Agentschap Informatie Vlaanderen is dan ook afhankelijk van deze externe bron voor de verwerking van de gegevens en het terugkoppelen van informatie en notificaties.
| Info | ||
|---|---|---|
| ||
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.GeefCodelijst-02.00 |
|---|---|
| Voorbeeld | Dossier.GeefCodelijst-02.00_20131103115553530. |
Functionaliteiten
Een afnemer/dossierbeheerder kan via de GeefCodelijst de codelijsten opvragen voor de verschillende dossier-elementen die op basis van vastgelegde codes moeten worden gekwalificeerd. Deze zijn:
- ../Dossier/Status/Fase) = codelijst StatusVlaamsFase
- ../Dossier/Status/Code) = codelijst StatusVlaamsCode
- ../Dossier/Status/EDRL) = codelijst StatusEDRL
- ../Dossier/Type) = codelijst TypeDossier
De afnemer moet deze dienst apart oproepen voor elke codelijst.
Werking
Responsetijden & Beschikbaarheid
| Note | ||
|---|---|---|
| ||
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
| Table of Contents | ||
|---|---|---|
|
Binnen deze handleiding
| Page Tree | ||
|---|---|---|
|
Omgevingsinformatie
| Functioneel Domein | |
|---|---|
| Classificatie |
| Create from Template | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Create from Template | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Create from Template | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Create from Template | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Create from Template | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Create from Template | ||||||||
|---|---|---|---|---|---|---|---|---|
|
| Create from Template | ||||||||
|---|---|---|---|---|---|---|---|---|
|