...
Id: unieke identificator van de notificatie (Guid)
Category: Categorie van de notificatie. Mogelijke waarden: Information, Warning, Task
NotificatieType: Type 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.
ExpiresOn: tijdstip waarop de notificatie zal verwijderd worden uit het GIPOD-systeem.
API
Volgende functionaliteiten worden voorzien in de Api:
zoeken notificaties
opvragen detail van een notificatie
opvragen notificatie types
Zoeken notificaties
Opvragen van een lijst van notificaties obv volgende criteria:
notificationTypeorganisationId
notificationTypeId
categorycategoryId
createdOn
Indien geen “organisationId” wordt meegegeven zal de response de notificaties bevatten voor alle organisatie in organisatie structuur van de ingelogde organisatie.
Endpoint:
GET api\v1\notifications?
...
organisationId=¬ificationTypeId=&categoryId=&createdOn.start=&createdOn.end=
Opvragen detail van een notificatie
...
Code Block | ||
---|---|---|
| ||
{ "@id": "api\v1\notifications\8bc826d8-645b-4926-b4dd-1cfbeea6d289", "value":"8bc826d8-645b-4926-b4dd-1cfbeea6d289", "notificationCategory": { "@id": "api\v1\notification-categories\e20f39f9-a2d8-4161-8a4a-fe1d3b9b17af", "value":"e20f39f9-a2d8-4161-8a4a-fe1d3b9b17af", "prefLabel":"Information", "definition":"Informational notification", }, notificationType": { "id":"api\v1\taxonomies\notificationtypes\eafe63a5-cbea-4a24-b16b-9932b9a2f324", "value": "eafe63a5-cbea-4a24-b16b-9932b9a2f324", "prefLabel":"TrenchSynergyRequestReceived", "definition":"TrenchSynergyRequestReceived" }, "OrganisationId": { "@id":"api\v1\organisations\17596932-6e85-4103-b037-824bbfcd74d0", "value":"17596932-6e85-4103-b037-824bbfcd74d0", "preferredName":"Agentschap Informatie Vlaanderen" }, "metadata": [{ "key": "TrenchSynergyRequest", "value": "api\\v1\\groundworks\\12345\\trench-synergy-requests\\1" }], "createdOn": "2020-04-07T06:57:39Z", "expiresOn": "2020-05-07T06:57:39Z" } |
Volgende functionaliteiten zullen via de API voorzien worden.
...
GIPOD-systeem
Het GIPOD-systeem maakt notificaties aan en zal deze automatisch verwijderen na het verval tijdstip.
...