Document toolboxDocument toolbox

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


Configuratie Toelatingen

Link naar Swagger-documentatie: https://tni.dosis.dev-vlaanderen.be/api/bron/swagger/index#/Toelating

POST /api/v2/dosis/bron/toelatingen

Alle velden zijn verplicht

 

{
"Identificatie": {
"BronId": 0,
"Referentie": "string"
},
"Toelating": {
"ReferentieNummer": "string",
"Titel": "string",
"Omschrijving": "string",
"DoorverwijzingUrl": "string",
"AangemaaktOp": "2023-09-14T13:25:04.451Z",
"IsPubliek": true,
"ProductId": 0,
"ToegekendDoor": {
"OrganisatieCode": "string",
"Naam": "string"
},
"ToegekendAan": {
"Identificatie": "string"
},
"AangevraagdDoor": {
"Identificatie": "string"
},
"Status": {
"WijzigingsDatum": "2023-09-14T13:25:04.451Z",
"StartDatum": "2023-09-14T13:25:04.451Z",
"EindDatum": "2023-09-14T13:25:04.451Z",
"HernieuwingsDatum": "2023-09-14T13:25:04.451Z",
"Dossier": {
"Nummer": "string"
}
}
}
}

Veld

Toelichting

Veld

Toelichting

BronId

Op te halen via https://tni.dosis.dev-vlaanderen.be/api/bron/swagger/index#!/Bron/Bron_GetBronUris
BronURI ontvangen tijdens aansluitingsproces

Indien u al Dossierstatusinformatie aanbiedt via een bepaalde bron, gebruik dan zeker dezelfde bron om de gelinkte Toelating te versturen.

Referentie

Wordt niet getoond op het scherm

De combinatie van de BronID en Referentie moet uniek zijn.

Referentienummer

Wordt getoond op het scherm, kan idem zijn aan de Referentie

DoorverwijzingUrl

Verwijst naar de effectieve Toelating (pdf, certificaat, link naar een portaal, enz.)
Geen SSO mogelijk

Aangemaakt op

Datum waarop de Toelatinginformatie wordt ontvangen door Digitaal Vlaanderen

IsPubliek

Voor burgers: altijd false

Voor ondernemers/verenigingen: vrij te kiezen true of false

Eenmanszaken: altijd false (GDPR)

ProductId

IPDC-product/-dienst

Toegekend door

Dienst die de Toelating aanmaakt - OVO-code + Naam (vrij tekstveld)

Toegekend aan

Agent: rijksregisternummer, KBO-nummer of V-code

Aangevraagd door

Agent: rijksregisternummer, KBO-nummer of V-code

Status

Wijzigingsdatum en Startdatum zijn verplicht

Formaat: 2023-04-20T11:08:05+1:00

Einddatum is einde geldigheidsduur

Hernieuwingsdatum: kan vooraf worden meegegeven zodat bijv. op basis van deze datum een notificatie kan verstuurd worden om de ontvanger te verwittigen dat de einddatum er binnen afzienbare tijd aankomt, en dat bijv. een opleiding moet gepland worden.

Dossier

niet verplicht

Dossiernummer zoals in DOSIS voor dezelfde BronId (case-sensitive)

Deze link blijft geldig bij opvragen van dossier en/of toelating.

 

POST /api/v2/dosis/bron/bronnen/{bronId}/toelatingen/{referentie}/event

Veld

Toelichting

Veld

Toelichting

Status

Wijzigingsdatum en Startdatum zijn verplicht

Formaat: 2023-04-20T11:08:05+1:00

Einddatum is einde geldigheidsduur

Hernieuwingsdatum: kan vooraf worden meegegeven zodat bijv. op basis van deze datum een notificatie kan verstuurd worden om de ontvanger te verwittigen dat de einddatum er binnen afzienbare tijd aankomt, en dat bijv. een opleiding moet gepland worden.

Dossier

niet verplicht

Dossiernummer zoals in DOSIS voor dezelfde BronId (case-sensitive)

Deze link blijft geldig bij opvragen van dossier en/of toelating.

Schrijf OVO-code altijd met hoofdletters.

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