| Table of Contents | ||||
|---|---|---|---|---|
|
API-documentatie
We maken 2 types API-documentatie beschikbaar:
Voor de POST-call, die alleen kan gedaan worden door de afzender, vindt u hieronder een codevoorbeeld.
...
Een voorbeeld van een payload bij een notificatiebundel voor passieve notificaties:
| Code Block |
|---|
{
"VerzendDatum": null,
"Id": "92a6044e-362b-4562-a96b-f358d6b5da0f",
"Bestemmelingen": [
{
"Identificatie": "00010100173",
"Type": "RijksRegisterNummer"
},
{
"ContactInfo": {
"Email": "test@test.com"
},
"Type": "PersoonMetContactInfo"
},
{
"ContactInfo": {
"Email": "test@test.com"
},
"Type": "OrganisatieMetContactInfo"
},
{
"OndernemingsNummer": "0123321123",
"Type": "GeregistreerdeOrganisatie"
}
],
"Categorie": {
"Code": "TerugmeldingMelder"
},
"TransactieId": "interne-referentie-ea97ae17-3cc2-47cc-ab92-52da1c6a7afc",
"VervalDatum": "2023-09-07T11:43:41.573Z",
"Kanalen": [
{
"Type": "Passief"
}
],
"ProductId": "201",
"SleutelWaardeParen": [
{
"Waarde": "VoorbeeldWaarde",
"Sleutel": "VoorbeeldSleutel"
},
{
"Waarde": [
{
"Waarde": [
{
"Waarde": "VoorbeeldChildWaarde",
"Sleutel": "VoorbeeldChildListSleutel1"
},
{
"Waarde": "VoorbeeldChildListWaarde",
"Sleutel": "VoorbeeldChildListSleutel2"
}
],
"Sleutel": "0"
},
{
"Waarde": [
{
"Waarde": "VoorbeeldChildListWaarde",
"Sleutel": "VoorbeeldChildListSleutel1"
},
{
"Waarde": "VoorbeeldChildListWaarde",
"Sleutel": "VoorbeeldChildListSleutel2"
}
],
"Sleutel": "1"
}
],
"Sleutel": "VoorbeeldLijstObjecten"
},
{
"Waarde": [
{
"Waarde": "VoorbeeldChildWaarde",
"Sleutel": "VoorbeeldChildSleutel1"
},
{
"Waarde": "VoorbeeldChildWaarde",
"Sleutel": "VoorbeeldChildSleutel2"
}
],
"Sleutel": "VoorbeeldObject"
}
]
} |
Een voorbeeld van een payload bij een notificatiebundel voor een vrije notificaties:
| Code Block |
|---|
{
"Id": "85144567-7043-4469-9e79-279f4eb31e27",
"Bestemmelingen": [
{
"Identificatie": "80102529724",
"Type": "RijksRegisterNummer"
},
],
"Categorie": {
"Code": "VrijeNotificatie",
},
"TransactieId": "interne-referentie-111",
"VerzendDatum": "2021-07-27T14:25:05.514Z",
"VervalDatum": "2022-03-01T10:00:10.514Z",
"Kanalen": [
{
"Type": "Passief",
},
],
"ProductId": "130",
"SleutelWaardeParen": [
{
"Sleutel": "Body",
"Waarde": " Uw inschrijving tot de dienstenchequesportaal is bevestigd"
},
{
"Sleutel": "Titel",
"Waarde": "Inschrijving dienstencheques"
},
{
"Sleutel": "DocumentLinkUri",
"Waarde": "http://www.dienstencheques.vlaanderen.be/xxx"
},
{
"Sleutel": "ExterneLinkNaam",
"Waarde": "Meer informatie"
},
]
} |
...
De tijdzone moet ook ingevuld zijn (timezone = ISO 8601). Dit is noodzakelijk om te vermijden dat het tijdstip hetzelfde is, maar in een andere tijdzone.
De datum moet in de toekomst liggen
Er is geen minimum toekomstige datum. Gebruik dit veld zinvol: maak bijvoorbeeld geen notificatie die een half uur later kan worden uitgestuurd.
Er is echter wel een maximale datum in de toekomst, nl. vandaag + 1 maand. Hiermee vermijdt u dat de informatie in de notificatie niet meer accuraat/gevalideerd is.
| Info |
|---|
De volgende velden hoeft u niet in te vullen:
|
...
|
| Note |
|---|
|