| Table of Contents |
|---|
| Note |
|---|
| Info |
Meer info en configuratie na aanmelden (met de juiste rol) via:
|
API-call bij een standaard DOSIS-integratie met een vereenvoudigde interface
POST
...
/
...
api
...
/v1/
...
dosis/dossiers
Om Call om een nieuwe dossierstatus op te laden.
Geef een dossier door in de body van de request met payload in JSON .
Zet het juiste contenttype (application/json) in de Content-Type request header.
| Info |
|---|
Dit is een asynchrone verwerking met synchrone validatie. Het kan - afhankelijk van de drukte - even duren vooraleer het dossier beschikbaar is. Gebruik de |
Zie ook: https://vlaamseoverheid.atlassian.net/l/c/ApYBWnzd
...
Voor een standaardintegratie volstaan de volgende calls:
POST
...
/
...
api
...
/v2/dosis/dossiers
Must-have call om een nieuwe dossierstatus op te laden.
Geef een dossier door in de body van de request met payload in JSON.
Zet het content type contenttype (application/json) in de Content-Type request header.
| Info |
|---|
Als deze call een 200 OK teruggeeft, is dat de bevestiging dat alles correct bij DOSIS verwerkt zal worden (= asynchrone verwerking). De resultaten van de verwerking opvragen kan, maar is niet noodzakelijk. |
| Info |
<a href="Zie /api/helpv1/methode/GET-api-v1-dosis-resultaten_bron_dossierNummer">resultaten?bron={bron}&dossiernummer={dossiernummer}</a>dosis/resultaten |
Payload-voorbeeld: Minimale json-code DOSIS voor burgers, geen actie nodig
...
| Code Block |
|---|
{
"Identificatie": {
"Bron": "urn://entiteit.be/applicatie",
"DossierNummer": "test_20210318_2"
},
"UploadId": "62ebf665-eb35-43a1-a213-8ab04cdc4160",
"Naam": "test 2 dossiernaam x",
"WijzigingsDatum": "2021-03-25T14:47:15.682Z",
"Status": {
"VlaamsFase": "Samenstelling",
"VlaamsCode": "Aangevraagd",
"Detail1": "dit is de detailstatus",
"WijzigingsDatum": "2021-03-25T14:47:15.682Z",
"Actie": {
"ActieNodig": true,
"Actie": "U dient nog documenten aan te leveren."
},
},
"TypeDossierCode": "DossierStatus",
"Producten": [
{
"Id": "1710"
}
],
"DossierBeheerder": {
"Dienst": "test dienst dossierbeheerder",
"Telefoon": "025537202",
"Email": "digitaal.vlaanderen@vlaanderen.be",
"Website": "https://www.vlaanderen.be/digitaal-vlaanderen",
},
"Doorverwijzing": "https://mijn.loket.be/dossier/test_20210318_2",
"Agenten": [
{
"Identificatie": "71090999892",
"Toegangsrechten": [
{
"Code": "Raadpleger"
}
]
}
]
} |
Body parameters
Voor bèta zie Zie de documentatie via https://betaprod.dosisnotificaties.dev-vlaanderen.be/Dosis voor alle mogelijke velden in de body van de oproep.
GET /api/v2/
...
dosis/
...
bronnen/
...
Voor productie zie https://prod.dosis-burgers.vlaanderen.be/api/swagger/index
...
uris
Endpoint die een lijst teruggeeft van alle bronnen, met bron-Uri, bron-Id en organisatiegegevens die geconfigureerd zijn voor de gebruiker door het Aansluitingen-team.
Deze methode geeft alle bronnen terug waarvoor de oproeper dossierstatussen mag beheren. Het is dus een goede test om na te gaan of het gebruikte token correct is en of alle verwachte bronnen beschikbaar zijn op deze omgeving.
| Code Block | ||
|---|---|---|
| ||
{
"TotalItems": 0,
"PageSize": 0,
"Items": [
{
"BronId": 0,
"BronUri": "string",
"OrganisatieId": 0,
"Omschrijving": "string",
"Afzender": {
"OrganisatieCode": "string",
"OrganisatieNaam": "string"
}
}
]
} |
GET /api/v1/dosis/instellingen/validatie
Endpoint om te valideren of de configuratie (bron-URI + product-ID Id + authenticatie) in orde is vooraleer er effectief dossiers worden doorgestuurd.
<zodra op ACM/IDM ook validatie op token>
...
Deze methode controleert of de oproeper het recht heeft om de bron-Uri voor een specifiek product te gebruiken. Het is dus een goede tweede test om te zien of de productconfiguratie van een bron correct is, nadat de lijst van bronnen gecontroleerd is met GET /api/v2/dosis/bronnen/uris
GET /api/v1/dosis/resultaten/fouten?bron={
...
bronUri}
De resultaten/fouten-methode om alle dossiers die naar DOSIS werden doorgestuurd, maar niet konden verwerkt worden, op te vragen
GET
...
/
...
api/v1/dosis/resultaten?bron={
...
bronUri}&
...
dossierNummer={
...
dossierNummer}
De dossiernummer-methode om het laatste verwerkingsresultaat van 1 specifiek dossier op te vragen.
...
DELETE /api/v1/dosis/dossiers?bron={
...
bronUri}&
...
dossierNummer={
...
dossierNummer}
Call om een dossier te verwijderen. Het is aangeraden om oude dossiers te verwijderen zodat ze niet eeuwig zichtbaar blijven voor de burger. Als afnemer gaat u zelf na of er wettelijke bewaartermijnen bestaan en stemt u de implementatie af op uw businesslogica.
...
De onderstaande calls zijn minder belangrijk omdat DOSIS synchroon werkt. Deze informatie is alleen relevant voor integratoren die er bewust voor kiezen om asynchroon te werken.
GET
...
/
...
api
...
/v1/dosis/resultaten/
...
perUploadId?
...
uploadId={
...
uploadId}
...
Om Call om het resultaat van een POST-call op te vragen.
...
GET /api/
...
v2/dosis/resultaten/fouten?bron={
...
bronUri}&limit={
...
max}&offset={
...
start}
Alternatieve call om op niveau van de bron alleen de fouten op te vragen i.p.v het ok/nok-resultaat specifiek per uploadID.
GET
...
/
...
api
...
/v1/dosis/codelijsten/{naam}
Om statische data op te vragen: de lijst van Vlaamse Fasen en Codes met hun technische keybijv. geïnitieerd is geinitieerd, zonder trema, in de callDeze call geeft altijd dezelfde values terug: de exacte waardes voor Vlaamse Fasen en Codes
De namen van de lijsten zijn:
StatusVlaamsCode
StatusVlaamsFase
StatusEDRL
TypeDossier
TypeSubsidie
UpdateFrequentieType
| Info |
|---|
De technische codes bevatten vaak geen spaties of trema's. |
Swagger
Swagger-documentatie bij de DOSIS API:
Voor bèta zie https://beta.dosis.dev-vlaanderen.be/api/swagger/index#/
Voor productie zie https://prod.dosis-burgers.vlaanderen.be/api/swagger/index
| Note |
|---|
De Swagger is alleen relevant voor de documentatie. Gebruik niet de endpoints vermeld in de SwaggerZo wordt bijv. geïnitieerd → geinitieerd, zonder trema. |