/
Hoe DOSIS voeden via RegistreerDossierBasis

Documentatie bouwstenen digitale loketten

Hoe DOSIS voeden via RegistreerDossierBasis

Deze pagina beschrijft de vereenvoudigde payload voor de API‑call RegistreerDossierBasis.

Over de vereenvoudigde interface

RegistreerDossierBasis is de synchrone DOSIS‑API‑call waarmee een bron met een beperkte, vereenvoudigde payload een dossier identificeert en registreert én tegelijk de actuele dossierstatus bijwerkt, zodat u meteen de verwerking in DOSIS ziet.

Een dossier wordt herkend op basis van een bron en een uniek dossiernummer. Dankzij de beperkte payload, met alleen de essentiële velden, ziet u meteen de verwerking van het dossier in DOSIS.

Deze vereenvoudigde interface volstaat voor de meeste DOSIS-implementaties.

Zie ook: API-calls DOSIS | API call bij een standaard DOSIS integratie met een vereenvoudigde interface.

Link naar de Swagger-documentatie

Zie: https://tni.notificatie.dev-vlaanderen.be/Dosis

image-20240321-111240.png

 

image-20240321-111354.png

 

Overzicht velden vereenvoudigde interface

Hieronder vindt u een overzicht van de (niet-)functionele velden, inclusief de mapping op de uitgebreide interface in de tabel onder de voorbeeldpayload.

{ "DossierIdentificatie": { "Bron": "string", "Nummer": "string" }, "Naam": "string", "WijzigingsDatum": "2022-03-10T11:38:11.676Z", "ProductId": 1, "VlaamseFase": "string", "VlaamseCode": "string", "DetailStatus": "string", "Actie": "string", "DoorverwijzingUrl": "https://voorbeeld.vlaanderen.be/dossier/12345", "DossierBeheerder": { "Naam": "string", "Dienst": "string", "Telefoon": "string", "Email": "string", "Website": "string", "Adres": { "Straat": "string", "Nummer": "string", "Postcode": "string", "Gemeente": "string" } }, "Agenten": [ { "Rijksregisternummer": "01234567891", "$type": "Burger" }, { "KboNummer": "0123456789", "ToegangsRechten": [ { "Code": "1" } ], "$type": "Onderneming" } ] }

Dossierstatus

Naam

Omschrijving

Type

Verplicht/
Optioneel

Mapping op huidige uitgebreide interface

Naam

Omschrijving

Type

Verplicht/
Optioneel

Mapping op huidige uitgebreide interface

DossierIdentificatie

Identificatie van het dossier waarbinnen deze dossierstatus hoort

Dossier-Identificatie

Verplicht

/

Naam

De titel van het dossier

String

Verplicht
(0 - 255)

Dossier.Naam

Wijzigingsdatum

Datum en tijdstip van de laatste dossierwijziging. Vergeet de tijdzone niet mee te geven (via de Z achteraan)

DateTime

Verplicht

Dossier.WijzigingsDatum
Dossier.Status.WijzigingsDatum

ProductId

De IPDC-ID (getal) van het product of de dienst waarop het dossier betrekking heeft.

Integer

Verplicht

Dossier.Producten[0].ProductId

VlaamseFase

OSLO-standaard - Vlaamse status - Fase

String

Verplicht
(0 - 255)

Dossier.Status.VlaamseFase

VlaamseCode

OSLO standaard - Vlaamse status - Code

String

Verplicht
(0 - 255)

Dossier.Status.VlaamseCode

DetailStatus

Vrij in te vullen detailinformatie over de dossierstatus

String

Optioneel
(0 - 255)

Dossier.Status.Detail1

Actie

Omschrijving van de uit te voeren actie

String

Optioneel
(0 - 255)

Indien ingevuld en lengte > 0 en niet enkel whitespace:
Dossier.Status.Actie.ActieNodig = true
Dossier.Status.Actie.Actie = Actie

