Page Comparison

API-call bij een standaard DOSIS-integratie met een vereenvoudigde interface

POST /api/v1/dosis/dossiers

Om Call om een nieuwe dossierstatus op te laden.

• Geef een dossier door in de body van de request met payload in JSON .

• Zet het juiste contenttype (application/json) in de Content-Type request header.

...

• Geef een dossier door in de body van de request met payload in JSON.

• Zet het content type contenttype (application/json) in de Content-Type request header.

...

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

Body parameters

Zie de documentatie via https://tniprod.dosisnotificaties.dev-vlaanderen.be/api/bron/swagger/index#!/Dossier/Dossier_RegistreerDossierV2Dosis voor alle mogelijke velden in de body van de oproep.

...

Endpoint die een lijst teruggeeft van alle bronnen, met bronUri, bronId en organisatie gegevens bron-Uri, bron-Id en organisatiegegevens die geconfigureerd zijn voor de gebruiker door het Aansluitingen-team.

Deze methode geeft alle bronnen terug waarvoor de oproeper dossier statussen dossierstatussen mag beheren. Het is dus een goede test om na te zien gaan of de het gebruikte token correct is en of alle verwachte bronnen beschikbaar zijn op deze omgeving.

...

Endpoint om te valideren of de configuratie (bron-URI + product-ID Id + authenticatie) in orde is vooraleer er effectief dossiers worden doorgestuurd.

Deze methode controleert of de oproeper het recht heeft om de bronUri bron-Uri voor een specifiek product te gebruiken. Het is dus een goede tweede test om te zien of de product configuratie productconfiguratie van een bron correct is, nadat de lijst van bronnen gecontroleerd is met GET /api/v2/dosis/bronnen/uris

...

GET /api/v1/dosis/resultaten/fouten?bron={bronUri}

...

De dossiernummer-methode om het laatste verwerkingsresultaat van 1 specifiek dossier op te vragen.

DELETE  DELETE /api/v1/dosis/dossiers?bron={bronUri}&dossierNummer={dossierNummer}

...

GET /api/v1/dosis/resultaten/perUploadId?uploadId={uploadId}

Om Call om het resultaat van een POST-call op te vragen. 

GET  GET /api/v2/dosis/resultaten/fouten?bron={bronUri}&limit={max}&offset={start}

...

Om statische data op te vragen: de lijst van Vlaamse Fasen en Codes met hun technische keybijv. geïnitieerd is geinitieerd, zonder trema.

De namen van de lijsten zijn:

...

Swagger

Swagger-documentatie bij de DOSIS API:

• Voor TNI zie https://tni.dosis.dev-vlaanderen.be/api/bron/swagger/index

• Voor productie zie https://prod.dosis-burgers.vlaanderen.be/api/bron/swagger/index