FOCUS

Inleiding

FOCUS is de softwareapplicatie die lokale politiezones gebruiken om evenementen te beheren. De FOCUS-connector legt een link met deze applicatie om enerzijds evenementgegevens door te spelen (een happening) en anderzijds advies van de politie over dat evenement op te vragen en op te volgen (een adviesaanvraag).

Use case

De FOCUS-connector wordt ingezet in evenementgerelateerde dossiers waarbij een advies van de lokale politie nodig is vooraleer een evenement (sportmanifestatie, festival, rommelmarkt, enzovoort) kan doorgaan of vergund wordt.

Typisch verloop binnen een Skryv-toepassing:

1. Een burger of organisator dient een evenementaanvraag in via het digitale loket.

2. De workflow maakt een happening aan in FOCUS (addHappening) met de evenementgegevens uit het dossier.

3. De workflow voegt een adviesaanvraag toe voor de bevoegde politiezone (addAdviceRequest).

4. Zolang er nog geen advies is, pollt de workflow periodiek (bijvoorbeeld via een timer-event) of het advies al beschikbaar is (getUnconfirmedAdvice).

5. Zodra een advies beschikbaar is, haalt de workflow het advies en eventuele bijlagen op (getAdvice, saveAdviceAttachment) en bevestigt de ontvangst (confirmAdvice).

6. Het advies dient als input voor de verdere afhandeling van het dossier, bijvoorbeeld bij de beslissing of de motivering ervan.

7. Wordt de aanvraag ingetrokken of geannuleerd vóór het advies binnen is, dan trekt de workflow de adviesaanvraag in (repealAdviceRequest).

Setup

Onboarding bij FOCUS

Neem via de lokale politiezone contact op met het FOCUS-team om de onboardingprocedure te doorlopen. Tijdens dit proces verkrijg je de informatie die je via de applicatie eigenschappen moet toevoegen. Je krijgt ook toegang tot de FOCUS OpenAPI-specificatie. Die heb je nodig om specifieke calls op te bouwen.

Dependency toevoegen in het pom.xml bestand

Voeg onderstaande dependency toe aan het pom.xml bestand van je applicatie. Dit zorgt ervoor dat de connector code ingeladen wordt bij de build van de applicatie.

 <dependency>
      <groupId>com.skryv.connectors</groupId>
      <artifactId>focus</artifactId>
 </dependency>

Applicatie eigenschappen

Services en functies

Overzicht

@RequiredArgsConstructor
public class MyOwnService {
    private final FocusConnector focus;
}

addHappening

Java-code

Object response = focus.addHappening(request);

Input

Top-level structuur van request (beide verplicht):

• happening: de kerngegevens van het evenement: startTime, endTime, name (max 255), happeningTypeKey (enum: escort, filmShoot, localSoccer, manifestation, publicDomainIntake, studentActivity), externalId, externalReference, en location (één van vier varianten: fixedLocation, multipleFixedLocations, trail of specialLocation).

• providerData: bijkomende context zoals contactpersonen, locatie-intakes, hindermuziek, activiteiten (bv. drones met piloten) en beveiliging/diensten.

Voor de volledige, gedetailleerde structuur (verplichte velden, enums, varianten) verwijzen we naar de FOCUS OpenAPI-documentatie zelf.

Output

Geen response body.

Error-handling

getHappening

Java-code

Object response = focus.getHappening(externalId);

Input

Output

Object, ongetypeerd. De spec definieert voor dit endpoint geen response-schema (enkel de statuscodes).

Error-handling

updateHappening

Java-code

Object response = focus.updateHappening(externalId, request);

Input

Output

Object, ongetypeerd. Geen response-schema gedefinieerd (net als bij getHappening/addHappening).

Error-handling

addAdviceRequest

Java-code

Object response = focus.addAdviceRequest(externalId, adviceRequestId, request);

Input

Structuur van request (verplicht: type):

• type (string, max 50): bv. "Technisch advies".

• options (array, min. 2 items): de mogelijke adviesuitkomsten, elk met label, value (patroon ^[a-zA-Z0-9_]*$) en optioneel fields (extra invulvelden met key, label, required, maxLength).

• attachments (optioneel): allowedTypes (array, bv. "IMAGE") en maxAmount (1 tot 10).

Output

Geen output, anders dan statuscodes.

Error-handling

getUnconfirmedAdvice

Deze functie is een pollingstap: ze haalt de volledige lijst van onbevestigde adviezen op voor de eigen provider (GET /happenings/{provider}/advices/unconfirmed) en filtert die client-side op externalId. Er is geen server-side filterparameter. Bij elke aanroep wordt dus de volledige lijst opgehaald en pas daarna doorzocht.

Java-code

UnconfirmedAdvice advice = focus.getUnconfirmedAdvice(externalId);

Input

Output

Error-handling

getAdvice

Java-code

HappeningsProviderExternalIdAdviceRequestsAdviceRequestIdAdviceGet200Response response =
        focus.getAdvice(externalId, adviceRequestId);

Input

Output

Error-handling

saveAdviceAttachment

Java-code

Attachment attachment = focus.saveAdviceAttachment(dossierId, externalId, adviceRequestId, attachmentId);

Input

Output

Een Attachment, opgeslagen bij het opgegeven dossier. Bestandsnaam en content-type worden niet uit het JSON-antwoord gehaald, maar rechtstreeks uit de HTTP-headers van FOCUS: de bestandsnaam komt uit Content-Disposition, het content-type uit Content-Type. De connector saniteert de bestandsnaam (verwijdert niet-toegelaten tekens) en garandeert dat er een extensie aanwezig is.

Error-handling

repealAdviceRequest

Java-code

focus.repealAdviceRequest(externalId, adviceRequestId);

Input

De connector verstuurt hierbij zelf een leeg JSON-object als request body. Er is geen inhoudelijke input mee te geven.

Output

Geen output, anders dan statuscodes.

Error-handling

confirmAdvice

Java-code

Object response = focus.confirmAdvice(advice); // advice: UnconfirmedAdvice

Input

De connector haalt intern zelf eerst getAdvice() op om de confirmationToken te vinden, en stuurt die dan door naar FOCUS — je geeft die token dus niet zelf mee.

Output

Geen inhoud, anders dan statuscodes.

Error-handling