Voorbeelden payloads DOSIS

1 Minimale payload DOSIS voor burgers
2 Datumnotaties in de payloads

Neem steeds een kijkje in onze swagger voor de meest actuele payloads, inclusief alle (nieuwe) features.

Minimale payload DOSIS voor burgers

Maximaal 1 product is verplicht mee te geven voor een dossier van het type DossierStatus.

{
  "Identificatie": {
    "Bron": "urn://eniteit.be/applicatie",
    "DossierNummer": "test_20210318_2"
  },
  "UploadId": "62ebf665-eb35-43a1-a213-8ab04cdc4160",
  "Naam": "test 2 dossiernaam x",
  "WijzigingsDatum": "2021-03-25T14:47:15.682Z",
  "Status": {
    "VlaamsCode": "Aangevraagd",
    "VlaamsFase": "Samenstelling",
    "Detail1": "dit is de detailstatus",
    "WijzigingsDatum": "2021-03-25T14:47:15.682Z",
  },
  "TypeDossierCode": "DossierStatus",
  "Producten": [
    {
      "Id": "xxx"
    }
  ],
  "DossierBeheerder": {
    "Dienst": "test dienst dossierbeheerder",
    "Telefoon": "025537202",
    "Email": "digitaal.vlaanderen@vlaanderen.be",
    "Website": "https://www.vlaanderen.be/digitaal-vlaanderen",
  },
  "Doorverwijzing": "https://mijn.gent.be/dossier/test_20210318", 
  "Agenten": [
    {
      "Identificatie": "80102529724",
      "Toegangsrechten": [
        {
          "Code": "Raadpleger"
        }
      ]
    }
  ]
}

Maximaal 1 product is verplicht mee te geven voor een dossier van het type DossierStatus.

{
  "Identificatie": {
    "Bron": "urn://entiteit.be/applicatie",
    "DossierNummer": "test_20210318_2"
  },
  "UploadId": "62ebf665-eb35-43a1-a213-8ab04cdc4160",
  "Naam": "test 2 dossiernaam x",
  "WijzigingsDatum": "2021-03-25T14:47:15.682Z",
  "Status": {
    "VlaamsFase": "Samenstelling",
    "VlaamsCode": "Aangevraagd",
    "Detail1": "dit is de detailstatus",
    "WijzigingsDatum": "2021-03-25T14:47:15.682Z",
    "Actie": {
        "ActieNodig": true,
        "Actie": "U dient nog documenten aan te leveren."
      },
  },
  "TypeDossierCode": "DossierStatus",
  "Producten": [
    {
      "Id": "1710"
    }
  ],
  "DossierBeheerder": {
    "Dienst": "test dienst dossierbeheerder",
    "Telefoon": "025537202",
    "Email": "digitaal.vlaanderen@vlaanderen.be",
    "Website": "https://www.vlaanderen.be/digitaal-vlaanderen",
  },
  "Doorverwijzing": "https://mijn.loket.be/dossier/test_20210318_2", 
  "Agenten": [
    {
      "Identificatie": "71090999892",
      "Toegangsrechten": [
        {
          "Code": "Raadpleger"
        }
      ]
    }
  ]
}

Datumnotaties in de payloads

In de payloads kunnen er 2 datumnotaties zijn die meegeven wanneer een dossier werd aangepast. In beide gevallen is het noodzakelijk om de tijdzone ook mee te geven. Dit kan je zien aan de Z op het einde. Beide velden zijn verplicht in te vullen.

De Wijzigingsdatum is de datum/timestamp van wanneer de wijziging naar DOSIS wordt doorgevoerd. Dit veld is verplicht en wordt getoond in Mijn Burgerprofiel.
De Wijzigingsdatum bij “Status” is de effectieve datum dat een statuswijziging is gebeurd. Deze datum wordt eveneens in Mijn Burgerprofiel getoond.

Geef in beide velden dezelfde informatie mee.

Maximaal 1 product is verplicht mee te geven voor een dossier van het type DossierStatus.

{
  "Identificatie": {
    "Bron": "urn://eniteit.be/applicatie",
    "DossierNummer": "test_20210318_2"
  },
  "UploadId": "62ebf665-eb35-43a1-a213-8ab04cdc4160",
  "Naam": "test 2 dossiernaam x",
  "WijzigingsDatum": "2021-03-25T14:47:15.682Z",
  "Status": {
    "VlaamsCode": "Aangevraagd",
    "VlaamsFase": "Samenstelling",
    "Detail1": "dit is de detailstatus",
    "WijzigingsDatum": "2021-03-25T14:47:15.682Z"
  },
  "TypeDossierCode": "DossierStatus",
  "Producten": [
    {
      "Id": "xxx"
    }
  ],
  "DossierBeheerder": {
    "Dienst": "test dienst dossierbeheerder",
    "Telefoon": "025537202",
    "Email": digitaal.vlaanderen@vlaanderen.be,
    "Website": https://www.vlaanderen.be/digitaal-vlaanderen,
  },
  "Doorverwijzing": https://mijn.gent.be/dossier/test_20210318,
  "Agenten": [
    {
      "Identificatie": "80102529724",
      "Toegangsrechten": [
        {
          "Code": "Raadpleger"
        }
      ]
    }
  ]
}

Wens je dossierstatussen in een andere taal dan het Nederlands te sturen, volg dan de instructies op Overzicht basisbegrippen DOSIS | Meertaligheid

Documentatie bouwstenen digitale loketten Digitaal Vlaanderen

Documentatie voor partners van Digitaal Vlaanderen - bouwstenen digitale loketten

Voorbeelden payloads DOSIS

Minimale payload DOSIS voor burgers

Datumnotaties in de payloads