Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Een voorbeeld van een payload bij een notificatiebundel 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"
    }
  ]
}

...

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"
    }
  ]
}

...

  • 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:

  • Afzenderorganisatiecode: Digitaal Vlaanderen vult hier de OVO-code in van de organisatie die de notificaties verstuurt. De OVO-code is gekend uit de ACM Client claims.

  • Merkcode: staat al vooraf geconfigureerd door Digitaal Vlaanderen