...

Een notificatie bevat volgende informatie:

• Id: unieke

  • Unieke identificator van de notificatie (Guid)

• Category:

  • Categorie van de notificatie.

  • Mogelijke waarden:

    • Informatie

  ,

  • • .

    • Waarschuwing

  ,

  • • .

    • Taak.

• NotificatieType:

  • Type van de notificatie.

• OrganisationId:

  • De organisatie waarvoor de notificatie bestemd is.

  • Indien de OrganisatieId niet is ingevuld betreft het een notificatie die voor alle organisaties relevant zijn.

• Metadata: Sleutelwaarden Data:

  • Lijst van sleutelwaarden met extra informatie voor deze notificatie.

  • De mogelijke sleutelwaarden

  kunnen

  • verschillen

  afhankelijk van de

  • per notificatie type.

• CreatedOn:

  • Tijdstip waarop de notificatie werd aangemaakt door het GIPOD-systeem.

• ExpiresOn: tijdstip

  • Tijdstip waarop de notificatie zal verwijderd worden uit het GIPOD-systeem.

• Status:

  • Bij aanmaak van een notificatie krijgt deze de status: Nieuw.

Api

Volgende functionaliteiten worden voorzien:

• Taxonomieën

  • Opvragen van de beschikbare notificatie types.

  • Opvragen notificatie categoriën.

  • Opvragen notificatie statussen.

• Zoeken notificaties op basis van filter criteria.

• Opvragen detail van een bepaalde notificatie.

• Aanpassen status van een bepaalde notificatie.

Opvragen notificatie types

...

Volgende categorieën worden voorzien:

• Information

• Warning

• Task

Endpoints:

...

Volgende statussen worden voorzien:

• Nieuw

• AfgehandeldGelezen

• … (statussen te valideren en nog verder te definiëren)

...

• GET api\v1\taxonomies\statuses

• GET api\v1\taxonomies\statuses\{notificationstatusid}

Zoeken notificaties

Opvragen van een lijst van notificaties obv volgende criteriaZoeken notificaties bestemd voor de geautentiseerde organisatie. Vervallen notificaties worden niet teruggeven in het resultaat.

Volgende criteria worden voorzien:

• organisatie

  • Indien de organisatie niet wordt meegegeven worden alle notificaties binnen de organisatie-structuur van de ingelogde organisatie teruggegeven.

• notificatie type notificatie

• category

• creatie tijdstip

• status

...

{
  "@id":"api\v1\notifications\8bc826d8-645b-4926-b4dd-1cfbeea6d289",
  "value":"8bc826d8-645b-4926-b4dd-1cfbeea6d289",
  "notificationCategory": {
      "@id": "api\v1\taxonomies\notification-categories\e20f39f9-a2d8-4161-8a4a-fe1d3b9b17af",
      "prefLabel":"Information"
  },
  "notificationType": {
      "@id":"api\v1\taxonomies\notificationtypes\eafe63a5-cbea-4a24-b16b-9932b9a2f324",
      "prefLabel":"TrenchSynergyRequestReceived"
  },
  "organisation": {
      "@id":"api\v1\organisations\17596932-6e85-4103-b037-824bbfcd74d0",
      "preferredName":"Agentschap Informatie Vlaanderen"
  },
  "metadatadata": [{
      "key":"TrenchSynergyRequest",
      "value":"api\v1\groundworks\2345\trench-synergy-requests\1"
  }],
  "createdOn":"2020-04-07T06:57:39Z",
  "expiresOn":"2020-05-07T06:57:39Z",
  "status": {
      "@id":"api\v1\taxonomies\statuses\48c22307-fce2-41c9-910a-b57f5b471246",
      "prefLabel":"Behandeld"
  }
}

...