Documentatie voor klanten en partners van Digitaal Vlaanderen - bouwstenen Mijn Burgerprofiel, Verenigingsloket en e-loketondernemers
Dossierstatusinformatie via een vereenvoudigde interface
- Heidi Vannevel
- christophe.vanderhaeghen
- pascal.vancauwenberghe
- 1 Over de vereenvoudigde interface
- 2 Link naar de Swagger-documentatie
- 3 Overzicht velden vereenvoudigde interface
- 3.1 Dossierstatus
- 3.2 Dossieridentificatie
- 3.3 Contact
- 3.4 Adres
- 3.5 Agent
- 3.5.1 BurgerAgent
- 3.5.2 OndernemerAgent
- 3.5.3 VerenigingsAgent
- 3.6 Aanvrager
- 3.7 Niet-gemapte verplichte velden
- 3.8 Niet-gemapte optionele velden
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
| 
|
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/ | 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 | 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 |
ProductId | De IPDC-ID (getal) van het product of de dienst waarop het dossier betrekking heeft. | Integer | Verplicht | Dossier.Producten[0].ProductId |
OSLO-standaard - Vlaamse status - Fase | String | Verplicht | Dossier.Status.VlaamseFase | |
OSLO standaard - Vlaamse status - Code | String | Verplicht | Dossier.Status.VlaamseCode | |
DetailStatus | Vrij in te vullen detailinformatie over de dossierstatus | String | Optioneel | Dossier.Status.Detail1 |
Actie | Omschrijving van de uit te voeren actie | String | Optioneel | Indien ingevuld en lengte > 0 en niet enkel whitespace: |
DoorverwijzingUrl | Hyperlink naar een applicatie waar er meer informatie over het dossier beschikbaar is. Moet een geldige URL zijn | URL | Optioneel | 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/ | Mapping op uitgebreide interface |
|---|---|---|---|---|
Bron | De bron (namespace) van het dossier, bv. http://www.agentschap.vl/applicatie. | URL | Verplicht | Dossier.Identificatie.Bron |
Nummer | Het unieke nummer van het dossier binnen de gekozen bron | String | Verplicht | Dossier.Identificatie.DossierNummer |
Contact
Naam | Omschrijving | Type | Verplicht/ | Mapping op uitgebreide interface |
|---|---|---|---|---|
Naam | De naam van de dossierbeheerder | String | Optioneel | Dossier.DossierBeheerder.Naam |
Dienst | De dienst van de dossierbeheerder | String | Optioneel | Dossier.DossierBeheerder.Dienst |
Telefoon | Het telefoonnummer van de dossierbeheerder | String | Optioneel | Dossier.DossierBeheerder.Telefoon |
Het e-mailadres van de dossierbeheerder eldig email-formaat hebben | String | Optioneel | Dossier.DossierBeheerder.Email | |
Website | De website van de dossierbeheerder | String | Optioneel | Dossier.DossierBeheerder.Website |
Adres | Adres | Optioneel | Dossier.DossierBeheerder.Adres |
Adres
Naam | Omschrijving | Type | Verplicht/ | Mapping op uitgebreide interface |
|---|---|---|---|---|
Straat | De straatnaam in het adres van de dossierbeheerder | String | Optioneel | Dossier.DossierBeheerder.Adres. |
Nummer | Het huisnummer (en eventueel het busnummer) in het adres van de dossierbeheerder. | String | Optioneel | Dossier.DossierBeheerder.Adres. |
Postcode | De postcode in het adres van de dossierbeheerder. | String | Optioneel | Dossier.DossierBeheerder.Adres. |
Gemeente | De gemeentenaam in het adres van de dossierbeheerder | String | Optioneel | Dossier.DossierBeheerder.Adres. |
Agent
BurgerAgent
Naam | Omschrijving | Type | Verplicht/ | 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/ | 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 | Lijst met strings | Verplicht 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/ | Mapping op uitgebreide interface |
|---|---|---|---|---|
VCodeNummer | Uniek verenigingsnummer, met als prefix “V”, aangevuld met 7 tot 9 cijfers. Bijvoorbeeld “V1234567” | String | Verplicht | Dossier.Agenten.Identificatie |
Toegangsrechten | De rollen waarmee een gebruiker toegang krijgt om het dossier te raadplegen Gebruik hier: CJM_Vloket_VER_CompEnt_DossierLezer | Lijst met strings | Verplicht Niet enkel whitespace | Dossier.Agenten.Toegangsrechten.Code
|
$type | Het type agent; voor een VerenigingsAgent is dit “Vereniging” (case insensitive) | String | Verplicht |
|
Aanvrager
Naam | Omschrijving | Type | Verplicht/ | Mapping op uitgebreide interface |
|---|---|---|---|---|
Naam | De familienaam van de persoon die het dossier heeft gestart/aangevraagd | String | Optioneel | Dossier.Aanvrager |
Voornaam | De voornaam van de persoon die het dossier heeft gestart/aangevraagd | String | Optioneel | Dossier.Aanvrager |
Niet-gemapte verplichte velden
TypeDossierCode = “DossierStatus”
Niet-gemapte optionele velden
Deze velden worden niet ingevuld:
IsVertrouwelijk = false
IsPubliek = false
IsNietRaadpleegbaar = false
Related content
Dit is een officiële website van de Vlaamse overheid - Uitgegeven door Digitaal Vlaanderen: https://www.vlaanderen.be/digitaal-vlaanderen
DISCLAIMER: http://www.vlaanderen.be/nl/disclaimer
TOEGANKELIJKHEID:
http://www.vlaanderen.be/nl/toegankelijkheid