...
Id: unieke identificator van de notificatie (Guid)
Category: Categorie van de notificatie. Mogelijke waarden: InformationInformatie, WarningWaarschuwing, TaskTaak
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 van de beschikbare notificatie types
Zoeken notificaties
Opvragen detail van een notificatieopvragen
Opvragen notificatie-types
Zoeken notificaties
Opvragen van een lijst van notificaties obv volgende criteria:
...
organisationId
notificationTypeId
categoryId
createdOn
...
Example:
GET api\v1\notifications?notificationTypeId=eafe63a5-cbea-4a24-b16b-9932b9a2f324
| Code Block |
|---|
{
"@context": "http://www.w3.org/ns/hydra/context.jsonld",
"@id": "\api\v1\notifications",
"@type": "Collection",
"totalItems": "23",
"member": [
{
"@id": "api\v1\notifications\a26e477c-f10b-4d7f-bba9-60228e092b75",
notificationType": {
"id":"api\v1\taxonomies\notificationtypes\eafe63a5-cbea-4a24-b16b-9932b9a2f324",
"prefLabel":"TrenchSynergyRequestReceived",
}
},
{
"@id": "\api\v1\notifications\d454970a-35d5-41c9-a832-dc940c061e17",
notificationType": {
"id":"api\v1\taxonomies\notificationtypes\eafe63a5-cbea-4a24-b16b-9932b9a2f324",
"prefLabel":"TrenchSynergyRequestReceived",
}
},
...
]
} |
Opvragen detail van een notificatie
...
| Code Block | ||
|---|---|---|
| ||
{
"@id": "api\v1\notifications\8bc826d8-645b-4926-b4dd-1cfbeea6d289",
"value":"8bc826d8-645b-4926-b4dd-1cfbeea6d289",
"category": {
"@id": "api\v1\taxonomies\notification-categories\e20f39f9-a2d8-4161-8a4a-fe1d3b9b17af",
"value":"e20f39f9-a2d8-4161-8a4a-fe1d3b9b17af",
"prefLabel":"Information",
"definition":"An informational notification.",
},
notificationType": {
"id":"api\v1\taxonomies\notificationtypes\eafe63a5-cbea-4a24-b16b-9932b9a2f324",
"value": "eafe63a5-cbea-4a24-b16b-9932b9a2f324",
"prefLabel":"TrenchSynergyRequestReceived",
"definition":"Notification that a new trench synergy request is received by your organisation."
},
"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"
} |
...