Versions Compared

Key

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

...

GIPOD voorziet in een systeem van passieve notificaties. Dit is een pull systeem waarbij een organisatie relevante notificaties komt ophalen in het GIPOD-systeem.

API

Notificatie bericht

Een notificatie bevat 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",
}

...

Functionaliteiten

Volgende functionaliteiten zullen via de API voorzien worden.

...