Notificatie-gegevens

Onderstaande lijst geeft een overzicht, per notificatiecategorie, welke SleutelWaardeParen moeten meegeleverd worden bij een notificatie-verzoek. Daarnaast wordt ook getoond welke SleutelWaardeParen de notificatie-component zélf zal verrijken.

Notificatie-categorie

Opvragen

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
Body Tekst zonder enige opmaak met uitzondering van nieuwe lijnen in verschillende verschijningsvormen (line break, new line, carriage return, ...). Mag geen html-tags bevatten (ook geen <br> om een nieuwe lijn aan te geven). Maar moet wel speciale tekens kunnen bevatten voor het dagdagelijkse taalgebruik.
Titel Het onderscheidende element dat deel uitmaakt van een generieke titel in de notificatie of de volledige titel.

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
Aanspreektitel De Aanspreektitel van de bestemmeling.
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 Aanspreektitel De Aanspreektitel van de bestemmeling.
Body Tekst zonder enige opmaak met uitzondering van nieuwe lijnen in verschillende verschijningsvormen (line break, new line, carriage return, ...). Mag geen html-tags bevatten (ook geen <br> om een nieuwe lijn aan te geven). Maar moet wel speciale tekens kunnen bevatten voor het dagdagelijkse taalgebruik.
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
Titel Het onderscheidende element dat deel uitmaakt van een generieke titel in de notificatie of de volledige titel.