Algemene Toelating voor grondwerken API's

API’s Algemene Toelating

Actie	Security - Door wie?	Endpoint / Velden / Business regels

Actie	Security - Door wie?	Endpoint / Velden / Business regels
Registratie door aanvrager	pdo_write	Business regel: krijgt automatisch de status “In aanvraag” `POST /api/v1/general-permit-groundworks` publicDomainAdministratorId (verplicht een organisatie die domeinbeheerder is (odbcode óf niscode)) applicantId (verplicht een hoofdorganisatie) applicantContactOrganisation applicationRemark (optioneel, max. 250 karakters) applicationAttachment[] (optioneel, max. 25MB per bijlage, max. 10 bijlagen, zie “Opladen bijlage” hieronder)
Goedkeuring door domeinbeheerder	pdo_write + organisatie (of sub) is domeinbeheerder (*) + organisatie (of sub) is publicDomainAdministrator van aanvraag	Business regel: kan enkel voor algemene toelatingen met de status “In aanvraag” `PUT /api/v1/general-permit-groundworks/{gipodID}/approve` permitAttachment / permitUrl (minimum één attachment of url, zie “Opladen bijlage” hieronder) PeriodStart / PeriodEnd publicDomainAdministratorContactInformation (contactgegevens van de domeinbeheerder) isPermitValidForEntireTerritory (geldt de vergunning voor het volledige grondgebied? false indien uitzonderingen vb. niet in historisch centrum) permitValidForGroundworkCategories (voor welke categorieën geldt deze algemene toelating) decisionRemark (optioneel, opmerking bij de beslissing van de domeinbeheerder) permitReference (optioneel, eigen referentie domeinbeheerder)
Weigering door domeinbeheerder	pdo_write + organisatie (of sub) is domeinbeheerder (*) + organisatie (of sub) is publicDomainAdministrator van aanvraag	Business regel: kan enkel voor algemene toelatingen met de status “In aanvraag” `PUT /api/v1/general-permit-groundworks/{gipodID}/decline` permitAttachment / permitUrl (minimum één attachment of url, zie “Opladen bijlage” hieronder) publicDomainAdministratorContactInformation (contactgegevens van de domeinbeheerder) decisionRemark (verplicht, opmerking bij de beslissing van de domeinbeheerder) permitReference (optioneel, eigen referentie domeinbeheerder)
Intrekken door domeinbeheerder	pdo_write + organisatie (of sub) is domeinbeheerder (*) + organisatie (of sub) is publicDomainAdministrator van aanvraag	Business regel: kan enkel voor algemene toelatingen met de status “Goedgekeurd” `PUT /api/v1/general-permit-groundworks/{gipodID}/revoke` revocationAttachment (minimum één attachment, zie “Opladen bijlage” hieronder) revocationRemark (verplicht, reden van de beslissing van de domeinbeheerder)
Update contactgegevens aanvrager	pdo_write + organisatie (of sub) is applicant van aanvraag	`PUT /api/v1/general-permit-groundworks/{gipodID}/applicant/contactorganisations` contactInformation
Update contactgegevens domeinbeheerder	pdo_write + organisatie (of sub) is publicDomainAdministrator van aanvraag	`PUT /api/v1/general-permit-groundworks/{gipodID}/public-domain-administrator/contactorganisations` contactInformation
Zoeken naar algemene toelatingen	pdo_read (iedereen met leesrechten tot GIPOD)	`GET /api/v1/general-permit-groundworks`
Opvragen detail algemene toelating	pdo_read (iedereen met leesrechten tot GIPOD)	`GET /api/v1/general-permit-groundworks/{gipodID}`

(*) domeinbeheerder: organisatie heeft een niscode (gemeente) of odbCode (andere domeinbeheerders)

Opladen bijlage

Omdat er validatie gebeurt op aanwezigheid van bijlagen, werd gekozen voor een systeem waar de bijlage éérst opgeladen wordt via een generiek endpoint POST /api/v1/attachments. Vervolgens wordt de referentie (GUID) naar deze bijlage meegegeven in het specifieke endpoint. Een bijlage die opgeladen werd via het generieke endpoint, kan slechts één keer gekoppeld worden aan een algemene toelating.

Actie	Security - Door wie?	Endpoint / Business regels

Actie	Security - Door wie?	Endpoint / Business regels
Opladen bijlage	pdo_write	POST /api/v1/attachments

Informatie domeinbeheerders ivm Algemene Toelating

Search API: GET /api/v1/publicdomainadministrators

Domeinbeheerder werkt met algemene toelating (generalPermitForGroundworksEnabled)
Link naar algemene voorwaarden voor het bekomen van een algemene toelating (generalPermitForGroundworksConditionsUri)