Versions Compared

Key

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

...

De inkomende en uitgaande sleutelwaardeparen zijn identiek. Bovendien zijn de sleutelwaardeparen identiek voor beide kanalen: passief en e-mail.

Verplichte Sleutels

Waarde

Omschrijving

Titel

string

De titel van de notificatie

Body

string

Vrij te kiezen tekst met beperkte opmaakmogelijkheden. De toegelaten html-tags zijn:

  • <p>

  • <ul>

  • <ol>

  • <li>

Optionele Sleutels

Waarde

Omschrijving

DocumentLinkUri

string

Een deep-link naar meer informatie voor de bestemmeling, vb. naar de detailpagina in het loket van het agentschap van de broninformatie.

ExterneLinkNaam

string - maximum 25 karakters

Het label dat moet gebruikt worden voor de deep-link

Template voor de NotificatieCategorie “Vervaldagbericht”

De inkomende en uitgaande sleutelwaardeparen zijn identiek. Bovendien zijn de sleutelwaardeparen identiek voor beide kanalen: passief en e-mail.

Verplichte Sleutels

Waarde

Omschrijving

ArtikelNaam

string

De naam van het product dat vervalt, bijvoorbeeld: “Elektronische identiteitskaart”

Vervaldatum

string (datum/tijd)

De effectieve datum waarop het artikel vervalt

Optionele Sleutels

Waarde

Omschrijving

BegeleidendeInfo

string

Vrij te kiezen aanvullende tekst met beperkte opmaakmogelijkheden. Dit is niet de body van de notificatie. Toegelaten HTML-tags zijn

  • <p>

  • <ul>

  • <ol>

  • <li>

DocumentLinkUri

string

Een deeplink naar meer informatie voor de bestemmeling, bijv. naar de detailpagina van het product in het loket van het agentschap dat de broninformatie beheert

ExterneLinkNaam

string

Het label dat moet gebruikt worden voor de deep-link

Een voorbeeld van een payload met informatie over een vervaldagbericht:

...

Info

De volgende velden hoeft u niet in te vullen:

  • Afzenderorganisatiecode: Digitaal Vlaanderen vult hier de OVO-code in van de organisatie die de notificaties verstuurt. De OVO-code is gekend uit de ACM Client claims.

  • Merkcode: staat al vooraf geconfigureerd door Digitaal Vlaanderen

Note

Schrijf OVO-code altijd met hoofdletters.