Indien niet ingevuld of lengte = 0 of enkel whitespace:
Dossier.Status.Actie.ActieNodig = false
Dossier.Status.Actie.Actie = null

DoorverwijzingUrl

Hyperlink naar een applicatie waar er meer informatie over het dossier beschikbaar is.

Moet een geldige URL zijn

URL

Optioneel
(0 - 255)

Dossier.Doorverwijzing

DossierBeheerder

De contactgegevens van de dossierbeheerder

Contact

Optioneel

Dossier.DossierBeheerder

Agenten

Een lijst van burgers, ondernemingen of verenigingen die bij het dossier betrokken zijn.

Er moet minstens 1 agent gedefinieerd zijn op het dossier.

Lijst van 
Agenten

Verplicht

Dossier.Agenten

Aanvrager

De naam van de aanvrager van het dossier

Alleen voor verenigingen

Aanvrager

Optioneel

Dossier.Aanvrager

Dossieridentificatie

Naam

Omschrijving

Type

Verplicht/
Optioneel

Mapping op uitgebreide interface

Naam

Omschrijving

Type

Verplicht/
Optioneel

Mapping op uitgebreide interface

Bron

De bron (namespace) van het dossier, bijv. http://www.agentschap.vl/applicatie.

Deze namespace wordt aangemaakt bij de aansluiting aan DOSIS.

URL

Verplicht
String
(0 - 255)

Dossier.Identificatie.Bron

Nummer

Het unieke nummer van het dossier binnen de gekozen bron

String
(Geen white-space)

Verplicht
String
(1 - 255)

Dossier.Identificatie.DossierNummer

Contact (optioneel)

(indien meegegeven is minstens één contactgegeven verplicht)

Naam

Omschrijving

Type

Verplicht/
Optioneel

Mapping op uitgebreide interface

Naam

Omschrijving

Type

Verplicht/
Optioneel

Mapping op uitgebreide interface

Naam

De naam van de dossierbeheerder

String

Optioneel
(0 - 255)

Dossier.DossierBeheerder.Naam

Dienst

De dienst van de dossierbeheerder

String

Optioneel
(0 - 255)

Dossier.DossierBeheerder.Dienst

Telefoon

Het telefoonnummer van de dossierbeheerder

Moet een geldig telefoonnummer-formaat zijn

String

Optioneel
(0 - 255)

Dossier.DossierBeheerder.Telefoon

Email

Het e-mailadres van de dossierbeheerder

Moet een geldig e-mailformaat zijn

String

Optioneel
(0 - 255)

Dossier.DossierBeheerder.Email

Website

De website van de dossierbeheerder

Moet een geldige URL zijn

String

Optioneel
(0 - 255)

Dossier.DossierBeheerder.Website

Adres

Zie hieronder:

Adres

Optioneel

Dossier.DossierBeheerder.Adres

Adres

Naam

Omschrijving

Type

Verplicht/
Optioneel

Mapping op uitgebreide interface

Naam

Omschrijving

Type

Verplicht/
Optioneel

Mapping op uitgebreide interface

Straat

De straatnaam in het adres van de dossierbeheerder

String

Optioneel
(0 - 255)

Dossier.DossierBeheerder.Adres.
Straat

Nummer

Het huisnummer (en eventueel het busnummer) in het adres van de dossierbeheerder.

String

Optioneel
(0 - 255)

Dossier.DossierBeheerder.Adres.
Nummer

Postcode

De postcode in het adres van de dossierbeheerder.

String

Optioneel
(0 - 255)

Dossier.DossierBeheerder.Adres.
Postcode

Gemeente

De gemeentenaam in het adres van de dossierbeheerder

String

Optioneel
(0 - 255)

Dossier.DossierBeheerder.Adres.
Gemeente

Agent

BurgerAgent

Naam

Omschrijving

Type

Verplicht/
Optioneel

Mapping op uitgebreide interface

Naam

Omschrijving

Type

Verplicht/
Optioneel

Mapping op uitgebreide interface

