GIPOD

Inleiding

Connectie met GIPOD is nodig om een inname van de publieke ruimte aan te vragen. Typische use case is de organisatie van een evenement.

Protocol

Onboarding

Neem contact op met Athumi Vlaanderen om de connectie voor je dienstverlening te maken. Grosso modo doorloop je onderstaande stappen.

Aansluiting aanvragen bij Athumi via e-mailadres: gipod@athumi.eu.
Athumi zet de testomgeving op en bezorgt je een 0Auth clientId voor toegang tot de testomgeving.
Log in bij het beheerdersportaal om de 0Auth clientID te beheren en er een gevalideerde public key (certificaat onder de vorm van .jwks-bestand) op te laden.
Koppelen met testomgeving en valideren van de connectie.
Athumi zet de productieomgeving op en bezorgt je een 0Auth clientId voor toegang tot de productieomgeving.
Log in bij het beheerdersportaal om de 0Auth clientID te beheren en er een gevalideerde public key (certificaat onder de vorm van .jwks-bestand) op te laden.
Koppelen met productieomgeving en verder operationaliseren.

Deze stappen zijn in grote lijnen dezelfde als voor aansluiting met MAGDA.

Maven dependency in pom.xml

Voeg onderstaande maven dependency toe in je pom.xml. Dit zorgt ervoor dat de connector code binnengehaald en meegenomen wordt in de build van je applicatie.

CODE

<dependency>
   <groupId>com.skryv.connectors</groupId>
   <artifactId>gipod</artifactId>
   <version>${skryv.version}</version>
</dependency>

Applicatie eigenschappen

GIPOD-specifieke applicatie eigenschappen.

Eigenschap	Uitleg
`skryv.connectors.geosecure.gipod.scope`	Scope bevat info die je ontvangt tijdens het onboardingproces.
`skryv.connectors.geosecure.gipod.keypath`	Private JWK.
`skryv.connectors.geosecure.gipod.aws.keypath`	JWK in AWS Secrets Manager.

Interface

De interface verloopt via een formulier dat je opzet binnen de context van het dossier. Hierin verzamel je de nodige inputdata.

Input	Type veld	Beschrijving
Inname	Kaart	Polygoon die het in te nemen gebied definieert.
Startdatum	Datum (string met masker)	Startdatum inname publieke ruimte.
Einddatum	Datum (string met masker)	Einddatum inname publieke ruimte.
E-mailadres contactpersoon	E-mail	Persoon die de inname van de publieke ruimte aanvraagt (bijvoorbeeld de organisator van het evenement).
Beschrijving	Tekst	Beschrijving doel of aard van de inname (bijvoorbeeld de naam van het evenement).

Typische flow

De registratie van een inname publiek domein volgt een typische flow in drie stappen.

Check bij GIPOD of er geen conflicterende inname publiek domein aanwezig is (zie getPublicOccupancies).
Indien OK, registreer dan de inname bij GIPOD. Je krijgt een ID terug (zie registerEvent). Opgelet: de inname is geregistreerd, maar nog niet bevestigd.
Bevestig de inname bij GIPOD (zie updateEventStatus). De inname is nu definitief.

Indien nodig, is het uiteraard mogelijk om de inname opnieuw ongedaan te maken (zie deleteEvent).

Services en functies

deleteEvent

Deze verwijdert een eerder geregistreerd evenement bij GIPOD op basis van de ID zoals die gekend is bij GIPOD zelf.

Zie service taak template ‘Verwijder evenement’.

Workflow expression

${gipodService.deleteEvent(gipodEventId)}

Input

Inputparameters	Datatype	Voorbeeld	Uitleg
gipodEventId	String	-	Procesvariabele waarin de ID van het GIPOD evenement opgeslagen zit.

Output

Geen Output.

getPublicOccupancies

Check bij GIPOD of er al een inname publiek domein voor de opgegeven parameters bestaat. Indien ja, dan is er sprake van een conflict dat vervolgens weggeschreven wordt naar de resultaatvariabele.

Zie service taak template ‘Register public domain occupation’.

Workflow expression

${gipodService.getPublicOccupancies(execution.processBusinessKey, "formKey", "identiteit.kaart", "identiteit.startdatum", "identiteit.einddatum")}

Input

Inputparameters	Datatype	Voorbeeld	Uitleg
execution.processBusinessKey	String	-	Dossier ID
formKey	String	-	Key van het formulier waarin de inputdata voor de GIPOD-registratie opgeslagen zitten.
identiteit.kaart	String	-	Referentie naar de kaartcomponent in het formulier
identiteit.startdatum	String	-	Referentie naar de startdatum in het formulier
identiteit.einddatum	String	-	Referentie naar de einddatum in het formulier

Output

Outputparameters	Datatype	Voorbeeld	Uitleg
conflict	String	-	Procesvariabele waarin het GIPOD conflict wordt opgeslagen.

registerEvent

Registreer bij GIPOD een inname publiek domein op basis van de opgegeven informatie.

Zie service taak template ‘Registreer evenement’.

Workflow expression

${gipodService.registerEvent(execution.processBusinessKey, "formKey", "emailPad", "beschrijvingPad", "kaartPad", "startdatumPad", "einddatumPad")}

Input

Inputparameters	Datatype	Voorbeeld	Uitleg
execution.processBusinessKey	String	-	Dossier ID
formKey	String	-	Key van het formulier waarin de inputdata voor de GIPOD-registratie opgeslagen zitten.
emailPad	String	-	Referentie naar e-mailadres contactpersoon in het formulier
beschrijvingPad	String	-	Referentie naar beschijvingsveld (aard of doel van de inname)
kaartPad	String	-	Referentie naar de kaart component
startdatumPad	String	-	Referentie naar de startdatum in het formulier
einddatumPad	String	-	Referentie naar de einddatum in het formulier

Output

Outputparameters	Datatype	Voorbeeld	Uitleg
gipodEventId	String	-	Procesvariabele waarin de ID van het GIPOD evenement opgeslagen wordt.

updateEventStatus

Deze bevestigt een eerder geregistreerd evenement bij GIPOD op basis van de ID zoals die gekend is bij GIPOD zelf.

Zie service taak template ‘Bevestig evenement’.

Workflow expression

${gipodService.confirmEvent(gipodEventId)}

Input

Inputparameters	Datatype	Voorbeeld	Uitleg
gipodEventId	String	-	Procesvariabele waarin de ID van het GIPOD evenement opgeslagen zit.

Output

Geen output.