Inhoud

Voorbeeldberichten ZGW creëren van zaak

Voorbeeldberichten ZGW creëren van zaak

Inleiding

Hieronder een reeks voorbeelden waarmee een zender een zaak in OpenWave kan aanmaken met een rolcontact, met een adres, met extra eigenschappen en met een document. Hoe OpenWave ingericht moet zijn om deze berichten te kunnen verwerken staat in een apart lemma:Voorbeeld inrichting OpenWave voor ontvangen ZGW-berichten.

Voor elk van de onderstaande berichten zal een valide token moeten worden meegegeven in de Authorization Header onder type Bearer Token

Dat token kan worden opgehaald met een POST op het Endpoint baseurl/api/zgw/authentication/token/ waarbij de Authorization Header onder type Basic Auth is gevuld met een base64-string van respectievelijk een username en password (gescheiden door dubbele punt) die eenmalig zijn gecommuniceerd en die door de ontvangende organisatie zijn toegekend aan de zender.

De baseurl is de implementatie van OpenWave waartegen aan gepraat moet worden, bijvoorbeeld: https://acc.rommeldam.open-wave.nl

Zaak creëren

Met een POST op het endpoint baseurl/api/zgw/zaken/api/v1/zaken/
Deze header parameters zijn verplicht:

Content-Type = application/json
Content-Crs = EPSG:4326
Accept-Crs = EPSG:4326

De Bearer token authenticatieparameter moet gevuld worden met de opgehaalde token

In de body van het POST-bericht:

voorbeeld postbericht creer zaak

{
	  "bronorganisatie": "rsin van bronorganisatie",
	  "omschrijving": "Toezichtzaak",
	  "toelichting": "Toezicht op Risicovol bedrijf",
	  "zaaktype": "https://acc.rommeldam.open-wave.nl/api/zgw/catalogi/api/v1/zaaktypen/a5b5d601-c835-4f4c-9dfc-256ed3ff9166",
	  "verantwoordelijkeOrganisatie": "rsin van behandelende organisatie",
	  "startdatum": "2025-10-01",
	  "zaakgeometrie": {
		  "coordinates": [
			  52.3685617,
			  4.9384269
                     ],
		  "type": "Point"
	  }
  }

Uitleg:

Achter zaaktype moet de unieke URL staan waar het zaaktype (bijv. toezichtzaak) leeft waaronder de zaak moet worden aangemaakt. Die kan worden opgehaald achter item URL van de response op de GET aanroep op baseurl/api/zgw/catalogi/api/v1/zaaktypen/
a5b5d601-c835-4f4c-9dfc-256ed3ff9166 is in dit voorbeeld de uuid van het zaaktype dat in de openwave implementatie aan het betreffende zaaktype is toegekend. Die kan worden opgehaald met dezelde GET op baseurl/api/zgw/catalogi/api/v1/zaaktypen/ achter item identificatie
geometrie mag ook als Polygon worden doorgegeven
Indien de instelling Sectie: ZGW en Item: GeometrieVerplicht is aangevinkt, dan moet er geometrie zijn opgenomen in het bericht, anders wordt een foutmelding gegenereerd als response.

Het Responsbericht:

voorbeeld response

{
  "zaakgeometrie": {
    "coordinates": [
      52.3685617,
      4.9384269
    ],
    "type": "Point"
  },
  "identificatie": "2025T0001",
  "bronorganisatie": "rsin van bronorganisatie ",
  "zaaktype": "https://acc.rommeldam.open-wave.nl/api/zgw/catalogi/api/v1/zaaktypen/a5b5d601-c835-4f4c-9dfc-256ed3ff9166",
  "einddatum": null,
  "betalingsindicatieWeergave": "n.v.t",
  "uuid": "86957076ebb4484585386a5cfa84ae2d",
  "verantwoordelijkeOrganisatie": "rsin van behandelende organisatie",
  "url": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaken/86957076ebb4484585386a5cfa84ae2d",
  "omschrijving": "Toezichtzaak",
  "rollen": [],
  "deelzaken": [],
  "startdatum": "2025-10-01",
  "eigenschappen": [],
  "zaakobjecten": [],
  "zaakinformatieobjecten": [],
  "toelichting": "Toezicht op Risicovol bedrijf",
  "status": null
}

