Notificatie-gegevens
Notificatie-categorie
Verplichte sleutelwaardeparen:
Volgende sleutelwaardeparen zijn verplicht aan te leveren voor de gekozen kanalen. Het ontbreken van deze waarden zal ertoe leiden dat de aangeboden bundel geweigerd wordt bij de validatiestap.
SleutelWaarde | Omschrijving |
---|---|
ArtikelNaam | De naam van het product dat komt te vervallen, bijvoorbeeld “Elektronische identiteitskaart“. |
Vervaldatum | De effectieve datum waarop het artikel vervalt. |
Optionele sleutelwaardeparen:
Optionele sleutelwaardeparen zijn niet verplicht. Ze kunnen meegeleverd worden indien beschikbaar, maar het ontbreken ervan leidt niet tot validatiefouten. Sommige door de Notificatie-component verrijkte waarden kunnen eveneens worden overschreven (op voorwaarde dat ze in deze lijst staan), waarbij de aanleverende kant voorrang krijgt.
SleutelWaarde | Omschrijving |
---|---|
BegeleidendeInfo | Vrij te kiezen aanvullende tekst met beperkte opmaakmogelijkheden. Dit is niet de body van de notificatie. Momenteel toegalaten html tags zijn <p>, <ul>, <ol>, <li>. |
DocumentLinkUri | Een deep-link naar de detail pagina in het loket van het agentschap. |
ExterneLinkNaam | Het label dat moet gebruikt worden voor de deep-link |
Deze sleutelwaardeparen worden door de Notificatie-component ingevuld aan de hand van contextuele informatie en gegevens afkomstig uit andere systemen. Ze maken dus enkel deel uit van de ontsloten Notificatie, en niet van de aangeboden NotificatieBundel.
SleutelWaarde | Omschrijving |
---|---|
MerkNaam | |
NotificatieDatum | TODO |
In de ontsloten Notificatie zijn volgende sleutelwaardeparen beschikbaar. Met andere woorden, deze sleutelwaardeparen zijn beschikbaar voor de weergave en verwerking van meldingen naar een eindgebruiker toe. Merk op dat voor verschillende kanalen een andere set van resulterende sleutelwaardeparen mogelijk is.
Kanaal | SleutelWaarde | Omschrijving |
---|---|---|
Passief | ArtikelNaam | De naam van het product dat komt te vervallen, bijvoorbeeld “Elektronische identiteitskaart“. |
BegeleidendeInfo | Vrij te kiezen aanvullende tekst met beperkte opmaakmogelijkheden. Dit is niet de body van de notificatie. Momenteel toegalaten html tags zijn <p>, <ul>, <ol>, <li>. | |
DocumentLinkUri | Een deep-link naar de detail pagina in het loket van het agentschap. | |
ExterneLinkNaam | Het label dat moet gebruikt worden voor de deep-link | |
MerkNaam | ||
NotificatieDatum | TODO | |
Vervaldatum | De effectieve datum waarop het artikel vervalt. |