...
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
|
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:
| Code Block |
|---|
{
"Id": "e682c962-fe95-47d8-9cd2-65edc059d706",
"TransactieId": "interne-referentie-e42231b6-b98c-48fd-bcfc-2a535d10346b",
"AfzenderOrganisatieCode": "OVO000001",
"ProductId": "148",
"VerzendDatum": "2021-05-03T07:24:00Z",
"VervalDatum": "2021-05-05T00:00:00Z",
"Bestemmelingen": [
{
"Identificatie": "99999999999",
"Type": "RijksRegisterNummer"
}
],
"Categorie": {
"Code": "VervaldagBericht"
},
"Kanalen": [
{
"Type": "Email"
},
{
"Type": "Passief"
}
],
"SleutelWaardeParen": [
{
"Waarde": "Elektronische identiteitskaart",
"Sleutel": "ArtikelNaam"
},
{
"Waarde": "2021-06-03",
"Sleutel": "Vervaldatum"
},
{
"Waarde": "<p>Breng mee: <ul><li>oude identiteitskaart</li><li>uitnodiging om een nieuwe identiteitskaart op te halen</li></ul></p>",
"Sleutel": "BegeleidendeInfo"
},
{
"Waarde": "https://www.vlaanderen.be/elektronische-identiteitskaart-eid",
"Sleutel": "DocumentLinkUri"
},
{
"Waarde": "Elektronische identiteitskaart (eID)",
"Sleutel": "ExterneLinkNaam"
}
]
} |
Uitgestelde notificaties
Dit zijn notificatiebundels die worden aangemaakt om op een later tijdstip te versturen naar de bestemmeling.
...