/
Dossierstatusinformatie via een vereenvoudigde interface

Documentatie voor klanten en partners van Digitaal Vlaanderen - bouwstenen Mijn Burgerprofiel, Verenigingsloket en e-loketondernemers


Dossierstatusinformatie via een vereenvoudigde interface

 

Over de vereenvoudigde interface

Voor nieuwe DOSIS-aansluitingen wordt altijd de synchrone RegistreerDossierBasis gebruikt. 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.

{ "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": "string", "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
String
(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
String
(0 - 255)

Dossier.Status.VlaamseFase

VlaamseCode

OSLO standaard - Vlaamse status - Code

String

Verplicht
String
(0 - 255)

Dossier.Status.VlaamseCode

DetailStatus

Vrij in te vullen detailinformatie over de dossierstatus

String

Optioneel
String
(0 - 255)

Dossier.Status.Detail1

Actie

Omschrijving van de uit te voeren actie

String

Optioneel
String
(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
String
(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 Agent

Verplicht

Dossier.Agenten

Aanvrager

De naam van de aanvrager van het dossier

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, bv. http://www.agentschap.vl/applicatie.

URL

Verplicht
String
(0 - 255)