Wat

Notificaties zijn berichten bedoeld ter ondersteuning van de business processen binnen het GIPOD-systeem. De bestemmeling van een notificatie is steeds een organisatie gekend binnen het GIPOD-systeem. Op basis van een notificatie wordt een organisatie verwittigd van een bepaalde gebeurtenis binnen het GIPOD-systeem zodat deze kan nagaan of er al dan niet een actie moet worden ondernomen.

Passieve notificaties

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

API

Notificatie

Een notificatie bevat volgend volgende informatie:

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

Voorbeeld

{
  "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",
  "readOn": "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
  • createdOn
• Opvragen detail van een notificatie
• Markeer een notificatie als gelezen

...