Dit is een oude revisie van het document!

Opvragen informatie van één zaak conform OpenZaak API

Op het endpoint base-url/api/zgw/zaken/api/v1/zaken/{identifier} kan met een GET informatie opgevraagd worden van een specifieke zaak.
De base_url is de implementatie van OpenWave waar tegenaan gepraat moet worden, bijvoorbeeld: https://acc.rommeldam.open-wave.nl. De zaak die opgevraagd wordt is de {identifier} in de pathparameter): dat is de UUID die geretourneerd is aan een eerder gecreëerde zaak Creëer zaakobject conform OpenZaak API(Creëer ZGW zaak conform OpenZaak API). Voorbeeld van een aanroep: base-url/api/zgw/zaken/api/v1/zaken/548358458459-0-9090-0

Gebaseerd op versie Open Zaak API 1.2

Whitelist

De zender die hier een van de zaaktypen opvraagt zal gewhitelist moeten worden. Dit kan in de tabellen tbendpointlist en tbipauthorisationlist onder de tegel Endpoints whitelist op het nieuwe beheerportaal onder de kolom Gebruikers. In de tabel tbendpointlist zal minimaal het endpoint /api/zgw gedefinieerd moeten zijn met daaronder (in de tabel tbipauthorisationlist) het IP-adres van de zender.

Authorisation Token

In de Authorization header van dit GET bericht moet een valide JWT-token worden meegegeven onder Bearer Token. Zie voorbeeld bij Creëer ZGW zaak conform OpenZaak API.

Voor het verkrijgen van een token (met beperkte geldigheidsduur!) zie: ZGW OpenZaak API Functionaliteit.

De token wordt opgezocht in de tabel tbaccesstoken en het tijdstip van aanvraag wordt getoetst aan de geldigheidsduur van de gevonden rij.

(robot) Medewerker moet gelinkt zijn aan endpoint

De gevonden token is gelinkt aan een (robot)-medewerker (degene onder wiens credentials het token is gecreëerd). Bij de betreffende medewerkers kaart moet de kolom Endpoint (robotmedewerker is gedefinieerd voor binnenkomende berichten op endpoint) (dnkeyendpointlist) in blok login verwijzen naar een kaart in tbendpointlist waarvan de inhoud van de kolom dvendpointurl een substring is van dit endpoint api/zgw/catalogus/api/v1/zaakobjecttypen/ // waarop deze zaakobjecttypenlijst wordt gevraagd: bijvoorbeeld: /api/zgw//

Path Parameter

De pathparameter moet gevuld zijn met de uuid van de op te vragen zaak.

Headers

  • Content-type: application/json
  • Content-Crs: EPSG:4326
  • Accept-Crs : EPSG:4326

Query Parameters

Worden niet ondersteund door OpenWave

Body

Geen body.

Responsebericht

Indien de zaakinformatie niet kon worden gegenereerd wordt een responsecode anders dan 200/201 geretourneerd met in de body de oorzaak van het falen.

Indien de zaakinformatie wel succesvol is gegenereerd wordt onder de responsecode 200 in de body de informatie getoond.

Voorbeeld response body

{
  "identificatie": "2024K0105",
  "bronorganisatie": null,
  "zaaktype": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaaktypen/365f113f-cb3c-4843-91ce-e7c9467f19c5",
  "einddatum": null,
  "betalingsindicatieWeergave": null,
  "registratiedatum": "2024-01-03",
  "uuid": "738107f2fd164619a071e0c29586270e",
  "url": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaken/738107f2fd164619a071e0c29586270e",
  "verantwoordelijkeOrganisatie": null,
  "omschrijving": "2. Ik hoor..  Pauls test ZGW",
  "rollen": [
    "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/rollen/b74d0d53f8be44638fbc48f33386037c"
  ],
  "deelzaken": [],
  "startdatum": "2024-01-03",
  "eigenschappen": [],
  "zaakobjecten": [
    "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaakobjecten/c6a70eae61a247c3b7263b36d42e5c80"
  ],
  "resultaat": null,
  "zaakinformatieobjecten": [],
  "status": null
}