| Table of Contents | ||||
|---|---|---|---|---|
|
API-documentatie
Zie de Swagger-documentatie bij de Notificaties API. Voor de belangrijkste call, de POST-callWe maken 2 types API-documentatie beschikbaar:
Voor de POST-call, die alleen kan gedaan worden door de afzender, vindt u hieronder een voorbeeldcodevoorbeeld.
POST-call
Voor het doorsturen van notificaties is er 1 API-call nodig: POST Deze call plaatst een nieuw ophaalverzoek voor de notificatiebundel: POST/api/v2/notificaties
Een voorbeeld van een payload om bij een passieve notificatie uit te sturennotificatiebundel voor passieve notificaties:
| Code Block |
|---|
{
"AfzenderOrganisatieCode": null,
"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",
"MerkCode": "Merk",
"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"
},
]
} |
...