Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Functionele beschrijving

API’s Algemene Toelating

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

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

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

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

Update contactgegevens aanvrager

pdo_write

+ organisatie (of sub) is applicant van aanvraag

PUT /api/v1/general-permit-groundworks/{gipodID}/applicant/contactorganisations

Update contactgegevens domeinbeheerder

pdo_write

+ organisatie (of sub) is publicDomainAdministrator van aanvraag

PUT /api/v1/general-permit-groundworks/{gipodID}/public-domain-administrator/contactorganisations

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)

...

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

Opladen bijlage

pdo_write

POST /api/v1/attachments

Informatie domeinbeheerders ivm Algemene Toelating

...