Uitleg:

In het item uuid staat de unieke identifier die voor deze aangemaakte zaak is uitgetrokken (86957076ebb4484585386a5cfa84ae2d)
In het item URL staat de URL waarin deze specifieke zaak leeft (de URL eindigt met dezelfde uuid)

uitzondering

OpenWave ondersteunt een op maat gemaakte afwijking op dit bericht ten behoeve van klacht/waarnemings-gegevens: zie hiervoor kopje Uitzondering extra waarnemings-items in Creëer ZGW zaak conform OpenZaak API

Zaakobjecttype adres toevoegen

Met een POST op het endpoint baseurl/api/zgw/zaken/api/v1/zaakobjecten/
Deze header parameters zijn verplicht:

Content-Type = application/json

De Bearer token authenticatieparameter moet gevuld worden met de opgehaalde token.

In de body van het POST-bericht:

voorbeeld postbericht maak zaakobject adres

{
   "zaak": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaken/86957076ebb4484585386a5cfa84ae2d",
    "objectType": "adres",
    "objectIdentificatie": {
        "identificatie": "0",
        "wplWoonplaatsNaam": "Amsterdam",
        "gorOpenbareRuimteNaam": "Cruquiusweg",
        "huisnummer": 70,
        "huisletter": null,
        "huisnummertoevoeging": null,
        "postcode": null
    }
  }

Uitleg:

Zaak moet gevuld zijn met de URL van de eerder aangemaakte zaak
Objecttype moet gevuld zijn met adres
Objectidentificatie : Indien het item identificatie uit zestien cijfers bestaat, waarbij posities 5 + 6 samen één van de volgende combinaties vormt: 01, 02, 03, 10, 20 of 30, dan beschouwt OpenWave de identificatie als een BAG-identificatie, anders niet.

Responsebericht

voorbeeld response

{
  "objectIdentificatie": {
    "identificatie": "0",
    "gorOpenbareRuimteNaam": "Cruquiusweg",
    "huisnummer": 70,
    "huisletter": null,
    "huisnummertoevoeging": null,
    "postcode": null,
    "wplWoonplaatsNaam": "Amsterdam"
  },
  "zaak": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaken/86957076ebb4484585386a5cfa84ae2d",
  "uuid": "63f8d2ee42f74170be3eadf84a4a0086",
  "url": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaakobjecten/adres/63f8d2ee42f74170be3eadf84a4a0086",
  "objectType": "adres"
 }

Uitleg:

De uuid (en URL) van het aangemaakte koppeling adres/zaak worden opgeslagen in de database van OpenWave, maar is voor de zender niet van verder belang

Zaakobjecttype medewerker toevoegen

Met een POST op het endpoint baseurl/api/zgw/zaken/api/v1/zaakobjecten/
Deze header parameters zijn verplicht:

Content-Type = application/json

De Bearer token authenticatieparameter moet gevuld worden met de opgehaalde token.

In de body van het POST-bericht:

voorbeeld postbericht maak zaakobject medewerker

{
   "zaak": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaken/86957076ebb4484585386a5cfa84ae2d",
    "objectType": "medewerker",
    "objectIdentificatie": {
        "identificatie": "pdeboer@rem.nl",
        "achternaam": "Boer",
        "voorletters": "P.A.",
        "voorvoegselAchternaam": "de"
    }
}

Uitleg:

Zaak moet gevuld zijn met de URL van de eerder aangemaakte zaak
Objecttype moet gevuld zijn met medewerker
Objectidentificatie: identificatie moet gevuld zijn met het emailadres van de behandelend medewerker zoals die in de betreffende OpenWave implementatie bekend is.

Responsebericht

voorbeeld response

{
  "objectIdentificatie": {
    "achternaam": "Boer",
    "identificatie": "pdeboer@odrommeldam.nl",
    "voorletters": "P.A.",
    "voorvoegselAchternaam": "de"
  },
  "zaak": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaken/86957076ebb4484585386a5cfa84ae2d",
  "uuid": "6b956d1c95264e329efc325fc5e920f3",
  "url": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaakobjecten/medewerker/6b956d1c95264e329efc325fc5e920f3",
  "objectType": "medewerker"
 }

Uitleg:

