Wat

Het informeren van organisaties of personen van gebeurtenissen of te ondernemen acties Notificaties zijn bedoeld ter ondersteuning van de business processen binnen het GIPOD-systeem.

Passieve notificaties

In een eerste fase zal GIPOD voorzien in een systeem van passieve notificaties. Dit is een pull systeem waarbij een organisatie relevante notificaties voor komt ophalen in het GIPOD-systeem.

Notificatie

Een notificatie bevat volgend informatie:

(Pull)

De organisatie of personen nemen zelf actie om de notificatie berichten te komen ophalen in het GIPOD-systeem op een zelf gekozen tijdstip.

Custom Queries

• Custom endpoints op de API
  • bijv: ontvangen synergie-aanvragen

Notificaties API

• Publiceren van events via een API

Actieve notificaties

(Push)

Het GIPOD-systeem stuurt zelf notificatie berichten uit naar geïnteresseerde organisaties of specifieke gebruikers binnen deze organisaties.

API 2 API

Webhooks

Email

...

• Id: unieke identificator van de notificatie (Guid)
• Category: Categorie van de notificatie. Mogelijke waarden: Informational, Warning, Task
• Name: naam van de notificatie.
• OrganisationId: de organisatie waarvoor de notificatie bestemd is.
• Metadata: sleutelwaarden met extra informatie. De mogelijke sleutelwaarden kunnen verschillen afhankelijk van de notificatie.
• CreatedOn: tijdstip waarop de notificatie werd aangemaakt.
• ReadOn: tijdstip waarop de notificatie werd gelezen.
• ExpireOn: tijdstip waarop de notificatie zal verwijderd worden uit het GIPOD-systeem.

{
    "id": "8bc826d8-645b-4926-b4dd-1cfbeea6d289",
    "category": "Informational",
    "name": "TrenchSynergyRequestReceived",
    "OrganisationId": "17596932-6e85-4103-b037-824bbfcd74d0",
    "metadata": [{
        "key": "TrenchSynergyRequest",
        "value": "api\v1\groundworks\12345\trench-synergy-requests\1"
    },
   "createdOn": "2020-04-07T06:57:39Z",
   "readAt": "2020-04-10T08:05:47Z",
   "expiresOn": "2020-05-07T06:57:39Z",
}

API

Volgende functionaliteiten zullen via de API voorzien worden.

• Opvragen van een lijst van notificaties obv volgende criteria:
  • naam
  • organisatie
  • category
  • Category
• Opvragen detail van een notificatie
• Markeer een notificatie als gelezen

GIPOD-systeem

Het GIPOD-systeem maakt notificaties aan en zal deze automatisch verwijderen na het verval tijdstip.