Rijksregister-nummer

Uniek persoonsnummer

String

Verplicht

Dossier.Agenten.Identificatie

$type

Het type agent; voor een BurgerAgent is dit “Burger” (case insensitive)

String

Verplicht

 

OndernemerAgent

Naam

Omschrijving

Type

Verplicht/
Optioneel

Mapping op uitgebreide interface

Naam

Omschrijving

Type

Verplicht/
Optioneel

Mapping op uitgebreide interface

KboNummer

Uniek ondernemingsnummer

String

Verplicht

Dossier.Agenten.Identificatie

Toegangsrechten

De rollen waarmee een gebruiker toegang krijgt om het dossier te raadplegen

Dit kan leeg blijven. Alleen wanneer u een bepaalde rol meegeeft, zullen niet-vertegenwoordigers die deze rol hebben, het dossier kunnen inkijken.

Laat dit veld standaard leeg. Om rollen te gebruiken, overleg eerst met de collega’s van e-loketondernemers.be (Vlaio).

Lijst met strings

Verplicht
(1 - 255)

Niet enkel whitespace

Dossier.Agenten.Toegangsrechten.Code

$type

Het type agent; voor een OndernemerAgent is dit “Onderneming” (case insensitive)

String

Verplicht

 

VerenigingsAgent

Naam

Omschrijving

Type

Verplicht/
Optioneel

Mapping op uitgebreide interface

Naam

Omschrijving

Type

Verplicht/
Optioneel

Mapping op uitgebreide interface

VCodeNummer

Uniek verenigingsnummer, met als prefix “V”, aangevuld met 7 tot 9 cijfers. Bijvoorbeeld “V1234567”

  • Voor vzw’s wordt altijd het KBO-nummer gebruikt.

  • Voor feitelijke verenigingen en afdelingen wordt altijd en alleen de V-Code gebruikt.

String

Verplicht

Dossier.Agenten.Identificatie

Toegangsrechten

De rollen waarmee een gebruiker toegang krijgt om het dossier te raadplegen

Dit kan leeg blijven. Alleen wanneer u een bepaalde rol meegeeft, zullen niet-vertegenwoordigers die deze rol hebben, het dossier kunnen inkijken. Een voorbeeld van rol is: CJM_Vloket_VER_CompEnt_DossierLezer

Laat dit veld standaard leeg. Om rollen te gebruiken, overleg eerst met de collega’s van aansluitingen.verenigingsloket@vlaanderen.be of kom langs op het technisch spreekuur.

Lijst met strings

Verplicht
(1 - 255)

Niet enkel whitespace

Dossier.Agenten.Toegangsrechten.Code

 

$type

Het type agent; voor een VerenigingsAgent is dit “Vereniging” (case insensitive)

String

Verplicht

 

Aanvrager

Optioneel veld, alleen te gebruiken in de context van verenigingen. Meer info.

Naam

Omschrijving

Type

Verplicht/
Optioneel

Mapping op uitgebreide interface

Naam

Omschrijving

Type

Verplicht/
Optioneel

Mapping op uitgebreide interface

Naam

De familienaam van de persoon die het dossier heeft gestart/aangevraagd

String

Optioneel
String
(0 - 255)

Dossier.Aanvrager

Voornaam

De voornaam van de persoon die het dossier heeft gestart/aangevraagd

String

Optioneel
String
(0 - 255)

Dossier.Aanvrager

Niet-gemapte verplichte velden

TypeDossierCode = “DossierStatus”

📌 Deze waarde moet u altijd zo instellen.

Niet-gemapte optionele velden

Deze velden kunt u negeren en hoeft u niet mee te geven in de payload:

  • IsVertrouwelijk = false

  • IsPubliek = false

  • IsNietRaadpleegbaar = false

Meertaligheid

Wilt u dossierstatussen in een andere taal dan het Nederlands te sturen? Volg dan de instructies op Overzicht basisbegrippen DOSIS | Meertaligheid