De uuid (en URL) van het aangemaakte koppeling medewerker/zaak worden opgeslagen in de database van OpenWave, maar is voor de zender niet van verder belang.

Aanvrager/initiator toevoegen

Met een POST op het endpoint baseurl/api/zgw/zaken/api/v1/rollen/
Deze header parameters zijn verplicht:

Content-Type = application/json

De Bearer token authenticatieparameter moet gevuld worden met de opgehaalde token.

In de body van het POST-bericht:

voorbeeld postbericht maak rolobject initiator van type vestiging

{
    "zaak": "https://acc.rommeldam.open-wave.nl/api/openzaak/zaken/api/v1/zaken/86957076ebb4484585386a5cfa84ae2d",
    "betrokkeneType": "vestiging",
    "roltype": "https://acc.rommeldam.open-wave.nl/api/openzaak/catalogi/api/v1/roltypen/56871c10-b6eb-42cb-af7b-d3d950123a21",
    "roltoelichting": "initiator",
    "contactpersoonRol": {
        "emailadres": "Van@rem.nl",
        "functie": "",
        "telefoonnummer": "",
        "naam": "Eend, Vano"
    },
    "betrokkeneIdentificatie": {
        "vestigingsNummer": "213412341234",
        "handelsnaam": ["Zwaan BV"],
        "verblijfsadres": {
            "aoaIdentificatie": "",
            "wplWoonplaatsNaam": "Amsterdam",
            "gorOpenbareRuimteNaam": "Mercatorplein",
            "aoaPostcode": "",
            "aoaHuisnummer": 1238,
            "aoaHuisletter": "",
            "aoaHuisnummertoevoeging": ""
          },
        "subVerblijfBuitenland": {},
        "kvkNummer": "33344466"
    }
}

voorbeeld postbericht maak rolobject initiator van type natuurlijk persoon

{
    "zaak": "https://acc.rommeldam.open-wave.nl/api/openzaak/zaken/api/v1/zaken/Pau04c5f-001d-46d7-a678-36054799aPau",
    "betrokkeneType": "natuurlijk persoon",
    "roltype": "https://acc.rommeldam.open-wave.nl/api/openzaak/catalogi/api/v1/roltypen/b16743b9-6555-48c5-986d-b4c8c646a40c",
   "roltoelichting": "initiator",
  "contactpersoonRol": {
      "emailadres": "smulders@rem.nl",
      "functie": "",
      "telefoonnummer": "",
      "naam": "Smulders, Harry"
  },
  "betrokkeneIdentificatie": {
      "inpBsn": "",
      "anpIdentificatie": "",
      "inpA_nummer": "",
      "geslachtsnaam": "Smulders",
      "voorvoegselGeslachtsnaam": "",
      "voorletters": "M.H.",
      "voornamen": "",
      "geslachtsaanduiding": "m",
      "geboortedatum": "",
      "verblijfsadres": {
          "aoaIdentificatie": "1234567890",
          "wplWoonplaatsNaam": "Assendelft",
          "gorOpenbareRuimteNaam": "Bakkerstraat",
          "aoaPostcode": "1074XK",
          "aoaHuisnummer": "13",
          "aoaHuisletter": "s",
          "aoaHuisnummertoevoeging": "",
          "inpLocatiebeschrijving": ""
      }
  }
}

Uitleg:

Zaak moet gevuld zijn met de URL van de eerder aangemaakte zaak
Betrokkenetype moet gevuld zijn met natuurlijk_persoon of niet_natuurlijk_persoon of vestiging
Roltype moet gevuld zijn met de URL waaronder de rol leeft in OpenWave: dat is een unieke URL voor de combinatie zaaktype (toezichtzaak) en de rol (initiator). Die kan worden opgehaald achter item URL in het response bericht van de GET op endpoint baseurl/api/zgw/catalogi/api/v1/roltypen/?zaaktypeIdentificatie=a5b5d601-c835-4f4c-9dfc-256ed3ff9166 waarbij de waarde van de query paramter zaaktypeIdentificatie moet worden gevuld met de uuid van het zaaktype zie: Opvragen lijst met roltypen conform OpenZaak API of als path parameter met worden doorgegeven.

Responsebericht

voorbeeld response vestiging

{
  "roltoelichting": "initiator",
  "roltype": "Aanvrager vergunning",
  "statussen": [],
  "betrokkeneIdentificatie": {
    "subVerblijfBuitenland": {},
    "kvkNummer": "33344466",
    "vestigingsNummer": "213412341234",
    "handelsnaam": [
      "Zwaan BV"
    ],
    "verblijfsadres": {
      "aoaIdentificatie": "",
      "gorOpenbareRuimteNaam": "Mercatorplein",
      "wplWoonplaatsNaam": "Amsterdam",
      "aoaHuisnummertoevoeging": "",
      "aoaHuisletter": "",
      "aoaHuisnummer": 1238,
      "aoaPostcode": ""
    }
  },
  "zaak": "https://acc.rommeldam.open-wave.nl/api/openzaak/zaken/api/v1/zaken/86957076ebb4484585386a5cfa84ae2d",
  "betrokkeneType": "vestiging",
  "contactpersoonRol": {
    "functie": "",
    "telefoonnummer": "",
    "naam": "Eend, Vano",
    "emailadres": "Van@rem.nl"
  },
  "registratiedatum": "2025-09-16T14:39:47",
  "uuid": "8c02d57e81504b86a2540ab6ab8c0fb7",
  "omschrijvingGeneriek": "initiator",
  "url": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/rollen/8c02d57e81504b86a2540ab6ab8c0fb7"
}

Uitleg:

De uuid (en URL) van het aangemaakte koppeling rol/zaak worden opgeslagen in de database van OpenWave, maar is voor de zender niet van verder belang

Zaakeigenschap toevoegen

Met een POST op het endpoint baseurl/api/zgw/zaken/api/v1/zaken/{zaak-identifier}/zaakeigenschappen
De path parameter {zaakidentifier} is de unieke uuid van een zaak bijv. 86957076ebb4484585386a5cfa84ae2d
Deze header parameters zijn verplicht:

Content-Type = application/json

De Bearer token authenticatieparameter moet gevuld worden met de opgehaalde token.

In de body van het POST-bericht:

voorbeeld postbericht zaakeigenschap toevoegen

{
"zaak": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaken/86957076ebb4484585386a5cfa84ae2d",
"eigenschap": "https://acc.rommeldam.open-wave.nl/api/zgw/catalogi/api/v1/eigenschappen/a73c04eb-0edf-4f6b-b929-bbe7a6cb95d6",
"waarde": "2018E1538"
}

Uitleg:

De pathparameter {zaak-identifier} moet gevuld worden met de uuid van de eerder aangemaakte zaak
Zaak moet ook gevuld zijn met de URL van de eerder aangemaakte zaak
Eigenschap moet gevuld zijn met de URL waaronder de eigenschap leeft in OpenWave: dat is een unieke URL voor de combinatie zaaktype en eigenschap. Die kan worden opgehaald achter item URL in het response bericht van de GET op endpoint baseurl/api/zgw/catalogi/api/v1/eigenschappen/?zaaktypeIdentificatie=a5b5d601-c835-4f4c-9dfc-256ed3ff9166 waarbij de waarde van de query parameter zaaktypeIdentificatie moet worden gevuld met de uuid van het zaaktype (zie: Opvragen lijst met eigenschappen conform OpenZaak API. De implementatie van OpenWave bepaalt welke eigenschappen aan een zaak kunnen worden toegevoegd bijvoorbeeld een inrichtingsnummer teneinde een zaak aan een inrichting te kunnen koppelen, of een productcode, etcetera.

Responsebericht

voorbeeld respons

{
  "zaak": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaken/86957076ebb4484585386a5cfa84ae2d",
  "waarde": "2018E1538",
  "eigenschap": "https://acc.rommeldam.open-wave.nl/api/zgw/catalogi/api/v1/eigenschappen/a73c04eb-0edf-4f6b-b929-bbe7a6cb95d6",
  "naam": "Inrichtingssleutel",
  "uuid": "7975c750c8c24e4a98f71df1ee2d1208",
  "url": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaken/eigenschappen/7975c750c8c24e4a98f71df1ee2d1208"
}

Uitleg:

De uuid (en URL) van het aangemaakte eigenschap bij de zaak worden NIET opgeslagen in de database van OpenWave, en zijn derhalve voor de zender niet van verder belang.

Uploaden document

Met een POST op het endpoint baseurl/api/zgw/documenten/api/v1/enkelvoudiginformatieobjecten
Deze header parameters zijn verplicht:

Content-Type = application/json

De Bearer token authenticatieparameter moet gevuld worden met de opgehaalde token.

In de body van het POST-bericht:

voorbeeld postbericht document uploaden

{
    "bronorganisatie": "rsin van bronorganisatie",
    "creatiedatum": "2025-10-10",
    "informatieobjecttype": "https://acc.rommeldam.open-wave.nl/api/zgw/catalogi/api/v1/informatieobjecttypen/bf6152d0-c6e6-4149-8880-838cf22e143b",
    "titel": "TestTekst",
    "auteur": "Jan Janssen",
    "taal": "ned",
    "bestandsnaam":"Ditiseentest.txt",
    "inhoud": "RGl0IGlzIGVlbiB0ZXN0"
  }

Uitleg:

informatieobjecttype moet gevuld zijn met de URL waaronder dit type leeft in OpenWave: dat is een unieke URL die kan worden opgehaald achter item URL in het response bericht van de GET op endpoint baseurl/api/zgw/catalogi/api/v1/informatieobjecttypen/. Zie: Opvragen lijst met informatieobjecttypen conform OpenZaak API.
inhoud moet bestaan uit een base64 string

Responsebericht

voorbeeld response

{
  "bronorganisatie": "rsin van bronorganisatie",
  "beginRegistratie": "2025-10-10T09:28:24",
  "versie": 1,
  "taal": "ned",
  "identificatie":"79fdba5ed24543d48f7253e1e7623487",
  "url": "https://acc.rommeldam.open-wave.nl/api/zgw/documenten/api/v1/enkelvoudiginformatieobjecten/79fdba5ed24543d48f7253e1e7623487",
  "auteur": "Jan Janssen",
  "inhoud": "Hier stond het document in base64",
  "titel": "TestTekst",
  "informatieobjecttype": "https://acc.rommeldam.open-wave.nl/api/zgw/catalogi/api/v1/informatieobjecttypen/bf6152d0-c6e6-4149-8880-838cf22e143b",
  "bestandsnaam": "Ditsiseentest.txt",
  "bestandsdelen": [],
  "creatiedatum": "2025-10-10",
  "locked": true
  }

Uitleg:

de identificatie en URL zijn toegekend door OpenWave voor gebruik bij de POST op het endpoint om dit document te koppelen aan een zaak. Tot die tijd wordt het document tijdelijk bewaard op een tempmap.

Eerder upgeload document koppelen aan zaak

Met een POST op het endpoint baseurl/api/zgw/zaken/api/v1/zaakinformatieobjecten
Deze header parameters zijn verplicht:

Content-Type = application/json

De Bearer token authenticatieparameter moet gevuld worden met de opgehaalde token.

In de body van het POST-bericht:

voorbeeld post KoppelDocumentAanZaak

{
   "informatieobject": "https://acc.rommeldam.open-wave.nl/api/zgw/documenten/api/v1/enkelvoudiginformatieobjecten/79fdba5ed24543d48f7253e1e7623487",
   "zaak": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaken/86957076ebb4484585386a5cfa84ae2d"
  }

Uitleg:

informatieobject is de waarde van item URL uit het response bericht waarmee een document eerder is geüpload
zaak is de waarde van item URL uit het response bericht creerzaak waarmee de zaak is aangemaakt.

ResponseBericht

voorbeeld response

{
  "zaak": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaken/86957076ebb4484585386a5cfa84ae2d",
  "informatieobject": "https://acc.rommeldam.open-wave.nl/api/zgw/documenten/api/v1/enkelvoudiginformatieobjecten/79fdba5ed24543d48f7253e1e7623487",
  "aardRelatieWeergave": "Hoort bij",
  "registratiedatum": "2025-10-02T12:55:53",
  "uuid": "f928a1b37309456e8d07ed773ec692af",
  "url": "https://acc.rommeldam.open-wave.nl/api/zgw/zaken/api/v1/zaakinformatieobjecten/f928a1b37309456e8d07ed773ec692af"
  }

Uitleg:

de waarde van het item UUID wordt opgeslagen bij het geregistreerde document bij de zaak in OpenWave