From 4226fea577639de190c3039eedb25017acb94157 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Thu, 17 Oct 2024 11:38:31 +0200 Subject: [PATCH 01/36] Synchronized current version zrc with 1.5.1 --- .../zrc/current_version/openapi.yaml | 16 ++++++---------- 1 file changed, 6 insertions(+), 10 deletions(-) diff --git a/api-specificatie/zrc/current_version/openapi.yaml b/api-specificatie/zrc/current_version/openapi.yaml index 74fa70d1b..3dc6b66b0 100644 --- a/api-specificatie/zrc/current_version/openapi.yaml +++ b/api-specificatie/zrc/current_version/openapi.yaml @@ -12418,11 +12418,6 @@ components: Omschrijving van het object, subject of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking heeft. maxLength: 200 - resultaattoelichting: - type: string - description: Een toelichting op wat het resultaat van de zaak inhoudt. - title: resultaattoelichting - maxLength: 1000 startdatumBewaartermijn: type: string format: date @@ -14074,11 +14069,6 @@ components: Omschrijving van het object, subject of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking heeft. maxLength: 200 - resultaattoelichting: - type: string - description: Een toelichting op wat het resultaat van de zaak inhoudt. - title: resultaattoelichting - maxLength: 1000 startdatumBewaartermijn: type: string format: date @@ -14935,6 +14925,12 @@ components: description: Een korte identificatie van de organisatorische eenheid. type: string example: "123456789" + expand: + description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,' \ + \ hoofdzaak.deelzaken.status.statustype`Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt." + title: expand + type: string + example: zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype ordering: title: Ordering description: Het veld waarop de resultaten geordend worden. Het minnetje betekent omgekeerde volgorde. From c998f90d254d446e9ffcd7d4831916137ed5bee5 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Thu, 17 Oct 2024 12:53:16 +0200 Subject: [PATCH 02/36] create zrc 1.5.2 versie. Dit is de (onterechte) zrc 1.5.1 versie van branch oplossen-expand-probleem. --- api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml | 15970 ++++++++++++++++ 1 file changed, 15970 insertions(+) create mode 100644 api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml new file mode 100644 index 000000000..74b949992 --- /dev/null +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml @@ -0,0 +1,15970 @@ +openapi: 3.0.3 +info: + title: Zaken API + version: 1.5.1 + description: " Met expand mechanisme in plain json + + + Een API om een zaakregistratiecomponent (ZRC) te benaderen. + + + De ZAAK is het kernobject in deze API, waaraan verschillende andere + + resources gerelateerd zijn. De Zaken API werkt samen met andere API's voor + + Zaakgericht werken om tot volledige functionaliteit te komen. + + + **Wat is nieuw?** + + * Query parameters en zoekvelden voor archivering. + + + **Afhankelijkheden** + + + Deze API is afhankelijk van: + + + * Catalogi API + + * Notificaties API + + * Documenten API *(optioneel)* + + * Besluiten API *(optioneel)* + + * Autorisaties API *(optioneel)* + + + **Autorisatie** + + + Deze API vereist autorisatie. Je kan de + + [token-tool](https://zaken-auth.vng.cloud/) gebruiken om JWT-tokens te + + genereren. + + + ### Notificaties + + + Deze API publiceert notificaties op het kanaal `zaken`. + + + **Main resource** + + + `zaak` + + + + + **Kenmerken** + + + * `bronorganisatie`: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers en voldoen + aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + + * `zaaktype`: URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS + waar deze voorkomt + + * `vertrouwelijkheidaanduiding`: Aanduiding van de mate waarin het zaakdossier + van de ZAAK voor de openbaarheid bestemd is. + + + **Resources en acties** + + - `zaak`: create, update, destroy + + - `status`: create + + - `zaakobject`: create, update, destroy + + - `zaakinformatieobject`: create + + - `zaakeigenschap`: create, update, destroy + + - `klantcontact`: create + + - `rol`: create, destroy + + - `resultaat`: create, update, destroy + + - `zaakbesluit`: create + + - `zaakcontactmoment`: create + + - `zaakverzoek`: create + + + + **Handige links** + + + * [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard) + + * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken) + + " + contact: + email: standaarden.ondersteuning@vng.nl + url: https://vng-realisatie.github.io/gemma-zaken + license: + name: EUPL 1.2 + url: https://opensource.org/licenses/EUPL-1.2 +paths: + /klantcontacten: + get: + operationId: klantcontact_list + description: 'Alle KLANTCONTACTen opvragen. + + + **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' + summary: 'Alle KLANTCONTACTen opvragen. ' + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - klantcontacten + security: + - JWT-Claims: + - zaken.lezen + deprecated: true + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedKlantContactList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: klantcontact_create + description: + 'Indien geen identificatie gegeven is, dan wordt deze automatisch + gegenereerd. + + + **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' + summary: Maak een KLANTCONTACT bij een ZAAK aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - klantcontacten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KlantContact' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + deprecated: true + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/KlantContact' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /klantcontacten/{uuid}: + get: + operationId: klantcontact_retrieve + description: 'Een specifieke KLANTCONTACT opvragen. + + + **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' + summary: Een specifieke KLANTCONTACT opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - klantcontacten + security: + - JWT-Claims: + - zaken.lezen + deprecated: true + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/KlantContact' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /resultaten: + get: + operationId: resultaat_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle RESULTAATen van ZAAKen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: resultaattype + required: false + in: query + description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API). + schema: + type: string + format: uri + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - resultaten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedResultaatList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: resultaat_create + description: '**Er wordt gevalideerd op:** + + - geldigheid URL naar de ZAAK + + - geldigheid URL naar het RESULTAATTYPE' + summary: Maak een RESULTAAT bij een ZAAK aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - resultaten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /resultaten/{uuid}: + get: + operationId: resultaat_retrieve + description: Een specifieke RESULTAAT opvragen. + summary: Een specifieke RESULTAAT opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - resultaten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: resultaat_update + description: + "**Er wordt gevalideerd op** \n- geldigheid URL naar de ZAAK\n\ + - het RESULTAATTYPE mag niet gewijzigd worden" + summary: Werk een RESULTAAT in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - resultaten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: resultaat_partial_update + description: + "**Er wordt gevalideerd op** \n- geldigheid URL naar de ZAAK\n\ + - het RESULTAATTYPE mag niet gewijzigd worden" + summary: Werk een RESULTAAT deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - resultaten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedResultaat' + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: resultaat_destroy + description: Verwijder een RESULTAAT van een ZAAK. + summary: Verwijder een RESULTAAT van een ZAAK. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - resultaten + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: resultaat_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) RESULTAAT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - resultaten + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /rollen: + get: + operationId: rol_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle ROLlen bij ZAAKen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: betrokkene + required: false + in: query + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + schema: + type: string + format: uri + - name: betrokkeneType + required: false + in: query + description: Type van de `betrokkene`. + schema: + type: string + enum: + - natuurlijk_persoon + - niet_natuurlijk_persoon + - vestiging + - organisatorische_eenheid + - medewerker + - name: betrokkeneIdentificatie__natuurlijkPersoon__inpBsn + required: false + in: query + description: + Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene + bepalingen burgerservicenummer. + schema: + type: string + - name: betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie + required: false + in: query + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NATUURLIJK PERSOON + schema: + type: string + - name: betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer + required: false + in: query + description: Het administratienummer van de persoon, bedoeld in de Wet BRP + schema: + type: string + - name: betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId + required: false + in: query + description: + Het door een kamer toegekend uniek nummer voor de INGESCHREVEN + NIET-NATUURLIJK PERSOON + schema: + type: string + - name: betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie + required: false + in: query + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NIET-NATUURLIJK PERSOON + schema: + type: string + - name: betrokkeneIdentificatie__vestiging__vestigingsNummer + required: false + in: query + description: Een korte unieke aanduiding van de Vestiging. + schema: + type: string + - name: betrokkeneIdentificatie__organisatorischeEenheid__identificatie + required: false + in: query + description: Een korte identificatie van de organisatorische eenheid. + schema: + type: string + - name: betrokkeneIdentificatie__medewerker__identificatie + required: false + in: query + description: Een korte unieke aanduiding van de MEDEWERKER. + schema: + type: string + - name: roltype + required: false + in: query + description: URL-referentie naar een roltype binnen het ZAAKTYPE van de ZAAK. + schema: + type: string + format: uri + - name: omschrijving + required: false + in: query + description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. + schema: + type: string + - name: omschrijvingGeneriek + required: false + in: query + description: + Algemeen gehanteerde benaming van de aard van de ROL, afgeleid + uit het ROLTYPE. + schema: + type: string + enum: + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - rollen + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRolList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: rol_create + description: Maak een ROL aan bij een ZAAK. + summary: Maak een ROL aan bij een ZAAK. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - rollen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Rol' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Rol' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /rollen/{uuid}: + get: + operationId: rol_retrieve + description: Een specifieke ROL bij een ZAAK opvragen. + summary: Een specifieke ROL bij een ZAAK opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - rollen + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Rol' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: rol_destroy + description: Verwijder een ROL van een ZAAK. + summary: Verwijder een ROL van een ZAAK. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - rollen + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: rol_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ROL opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - rollen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /statussen: + get: + operationId: status_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle STATUSsen bij ZAAKen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: statustype + required: false + in: query + description: URL-referentie naar het STATUSTYPE (in de Catalogi API). + schema: + type: string + format: uri + - name: indicatieLaatstGezetteStatus + required: false + in: query + description: + Het gegeven is afleidbaar uit de historie van de attribuutsoort + Datum status gezet van van alle statussen bij de desbetreffende zaak. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - statussen + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedStatusList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: status_create + description: '**Er wordt gevalideerd op** + + - geldigheid URL naar de ZAAK + + - geldigheid URL naar het STATUSTYPE + + - indien het de eindstatus betreft, dan moet het attribuut `indicatieGebruiksrecht` + gezet zijn op alle informatieobjecten dieaan de zaak gerelateerd zijn + + + **Opmerkingen** + + - Indien het statustype de eindstatus is (volgens het ZTC), dan wordt de zaak + afgesloten door de einddatum te zetten.' + summary: Maak een STATUS aan voor een ZAAK. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - statussen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Status' + required: true + security: + - JWT-Claims: + - (zaken.aanmaken | zaken.statussen.toevoegen | zaken.heropenen) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/StatusRequestbody' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /statussen/{uuid}: + get: + operationId: status_retrieve + description: Een specifieke STATUS van een ZAAK opvragen. + summary: Een specifieke STATUS van een ZAAK opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - statussen + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Status' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: status_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) STATUS opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - statussen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaakcontactmomenten: + get: + operationId: zaakcontactmoment_list + description: Alle ZAAKCONTACTMOMENTen opvragen. + summary: Alle ZAAKCONTACTMOMENTen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: contactmoment + required: false + in: query + description: + URL-referentie naar het CONTACTMOMENT (in de Klantinteractie + API) + schema: + type: string + format: uri + tags: + - zaakcontactmomenten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ZaakContactMoment' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakcontactmoment_create + description: '**Er wordt gevalideerd op:** + + - geldigheid URL naar het CONTACTMOMENT' + summary: Maak een ZAAKCONTACTMOMENT aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakcontactmomenten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakContactMoment' + required: true + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakContactMoment' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaakcontactmomenten/{uuid}: + get: + operationId: zaakcontactmoment_retrieve + description: Een specifiek ZAAKCONTACTMOMENT opvragen. + summary: 'Een specifiek ZAAKCONTACTMOMENT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - zaakcontactmomenten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakContactMoment' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakcontactmoment_destroy + description: Verwijder een ZAAKCONTACTMOMENT. + summary: Verwijder een ZAAKCONTACTMOMENT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakcontactmomenten + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaakinformatieobjecten: + get: + operationId: zaakinformatieobject_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: 'Alle ZAAK-INFORMATIEOBJECT relaties opvragen ' + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: informatieobject + required: false + in: query + description: + URL-referentie naar het INFORMATIEOBJECT (in de Documenten API), + waar ook de relatieinformatie opgevraagd kan worden. + schema: + type: string + format: uri + tags: + - zaakinformatieobjecten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ZaakInformatieObject' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakinformatieobject_create + description: + "Maak een ZAAK-INFORMATIEOBJECT relatie aan.\n\n**Er wordt gevalideerd\ + \ op**\n- geldigheid zaak URL\n- geldigheid informatieobject URL\n- `zaak.archiefstatus`\ + \ moet gelijk zijn aan 'nog_te_archiveren' \n- de combinatie informatieobject\ + \ en zaak moet uniek zijn\n\n**Opmerkingen**\n- De registratiedatum wordt\ + \ door het systeem op 'NU' gezet. De `aardRelatie` wordt ook door het systeem\ + \ gezet.\n- Bij het aanmaken wordt ook in de Documenten API de gespiegelde\ + \ relatie aangemaakt, echter zonder de relatie-informatie.\n" + summary: Maak een ZAAK-INFORMATIEOBJECT relatie aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakinformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + required: true + security: + - JWT-Claims: + - (zaken.aanmaken | zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaakinformatieobjecten/{uuid}: + get: + operationId: zaakinformatieobject_retrieve + description: Een specifieke ZAAK-INFORMATIEOBJECT relatie opvragen. + summary: Een specifieke ZAAK-INFORMATIEOBJECT relatie opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaakinformatieobjecten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaakinformatieobject_update + description: + "Je mag enkel de gegevens van de relatie bewerken, en niet de relatie\ + \ zelf aanpassen.\n\n**Er wordt gevalideerd op** \n- informatieobject URL\ + \ en zaak URL mogen niet veranderen" + summary: Werk een ZAAK-INFORMATIEOBJECT relatie in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakinformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaakinformatieobject_partial_update + description: + "Je mag enkel de gegevens van de relatie bewerken, en niet de relatie\ + \ zelf aanpassen.\n\n**Er wordt gevalideerd op** \n- informatieobject URL\ + \ en zaak URL mogen niet veranderen" + summary: Werk een ZAAK-INFORMATIEOBJECT relatie deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakinformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedZaakInformatieObject' + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakinformatieobject_destroy + description: + De gespiegelde relatie in de Documenten API wordt door de Zaken + API verwijderd. Consumers kunnen dit niet handmatig doen. + summary: Verwijder een ZAAK-INFORMATIEOBJECT relatie. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakinformatieobjecten + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken | zaken.verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaakinformatieobject_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAKINFORMATIEOBJECT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaakinformatieobjecten + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaakobjecten: + get: + operationId: zaakobject_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle ZAAKOBJECTen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: object + required: false + in: query + description: URL-referentie naar de resource die het OBJECT beschrijft. + schema: + type: string + format: uri + - name: objectType + required: false + in: query + description: + Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er geen + passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. + schema: + type: string + enum: + - adres + - besluit + - buurt + - enkelvoudig_document + - gemeente + - gemeentelijke_openbare_ruimte + - huishouden + - inrichtingselement + - kadastrale_onroerende_zaak + - kunstwerkdeel + - maatschappelijke_activiteit + - medewerker + - natuurlijk_persoon + - niet_natuurlijk_persoon + - openbare_ruimte + - organisatorische_eenheid + - pand + - spoorbaandeel + - status + - terreindeel + - terrein_gebouwd_object + - vestiging + - waterdeel + - wegdeel + - wijk + - woonplaats + - woz_deelobject + - woz_object + - woz_waarde + - zakelijk_recht + - overige + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - zaakobjecten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedZaakObjectList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakobject_create + description: 'Maak een ZAAKOBJECT aan. + + + **Er wordt gevalideerd op** + + - Indien de `object` URL opgegeveven is, dan moet deze een geldige response + (HTTP 200) geven. + + - Indien opgegeven, dan wordt `objectIdentificatie` gevalideerd tegen de `objectType` + discriminator.' + summary: Maak een ZAAKOBJECT aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + required: true + security: + - JWT-Claims: + - (zaken.aanmaken | zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaakobjecten/{uuid}: + get: + operationId: zaakobject_retrieve + description: Een specifieke ZAAKOBJECT opvragen. + summary: Een specifieke ZAAKOBJECT opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaakobjecten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaakobject_update + description: + "**Er wordt gevalideerd op** \n- De attributen `zaak`, `object`\ + \ en `objectType` mogen niet gewijzigd worden.\n- Indien opgegeven, dan wordt\ + \ `objectIdentificatie` gevalideerd tegen de objectType discriminator." + summary: Werk een ZAAKOBJECT zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaakobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaakobject_partial_update + description: + "**Er wordt gevalideerd op** \n- De attributen `zaak`, `object`\ + \ en `objectType` mogen niet gewijzigd worden.\n- Indien opgegeven, dan wordt\ + \ `objectIdentificatie` gevalideerd tegen de objectType discriminator." + summary: Werk een ZAAKOBJECT deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaakobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedZaakObject' + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakobject_destroy + description: + Verbreek de relatie tussen een ZAAK en een OBJECT door de ZAAKOBJECT + resource te verwijderen. + summary: Verwijder een ZAAKOBJECT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - zaakobjecten + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken | zaken.verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaakobject_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAKOBJECT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaakobjecten + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaakverzoeken: + get: + operationId: zaakverzoek_list + description: Alle ZAAK-VERZOEKen opvragen. + summary: Alle ZAAK-VERZOEKen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: verzoek + required: false + in: query + description: URL-referentie naar het VERZOEK (in de Klantinteractie API) + schema: + type: string + format: uri + tags: + - zaakverzoeken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ZaakVerzoek' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakverzoek_create + description: '**Er wordt gevalideerd op** + + - geldigheid URL naar de VERZOEK' + summary: Maak een ZAAK-VERZOEK aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakverzoeken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakVerzoek' + required: true + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakVerzoek' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaakverzoeken/{uuid}: + get: + operationId: zaakverzoek_retrieve + description: Een specifieke ZAAK-VERZOEK opvragen. + summary: Een specifieke ZAAK-VERZOEK opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - zaakverzoeken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakVerzoek' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakverzoek_destroy + description: Verwijder een ZAAK-VERZOEK. + summary: Verwijder een ZAAK-VERZOEK. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakverzoeken + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken: + get: + operationId: zaak_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle ZAAKen opvragen. + parameters: + - name: identificatie + required: false + in: query + description: + De unieke identificatie van de ZAAK binnen de organisatie die + verantwoordelijk is voor de behandeling van de ZAAK. + schema: + type: string + example: "zaak123" + - name: bronorganisatie + required: false + in: query + description: + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers + en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + schema: + type: string + example: "000000000" + - name: bronorganisatie__in + required: false + in: query + description: Multiple values may be separated by commas. + schema: + type: array + items: + type: string + example: ["000000000","479559740","875883461"] + style: form + explode: false + - name: zaaktype + required: false + in: query + description: + URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS + waar deze voorkomt + schema: + type: string + format: uri + example: "https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/e80b7507-199a-484c-ad49-c41a1e43a6e7" + - name: archiefnominatie + required: false + in: query + description: + Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + schema: + type: string + enum: + - blijvend_bewaren + - vernietigen + example: "blijvend_bewaren" + - name: archiefnominatie__in + required: false + in: query + description: Multiple values may be separated by commas. + schema: + type: array + items: + type: string + example: ["blijvend_bewaren", "vernietigen"] + style: form + explode: false + - name: archiefactiedatum + required: false + in: query + description: + De datum waarop het gearchiveerde zaakdossier vernietigd moet + worden dan wel overgebracht moet worden naar een archiefbewaarplaats. Wordt + automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT aan + deze ZAAK indien nog leeg. + schema: + type: string + example: "2019-01-02" + - name: archiefactiedatum__isnull + required: false + in: query + description: De archiefactiedatum is leeg. + schema: + type: boolean + example: false + - name: archiefactiedatum__lt + required: false + in: query + description: De archiefactiedatum is kleiner dan de opgegeven datum. + schema: + type: string + example: "2020-01-02" + - name: archiefactiedatum__gt + required: false + in: query + description: De archiefactiedatum is groter dan de opgegeven datum. + schema: + type: string + example: "2018-01-02" + - name: archiefstatus + required: false + in: query + description: + Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + schema: + type: string + enum: + - nog_te_archiveren + - gearchiveerd + - gearchiveerd_procestermijn_onbekend + - overgedragen + example: "nog_te_archiveren" + - name: archiefstatus__in + required: false + in: query + description: Multiple values may be separated by commas. + schema: + type: array + items: + type: string + example: ["nog_te_archiveren","gearchiveerd","gearchiveerd_procestermijn_onbekend","overgedragen"] + style: form + explode: false + - name: startdatum + required: false + in: query + description: De datum waarop met de uitvoering van de zaak is gestart + schema: + type: string + example: "2017-01-02" + - name: startdatum__gt + required: false + in: query + description: De startdatum is groter dan de opgegeven datum. + schema: + type: string + example: "2018-01-02" + - name: startdatum__gte + required: false + in: query + description: De startdatum is groter dan of gelijk dan de opgegeven datum. + schema: + type: string + example: "2016-01-02" + - name: startdatum__lt + required: false + in: query + description: De startdatum is kleiner dan de opgegeven datum. + schema: + type: string + example: "2018-01-02" + - name: startdatum__lte + required: false + in: query + description: De startdatum is kleiner of gelijk dan de opgegeven datum. + schema: + type: string + example: "2018-01-02" + - name: registratiedatum + required: false + in: query + description: + De datum waarop de zaakbehandelende organisatie de ZAAK heeft + geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag + gebruikt. + schema: + type: string + example: "2015-01-02" + - name: registratiedatum__gt + required: false + in: query + description: + De registratiedatum is groter dan de opgegeven datum. + schema: + type: string + example: "2014-01-02" + - name: registratiedatum__lt + required: false + in: query + description: + De registratiedatum is kleiner dan de opgegeven datum. + schema: + type: string + example: "2016-01-02" + - name: einddatum + required: false + in: query + description: De datum waarop de uitvoering van de zaak afgerond is. + schema: + type: string + example: "2022-01-02" + - name: einddatum__isnull + required: false + in: query + description: De einddatum is leeg. + schema: + type: boolean + example: false + - name: einddatum__gt + required: false + in: query + description: De einddatum is groter dan de opgegeven datum. + schema: + type: string + example: "2021-01-02" + - name: einddatum__lt + required: false + in: query + description: De einddatum is kleiner dan de opgegeven datum. + schema: + type: string + example: "2023-01-02" + - name: einddatumGepland + required: false + in: query + description: + De datum waarop volgens de planning verwacht wordt dat de zaak + afgerond wordt. + schema: + type: string + example: "2022-01-02" + - name: einddatumGepland__gt + required: false + in: query + description: + De geplande einddatum is groter dan de opgegeven datum. + schema: + type: string + example: "2021-01-02" + - name: einddatumGepland__lt + required: false + in: query + description: + De geplande einddatum is kleiner dan de opgegeven datum. + schema: + type: string + example: "2024-01-02" + - name: uiterlijkeEinddatumAfdoening + required: false + in: query + description: + De laatste datum waarop volgens wet- en regelgeving de zaak afgerond + dient te zijn. + schema: + type: string + example: "2024-01-02" + - name: uiterlijkeEinddatumAfdoening__gt + required: false + in: query + description: + De uiterlijke einddatumafdoening is groter dan de opgegeven datum. + schema: + type: string + example: "2023-01-02" + - name: uiterlijkeEinddatumAfdoening__lt + required: false + in: query + description: + De uiterlijke einddatumafdoening is kleiner dan de opgegeven datum. + schema: + type: string + example: "2025-01-02" + - name: rol__betrokkeneType + required: false + in: query + description: Type van de `betrokkene`. + schema: + type: string + enum: + - natuurlijk_persoon + - niet_natuurlijk_persoon + - vestiging + - organisatorische_eenheid + - medewerker + example: "natuurlijk_persoon" + - name: rol__betrokkene + required: false + in: query + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + schema: + type: string + format: uri + example: "https://example.com" + - name: rol__omschrijvingGeneriek + required: false + in: query + description: + Algemeen gehanteerde benaming van de aard van de ROL, afgeleid + uit het ROLTYPE. + schema: + type: string + enum: + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator + example: "initiator" + - name: maximaleVertrouwelijkheidaanduiding + required: false + in: query + description: + Zaken met een vertrouwelijkheidaanduiding die beperkter is dan + de aangegeven aanduiding worden uit de resultaten gefiltered. + schema: + type: string + enum: + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim + example: "zaakvertrouwelijk" + - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn + required: false + in: query + description: + Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene + bepalingen burgerservicenummer. + schema: + type: string + maxLength: 9 + example: "123456789" + - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie + required: false + in: query + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NATUURLIJK PERSOON + schema: + type: string + maxLength: 17 + example: "123456789" + - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer + required: false + in: query + description: Het administratienummer van de persoon, bedoeld in de Wet BRP + schema: + type: string + maxLength: 10 + example: "123456789" + - name: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId + required: false + in: query + description: + Het door een kamer toegekend uniek nummer voor de INGESCHREVEN + NIET-NATUURLIJK PERSOON + schema: + type: string + example: "123456789" + - name: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie + required: false + in: query + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NIET-NATUURLIJK PERSOON + schema: + type: string + maxLength: 17 + example: "123456789" + - name: rol__betrokkeneIdentificatie__vestiging__vestigingsNummer + required: false + in: query + description: Een korte unieke aanduiding van de Vestiging. + schema: + type: string + maxLength: 24 + example: "123456789" + - name: rol__betrokkeneIdentificatie__medewerker__identificatie + required: false + in: query + description: Een korte unieke aanduiding van de MEDEWERKER. + schema: + type: string + maxLength: 24 + example: "123456789" + - name: rol__betrokkeneIdentificatie__organisatorischeEenheid__identificatie + required: false + in: query + description: Een korte identificatie van de organisatorische eenheid. + schema: + type: string + example: "123456789" + - name: expand + in: query + description: Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt. + schema: + type: string + example: zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype + - name: ordering + required: false + in: query + description: Het veld waarop de resultaten geordend worden. Het minnetje betekent omgekeerde volgorde. + schema: + type: array + items: + type: string + enum: + - startdatum + - -startdatum + - einddatum + - -einddatum + - publicatiedatum + - -publicatiedatum + - archiefactiedatum + - -archiefactiedatum + - registratiedatum + - -registratiedatum + - identificatie + - -identificatie + example: "-startdatum" + style: form + explode: false + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + example: 1 + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedZaakList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaak_create + description: + 'Indien geen identificatie gegeven is, dan wordt deze automatisch + gegenereerd. De identificatie moet uniek zijn binnen de bronorganisatie. + + + **Er wordt gevalideerd op:** + + - geldigheid `zaaktype` URL - de resource moet opgevraagd kunnen worden uit + de Catalogi API en de vorm van een ZAAKTYPE hebben. + + - `zaaktype` is geen concept (`zaaktype.concept = False`) + + - `laatsteBetaaldatum` mag niet in de toekomst liggen. + + - `laatsteBetaaldatum` mag niet gezet worden als de betalingsindicatie "nvt" + is. + + - `barchiefnominatie` moet een waarde hebben indien archiefstatus niet de + waarde "nog_te_archiveren" heeft. + + - `archiefactiedatum` moet een waarde hebben indien archiefstatus niet de + waarde "nog_te_archiveren" heeft. + + - `archiefstatus` kan alleen een waarde anders dan "nog_te_archiveren" hebben + indien van alle gerelateeerde INFORMATIEOBJECTen het attribuut `status` de + waarde "gearchiveerd" heeft.' + summary: Maak een ZAAK aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Zaak' + required: true + security: + - JWT-Claims: + - zaken.aanmaken + responses: + '201': + headers: + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Zaak' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{uuid}: + get: + operationId: zaak_retrieve + description: Een specifieke ZAAK opvragen. + summary: Een specifieke ZAAK opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + - name: expand + in: query + description: Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt. + schema: + type: string + example: zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaak_update + description: + "**Er wordt gevalideerd op** \n- `identificatie` mag niet gewijzigd worden.\n- `laatsteBetaaldatum`\ + \ mag niet in de toekomst liggen.\n- `laatsteBetaaldatum` mag niet gezet worden\ + \ als de betalingsindicatie\n\"nvt\" is.\n- `archiefnominatie` moet een waarde\ + \ hebben indien `archiefstatus` niet de\nwaarde \"nog_te_archiveren\" heeft.\n\ + - `archiefactiedatum` moet een waarde hebben indien `archiefstatus` niet de\n\ + \ waarde \"nog_te_archiveren\" heeft.\n- `archiefstatus` kan alleen een waarde\ + \ anders dan \"nog_te_archiveren\"\n hebben indien van alle gerelateeerde\ + \ INFORMATIEOBJECTen het attribuut\n `status` de waarde \"gearchiveerd\"\ + \ heeft.\n**Opmerkingen**\n- er worden enkel zaken getoond van de zaaktypes\ + \ waar u toe geautoriseerd\n bent.\n- indien een zaak heropend moet worden,\ + \ doe dit dan door een nieuwe status\n toe te voegen die NIET de eindstatus\ + \ is. Zie de `Status` resource." + summary: Werk een ZAAK in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Zaak' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Zaak' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaak_partial_update + description: + "**Er wordt gevalideerd op** \n- `identificatie` mag niet gewijzigd worden.\n- `laatsteBetaaldatum`\ + \ mag niet in de toekomst liggen.\n- `laatsteBetaaldatum` mag niet gezet worden\ + \ als de betalingsindicatie\n\"nvt\" is.\n- `archiefnominatie` moet een waarde\ + \ hebben indien `archiefstatus` niet de\nwaarde \"nog_te_archiveren\" heeft.\n\ + - `archiefactiedatum` moet een waarde hebben indien `archiefstatus` niet de\n\ + \ waarde \"nog_te_archiveren\" heeft.\n- `archiefstatus` kan alleen een waarde\ + \ anders dan \"nog_te_archiveren\"\n hebben indien van alle gerelateeerde\ + \ INFORMATIEOBJECTen het attribuut\n `status` de waarde \"gearchiveerd\"\ + \ heeft.\n**Opmerkingen**\n- er worden enkel zaken getoond van de zaaktypes\ + \ waar u toe geautoriseerd\n bent.\n- indien een zaak heropend moet worden,\ + \ doe dit dan door een nieuwe status\n toe te voegen die NIET de eindstatus\ + \ is. Zie de `Status` resource." + summary: Werk een ZAAK deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedZaak' + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Zaak' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaak_destroy + description: '***De gerelateerde resources zijn hierbij*** + + - `zaak` - de deelzaken van de verwijderde hoofzaak + + - `status` - alle statussen van de verwijderde zaak + + - `resultaat` - het resultaat van de verwijderde zaak + + - `rol` - alle rollen bij de zaak + + - `zaakobject` - alle zaakobjecten bij de zaak + + - `zaakeigenschap` - alle eigenschappen van de zaak + + - `zaakkenmerk` - alle kenmerken van de zaak + + - `zaakinformatieobject` - dit moet door-cascaden naar de Documenten API, + zie ook: https://github.com/VNG-Realisatie/gemma-zaken/issues/791 (TODO) + + - `klantcontact` - alle klantcontacten bij een zaak' + summary: Verwijder een ZAAK. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.verwijderen + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaak_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAK opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaken/{zaak_uuid}/audittrail: + get: + operationId: audittrail_list + description: Alle audit trail regels behorend bij de ZAAK. + summary: Alle audit trail regels behorend bij de ZAAK. + parameters: + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - audittrails.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AuditTrail' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{zaak_uuid}/audittrail/{uuid}: + get: + operationId: audittrail_retrieve + description: Een specifieke audit trail regel opvragen. + summary: 'Een specifieke audit trail regel opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke identificatie van de audit regel. + title: uuid + required: true + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - audittrails.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/AuditTrail' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{zaak_uuid}/besluiten: + get: + operationId: zaakbesluit_list + description: Alle ZAAKBESLUITen opvragen. + summary: Alle ZAAKBESLUITen opvragen. + parameters: + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ZaakBesluit' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakbesluit_create + description: + '**LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** + + + De Besluiten API gebruikt dit endpoint om relaties te synchroniseren, daarom + is dit endpoint in de Zaken API geimplementeerd. + + + **Er wordt gevalideerd op:** + + - geldigheid URL naar de ZAAK' + summary: Maak een ZAAKBESLUIT aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakBesluit' + required: true + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakBesluit' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{zaak_uuid}/besluiten/{uuid}: + get: + operationId: zaakbesluit_retrieve + description: Een specifiek ZAAKBESLUIT opvragen. + summary: 'Een specifiek ZAAKBESLUIT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakBesluit' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakbesluit_destroy + description: + '***LET OP: Dit endpoint hoor je als consumer niet zelf aan te + spreken.*** + + + De Besluiten API gebruikt dit endpoint om relaties te synchroniseren, daarom + is dit endpoint in de Zaken API geimplementeerd. + + ' + summary: Verwijder een ZAAKBESLUIT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{zaak_uuid}/zaakeigenschappen: + get: + operationId: zaakeigenschap_list + description: Alle ZAAKEIGENSCHAPpen opvragen. + summary: 'Alle ZAAKEIGENSCHAPpen opvragen. ' + parameters: + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ZaakEigenschap' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakeigenschap_create + description: 'Maak een ZAAKEIGENSCHAP aan. + + + **Er wordt gevalideerd op:** + + - geldigheid `eigenschap` URL - de resource moet opgevraagd kunnen worden + uit de Catalogi API en de vorm van een EIGENSCHAP hebben. + + - de `eigenschap` moet bij het `ZAAK.zaaktype` horen' + summary: Maak een ZAAKEIGENSCHAP aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{zaak_uuid}/zaakeigenschappen/{uuid}: + get: + operationId: zaakeigenschap_retrieve + description: Een specifieke ZAAKEIGENSCHAP opvragen. + summary: Een specifieke ZAAKEIGENSCHAP opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaakeigenschap_update + description: + "**Er wordt gevalideerd op** \n- Alleen de `waarde` mag gewijzigd\ + \ worden" + summary: Werk een ZAAKEIGENSCHAP in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaakeigenschap_partial_update + description: + "**Er wordt gevalideerd op** \n- Alleen de `waarde` mag gewijzigd\ + \ worden" + summary: Werk een ZAAKEIGENSCHAP deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedZaakEigenschap' + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakeigenschap_destroy + description: Verwijder een ZAAKEIGENSCHAP + summary: Verwijder een ZAAKEIGENSCHAP. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaakeigenschap_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAKEIGENSCHAP opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaken/_zoek: + post: + operationId: zaak__zoek + description: + Zoeken/filteren gaat normaal via de `list` operatie, deze is echter + niet geschikt voor geo-zoekopdrachten. + summary: Voer een (geo)-zoekopdracht uit op ZAAKen. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: query + name: page + schema: + type: integer + description: Een pagina binnen de gepagineerde set resultaten. + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakZoek' + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedZaakList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error +components: + responses: + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + schemas: + AardRelatieEnum: + enum: + - vervolg + - onderwerp + - bijdrage + type: string + AardRelatieWeergaveEnum: + enum: + - 'Hoort bij, omgekeerd: kent' + - 'Legt vast, omgekeerd: kan vastgelegd zijn als' + type: string + ArchiefnominatieEnum: + enum: + - blijvend_bewaren + - vernietigen + type: string + ArchiefstatusEnum: + enum: + - nog_te_archiveren + - gearchiveerd + - gearchiveerd_procestermijn_onbekend + - overgedragen + type: string + AuditTrail: + type: object + properties: + uuid: + type: string + format: uuid + description: Unieke identificatie van de audit regel. + title: uuid + bron: + allOf: + - $ref: '#/components/schemas/BronEnum' + description: + 'De naam van het component waar de wijziging in is gedaan. + + + Uitleg bij mogelijke waarden: + + + * `ac` - Autorisaties API + + * `nrc` - Notificaties API + + * `zrc` - Zaken API + + * `ztc` - Catalogi API + + * `drc` - Documenten API + + * `brc` - Besluiten API + + * `cmc` - Contactmomenten API + + * `kc` - Klanten API + + * `vrc` - Verzoeken API' + title: bron + applicatieId: + type: string + description: Unieke identificatie van de applicatie, binnen de organisatie. + title: applicatie id + maxLength: 100 + applicatieWeergave: + type: string + description: Vriendelijke naam van de applicatie. + title: applicatie weergave + maxLength: 200 + gebruikersId: + type: string + description: + Unieke identificatie van de gebruiker die binnen de organisatie + herleid kan worden naar een persoon. + title: gebruikers id + maxLength: 255 + gebruikersWeergave: + type: string + description: Vriendelijke naam van de gebruiker. + title: gebruikers weergave + maxLength: 255 + actie: + type: string + description: 'De uitgevoerde handeling. + + + De bekende waardes voor dit veld zijn hieronder aangegeven, maar + andere waardes zijn ook toegestaan + + + Uitleg bij mogelijke waarden: + + + * `create` - Object aangemaakt + + * `list` - Lijst van objecten opgehaald + + * `retrieve` - Object opgehaald + + * `destroy` - Object verwijderd + + * `update` - Object bijgewerkt + + * `partial_update` - Object deels bijgewerkt' + title: actie + maxLength: 50 + actieWeergave: + type: string + description: Vriendelijke naam van de actie. + title: actie weergave + maxLength: 200 + resultaat: + type: integer + maximum: 599 + minimum: 100 + description: HTTP status code van de API response van de uitgevoerde handeling. + title: resultaat + hoofdObject: + type: string + format: uri + description: De URL naar het hoofdobject van een component. + title: hoofd object + maxLength: 1000 + resource: + type: string + description: Het type resource waarop de actie gebeurde. + title: resource + maxLength: 50 + resourceUrl: + type: string + format: uri + description: De URL naar het object. + title: resource url + maxLength: 1000 + toelichting: + type: string + description: Toelichting waarom de handeling is uitgevoerd. + title: toelichting + resourceWeergave: + type: string + description: Vriendelijke identificatie van het object. + title: resource weergave + maxLength: 200 + aanmaakdatum: + type: string + format: date-time + readOnly: true + description: De datum waarop de handeling is gedaan. + title: aanmaakdatum + wijzigingen: + allOf: + - $ref: '#/components/schemas/Wijzigingen' + title: wijzigingen + required: + - aanmaakdatum + - actie + - bron + - hoofdObject + - resource + - resourceUrl + - resourceWeergave + - resultaat + - wijzigingen + BetalingsindicatieEnum: + enum: + - nvt + - nog_niet + - gedeeltelijk + - geheel + type: string + BetrokkeneTypeEnum: + enum: + - natuurlijk_persoon + - niet_natuurlijk_persoon + - vestiging + - organisatorische_eenheid + - medewerker + type: string + BlankEnum: + enum: + - '' + BronEnum: + enum: + - ac + - nrc + - zrc + - ztc + - drc + - brc + - cmc + - kc + - vrc + type: string + ContactPersoonRol: + type: object + description: + De gegevens van de persoon die anderen desgevraagd in contact brengt + met medewerkers van de BETROKKENE, een NIET-NATUURLIJK PERSOON of VESTIGING + zijnde, of met BETROKKENE zelf, een NATUURLIJK PERSOON zijnde , vanuit het + belang van BETROKKENE in haar ROL bij een ZAAK. + properties: + emailadres: + type: string + format: email + title: Email + description: + Elektronich postadres waaronder de contactpersoon in de regel + bereikbaar is. + maxLength: 254 + functie: + type: string + description: + 'De aanduiding van de taken, rechten en plichten die de contactpersoon + heeft binnen de organisatie van BETROKKENE. ' + title: functie + maxLength: 50 + telefoonnummer: + type: string + description: + Telefoonnummer waaronder de contactpersoon in de regel bereikbaar + is. + title: telefoonnummer + maxLength: 20 + naam: + type: string + description: De opgemaakte naam van de contactpersoon namens de BETROKKENE. + title: naam + maxLength: 40 + required: + - naam + nullable: true + FieldValidationError: + type: object + description: Formaat van validatiefouten. + properties: + name: + type: string + description: Naam van het veld met ongeldige gegevens + title: name + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + reason: + type: string + description: Uitleg wat er precies fout is met de gegevens + title: reason + required: + - code + - name + - reason + Fout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: + URI met referentie naar dit specifiek voorkomen van de fout. + Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + required: + - code + - detail + - instance + - status + - title + GeoJSONGeometry: + title: GeoJSONGeometry + type: object + oneOf: + - $ref: '#/components/schemas/Point' + - $ref: '#/components/schemas/MultiPoint' + - $ref: '#/components/schemas/LineString' + - $ref: '#/components/schemas/MultiLineString' + - $ref: '#/components/schemas/Polygon' + - $ref: '#/components/schemas/MultiPolygon' + - $ref: '#/components/schemas/GeometryCollection' + discriminator: + propertyName: type + GeoWithin: + type: object + properties: + within: + allOf: + - $ref: '#/components/schemas/GeoJSONGeometry' + title: within + Geometry: + title: Geometry + description: GeoJSON geometry + type: object + required: + - type + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1 + properties: + type: + allOf: + - $ref: '#/components/schemas/GeometryTypeEnum' + description: The geometry type + GeometryCollection: + title: Geometry collection + description: GeoJSON multi-polygon geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.8 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - geometries + properties: + geometries: + type: array + items: + $ref: '#/components/schemas/Geometry' + GeometryTypeEnum: + type: string + enum: + - Point + - MultiPoint + - LineString + - MultiLineString + - Polygon + - MultiPolygon + - Feature + - FeatureCollection + - GeometryCollection + GeslachtsaanduidingEnum: + enum: + - m + - v + - o + type: string + IndicatieMachtigingEnum: + enum: + - gemachtigde + - machtiginggever + type: string + InnRechtsvormEnum: + enum: + - besloten_vennootschap + - cooperatie_europees_economische_samenwerking + - europese_cooperatieve_venootschap + - europese_naamloze_vennootschap + - kerkelijke_organisatie + - naamloze_vennootschap + - onderlinge_waarborg_maatschappij + - overig_privaatrechtelijke_rechtspersoon + - stichting + - vereniging + - vereniging_van_eigenaars + - publiekrechtelijke_rechtspersoon + - vennootschap_onder_firma + - maatschap + - rederij + - commanditaire_vennootschap + - kapitaalvennootschap_binnen_eer + - overige_buitenlandse_rechtspersoon_vennootschap + - kapitaalvennootschap_buiten_eer + type: string + KlantContact: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: De unieke aanduiding van een KLANTCONTACT + title: identificatie + maxLength: 14 + datumtijd: + type: string + format: date-time + description: De datum en het tijdstip waarop het KLANTCONTACT begint + title: datumtijd + kanaal: + type: string + description: Het communicatiekanaal waarlangs het KLANTCONTACT gevoerd wordt + title: kanaal + maxLength: 20 + onderwerp: + type: string + description: Het onderwerp waarover contact is geweest met de klant. + title: onderwerp + maxLength: 200 + toelichting: + type: string + description: Een toelichting die inhoudelijk het contact met de klant beschrijft. + title: toelichting + maxLength: 1000 + required: + - datumtijd + - url + - uuid + - zaak + LineString: + title: Line-string + description: GeoJSON line-string geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.4 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + type: array + items: + $ref: '#/components/schemas/Point2D' + minItems: 2 + MultiLineString: + title: Multi-line string + description: GeoJSON multi-line-string geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.5 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + type: array + items: + type: array + items: + $ref: '#/components/schemas/Point2D' + MultiPoint: + title: MultiPoint + description: GeoJSON multi-point geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.3 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + type: array + items: + $ref: '#/components/schemas/Point2D' + MultiPolygon: + title: Multi-polygon + description: GeoJSON multi-polygon geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.7 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + type: array + items: + type: array + items: + type: array + items: + $ref: '#/components/schemas/Point2D' + NullEnum: + enum: + - null + ObjectAdres: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + wplWoonplaatsNaam: + type: string + title: wpl woonplaats naam + maxLength: 80 + gorOpenbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: gor openbare ruimte naam + maxLength: 80 + huisnummer: + type: integer + maximum: 99999 + minimum: 0 + title: huisnummer + huisletter: + type: string + title: huisletter + maxLength: 1 + huisnummertoevoeging: + type: string + title: huisnummertoevoeging + maxLength: 4 + postcode: + type: string + title: postcode + maxLength: 7 + required: + - gorOpenbareRuimteNaam + - huisnummer + - identificatie + - wplWoonplaatsNaam + ObjectBuurt: + type: object + properties: + buurtCode: + type: string + description: De code behorende bij de naam van de buurt + title: buurt code + maxLength: 2 + buurtNaam: + type: string + description: De naam van de buurt, zoals die door het CBS wordt gebruikt. + title: buurt naam + maxLength: 40 + gemGemeenteCode: + type: string + description: + Een numerieke aanduiding waarmee een Nederlandse gemeente uniek + wordt aangeduid + title: gem gemeente code + maxLength: 4 + wykWijkCode: + type: string + description: De code behorende bij de naam van de wijk + title: wyk wijk code + maxLength: 2 + required: + - buurtCode + - buurtNaam + - gemGemeenteCode + - wykWijkCode + ObjectGemeente: + type: object + properties: + gemeenteNaam: + type: string + description: "De offici\xEBle door de gemeente vastgestelde gemeentenaam." + title: gemeente naam + maxLength: 80 + gemeenteCode: + type: string + description: + Een numerieke aanduiding waarmee een Nederlandse gemeente uniek + wordt aangeduid + title: gemeente code + maxLength: 4 + required: + - gemeenteCode + - gemeenteNaam + ObjectGemeentelijkeOpenbareRuimte: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + openbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: openbare ruimte naam + maxLength: 80 + required: + - identificatie + - openbareRuimteNaam + ObjectHuishouden: + type: object + properties: + nummer: + type: string + description: + Uniek identificerend administratienummer van een huishouden + zoals toegekend door de gemeente waarin het huishouden woonachtig is. + title: nummer + maxLength: 12 + isGehuisvestIn: + allOf: + - $ref: '#/components/schemas/ObjectTerreinGebouwdObject' + nullable: true + title: isGehuisvestIn + required: + - nummer + ObjectInrichtingselement: + type: object + properties: + type: + allOf: + - $ref: '#/components/schemas/ObjectInrichtingselementTypeEnum' + description: 'Specificatie van de aard van het inrichtingselement. + + + Uitleg bij mogelijke waarden: + + + * `bak` - Bak + + * `bord` - Bord + + * `installatie` - Installatie + + * `kast` - Kast + + * `mast` - Mast + + * `paal` - Paal + + * `sensor` - Sensor + + * `straatmeubilair` - Straatmeubilair + + * `waterinrichtingselement` - Waterinrichtingselement + + * `weginrichtingselement` - Weginrichtingselement' + title: type + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + description: De benaming van het OBJECT + title: naam + maxLength: 500 + required: + - identificatie + - type + ObjectInrichtingselementTypeEnum: + enum: + - bak + - bord + - installatie + - kast + - mast + - paal + - sensor + - straatmeubilair + - waterinrichtingselement + - weginrichtingselement + type: string + ObjectKadastraleOnroerendeZaak: + type: object + properties: + kadastraleIdentificatie: + type: string + description: De unieke identificatie van het OBJECT + title: kadastrale identificatie + maxLength: 100 + kadastraleAanduiding: + type: string + description: + De typering van de kadastrale aanduiding van een onroerende + zaak conform Kadaster + title: kadastrale aanduiding + maxLength: 1000 + required: + - kadastraleAanduiding + - kadastraleIdentificatie + ObjectKunstwerkdeel: + type: object + properties: + type: + allOf: + - $ref: '#/components/schemas/ObjectKunstwerkdeelTypeEnum' + description: + 'Specificatie van het soort Kunstwerk waartoe het kunstwerkdeel + behoort. + + + Uitleg bij mogelijke waarden: + + + * `keermuur` - Keermuur + + * `overkluizing` - Overkluizing + + * `duiker` - Duiker + + * `faunavoorziening` - Faunavoorziening + + * `vispassage` - Vispassage + + * `bodemval` - Bodemval + + * `coupure` - Coupure + + * `ponton` - Ponton + + * `voorde` - Voorde + + * `hoogspanningsmast` - Hoogspanningsmast + + * `gemaal` - Gemaal + + * `perron` - Perron + + * `sluis` - Sluis + + * `strekdam` - Strekdam + + * `steiger` - Steiger + + * `stuw` - Stuw' + title: type + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + title: naam + maxLength: 80 + required: + - identificatie + - naam + - type + ObjectKunstwerkdeelTypeEnum: + enum: + - keermuur + - overkluizing + - duiker + - faunavoorziening + - vispassage + - bodemval + - coupure + - ponton + - voorde + - hoogspanningsmast + - gemaal + - perron + - sluis + - strekdam + - steiger + - stuw + type: string + ObjectMaatschappelijkeActiviteit: + type: object + properties: + kvkNummer: + type: string + description: + Landelijk uniek identificerend administratienummer van een + MAATSCHAPPELIJKE ACTIVITEIT zoals toegewezen door de Kamer van Koophandel + (KvK). + title: kvk nummer + maxLength: 8 + handelsnaam: + type: string + description: De naam waaronder de onderneming handelt. + title: handelsnaam + maxLength: 200 + required: + - handelsnaam + - kvkNummer + ObjectOpenbareRuimte: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + wplWoonplaatsNaam: + type: string + title: wpl woonplaats naam + maxLength: 80 + gorOpenbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: gor openbare ruimte naam + maxLength: 80 + required: + - gorOpenbareRuimteNaam + - identificatie + - wplWoonplaatsNaam + ObjectOverige: + type: object + properties: + overigeData: + type: object + additionalProperties: {} + title: overige data + required: + - overigeData + ObjectPand: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + required: + - identificatie + ObjectSpoorbaandeel: + type: object + properties: + type: + allOf: + - $ref: '#/components/schemas/ObjectSpoorbaandeelTypeEnum' + description: 'Specificatie van het soort Spoorbaan + + + Uitleg bij mogelijke waarden: + + + * `breedspoor` - breedspoor + + * `normaalspoor` - normaalspoor + + * `smalspoor` - smalspoor + + * `spoorbaan` - spoorbaan' + title: type + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + description: De benaming van het OBJECT + title: naam + maxLength: 500 + required: + - identificatie + - type + ObjectSpoorbaandeelTypeEnum: + enum: + - breedspoor + - normaalspoor + - smalspoor + - spoorbaan + type: string + ObjectTerreinGebouwdObject: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + adresAanduidingGrp: + allOf: + - $ref: '#/components/schemas/TerreinGebouwdObjectAdres' + nullable: true + title: adresAanduidingGrp + required: + - identificatie + ObjectTerreindeel: + type: object + properties: + type: + type: string + title: type + maxLength: 40 + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + description: De benaming van het OBJECT + title: naam + maxLength: 500 + required: + - identificatie + - type + ObjectTypeEnum: + enum: + - adres + - besluit + - buurt + - enkelvoudig_document + - gemeente + - gemeentelijke_openbare_ruimte + - huishouden + - inrichtingselement + - kadastrale_onroerende_zaak + - kunstwerkdeel + - maatschappelijke_activiteit + - medewerker + - natuurlijk_persoon + - niet_natuurlijk_persoon + - openbare_ruimte + - organisatorische_eenheid + - pand + - spoorbaandeel + - status + - terreindeel + - terrein_gebouwd_object + - vestiging + - waterdeel + - wegdeel + - wijk + - woonplaats + - woz_deelobject + - woz_object + - woz_waarde + - zakelijk_recht + - overige + type: string + ObjectTypeOverigeDefinitie: + type: object + properties: + url: + type: string + format: uri + title: Objecttype-URL + description: + URL-referentie naar de objecttype resource in een API. Deze + resource moet de [JSON-schema](https://json-schema.org/)-definitie van + het objecttype bevatten. + maxLength: 1000 + schema: + type: string + title: schema-pad + description: + 'Een geldige [jq](http://stedolan.github.io/jq/) expressie. + Dit wordt gecombineerd met de resource uit het `url`-attribuut om het + schema van het objecttype uit te lezen. Bijvoorbeeld: `.jsonSchema`.' + maxLength: 100 + objectData: + type: string + title: objectgegevens-pad + description: + 'Een geldige [jq](http://stedolan.github.io/jq/) expressie. + Dit wordt gecombineerd met de JSON data uit de OBJECT url om de objectgegevens + uit te lezen en de vorm van de gegevens tegen het schema te valideren. + Bijvoorbeeld: `.record.data`.' + maxLength: 100 + required: + - objectData + - schema + - url + ObjectWaterdeel: + type: object + properties: + typeWaterdeel: + allOf: + - $ref: '#/components/schemas/TypeWaterdeelEnum' + description: 'Specificatie van het soort water + + + Uitleg bij mogelijke waarden: + + + * `zee` - Zee + + * `waterloop` - Waterloop + + * `watervlakte` - Watervlakte + + * `greppel_droge_sloot` - Greppel, droge sloot' + title: type waterdeel + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + description: De benaming van het OBJECT + title: naam + maxLength: 500 + required: + - identificatie + - typeWaterdeel + ObjectWegdeel: + type: object + properties: + type: + type: string + title: type + maxLength: 100 + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + description: De benaming van het OBJECT + title: naam + maxLength: 500 + required: + - identificatie + - type + ObjectWijk: + type: object + properties: + wijkCode: + type: string + description: De code behorende bij de naam van de wijk. + title: wijk code + maxLength: 2 + wijkNaam: + type: string + description: De naam van de wijk, zoals die door het CBS wordt gebruikt. + title: wijk naam + maxLength: 40 + gemGemeenteCode: + type: string + description: + Een numerieke aanduiding waarmee een Nederlandse gemeente uniek + wordt aangeduid + title: gem gemeente code + maxLength: 4 + required: + - gemGemeenteCode + - wijkCode + - wijkNaam + ObjectWoonplaats: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + woonplaatsNaam: + type: string + description: + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + toegekende benaming. + title: woonplaats naam + maxLength: 80 + required: + - identificatie + - woonplaatsNaam + ObjectWozDeelobject: + type: object + properties: + nummerWozDeelObject: + type: string + description: Uniek identificatienummer voor het deelobject binnen een WOZ-object. + title: nummer woz deel object + maxLength: 6 + isOnderdeelVan: + allOf: + - $ref: '#/components/schemas/ObjectWozObject' + title: isOnderdeelVan + required: + - nummerWozDeelObject + ObjectWozObject: + type: object + properties: + wozObjectNummer: + type: string + description: De unieke identificatie van het OBJECT + title: woz object nummer + maxLength: 100 + aanduidingWozObject: + allOf: + - $ref: '#/components/schemas/WozObjectAdres' + nullable: true + title: aanduidingWozObject + required: + - wozObjectNummer + ObjectWozWaarde: + type: object + properties: + waardepeildatum: + type: string + description: De datum waarnaar de waarde van het WOZ-object wordt bepaald. + title: waardepeildatum + maxLength: 9 + isVoor: + allOf: + - $ref: '#/components/schemas/ObjectWozObject' + title: isVoor + required: + - waardepeildatum + ObjectZakelijkRecht: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + avgAard: + type: string + description: aanduiding voor de aard van het recht + title: avg aard + maxLength: 1000 + heeftBetrekkingOp: + allOf: + - $ref: '#/components/schemas/ObjectKadastraleOnroerendeZaak' + title: heeftBetrekkingOp + heeftAlsGerechtigde: + allOf: + - $ref: '#/components/schemas/ZakelijkRechtHeeftAlsGerechtigde' + title: heeftAlsGerechtigde + required: + - avgAard + - identificatie + Opschorting: + type: object + description: + Gegevens omtrent het tijdelijk opschorten van de behandeling van + de ZAAK + properties: + indicatie: + type: boolean + description: Aanduiding of de behandeling van de ZAAK tijdelijk is opgeschort. + title: indicatie opschorting + reden: + type: string + description: + Omschrijving van de reden voor het opschorten van de behandeling + van de zaak. + title: reden opschorting + maxLength: 200 + required: + - indicatie + - reden + nullable: true + PaginatedKlantContactList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/KlantContact' + PaginatedResultaatList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Resultaat' + PaginatedRolList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Rol' + PaginatedStatusList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Status' + PaginatedZaakList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ZaakExpanded' + PaginatedZaakObjectList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ZaakObject' + PatchedResultaat: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + resultaattype: + type: string + format: uri + description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API). + title: resultaattype + maxLength: 1000 + toelichting: + type: string + description: Een toelichting op wat het resultaat van de zaak inhoudt. + title: toelichting + maxLength: 1000 + PatchedZaak: + type: object + description: 'Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + identificatie: + type: string + description: + De unieke identificatie van de ZAAK binnen de organisatie die + verantwoordelijk is voor de behandeling van de ZAAK. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + description: + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers + en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + title: bronorganisatie + maxLength: 9 + omschrijving: + type: string + description: Een korte omschrijving van de zaak. + title: omschrijving + maxLength: 80 + toelichting: + type: string + description: Een toelichting op de zaak. + title: toelichting + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de + CATALOGUS waar deze voorkomt + title: zaaktype + maxLength: 1000 + registratiedatum: + type: string + format: date + description: + De datum waarop de zaakbehandelende organisatie de ZAAK heeft + geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag + gebruikt. + title: registratiedatum + verantwoordelijkeOrganisatie: + type: string + description: + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die eindverantwoordelijk is voor de behandeling van de zaak. Dit moet + een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + title: verantwoordelijke organisatie + maxLength: 9 + startdatum: + type: string + format: date + description: De datum waarop met de uitvoering van de zaak is gestart + title: startdatum + einddatum: + type: string + format: date + readOnly: true + nullable: true + description: De datum waarop de uitvoering van de zaak afgerond is. + title: einddatum + einddatumGepland: + type: string + format: date + nullable: true + description: + De datum waarop volgens de planning verwacht wordt dat de zaak + afgerond wordt. + title: einddatum gepland + uiterlijkeEinddatumAfdoening: + type: string + format: date + nullable: true + description: + De laatste datum waarop volgens wet- en regelgeving de zaak + afgerond dient te zijn. + title: uiterlijke einddatum afdoening + publicatiedatum: + type: string + format: date + nullable: true + description: Datum waarop (het starten van) de zaak gepubliceerd is of wordt. + title: publicatiedatum + communicatiekanaal: + type: string + format: uri + description: + Het medium waarlangs de aanleiding om een zaak te starten is + ontvangen. URL naar een communicatiekanaal in de VNG-Referentielijst van + communicatiekanalen. + title: communicatiekanaal + maxLength: 1000 + productenOfDiensten: + type: array + items: + type: string + format: uri + title: URL naar product/dienst + maxLength: 1000 + description: + De producten en/of diensten die door de zaak worden voortgebracht. + Dit zijn URLs naar de resources zoals die door de producten- en dienstencatalogus-API + wordt ontsloten. De producten/diensten moeten bij het zaaktype vermeld + zijn. + title: producten of diensten + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + title: Vertrouwlijkheidaanduiding + description: + Aanduiding van de mate waarin het zaakdossier van de ZAAK voor + de openbaarheid bestemd is. Optioneel - indien geen waarde gekozen wordt, + dan wordt de waarde van het ZAAKTYPE overgenomen. Dit betekent dat de + API _altijd_ een waarde teruggeeft. + betalingsindicatie: + description: + 'Indicatie of de, met behandeling van de zaak gemoeide, kosten + betaald zijn door de desbetreffende betrokkene. + + + Uitleg bij mogelijke waarden: + + + * `nvt` - Er is geen sprake van te betalen, met de zaak gemoeide, kosten. + + * `nog_niet` - De met de zaak gemoeide kosten zijn (nog) niet betaald. + + * `gedeeltelijk` - De met de zaak gemoeide kosten zijn gedeeltelijk betaald. + + * `geheel` - De met de zaak gemoeide kosten zijn geheel betaald.' + title: betalingsindicatie + oneOf: + - $ref: '#/components/schemas/BetalingsindicatieEnum' + - $ref: '#/components/schemas/BlankEnum' + betalingsindicatieWeergave: + type: string + readOnly: true + description: Uitleg bij `betalingsindicatie`. + title: betalingsindicatieWeergave + laatsteBetaaldatum: + type: string + format: date-time + nullable: true + description: + De datum waarop de meest recente betaling is verwerkt van kosten + die gemoeid zijn met behandeling van de zaak. + title: laatste betaaldatum + zaakgeometrie: + allOf: + - $ref: '#/components/schemas/GeoJSONGeometry' + nullable: true + description: Punt, lijn of (multi-)vlak geometrie-informatie, in GeoJSON. + title: zaakgeometrie + verlenging: + allOf: + - $ref: '#/components/schemas/Verlenging' + nullable: true + description: + Gegevens omtrent het verlengen van de doorlooptijd van de behandeling + van de ZAAK + title: verlenging + opschorting: + allOf: + - $ref: '#/components/schemas/Opschorting' + nullable: true + description: + Gegevens omtrent het tijdelijk opschorten van de behandeling + van de ZAAK + title: opschorting + selectielijstklasse: + type: string + format: uri + description: + URL-referentie naar de categorie in de gehanteerde 'Selectielijst + Archiefbescheiden' die, gezien het zaaktype en het resultaattype van de + zaak, bepalend is voor het archiefregime van de zaak. + title: selectielijstklasse + maxLength: 1000 + hoofdzaak: + type: string + format: uri + nullable: true + title: Is deelzaak van + description: + "URL-referentie naar de ZAAK, waarom verzocht is door de initiator\ + \ daarvan, die behandeld wordt in twee of meer separate ZAAKen waarvan\ + \ de onderhavige ZAAK er \xE9\xE9n is." + minLength: 1 + maxLength: 1000 + deelzaken: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar deel ZAAKen. + title: is deelzaak van + uniqueItems: true + relevanteAndereZaken: + type: array + items: + $ref: '#/components/schemas/RelevanteZaak' + description: Een lijst van relevante andere zaken. + title: zaak + eigenschappen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + rollen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + status: + type: string + format: uri + readOnly: true + nullable: true + description: Indien geen status bekend is, dan is de waarde 'null' + title: status + zaakinformatieobjecten: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + zaakobjecten: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + kenmerken: + type: array + items: + $ref: '#/components/schemas/ZaakKenmerk' + description: + Lijst van kenmerken. Merk op dat refereren naar gerelateerde + objecten beter kan via `ZaakObject`. + title: zaak + archiefnominatie: + nullable: true + description: + 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + + + Uitleg bij mogelijke waarden: + + + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum + overgedragen worden naar een archiefbewaarplaats. + + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' + title: archiefnominatie + oneOf: + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/NullEnum' + archiefstatus: + allOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + description: + 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + + + Uitleg bij mogelijke waarden: + + + * `nog_te_archiveren` - De zaak cq. het zaakdossier is nog niet als geheel + gearchiveerd. + + * `gearchiveerd` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar + bewaarbaar gemaakt. + + * `gearchiveerd_procestermijn_onbekend` - De zaak cq. het zaakdossier + is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum + kan nog niet bepaald worden. + + * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een + archiefbewaarplaats.' + title: archiefstatus + archiefactiedatum: + type: string + format: date + nullable: true + description: + De datum waarop het gearchiveerde zaakdossier vernietigd moet + worden dan wel overgebracht moet worden naar een archiefbewaarplaats. + Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT + aan deze ZAAK indien nog leeg. + title: archiefactiedatum + resultaat: + type: string + format: uri + readOnly: true + nullable: true + description: + URL-referentie naar het RESULTAAT. Indien geen resultaat bekend + is, dan is de waarde 'null' + title: resultaat + opdrachtgevendeOrganisatie: + type: string + description: + De krachtens publiekrecht ingestelde rechtspersoon dan wel + ander niet-natuurlijk persoon waarbinnen het (bestuurs)orgaan zetelt dat + opdracht heeft gegeven om taken uit te voeren waaraan de zaak invulling + geeft. + title: opdrachtgevende organisatie + maxLength: 9 + processobjectaard: + type: string + nullable: true + title: Procesobjectaard + description: + Omschrijving van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, de zaak betrekking heeft. + maxLength: 200 + startdatumBewaartermijn: + type: string + format: date + nullable: true + description: + De datum die de start markeert van de termijn waarop het zaakdossier + vernietigd moet worden. + title: startdatum bewaartermijn + processobject: + allOf: + - $ref: '#/components/schemas/Processobject' + nullable: true + description: + Specificatie van de attribuutsoort van het object, subject + of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking + heeft en dat bepalend is voor de start van de archiefactietermijn. + title: processobject + PatchedZaakEigenschap: + type: object + description: + "A type of `ModelSerializer` that uses hyperlinked relationships + with compound keys instead + + of primary key relationships. Specifically: + + + * A 'url' field is included instead of the 'id' field. + + * Relationships to other instances are hyperlinks, instead of primary keys. + + + NOTE: this only works with DRF 3.1.0 and above." + properties: + url: + type: string + format: uri + readOnly: true + title: url + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + title: zaak + eigenschap: + type: string + format: uri + description: URL-referentie naar de EIGENSCHAP (in de Catalogi API). + title: eigenschap + maxLength: 1000 + naam: + type: string + readOnly: true + description: De naam van de EIGENSCHAP (overgenomen uit de Catalogi API). + title: ' naam' + waarde: + type: string + title: waarde + PatchedZaakInformatieObject: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + informatieobject: + type: string + format: uri + description: + URL-referentie naar het INFORMATIEOBJECT (in de Documenten + API), waar ook de relatieinformatie opgevraagd kan worden. + title: informatieobject + maxLength: 1000 + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + aardRelatieWeergave: + allOf: + - $ref: '#/components/schemas/AardRelatieWeergaveEnum' + readOnly: true + title: aardRelatieWeergave + titel: + type: string + description: + De naam waaronder het INFORMATIEOBJECT binnen het OBJECT bekend + is. + title: titel + maxLength: 200 + beschrijving: + type: string + description: + Een op het object gerichte beschrijving van de inhoud vanhet + INFORMATIEOBJECT. + title: beschrijving + registratiedatum: + type: string + format: date-time + readOnly: true + description: + De datum waarop de behandelende organisatie het INFORMATIEOBJECT + heeft geregistreerd bij het OBJECT. Geldige waardes zijn datumtijden gelegen + op of voor de huidige datum en tijd. + title: registratiedatum + vernietigingsdatum: + type: string + format: date-time + nullable: true + description: + De datum waarop het informatieobject uit het zaakdossier verwijderd + moet worden. + title: vernietigingsdatum + status: + type: string + format: uri + nullable: true + description: + De bij de desbetreffende ZAAK behorende STATUS waarvoor het + ZAAK-INFORMATIEOBJECT relevant is (geweest) met het oog op het bereiken + van die STATUS en/of de communicatie daarover. + title: status + minLength: 1 + maxLength: 1000 + PatchedZaakObject: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + object: + type: string + format: uri + description: URL-referentie naar de resource die het OBJECT beschrijft. + title: object + maxLength: 1000 + zaakobjecttype: + type: string + format: uri + description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API). + title: zaakobjecttype + maxLength: 1000 + objectType: + allOf: + - $ref: '#/components/schemas/ObjectTypeEnum' + description: + 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er + geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. + + + Uitleg bij mogelijke waarden: + + + * `adres` - Adres + + * `besluit` - Besluit + + * `buurt` - Buurt + + * `enkelvoudig_document` - Enkelvoudig document + + * `gemeente` - Gemeente + + * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte + + * `huishouden` - Huishouden + + * `inrichtingselement` - Inrichtingselement + + * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak + + * `kunstwerkdeel` - Kunstwerkdeel + + * `maatschappelijke_activiteit` - Maatschappelijke activiteit + + * `medewerker` - Medewerker + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `openbare_ruimte` - Openbare ruimte + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `pand` - Pand + + * `spoorbaandeel` - Spoorbaandeel + + * `status` - Status + + * `terreindeel` - Terreindeel + + * `terrein_gebouwd_object` - Terrein gebouwd object + + * `vestiging` - Vestiging + + * `waterdeel` - Waterdeel + + * `wegdeel` - Wegdeel + + * `wijk` - Wijk + + * `woonplaats` - Woonplaats + + * `woz_deelobject` - Woz deel object + + * `woz_object` - Woz object + + * `woz_waarde` - Woz waarde + + * `zakelijk_recht` - Zakelijk recht + + * `overige` - Overige' + title: object type + objectTypeOverige: + type: string + description: + Beschrijft het type OBJECT als `objectType` de waarde "overige" + heeft. + title: object type overige + pattern: '[a-z\_]+' + maxLength: 100 + objectTypeOverigeDefinitie: + allOf: + - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie' + nullable: true + title: definitie object type overige + description: + 'Verwijzing naar het schema van het type OBJECT als `objectType` + de waarde "overige" heeft. + + + * De URL referentie moet naar een JSON endpoint wijzen waarin het objecttype + gedefinieerd is, inclusief het [JSON-schema](https://json-schema.org/). + + * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen de + objecttype resource (deze gebruikt het [jq](http://stedolan.github.io/jq/) + formaat. + + * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens binnen + het OBJECT. Deze gebruikt ook het [jq](http://stedolan.github.io/jq/) + formaat. + + + Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven + en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven + OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.' + relatieomschrijving: + type: string + description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. + title: relatieomschrijving + maxLength: 80 + discriminator: + propertyName: objectType + mapping: + adres: '#/components/schemas/adres_PatchedZaakObject' + besluit: '#/components/schemas/besluit_PatchedZaakObject' + buurt: '#/components/schemas/buurt_PatchedZaakObject' + enkelvoudig_document: '#/components/schemas/enkelvoudig_document_PatchedZaakObject' + gemeente: '#/components/schemas/gemeente_PatchedZaakObject' + gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_PatchedZaakObject' + huishouden: '#/components/schemas/huishouden_PatchedZaakObject' + inrichtingselement: '#/components/schemas/inrichtingselement_PatchedZaakObject' + kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_PatchedZaakObject' + kunstwerkdeel: '#/components/schemas/kunstwerkdeel_PatchedZaakObject' + maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_PatchedZaakObject' + medewerker: '#/components/schemas/medewerker_PatchedZaakObject' + natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_PatchedZaakObject' + niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_PatchedZaakObject' + openbare_ruimte: '#/components/schemas/openbare_ruimte_PatchedZaakObject' + organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_PatchedZaakObject' + pand: '#/components/schemas/pand_PatchedZaakObject' + spoorbaandeel: '#/components/schemas/spoorbaandeel_PatchedZaakObject' + status: '#/components/schemas/status_PatchedZaakObject' + terreindeel: '#/components/schemas/terreindeel_PatchedZaakObject' + terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_PatchedZaakObject' + vestiging: '#/components/schemas/vestiging_PatchedZaakObject' + waterdeel: '#/components/schemas/waterdeel_PatchedZaakObject' + wegdeel: '#/components/schemas/wegdeel_PatchedZaakObject' + wijk: '#/components/schemas/wijk_PatchedZaakObject' + woonplaats: '#/components/schemas/woonplaats_PatchedZaakObject' + woz_deelobject: '#/components/schemas/woz_deelobject_PatchedZaakObject' + woz_object: '#/components/schemas/woz_object_PatchedZaakObject' + woz_waarde: '#/components/schemas/woz_waarde_PatchedZaakObject' + zakelijk_recht: '#/components/schemas/zakelijk_recht_PatchedZaakObject' + overige: '#/components/schemas/overige_PatchedZaakObject' + Point: + title: Point + description: GeoJSON point geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.2 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + $ref: '#/components/schemas/Point2D' + Point2D: + title: Point2D + type: array + items: + type: number + maxItems: 2 + minItems: 2 + Polygon: + title: Polygon + description: GeoJSON polygon geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.6 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + type: array + items: + type: array + items: + $ref: '#/components/schemas/Point2D' + Processobject: + type: object + description: + Specificatie van de attribuutsoort van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, de zaak betrekking heeft en dat bepalend is voor + de start van de archiefactietermijn. + properties: + datumkenmerk: + type: string + description: + De naam van de attribuutsoort van het procesobject dat bepalend + is voor het einde van de procestermijn. + title: datumkenmerk + maxLength: 250 + identificatie: + type: string + description: De unieke aanduiding van het procesobject. + title: identificatie + maxLength: 250 + objecttype: + type: string + description: Het soort object dat het procesobject representeert. + title: objecttype + maxLength: 250 + registratie: + type: string + description: + De naam van de registratie waarvan het procesobject deel uit + maakt. + title: registratie + maxLength: 250 + required: + - datumkenmerk + - identificatie + - objecttype + - registratie + nullable: true + RelevanteZaak: + type: object + properties: + url: + type: string + format: uri + title: URL-referentie naar de ZAAK. + maxLength: 1000 + aardRelatie: + allOf: + - $ref: '#/components/schemas/AardRelatieEnum' + description: + 'Benamingen van de aard van de relaties van andere zaken tot + (onderhanden) zaken. + + + Uitleg bij mogelijke waarden: + + + * `vervolg` - De andere zaak gaf aanleiding tot het starten van de onderhanden + zaak. + + * `onderwerp` - De andere zaak is relevant voor cq. is onderwerp van de + onderhanden zaak. + + * `bijdrage` - Aan het bereiken van de uitkomst van de andere zaak levert + de onderhanden zaak een bijdrage.' + title: aard relatie + required: + - aardRelatie + - url + Resultaat: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + resultaattype: + type: string + format: uri + description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API). + title: resultaattype + maxLength: 1000 + toelichting: + type: string + description: Een toelichting op wat het resultaat van de zaak inhoudt. + title: toelichting + maxLength: 1000 + required: + - resultaattype + - url + - uuid + - zaak + ResultaatExpanded: + allOf: + - $ref: '#/components/schemas/Resultaat' + - properties: + _expand: + $ref: '#/components/schemas/ResultaatEmbedded' + ResultaatEmbedded: + type: object + properties: + zaak: + $ref: '#/components/schemas/ZaakExpanded' + resultaattype: + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/ResultaatType' + Rol: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + betrokkene: + type: string + format: uri + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + title: betrokkene + maxLength: 1000 + betrokkeneType: + allOf: + - $ref: '#/components/schemas/BetrokkeneTypeEnum' + description: 'Type van de `betrokkene`. + + + Uitleg bij mogelijke waarden: + + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `vestiging` - Vestiging + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `medewerker` - Medewerker' + title: betrokkene type + afwijkendeNaamBetrokkene: + type: string + description: + De naam van de betrokkene waaronder deze in relatie tot de + zaak aangesproken wil worden. + title: afwijkende naam betrokkene + maxLength: 625 + roltype: + type: string + format: uri + description: + URL-referentie naar een roltype binnen het ZAAKTYPE van de + ZAAK. + title: roltype + maxLength: 1000 + omschrijving: + type: string + readOnly: true + description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. + title: omschrijving + omschrijvingGeneriek: + type: string + readOnly: true + description: + "Algemeen gehanteerde benaming van de aard van de ROL, afgeleid\ + \ uit het ROLTYPE.\n\nUitleg bij mogelijke waarden:\n\n* `adviseur` -\ + \ (Adviseur) Kennis in dienst stellen van de behandeling van (een deel\ + \ van) een zaak.\n* `behandelaar` - (Behandelaar) De vakinhoudelijke behandeling\ + \ doen van (een deel van) een zaak.\n* `belanghebbende` - (Belanghebbende)\ + \ Vanuit eigen en objectief belang rechtstreeks betrokken zijn bij de\ + \ behandeling en/of de uitkomst van een zaak.\n* `beslisser` - (Beslisser)\ + \ Nemen van besluiten die voor de uitkomst van een zaak noodzakelijk zijn.\n\ + * `initiator` - (Initiator) Aanleiding geven tot de start van een zaak\ + \ ..\n* `klantcontacter` - (Klantcontacter) Het eerste aanspreekpunt zijn\ + \ voor vragen van burgers en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6\ + rdinator) Er voor zorg dragen dat de behandeling van de zaak in samenhang\ + \ uitgevoerd wordt conform de daarover gemaakte afspraken.\n* `mede_initiator`\ + \ - Mede-initiator" + title: omschrijving generiek + roltoelichting: + type: string + title: roltoelichting + maxLength: 1000 + registratiedatum: + type: string + format: date-time + readOnly: true + description: De datum waarop dit object is geregistreerd. + title: registratiedatum + indicatieMachtiging: + description: 'Indicatie machtiging + + + Uitleg bij mogelijke waarden: + + + * `gemachtigde` - De betrokkene in de rol bij de zaak is door een andere + betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen + + * `machtiginggever` - De betrokkene in de rol bij de zaak heeft een andere + betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen' + title: indicatie machtiging + oneOf: + - $ref: '#/components/schemas/IndicatieMachtigingEnum' + - $ref: '#/components/schemas/BlankEnum' + contactpersoonRol: + allOf: + - $ref: '#/components/schemas/ContactPersoonRol' + nullable: true + description: + De gegevens van de persoon die anderen desgevraagd in contact + brengt met medewerkers van de BETROKKENE, een NIET-NATUURLIJK PERSOON + of VESTIGING zijnde, of met BETROKKENE zelf, een NATUURLIJK PERSOON zijnde + , vanuit het belang van BETROKKENE in haar ROL bij een ZAAK. + title: contactpersoonRol + statussen: + type: array + items: + type: string + format: uri + title: '' + minLength: 1 + maxLength: 1000 + readOnly: true + description: + De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd + dat STATUSsen in die ZAAK bereikt zijn. + title: statussen + uniqueItems: true + required: + - betrokkeneType + - omschrijving + - omschrijvingGeneriek + - registratiedatum + - roltoelichting + - roltype + - statussen + - url + - uuid + - zaak + discriminator: + propertyName: betrokkeneType + mapping: + medewerker: '#/components/schemas/medewerker_Rol' + natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_Rol' + niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_Rol' + organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_Rol' + vestiging: '#/components/schemas/vestiging_Rol' + RolExpanded: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + betrokkene: + type: string + format: uri + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + title: betrokkene + maxLength: 1000 + betrokkeneType: + allOf: + - $ref: '#/components/schemas/BetrokkeneTypeEnum' + description: 'Type van de `betrokkene`. + + + Uitleg bij mogelijke waarden: + + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `vestiging` - Vestiging + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `medewerker` - Medewerker' + title: betrokkene type + afwijkendeNaamBetrokkene: + type: string + description: + De naam van de betrokkene waaronder deze in relatie tot de + zaak aangesproken wil worden. + title: afwijkende naam betrokkene + maxLength: 625 + roltype: + type: string + format: uri + description: + URL-referentie naar een roltype binnen het ZAAKTYPE van de + ZAAK. + title: roltype + maxLength: 1000 + omschrijving: + type: string + readOnly: true + description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. + title: omschrijving + omschrijvingGeneriek: + type: string + readOnly: true + description: + "Algemeen gehanteerde benaming van de aard van de ROL, afgeleid\ + \ uit het ROLTYPE.\n\nUitleg bij mogelijke waarden:\n\n* `adviseur` -\ + \ (Adviseur) Kennis in dienst stellen van de behandeling van (een deel\ + \ van) een zaak.\n* `behandelaar` - (Behandelaar) De vakinhoudelijke behandeling\ + \ doen van (een deel van) een zaak.\n* `belanghebbende` - (Belanghebbende)\ + \ Vanuit eigen en objectief belang rechtstreeks betrokken zijn bij de\ + \ behandeling en/of de uitkomst van een zaak.\n* `beslisser` - (Beslisser)\ + \ Nemen van besluiten die voor de uitkomst van een zaak noodzakelijk zijn.\n\ + * `initiator` - (Initiator) Aanleiding geven tot de start van een zaak\ + \ ..\n* `klantcontacter` - (Klantcontacter) Het eerste aanspreekpunt zijn\ + \ voor vragen van burgers en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6\ + rdinator) Er voor zorg dragen dat de behandeling van de zaak in samenhang\ + \ uitgevoerd wordt conform de daarover gemaakte afspraken.\n* `mede_initiator`\ + \ - Mede-initiator" + title: omschrijving generiek + roltoelichting: + type: string + title: roltoelichting + maxLength: 1000 + registratiedatum: + type: string + format: date-time + readOnly: true + description: De datum waarop dit object is geregistreerd. + title: registratiedatum + indicatieMachtiging: + description: 'Indicatie machtiging + + + Uitleg bij mogelijke waarden: + + + * `gemachtigde` - De betrokkene in de rol bij de zaak is door een andere + betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen + + * `machtiginggever` - De betrokkene in de rol bij de zaak heeft een andere + betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen' + title: indicatie machtiging + oneOf: + - $ref: '#/components/schemas/IndicatieMachtigingEnum' + - $ref: '#/components/schemas/BlankEnum' + contactpersoonRol: + allOf: + - $ref: '#/components/schemas/ContactPersoonRol' + nullable: true + description: + De gegevens van de persoon die anderen desgevraagd in contact + brengt met medewerkers van de BETROKKENE, een NIET-NATUURLIJK PERSOON + of VESTIGING zijnde, of met BETROKKENE zelf, een NATUURLIJK PERSOON zijnde + , vanuit het belang van BETROKKENE in haar ROL bij een ZAAK. + title: contactpersoonRol + statussen: + type: array + items: + type: string + format: uri + title: '' + minLength: 1 + maxLength: 1000 + readOnly: true + description: + De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd + dat STATUSsen in die ZAAK bereikt zijn. + title: statussen + uniqueItems: true + _expand: + $ref: '#/components/schemas/RolEmbedded' + required: + - betrokkeneType + - omschrijving + - omschrijvingGeneriek + - registratiedatum + - roltoelichting + - roltype + - statussen + - url + - uuid + - zaak + discriminator: + propertyName: betrokkeneType + mapping: + medewerker: '#/components/schemas/medewerker_RolExpanded' + natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_RolExpanded' + niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_RolExpanded' + organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_RolExpanded' + vestiging: '#/components/schemas/vestiging_RolExpanded' + + # RolExpanded: + # allOf: + # - $ref: '#/components/schemas/Rol' + # - properties: + # _expand: + # $ref: '#/components/schemas/RolEmbedded' + RolEmbedded: + type: object + properties: + zaak: + $ref: '#/components/schemas/ZaakExpanded' + example: {} + roltype: + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/RolType' + statussen: + type: array + items: + $ref: '#/components/schemas/StatusExpanded' + RolMedewerker: + type: object + properties: + identificatie: + type: string + description: Een korte unieke aanduiding van de MEDEWERKER. + title: identificatie + maxLength: 24 + achternaam: + type: string + description: + De achternaam zoals de MEDEWERKER die in het dagelijkse verkeer + gebruikt. + title: achternaam + maxLength: 200 + voorletters: + type: string + description: + De verzameling letters die gevormd wordt door de eerste letter + van alle in volgorde voorkomende voornamen. + title: voorletters + maxLength: 20 + voorvoegselAchternaam: + type: string + description: + Dat deel van de geslachtsnaam dat voorkomt in Tabel 36 (GBA), + voorvoegseltabel, en door een spatie van de geslachtsnaam is + title: voorvoegsel achternaam + maxLength: 10 + RolNatuurlijkPersoon: + type: object + properties: + inpBsn: + type: string + description: + Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet + algemene bepalingen burgerservicenummer. + title: inp bsn + maxLength: 9 + anpIdentificatie: + type: string + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NATUURLIJK PERSOON + title: anp identificatie + maxLength: 17 + inpA_nummer: + type: string + description: Het administratienummer van de persoon, bedoeld in de Wet BRP + title: inp a nummer + pattern: ^[1-9][0-9]{9}$ + maxLength: 10 + geslachtsnaam: + type: string + description: De stam van de geslachtsnaam. + title: geslachtsnaam + maxLength: 200 + voorvoegselGeslachtsnaam: + type: string + title: voorvoegsel geslachtsnaam + maxLength: 80 + voorletters: + type: string + description: + De verzameling letters die gevormd wordt door de eerste letter + van alle in volgorde voorkomende voornamen. + title: voorletters + maxLength: 20 + voornamen: + type: string + description: Voornamen bij de naam die de persoon wenst te voeren. + title: voornamen + maxLength: 200 + geslachtsaanduiding: + description: + 'Een aanduiding die aangeeft of de persoon een man of een vrouw + is, of dat het geslacht nog onbekend is. + + + Uitleg bij mogelijke waarden: + + + * `m` - Man + + * `v` - Vrouw + + * `o` - Onbekend' + title: geslachtsaanduiding + oneOf: + - $ref: '#/components/schemas/GeslachtsaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + geboortedatum: + type: string + title: geboortedatum + maxLength: 18 + verblijfsadres: + allOf: + - $ref: '#/components/schemas/VerblijfsAdres' + nullable: true + title: verblijfsadres + subVerblijfBuitenland: + allOf: + - $ref: '#/components/schemas/SubVerblijfBuitenland' + nullable: true + title: subVerblijfBuitenland + RolNietNatuurlijkPersoon: + type: object + properties: + innNnpId: + type: string + description: + Het door een kamer toegekend uniek nummer voor de INGESCHREVEN + NIET-NATUURLIJK PERSOON + title: inn nnp id + maxLength: 9 + annIdentificatie: + type: string + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NIET-NATUURLIJK PERSOON + title: ann identificatie + maxLength: 17 + statutaireNaam: + type: string + description: + Naam van de niet-natuurlijke persoon zoals deze is vastgelegd + in de statuten (rechtspersoon) of in de vennootschapsovereenkomst is overeengekomen + (Vennootschap onder firma of Commanditaire vennootschap). + title: statutaire naam + maxLength: 500 + innRechtsvorm: + description: De juridische vorm van de NIET-NATUURLIJK PERSOON. + title: inn rechtsvorm + oneOf: + - $ref: '#/components/schemas/InnRechtsvormEnum' + - $ref: '#/components/schemas/BlankEnum' + bezoekadres: + type: string + description: De gegevens over het adres van de NIET-NATUURLIJK PERSOON + title: bezoekadres + maxLength: 1000 + subVerblijfBuitenland: + allOf: + - $ref: '#/components/schemas/SubVerblijfBuitenland' + nullable: true + title: subVerblijfBuitenland + RolOrganisatorischeEenheid: + type: object + properties: + identificatie: + type: string + description: Een korte identificatie van de organisatorische eenheid. + title: identificatie + maxLength: 24 + naam: + type: string + description: De feitelijke naam van de organisatorische eenheid. + title: naam + maxLength: 50 + isGehuisvestIn: + type: string + title: is gehuisvest in + maxLength: 24 + RolVestiging: + type: object + properties: + vestigingsNummer: + type: string + description: Een korte unieke aanduiding van de Vestiging. + title: vestigings nummer + maxLength: 24 + handelsnaam: + type: array + items: + type: string + maxLength: 625 + description: De naam van de vestiging waaronder gehandeld wordt. + title: handelsnaam + verblijfsadres: + allOf: + - $ref: '#/components/schemas/VerblijfsAdres' + nullable: true + title: verblijfsadres + subVerblijfBuitenland: + allOf: + - $ref: '#/components/schemas/SubVerblijfBuitenland' + nullable: true + title: subVerblijfBuitenland + kvkNummer: + type: string + description: Een uniek nummer gekoppeld aan de onderneming. + title: kvk nummer + maxLength: 8 + Status: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + statustype: + type: string + format: uri + description: URL-referentie naar het STATUSTYPE (in de Catalogi API). + title: statustype + maxLength: 1000 + datumStatusGezet: + type: string + format: date-time + description: De datum waarop de ZAAK de status heeft verkregen. + title: datum status gezet + statustoelichting: + type: string + description: + Een, voor de initiator van de zaak relevante, toelichting op + de status van een zaak. + title: statustoelichting + maxLength: 1000 + indicatieLaatstGezetteStatus: + type: boolean + readOnly: true + description: + Het gegeven is afleidbaar uit de historie van de attribuutsoort + Datum status gezet van van alle statussen bij de desbetreffende zaak. + title: indicatieLaatstGezetteStatus + gezetdoor: + type: string + format: uri + title: Gezet door + description: + De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd + dat STATUSsen in die ZAAK bereikt zijn. + maxLength: 200 + zaakinformatieobjecten: + type: array + items: + type: string + format: uri + title: '' + minLength: 1 + maxLength: 1000 + readOnly: true + title: zaakInformatieobjecten + uniqueItems: true + required: + - datumStatusGezet + - indicatieLaatstGezetteStatus + - statustype + - url + - uuid + - zaak + - zaakinformatieobjecten + StatusExpanded: + allOf: + - $ref: '#/components/schemas/Status' + - properties: + _expand: + $ref: '#/components/schemas/StatusEmbedded' + StatusEmbedded: + type: object + properties: + statustype: + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/StatusType' + gezetdoor: + $ref: '#/components/schemas/Rol' + zaakinformatieobjecten: + type: array + items: + $ref: '#/components/schemas/ZaakInformatieObject' + StatusRequestbody: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + statustype: + type: string + format: uri + description: URL-referentie naar het STATUSTYPE (in de Catalogi API). + title: statustype + maxLength: 1000 + datumStatusGezet: + type: string + format: date-time + description: De datum waarop de ZAAK de status heeft verkregen. + title: datum status gezet + statustoelichting: + type: string + description: + Een, voor de initiator van de zaak relevante, toelichting op + de status van een zaak. + title: statustoelichting + maxLength: 1000 + indicatieLaatstGezetteStatus: + type: boolean + readOnly: true + description: + Het gegeven is afleidbaar uit de historie van de attribuutsoort + Datum status gezet van van alle statussen bij de desbetreffende zaak. + title: indicatieLaatstGezetteStatus + gezetdoor: + type: string + format: uri + title: Gezet door + description: + De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd + dat STATUSsen in die ZAAK bereikt zijn. + maxLength: 200 + required: + - datumStatusGezet + - indicatieLaatstGezetteStatus + - statustype + - url + - uuid + - zaak + - zaakinformatieobjecten + SubVerblijfBuitenland: + type: object + properties: + lndLandcode: + type: string + description: + De code, behorende bij de landnaam, zoals opgenomen in de Land/Gebied-tabel + van de BRP. + title: lnd landcode + maxLength: 4 + lndLandnaam: + type: string + description: + De naam van het land, zoals opgenomen in de Land/Gebied-tabel + van de BRP. + title: lnd landnaam + maxLength: 40 + subAdresBuitenland_1: + type: string + title: sub adres buitenland 1 + maxLength: 35 + subAdresBuitenland_2: + type: string + title: sub adres buitenland 2 + maxLength: 35 + subAdresBuitenland_3: + type: string + title: sub adres buitenland 3 + maxLength: 35 + required: + - lndLandcode + - lndLandnaam + TerreinGebouwdObjectAdres: + type: object + properties: + numIdentificatie: + type: string + title: num identificatie + maxLength: 100 + oaoIdentificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + wplWoonplaatsNaam: + type: string + title: wpl woonplaats naam + maxLength: 80 + gorOpenbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: gor openbare ruimte naam + maxLength: 80 + aoaPostcode: + type: string + title: postcode + maxLength: 7 + aoaHuisnummer: + type: integer + maximum: 99999 + minimum: 0 + title: huisnummer + aoaHuisletter: + type: string + title: huisletter + maxLength: 1 + aoaHuisnummertoevoeging: + type: string + title: huisnummertoevoeging + maxLength: 4 + ogoLocatieAanduiding: + type: string + title: locatie aanduiding + maxLength: 100 + required: + - aoaHuisnummer + - gorOpenbareRuimteNaam + - oaoIdentificatie + - wplWoonplaatsNaam + TypeWaterdeelEnum: + enum: + - zee + - waterloop + - watervlakte + - greppel_droge_sloot + type: string + ValidatieFout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: + URI met referentie naar dit specifiek voorkomen van de fout. + Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + invalidParams: + type: array + items: + $ref: '#/components/schemas/FieldValidationError' + title: invalidParams + required: + - code + - detail + - instance + - invalidParams + - status + - title + VerblijfsAdres: + type: object + properties: + aoaIdentificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + wplWoonplaatsNaam: + type: string + title: wpl woonplaats naam + maxLength: 80 + gorOpenbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: gor openbare ruimte naam + maxLength: 80 + aoaPostcode: + type: string + title: postcode + maxLength: 7 + aoaHuisnummer: + type: integer + maximum: 99999 + minimum: 0 + title: huisnummer + aoaHuisletter: + type: string + title: huisletter + maxLength: 1 + aoaHuisnummertoevoeging: + type: string + title: huisnummertoevoeging + maxLength: 4 + inpLocatiebeschrijving: + type: string + title: locatie omschrijving + maxLength: 1000 + required: + - aoaHuisnummer + - aoaIdentificatie + - gorOpenbareRuimteNaam + - wplWoonplaatsNaam + Verlenging: + type: object + description: + Gegevens omtrent het verlengen van de doorlooptijd van de behandeling + van de ZAAK + properties: + reden: + type: string + description: + Omschrijving van de reden voor het verlengen van de behandeling + van de zaak. + title: reden verlenging + maxLength: 200 + duur: + type: string + description: + Het aantal werkbare dagen waarmee de doorlooptijd van de behandeling + van de ZAAK is verlengd (of verkort) ten opzichte van de eerder gecommuniceerde + doorlooptijd. + title: duur verlenging + format: duration + required: + - duur + - reden + nullable: true + VertrouwelijkheidaanduidingEnum: + enum: + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim + type: string + Wijzigingen: + type: object + properties: + oud: + type: object + additionalProperties: {} + description: + Volledige JSON body van het object zoals dat bestond voordat + de actie heeft plaatsgevonden. + title: oud + nieuw: + type: object + additionalProperties: {} + description: Volledige JSON body van het object na de actie. + title: nieuw + WozObjectAdres: + type: object + properties: + aoaIdentificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + wplWoonplaatsNaam: + type: string + title: wpl woonplaats naam + maxLength: 80 + gorOpenbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: gor openbare ruimte naam + maxLength: 80 + aoaPostcode: + type: string + title: postcode + maxLength: 7 + aoaHuisnummer: + type: integer + maximum: 99999 + minimum: 0 + title: huisnummer + aoaHuisletter: + type: string + title: huisletter + maxLength: 1 + aoaHuisnummertoevoeging: + type: string + title: huisnummertoevoeging + maxLength: 4 + locatieOmschrijving: + type: string + title: locatie omschrijving + maxLength: 1000 + required: + - aoaHuisnummer + - aoaIdentificatie + - gorOpenbareRuimteNaam + - wplWoonplaatsNaam + Zaak: + type: object + description: 'Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + identificatie: + type: string + description: + De unieke identificatie van de ZAAK binnen de organisatie die + verantwoordelijk is voor de behandeling van de ZAAK. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + description: + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers + en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + title: bronorganisatie + maxLength: 9 + omschrijving: + type: string + description: Een korte omschrijving van de zaak. + title: omschrijving + maxLength: 80 + toelichting: + type: string + description: Een toelichting op de zaak. + title: toelichting + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de + CATALOGUS waar deze voorkomt + title: zaaktype + maxLength: 1000 + registratiedatum: + type: string + format: date + description: + De datum waarop de zaakbehandelende organisatie de ZAAK heeft + geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag + gebruikt. + title: registratiedatum + verantwoordelijkeOrganisatie: + type: string + description: + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die eindverantwoordelijk is voor de behandeling van de zaak. Dit moet + een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + title: verantwoordelijke organisatie + maxLength: 9 + startdatum: + type: string + format: date + description: De datum waarop met de uitvoering van de zaak is gestart + title: startdatum + einddatum: + type: string + format: date + readOnly: true + nullable: true + description: De datum waarop de uitvoering van de zaak afgerond is. + title: einddatum + einddatumGepland: + type: string + format: date + nullable: true + description: + De datum waarop volgens de planning verwacht wordt dat de zaak + afgerond wordt. + title: einddatum gepland + uiterlijkeEinddatumAfdoening: + type: string + format: date + nullable: true + description: + De laatste datum waarop volgens wet- en regelgeving de zaak + afgerond dient te zijn. + title: uiterlijke einddatum afdoening + publicatiedatum: + type: string + format: date + nullable: true + description: Datum waarop (het starten van) de zaak gepubliceerd is of wordt. + title: publicatiedatum + communicatiekanaal: + type: string + format: uri + description: + Het medium waarlangs de aanleiding om een zaak te starten is + ontvangen. URL naar een communicatiekanaal in de VNG-Referentielijst van + communicatiekanalen. + title: communicatiekanaal + maxLength: 1000 + productenOfDiensten: + type: array + items: + type: string + format: uri + title: URL naar product/dienst + maxLength: 1000 + description: + De producten en/of diensten die door de zaak worden voortgebracht. + Dit zijn URLs naar de resources zoals die door de producten- en dienstencatalogus-API + wordt ontsloten. De producten/diensten moeten bij het zaaktype vermeld + zijn. + title: producten of diensten + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + title: Vertrouwlijkheidaanduiding + description: + Aanduiding van de mate waarin het zaakdossier van de ZAAK voor + de openbaarheid bestemd is. Optioneel - indien geen waarde gekozen wordt, + dan wordt de waarde van het ZAAKTYPE overgenomen. Dit betekent dat de + API _altijd_ een waarde teruggeeft. + betalingsindicatie: + description: + 'Indicatie of de, met behandeling van de zaak gemoeide, kosten + betaald zijn door de desbetreffende betrokkene. + + + Uitleg bij mogelijke waarden: + + + * `nvt` - Er is geen sprake van te betalen, met de zaak gemoeide, kosten. + + * `nog_niet` - De met de zaak gemoeide kosten zijn (nog) niet betaald. + + * `gedeeltelijk` - De met de zaak gemoeide kosten zijn gedeeltelijk betaald. + + * `geheel` - De met de zaak gemoeide kosten zijn geheel betaald.' + title: betalingsindicatie + oneOf: + - $ref: '#/components/schemas/BetalingsindicatieEnum' + - $ref: '#/components/schemas/BlankEnum' + betalingsindicatieWeergave: + type: string + readOnly: true + description: Uitleg bij `betalingsindicatie`. + title: betalingsindicatieWeergave + laatsteBetaaldatum: + type: string + format: date-time + nullable: true + description: + De datum waarop de meest recente betaling is verwerkt van kosten + die gemoeid zijn met behandeling van de zaak. + title: laatste betaaldatum + zaakgeometrie: + allOf: + - $ref: '#/components/schemas/GeoJSONGeometry' + nullable: true + description: Punt, lijn of (multi-)vlak geometrie-informatie, in GeoJSON. + title: zaakgeometrie + verlenging: + allOf: + - $ref: '#/components/schemas/Verlenging' + nullable: true + description: + Gegevens omtrent het verlengen van de doorlooptijd van de behandeling + van de ZAAK + title: verlenging + opschorting: + allOf: + - $ref: '#/components/schemas/Opschorting' + nullable: true + description: + Gegevens omtrent het tijdelijk opschorten van de behandeling + van de ZAAK + title: opschorting + selectielijstklasse: + type: string + format: uri + description: + URL-referentie naar de categorie in de gehanteerde 'Selectielijst + Archiefbescheiden' die, gezien het zaaktype en het resultaattype van de + zaak, bepalend is voor het archiefregime van de zaak. + title: selectielijstklasse + maxLength: 1000 + hoofdzaak: + type: string + format: uri + nullable: true + title: Is deelzaak van + description: + "URL-referentie naar de ZAAK, waarom verzocht is door de initiator\ + \ daarvan, die behandeld wordt in twee of meer separate ZAAKen waarvan\ + \ de onderhavige ZAAK er \xE9\xE9n is." + minLength: 1 + maxLength: 1000 + deelzaken: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar deel ZAAKen. + title: is deelzaak van + uniqueItems: true + relevanteAndereZaken: + type: array + items: + $ref: '#/components/schemas/RelevanteZaak' + description: Een lijst van relevante andere zaken. + title: zaak + eigenschappen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + rollen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + status: + type: string + format: uri + readOnly: true + nullable: true + description: Indien geen status bekend is, dan is de waarde 'null' + title: status + zaakinformatieobjecten: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + zaakobjecten: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + kenmerken: + type: array + items: + $ref: '#/components/schemas/ZaakKenmerk' + description: + Lijst van kenmerken. Merk op dat refereren naar gerelateerde + objecten beter kan via `ZaakObject`. + title: zaak + archiefnominatie: + nullable: true + description: + 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + + + Uitleg bij mogelijke waarden: + + + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum + overgedragen worden naar een archiefbewaarplaats. + + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' + title: archiefnominatie + oneOf: + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/NullEnum' + archiefstatus: + allOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + description: + 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + + + Uitleg bij mogelijke waarden: + + + * `nog_te_archiveren` - De zaak cq. het zaakdossier is nog niet als geheel + gearchiveerd. + + * `gearchiveerd` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar + bewaarbaar gemaakt. + + * `gearchiveerd_procestermijn_onbekend` - De zaak cq. het zaakdossier + is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum + kan nog niet bepaald worden. + + * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een + archiefbewaarplaats.' + title: archiefstatus + archiefactiedatum: + type: string + format: date + nullable: true + description: + De datum waarop het gearchiveerde zaakdossier vernietigd moet + worden dan wel overgebracht moet worden naar een archiefbewaarplaats. + Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT + aan deze ZAAK indien nog leeg. + title: archiefactiedatum + resultaat: + type: string + format: uri + readOnly: true + nullable: true + description: + URL-referentie naar het RESULTAAT. Indien geen resultaat bekend + is, dan is de waarde 'null' + title: resultaat + opdrachtgevendeOrganisatie: + type: string + description: + De krachtens publiekrecht ingestelde rechtspersoon dan wel + ander niet-natuurlijk persoon waarbinnen het (bestuurs)orgaan zetelt dat + opdracht heeft gegeven om taken uit te voeren waaraan de zaak invulling + geeft. + title: opdrachtgevende organisatie + maxLength: 9 + processobjectaard: + type: string + nullable: true + title: Procesobjectaard + description: + Omschrijving van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, de zaak betrekking heeft. + maxLength: 200 + startdatumBewaartermijn: + type: string + format: date + nullable: true + description: + De datum die de start markeert van de termijn waarop het zaakdossier + vernietigd moet worden. + title: startdatum bewaartermijn + processobject: + allOf: + - $ref: '#/components/schemas/Processobject' + nullable: true + description: + Specificatie van de attribuutsoort van het object, subject + of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking + heeft en dat bepalend is voor de start van de archiefactietermijn. + title: processobject + required: + - betalingsindicatieWeergave + - bronorganisatie + - deelzaken + - eigenschappen + - einddatum + - resultaat + - rollen + - startdatum + - status + - url + - uuid + - verantwoordelijkeOrganisatie + - zaakinformatieobjecten + - zaakobjecten + - zaaktype + ZaakExpanded: + allOf: + - $ref: '#/components/schemas/Zaak' + - properties: + _expand: + $ref: '#/components/schemas/ZaakEmbedded' + ZaakEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + zaaktype: + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/ZaakType' + hoofdzaak: + oneOf: + - $ref: '#/components/schemas/ZaakExpanded' + - $ref: '#/components/schemas/EmptyObject' + example: {} + deelzaken: + type: array + items: + $ref: '#/components/schemas/ZaakExpanded' + example: [{}] + relevanteAndereZaken: + type: array + items: + $ref: '#/components/schemas/ZaakExpanded' + example: [{}] + eigenschappen: + type: array + items: + $ref: '#/components/schemas/ZaakEigenschap' + rollen: + type: array + items: + $ref: '#/components/schemas/RolExpanded' + status: + oneOf: + - $ref: '#/components/schemas/StatusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaakobjecten: + type: array + items: + $ref: '#/components/schemas/ZaakObjectExpanded' + resultaat: + oneOf: + - $ref: '#/components/schemas/ResultaatExpanded' + - $ref: '#/components/schemas/EmptyObject' + EmptyObject: + type: object + description: Leeg object. Dit wordt teruggeven indien het te expanderen veld een null waarde heeft. + example: {} + ZaakBesluit: + type: object + description: + "A type of `ModelSerializer` that uses hyperlinked relationships + with compound keys instead + + of primary key relationships. Specifically: + + + * A 'url' field is included instead of the 'id' field. + + * Relationships to other instances are hyperlinks, instead of primary keys. + + + NOTE: this only works with DRF 3.1.0 and above." + properties: + url: + type: string + format: uri + readOnly: true + title: url + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + besluit: + type: string + format: uri + description: + URL-referentie naar het BESLUIT (in de Besluiten API), waar + ook de relatieinformatie opgevraagd kan worden. + title: besluit + maxLength: 1000 + required: + - besluit + - url + - uuid + ZaakContactMoment: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + contactmoment: + type: string + format: uri + description: + URL-referentie naar het CONTACTMOMENT (in de Klantinteractie + API) + title: contactmoment + maxLength: 1000 + required: + - contactmoment + - url + - uuid + - zaak + ZaakEigenschap: + type: object + description: + "A type of `ModelSerializer` that uses hyperlinked relationships + with compound keys instead + + of primary key relationships. Specifically: + + + * A 'url' field is included instead of the 'id' field. + + * Relationships to other instances are hyperlinks, instead of primary keys. + + + NOTE: this only works with DRF 3.1.0 and above." + properties: + url: + type: string + format: uri + readOnly: true + title: url + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + title: zaak + eigenschap: + type: string + format: uri + description: URL-referentie naar de EIGENSCHAP (in de Catalogi API). + title: eigenschap + maxLength: 1000 + naam: + type: string + readOnly: true + description: De naam van de EIGENSCHAP (overgenomen uit de Catalogi API). + title: ' naam' + waarde: + type: string + title: waarde + required: + - eigenschap + - naam + - url + - uuid + - waarde + - zaak + ZaakInformatieObject: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + informatieobject: + type: string + format: uri + description: + URL-referentie naar het INFORMATIEOBJECT (in de Documenten + API), waar ook de relatieinformatie opgevraagd kan worden. + title: informatieobject + maxLength: 1000 + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + aardRelatieWeergave: + allOf: + - $ref: '#/components/schemas/AardRelatieWeergaveEnum' + readOnly: true + title: aardRelatieWeergave + titel: + type: string + description: + De naam waaronder het INFORMATIEOBJECT binnen het OBJECT bekend + is. + title: titel + maxLength: 200 + beschrijving: + type: string + description: + Een op het object gerichte beschrijving van de inhoud vanhet + INFORMATIEOBJECT. + title: beschrijving + registratiedatum: + type: string + format: date-time + readOnly: true + description: + De datum waarop de behandelende organisatie het INFORMATIEOBJECT + heeft geregistreerd bij het OBJECT. Geldige waardes zijn datumtijden gelegen + op of voor de huidige datum en tijd. + title: registratiedatum + vernietigingsdatum: + type: string + format: date-time + nullable: true + description: + De datum waarop het informatieobject uit het zaakdossier verwijderd + moet worden. + title: vernietigingsdatum + status: + type: string + format: uri + nullable: true + description: + De bij de desbetreffende ZAAK behorende STATUS waarvoor het + ZAAK-INFORMATIEOBJECT relevant is (geweest) met het oog op het bereiken + van die STATUS en/of de communicatie daarover. + title: status + minLength: 1 + maxLength: 1000 + required: + - aardRelatieWeergave + - informatieobject + - registratiedatum + - url + - uuid + - zaak + ZaakInformatieObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakInformatieObject' + - properties: + _expand: + $ref: '#/components/schemas/ZaakInformatieObjectEmbedded' + ZaakInformatieObjectEmbedded: + type: object + properties: + status: + $ref: '#/components/schemas/StatusExpanded' + ZaakKenmerk: + type: object + properties: + kenmerk: + type: string + description: Identificeert uniek de zaak in een andere administratie. + title: kenmerk + maxLength: 40 + bron: + type: string + description: De aanduiding van de administratie waar het kenmerk op slaat. + title: bron + maxLength: 40 + required: + - bron + - kenmerk + ZaakObject: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + object: + type: string + format: uri + description: URL-referentie naar de resource die het OBJECT beschrijft. + title: object + maxLength: 1000 + zaakobjecttype: + type: string + format: uri + description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API). + title: zaakobjecttype + maxLength: 1000 + objectType: + allOf: + - $ref: '#/components/schemas/ObjectTypeEnum' + description: + 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er + geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. + + + Uitleg bij mogelijke waarden: + + + * `adres` - Adres + + * `besluit` - Besluit + + * `buurt` - Buurt + + * `enkelvoudig_document` - Enkelvoudig document + + * `gemeente` - Gemeente + + * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte + + * `huishouden` - Huishouden + + * `inrichtingselement` - Inrichtingselement + + * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak + + * `kunstwerkdeel` - Kunstwerkdeel + + * `maatschappelijke_activiteit` - Maatschappelijke activiteit + + * `medewerker` - Medewerker + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `openbare_ruimte` - Openbare ruimte + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `pand` - Pand + + * `spoorbaandeel` - Spoorbaandeel + + * `status` - Status + + * `terreindeel` - Terreindeel + + * `terrein_gebouwd_object` - Terrein gebouwd object + + * `vestiging` - Vestiging + + * `waterdeel` - Waterdeel + + * `wegdeel` - Wegdeel + + * `wijk` - Wijk + + * `woonplaats` - Woonplaats + + * `woz_deelobject` - Woz deel object + + * `woz_object` - Woz object + + * `woz_waarde` - Woz waarde + + * `zakelijk_recht` - Zakelijk recht + + * `overige` - Overige' + title: object type + objectTypeOverige: + type: string + description: + Beschrijft het type OBJECT als `objectType` de waarde "overige" + heeft. + title: object type overige + pattern: '[a-z\_]+' + maxLength: 100 + objectTypeOverigeDefinitie: + allOf: + - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie' + nullable: true + title: definitie object type overige + description: + 'Verwijzing naar het schema van het type OBJECT als `objectType` + de waarde "overige" heeft. + + + * De URL referentie moet naar een JSON endpoint wijzen waarin het objecttype + gedefinieerd is, inclusief het [JSON-schema](https://json-schema.org/). + + * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen de + objecttype resource (deze gebruikt het [jq](http://stedolan.github.io/jq/) + formaat. + + * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens binnen + het OBJECT. Deze gebruikt ook het [jq](http://stedolan.github.io/jq/) + formaat. + + + Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven + en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven + OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.' + relatieomschrijving: + type: string + description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. + title: relatieomschrijving + maxLength: 80 + required: + - objectType + - url + - uuid + - zaak + discriminator: + propertyName: objectType + mapping: + adres: '#/components/schemas/adres_ZaakObject' + besluit: '#/components/schemas/besluit_ZaakObject' + buurt: '#/components/schemas/buurt_ZaakObject' + enkelvoudig_document: '#/components/schemas/enkelvoudig_document_ZaakObject' + gemeente: '#/components/schemas/gemeente_ZaakObject' + gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_ZaakObject' + huishouden: '#/components/schemas/huishouden_ZaakObject' + inrichtingselement: '#/components/schemas/inrichtingselement_ZaakObject' + kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_ZaakObject' + kunstwerkdeel: '#/components/schemas/kunstwerkdeel_ZaakObject' + maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_ZaakObject' + medewerker: '#/components/schemas/medewerker_ZaakObject' + natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_ZaakObject' + niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_ZaakObject' + openbare_ruimte: '#/components/schemas/openbare_ruimte_ZaakObject' + organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_ZaakObject' + pand: '#/components/schemas/pand_ZaakObject' + spoorbaandeel: '#/components/schemas/spoorbaandeel_ZaakObject' + status: '#/components/schemas/status_ZaakObject' + terreindeel: '#/components/schemas/terreindeel_ZaakObject' + terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_ZaakObject' + vestiging: '#/components/schemas/vestiging_ZaakObject' + waterdeel: '#/components/schemas/waterdeel_ZaakObject' + wegdeel: '#/components/schemas/wegdeel_ZaakObject' + wijk: '#/components/schemas/wijk_ZaakObject' + woonplaats: '#/components/schemas/woonplaats_ZaakObject' + woz_deelobject: '#/components/schemas/woz_deelobject_ZaakObject' + woz_object: '#/components/schemas/woz_object_ZaakObject' + woz_waarde: '#/components/schemas/woz_waarde_ZaakObject' + zakelijk_recht: '#/components/schemas/zakelijk_recht_ZaakObject' + overige: '#/components/schemas/overige_ZaakObject' + ZaakObjectExpanded: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + object: + type: string + format: uri + description: URL-referentie naar de resource die het OBJECT beschrijft. + title: object + maxLength: 1000 + zaakobjecttype: + type: string + format: uri + description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API). + title: zaakobjecttype + maxLength: 1000 + objectType: + allOf: + - $ref: '#/components/schemas/ObjectTypeEnum' + description: + 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er + geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. + + + Uitleg bij mogelijke waarden: + + + * `adres` - Adres + + * `besluit` - Besluit + + * `buurt` - Buurt + + * `enkelvoudig_document` - Enkelvoudig document + + * `gemeente` - Gemeente + + * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte + + * `huishouden` - Huishouden + + * `inrichtingselement` - Inrichtingselement + + * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak + + * `kunstwerkdeel` - Kunstwerkdeel + + * `maatschappelijke_activiteit` - Maatschappelijke activiteit + + * `medewerker` - Medewerker + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `openbare_ruimte` - Openbare ruimte + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `pand` - Pand + + * `spoorbaandeel` - Spoorbaandeel + + * `status` - Status + + * `terreindeel` - Terreindeel + + * `terrein_gebouwd_object` - Terrein gebouwd object + + * `vestiging` - Vestiging + + * `waterdeel` - Waterdeel + + * `wegdeel` - Wegdeel + + * `wijk` - Wijk + + * `woonplaats` - Woonplaats + + * `woz_deelobject` - Woz deel object + + * `woz_object` - Woz object + + * `woz_waarde` - Woz waarde + + * `zakelijk_recht` - Zakelijk recht + + * `overige` - Overige' + title: object type + objectTypeOverige: + type: string + description: + Beschrijft het type OBJECT als `objectType` de waarde "overige" + heeft. + title: object type overige + pattern: '[a-z\_]+' + maxLength: 100 + objectTypeOverigeDefinitie: + allOf: + - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie' + nullable: true + title: definitie object type overige + description: + 'Verwijzing naar het schema van het type OBJECT als `objectType` + de waarde "overige" heeft. + + + * De URL referentie moet naar een JSON endpoint wijzen waarin het objecttype + gedefinieerd is, inclusief het [JSON-schema](https://json-schema.org/). + + * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen de + objecttype resource (deze gebruikt het [jq](http://stedolan.github.io/jq/) + formaat. + + * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens binnen + het OBJECT. Deze gebruikt ook het [jq](http://stedolan.github.io/jq/) + formaat. + + + Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven + en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven + OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.' + relatieomschrijving: + type: string + description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. + title: relatieomschrijving + maxLength: 80 + _expand: + $ref: '#/components/schemas/ZaakObjectEmbedded' + required: + - objectType + - url + - uuid + - zaak + discriminator: + propertyName: objectType + mapping: + adres: '#/components/schemas/adres_ZaakObjectExpanded' + besluit: '#/components/schemas/besluit_ZaakObjectExpanded' + buurt: '#/components/schemas/buurt_ZaakObjectExpanded' + enkelvoudig_document: '#/components/schemas/enkelvoudig_document_ZaakObjectExpanded' + gemeente: '#/components/schemas/gemeente_ZaakObjectExpanded' + gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_ZaakObjectExpanded' + huishouden: '#/components/schemas/huishouden_ZaakObjectExpanded' + inrichtingselement: '#/components/schemas/inrichtingselement_ZaakObjectExpanded' + kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_ZaakObjectExpanded' + kunstwerkdeel: '#/components/schemas/kunstwerkdeel_ZaakObjectExpanded' + maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_ZaakObjectExpanded' + medewerker: '#/components/schemas/medewerker_ZaakObjectExpanded' + natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_ZaakObjectExpanded' + niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_ZaakObjectExpanded' + openbare_ruimte: '#/components/schemas/openbare_ruimte_ZaakObjectExpanded' + organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_ZaakObjectExpanded' + pand: '#/components/schemas/pand_ZaakObjectExpanded' + spoorbaandeel: '#/components/schemas/spoorbaandeel_ZaakObjectExpanded' + status: '#/components/schemas/status_ZaakObjectExpanded' + terreindeel: '#/components/schemas/terreindeel_ZaakObjectExpanded' + terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_ZaakObjectExpanded' + vestiging: '#/components/schemas/vestiging_ZaakObjectExpanded' + waterdeel: '#/components/schemas/waterdeel_ZaakObjectExpanded' + wegdeel: '#/components/schemas/wegdeel_ZaakObjectExpanded' + wijk: '#/components/schemas/wijk_ZaakObjectExpanded' + woonplaats: '#/components/schemas/woonplaats_ZaakObjectExpanded' + woz_deelobject: '#/components/schemas/woz_deelobject_ZaakObjectExpanded' + woz_object: '#/components/schemas/woz_object_ZaakObjectExpanded' + woz_waarde: '#/components/schemas/woz_waarde_ZaakObjectExpanded' + zakelijk_recht: '#/components/schemas/zakelijk_recht_ZaakObjectExpanded' + overige: '#/components/schemas/overige_ZaakObjectExpanded' + ZaakObjectEmbedded: + type: object + properties: + zaakobjecttype: + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/ZaakObjectType' + ZaakVerzoek: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + verzoek: + type: string + format: uri + description: URL-referentie naar het VERZOEK (in de Klantinteractie API) + title: verzoek + maxLength: 1000 + required: + - url + - uuid + - verzoek + - zaak + ZaakZoek: + type: object + properties: + zaakgeometrie: + $ref: '#/components/schemas/GeoWithin' + uuid__in: + description: Array of unieke resource identifiers (UUID4) + type: array + items: + type: string + format: uuid + example: ["e80b7507-199a-484c-ad49-c41a1e43a6e7", "78e12133-c467-4202-91ba-4417baa52801"] + identificatie: + title: Identificatie + description: De unieke identificatie van de ZAAK binnen de organisatie die + verantwoordelijk is voor de behandeling van de ZAAK. + type: string + example: "zaak123" + bronorganisatie: + title: Bronorganisatie + description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers + en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + type: string + example: "000000000" + bronorganisatie__in: + description: Array van bronorganisaties. + type: array + items: + type: string + format: string + example: ["000000000","479559740","875883461"] + zaaktype: + title: Zaaktype + description: URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de + CATALOGUS waar deze voorkomt + type: string + example: "https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/e80b7507-199a-484c-ad49-c41a1e43a6e7" + zaaktype__in: + description: Array van zaaktypen. + type: array + items: + type: string + format: uri + example: ["https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/e80b7507-199a-484c-ad49-c41a1e43a6e7","https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/78e12133-c467-4202-91ba-4417baa52801"] + archiefnominatie: + title: Archiefnominatie + description: 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + Uitleg bij mogelijke waarden: + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum + overgedragen worden naar een archiefbewaarplaats. + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' + type: string + enum: + - blijvend_bewaren + - vernietigen + example: "blijvend_bewaren" + archiefnominatie__in: + title: Archiefnominatie in + description: Multiple values may be separated by commas. + type: array + items: + type: string + example: [ "blijvend_bewaren", "vernietigen" ] + archiefactiedatum: + title: Archiefactiedatum + description: De datum waarop het gearchiveerde zaakdossier vernietigd moet + worden dan wel overgebracht moet worden naar een archiefbewaarplaats. + Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT + aan deze ZAAK indien nog leeg. + type: string + example: "2019-01-02" + archiefactiedatum__isnull: + title: Archiefactiedatum is leeg + type: boolean + example: false + archiefactiedatum__lt: + title: Archiefactiedatum kleiner dan + type: string + example: "2020-01-02" + archiefactiedatum__gt: + title: Archiefactiedatum groter dan + type: string + example: "2018-01-02" + archiefstatus: + title: Archiefstatus + description: 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + Uitleg bij mogelijke waarden: + * `nog_te_archiveren` - De zaak cq. het zaakdossier is nog niet als geheel + gearchiveerd. + * `gearchiveerd` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar + bewaarbaar gemaakt. + * `gearchiveerd_procestermijn_onbekend` - De zaak cq. het zaakdossier + is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum + kan nog niet bepaald worden. + * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een + archiefbewaarplaats.' + type: string + enum: + - nog_te_archiveren + - gearchiveerd + - gearchiveerd_procestermijn_onbekend + - overgedragen + example: "nog_te_archiveren" + archiefstatus__in: + title: Archiefstatus in + description: Multiple values may be separated by commas. + type: array + items: + type: string + example: [ "nog_te_archiveren","gearchiveerd","gearchiveerd_procestermijn_onbekend","overgedragen" ] + startdatum: + title: Startdatum + description: De datum waarop met de uitvoering van de zaak is gestart + type: string + example: "2017-01-02" + startdatum__gt: + title: Startdatum groter dan + type: string + example: "2018-01-02" + startdatum__gte: + title: Startdatum groter dan of gelijk + type: string + example: "2016-01-02" + startdatum__lt: + title: Startdatum kleiner dan + type: string + example: "2018-01-02" + startdatum__lte: + title: Startdatum kleiner dan of gelijk + type: string + example: "2018-01-02" + registratiedatum: + title: Registratiedatum + description: De datum waarop de zaakbehandelende organisatie de ZAAK heeft geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag gebruikt. + type: string + example: "2015-01-02" + registratiedatum__gt: + title: Registratiedatum groter dan + type: string + example: "2014-01-02" + registratiedatum__lt: + title: Registratiedatum kleiner dan + type: string + example: "2016-01-02" + einddatum: + title: Einddatum + description: De datum waarop de uitvoering van de zaak afgerond is. + type: string + example: "2022-01-02" + einddatum__isnull: + title: Einddatum is leeg + type: boolean + example: false + einddatum__gt: + title: Einddatum groter dan + type: string + example: "2021-01-02" + einddatum__lt: + title: Einddatum kleiner dan + type: string + minLength: 1 + example: "2023-01-02" + einddatumGepland: + title: Einddatum gepland + description: De datum waarop volgens de planning verwacht wordt dat de zaak afgerond wordt. + type: string + example: "2022-01-02" + einddatumGepland__gt: + title: Einddatum gepland groter dan + type: string + example: "2021-01-02" + einddatumGepland__lt: + title: Einddatum gepland kleiner dan + type: string + example: "2024-01-02" + uiterlijkeEinddatumAfdoening: + title: Uiterlijke einddatumAfdoening + description: De laatste datum waarop volgens wet- en regelgeving de zaak afgerond dient te zijn. + type: string + example: "2024-01-02" + uiterlijkeEinddatumAfdoening__gt: + title: Uiterlijke einddatumAfdoening groter dan + type: string + example: "2023-01-02" + uiterlijkeEinddatumAfdoening__lt: + title: Uiterlijke einddatumAfdoening kleiner dan + type: string + example: "2025-01-02" + rol__betrokkeneType: + title: Rol betrokkenetype + description: 'Type van de `betrokkene`. + Uitleg bij mogelijke waarden: + * `natuurlijk_persoon` - Natuurlijk persoon + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + * `vestiging` - Vestiging + * `organisatorische_eenheid` - Organisatorische eenheid + * `medewerker` - Medewerker' + type: string + enum: + - natuurlijk_persoon + - niet_natuurlijk_persoon + - vestiging + - organisatorische_eenheid + - medewerker + example: "natuurlijk_persoon" + rol__betrokkene: + title: Rol betrokkene + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + type: string + example: "https://example.com" + rol__omschrijvingGeneriek: + title: Rol omschrijvinggeneriek + description: + Algemeen gehanteerde benaming van de aard van de ROL, afgeleid uit het ROLTYPE. + type: string + enum: + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator + example: "initiator" + maximaleVertrouwelijkheidaanduiding: + title: Maximalevertrouwelijkheidaanduiding + description: + Zaken met een vertrouwelijkheidaanduiding die beperkter is + dan de aangegeven aanduiding worden uit de resultaten gefiltered. + type: string + enum: + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim + example: "zaakvertrouwelijk" + rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn: + title: Rol betrokkeneidentificatie natuurlijkpersoon inpbsn + description: Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet + algemene bepalingen burgerservicenummer. + type: string + example: "123456789" + rol__betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie: + title: Rol betrokkeneidentificatie natuurlijkpersoon anpidentificatie + description: Het door de gemeente uitgegeven unieke nummer voor een ANDER + NATUURLIJK PERSOON + type: string + example: "123456789" + rol__betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer: + title: Rol betrokkeneidentificatie natuurlijkpersoon inpa nummer + description: Het administratienummer van de persoon, bedoeld in de Wet BRP + type: string + example: "123456789" + rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId: + title: Rol betrokkeneidentificatie nietnatuurlijkpersoon innnnpid + description: Het door een kamer toegekend uniek nummer voor de INGESCHREVEN + NIET-NATUURLIJK PERSOON + type: string + example: "123456789" + rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie: + title: Rol betrokkeneidentificatie nietnatuurlijkpersoon annidentificatie + description: Het door de gemeente uitgegeven unieke nummer voor een ANDER + NIET-NATUURLIJK PERSOON + type: string + example: "123456789" + rol__betrokkeneIdentificatie__vestiging__vestigingsNummer: + title: Rol betrokkeneidentificatie vestiging vestigingsnummer + description: Een korte unieke aanduiding van de Vestiging. + type: string + example: "123456789" + rol__betrokkeneIdentificatie__medewerker__identificatie: + title: Rol betrokkeneidentificatie medewerker identificatie + description: Een korte unieke aanduiding van de MEDEWERKER. + type: string + example: "123456789" + rol__betrokkeneIdentificatie__organisatorischeEenheid__identificatie: + title: Rol betrokkeneidentificatie organisatorischeeenheid identificatie + description: Een korte identificatie van de organisatorische eenheid. + type: string + example: "123456789" + expand: + description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,` \ + \ hoofdzaak.deelzaken.status.statustype`Haal details van gelinkte resources direct op. + Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt." + title: expand + type: string + example: zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype + ordering: + title: Ordering + description: Het veld waarop de resultaten geordend worden. Het minnetje betekent omgekeerde volgorde. + type: string + enum: + - startdatum + - -startdatum + - einddatum + - -einddatum + - publicatiedatum + - -publicatiedatum + - archiefactiedatum + - -archiefactiedatum + - registratiedatum + - -registratiedatum + - identificatie + - -identificatie + example: "-startdatum" + ZakelijkRechtHeeftAlsGerechtigde: + type: object + properties: + natuurlijkPersoon: + allOf: + - $ref: '#/components/schemas/RolNatuurlijkPersoon' + title: natuurlijkPersoon + nietNatuurlijkPersoon: + allOf: + - $ref: '#/components/schemas/RolNietNatuurlijkPersoon' + title: nietNatuurlijkPersoon + adres_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectAdres' + adres_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectAdres' + adres_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectAdres' + besluit_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + besluit_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + besluit_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + betrokkene_identificatie_RolMedewerker: + type: object + properties: + betrokkeneIdentificatie: + allOf: + - $ref: '#/components/schemas/RolMedewerker' + title: betrokkeneIdentificatie + betrokkene_identificatie_RolNatuurlijkPersoon: + type: object + properties: + betrokkeneIdentificatie: + allOf: + - $ref: '#/components/schemas/RolNatuurlijkPersoon' + title: betrokkeneIdentificatie + betrokkene_identificatie_RolNietNatuurlijkPersoon: + type: object + properties: + betrokkeneIdentificatie: + allOf: + - $ref: '#/components/schemas/RolNietNatuurlijkPersoon' + title: betrokkeneIdentificatie + betrokkene_identificatie_RolOrganisatorischeEenheid: + type: object + properties: + betrokkeneIdentificatie: + allOf: + - $ref: '#/components/schemas/RolOrganisatorischeEenheid' + title: betrokkeneIdentificatie + betrokkene_identificatie_RolVestiging: + type: object + properties: + betrokkeneIdentificatie: + allOf: + - $ref: '#/components/schemas/RolVestiging' + title: betrokkeneIdentificatie + buurt_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' + buurt_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' + buurt_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' + enkelvoudig_document_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + enkelvoudig_document_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + enkelvoudig_document_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + gemeente_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' + gemeente_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' + gemeente_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' + gemeentelijke_openbare_ruimte_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' + gemeentelijke_openbare_ruimte_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' + gemeentelijke_openbare_ruimte_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' + huishouden_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' + huishouden_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' + huishouden_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' + inrichtingselement_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' + inrichtingselement_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' + inrichtingselement_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' + kadastrale_onroerende_zaak_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' + kadastrale_onroerende_zaak_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' + kadastrale_onroerende_zaak_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' + kunstwerkdeel_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' + kunstwerkdeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' + kunstwerkdeel_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' + maatschappelijke_activiteit_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' + maatschappelijke_activiteit_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' + maatschappelijke_activiteit_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' + medewerker_Rol: + allOf: + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' + medewerker_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' + medewerker_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' + medewerker_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' + medewerker_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' + natuurlijk_persoon_Rol: + allOf: + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' + natuurlijk_persoon_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' + natuurlijk_persoon_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' + natuurlijk_persoon_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' + natuurlijk_persoon_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' + niet_natuurlijk_persoon_Rol: + allOf: + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' + niet_natuurlijk_persoon_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' + niet_natuurlijk_persoon_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' + niet_natuurlijk_persoon_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' + niet_natuurlijk_persoon_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' + object_identificatie_ObjectAdres: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectAdres' + title: objectIdentificatie + object_identificatie_ObjectBuurt: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectBuurt' + title: objectIdentificatie + object_identificatie_ObjectGemeente: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectGemeente' + title: objectIdentificatie + object_identificatie_ObjectGemeentelijkeOpenbareRuimte: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectGemeentelijkeOpenbareRuimte' + title: objectIdentificatie + object_identificatie_ObjectHuishouden: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectHuishouden' + title: objectIdentificatie + object_identificatie_ObjectInrichtingselement: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectInrichtingselement' + title: objectIdentificatie + object_identificatie_ObjectKadastraleOnroerendeZaak: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectKadastraleOnroerendeZaak' + title: objectIdentificatie + object_identificatie_ObjectKunstwerkdeel: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectKunstwerkdeel' + title: objectIdentificatie + object_identificatie_ObjectMaatschappelijkeActiviteit: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectMaatschappelijkeActiviteit' + title: objectIdentificatie + object_identificatie_ObjectOpenbareRuimte: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectOpenbareRuimte' + title: objectIdentificatie + object_identificatie_ObjectOverige: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectOverige' + title: objectIdentificatie + object_identificatie_ObjectPand: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectPand' + title: objectIdentificatie + object_identificatie_ObjectSpoorbaandeel: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectSpoorbaandeel' + title: objectIdentificatie + object_identificatie_ObjectTerreinGebouwdObject: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectTerreinGebouwdObject' + title: objectIdentificatie + object_identificatie_ObjectTerreindeel: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectTerreindeel' + title: objectIdentificatie + object_identificatie_ObjectWaterdeel: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWaterdeel' + title: objectIdentificatie + object_identificatie_ObjectWegdeel: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWegdeel' + title: objectIdentificatie + object_identificatie_ObjectWijk: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWijk' + title: objectIdentificatie + object_identificatie_ObjectWoonplaats: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWoonplaats' + title: objectIdentificatie + object_identificatie_ObjectWozDeelobject: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWozDeelobject' + title: objectIdentificatie + object_identificatie_ObjectWozObject: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWozObject' + title: objectIdentificatie + object_identificatie_ObjectWozWaarde: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWozWaarde' + title: objectIdentificatie + object_identificatie_ObjectZakelijkRecht: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectZakelijkRecht' + title: objectIdentificatie + object_identificatie_RolMedewerker: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/RolMedewerker' + title: objectIdentificatie + object_identificatie_RolNatuurlijkPersoon: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/RolNatuurlijkPersoon' + title: objectIdentificatie + object_identificatie_RolNietNatuurlijkPersoon: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/RolNietNatuurlijkPersoon' + title: objectIdentificatie + object_identificatie_RolOrganisatorischeEenheid: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/RolOrganisatorischeEenheid' + title: objectIdentificatie + object_identificatie_RolVestiging: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/RolVestiging' + title: objectIdentificatie + openbare_ruimte_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' + openbare_ruimte_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' + openbare_ruimte_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' + organisatorische_eenheid_Rol: + allOf: + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' + organisatorische_eenheid_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' + organisatorische_eenheid_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' + organisatorische_eenheid_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' + organisatorische_eenheid_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' + overige_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectOverige' + overige_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectOverige' + overige_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectOverige' + pand_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectPand' + pand_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectPand' + pand_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectPand' + spoorbaandeel_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' + spoorbaandeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' + spoorbaandeel_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' + status_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + status_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + status_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + terrein_gebouwd_object_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' + terrein_gebouwd_object_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' + terrein_gebouwd_object_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' + terreindeel_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' + terreindeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' + terreindeel_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' + vestiging_Rol: + allOf: + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' + vestiging_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' + vestiging_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' + vestiging_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' + vestiging_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' + waterdeel_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' + waterdeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' + waterdeel_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' + wegdeel_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' + wegdeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' + wegdeel_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' + wijk_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWijk' + wijk_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWijk' + wijk_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWijk' + woonplaats_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' + woonplaats_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' + woonplaats_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' + woz_deelobject_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' + woz_deelobject_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' + woz_deelobject_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' + woz_object_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' + woz_object_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' + woz_object_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' + woz_waarde_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' + woz_waarde_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' + woz_waarde_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' + zakelijk_recht_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' + zakelijk_recht_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' + zakelijk_recht_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' + securitySchemes: + JWT-Claims: + type: http + bearerFormat: JWT + scheme: bearer +servers: + - url: https://zaken-api.test.vng.cloud/api/v1 + - url: https://zaken-api.vng.cloud/api/v1 +tags: + - name: klantcontacten + description: '' + - name: resultaten + description: '' + - name: rollen + description: '' + - name: statussen + description: '' + - name: zaakcontactmomenten + description: '' + - name: zaakinformatieobjecten + description: '' + - name: zaakobjecten + description: '' + - name: zaakverzoeken + description: '' + - name: zaken + description: + Een zaak mag (in principe) niet meer gewijzigd worden als de `archiefstatus` + een andere status heeft dan "nog_te_archiveren". Voor praktische redenen is er + geen harde validatie regel aan de provider kant. From b7efff5660879bd43e6be46ccc13f94a74671c82 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Thu, 17 Oct 2024 12:55:41 +0200 Subject: [PATCH 03/36] Synchronize zrc 1.5.2 met current version --- .../zrc/current_version/openapi.yaml | 533 +++++++++++++++++- 1 file changed, 509 insertions(+), 24 deletions(-) diff --git a/api-specificatie/zrc/current_version/openapi.yaml b/api-specificatie/zrc/current_version/openapi.yaml index 3dc6b66b0..74b949992 100644 --- a/api-specificatie/zrc/current_version/openapi.yaml +++ b/api-specificatie/zrc/current_version/openapi.yaml @@ -13045,8 +13045,6 @@ components: dat STATUSsen in die ZAAK bereikt zijn. title: statussen uniqueItems: true - _expand: - $ref: '#/components/schemas/RolEmbedded' required: - betrokkeneType - omschrijving @@ -13067,11 +13065,173 @@ components: organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_Rol' vestiging: '#/components/schemas/vestiging_Rol' RolExpanded: - allOf: - - $ref: '#/components/schemas/Rol' - - properties: - _expand: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + betrokkene: + type: string + format: uri + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + title: betrokkene + maxLength: 1000 + betrokkeneType: + allOf: + - $ref: '#/components/schemas/BetrokkeneTypeEnum' + description: 'Type van de `betrokkene`. + + + Uitleg bij mogelijke waarden: + + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `vestiging` - Vestiging + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `medewerker` - Medewerker' + title: betrokkene type + afwijkendeNaamBetrokkene: + type: string + description: + De naam van de betrokkene waaronder deze in relatie tot de + zaak aangesproken wil worden. + title: afwijkende naam betrokkene + maxLength: 625 + roltype: + type: string + format: uri + description: + URL-referentie naar een roltype binnen het ZAAKTYPE van de + ZAAK. + title: roltype + maxLength: 1000 + omschrijving: + type: string + readOnly: true + description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. + title: omschrijving + omschrijvingGeneriek: + type: string + readOnly: true + description: + "Algemeen gehanteerde benaming van de aard van de ROL, afgeleid\ + \ uit het ROLTYPE.\n\nUitleg bij mogelijke waarden:\n\n* `adviseur` -\ + \ (Adviseur) Kennis in dienst stellen van de behandeling van (een deel\ + \ van) een zaak.\n* `behandelaar` - (Behandelaar) De vakinhoudelijke behandeling\ + \ doen van (een deel van) een zaak.\n* `belanghebbende` - (Belanghebbende)\ + \ Vanuit eigen en objectief belang rechtstreeks betrokken zijn bij de\ + \ behandeling en/of de uitkomst van een zaak.\n* `beslisser` - (Beslisser)\ + \ Nemen van besluiten die voor de uitkomst van een zaak noodzakelijk zijn.\n\ + * `initiator` - (Initiator) Aanleiding geven tot de start van een zaak\ + \ ..\n* `klantcontacter` - (Klantcontacter) Het eerste aanspreekpunt zijn\ + \ voor vragen van burgers en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6\ + rdinator) Er voor zorg dragen dat de behandeling van de zaak in samenhang\ + \ uitgevoerd wordt conform de daarover gemaakte afspraken.\n* `mede_initiator`\ + \ - Mede-initiator" + title: omschrijving generiek + roltoelichting: + type: string + title: roltoelichting + maxLength: 1000 + registratiedatum: + type: string + format: date-time + readOnly: true + description: De datum waarop dit object is geregistreerd. + title: registratiedatum + indicatieMachtiging: + description: 'Indicatie machtiging + + + Uitleg bij mogelijke waarden: + + + * `gemachtigde` - De betrokkene in de rol bij de zaak is door een andere + betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen + + * `machtiginggever` - De betrokkene in de rol bij de zaak heeft een andere + betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen' + title: indicatie machtiging + oneOf: + - $ref: '#/components/schemas/IndicatieMachtigingEnum' + - $ref: '#/components/schemas/BlankEnum' + contactpersoonRol: + allOf: + - $ref: '#/components/schemas/ContactPersoonRol' + nullable: true + description: + De gegevens van de persoon die anderen desgevraagd in contact + brengt met medewerkers van de BETROKKENE, een NIET-NATUURLIJK PERSOON + of VESTIGING zijnde, of met BETROKKENE zelf, een NATUURLIJK PERSOON zijnde + , vanuit het belang van BETROKKENE in haar ROL bij een ZAAK. + title: contactpersoonRol + statussen: + type: array + items: + type: string + format: uri + title: '' + minLength: 1 + maxLength: 1000 + readOnly: true + description: + De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd + dat STATUSsen in die ZAAK bereikt zijn. + title: statussen + uniqueItems: true + _expand: $ref: '#/components/schemas/RolEmbedded' + required: + - betrokkeneType + - omschrijving + - omschrijvingGeneriek + - registratiedatum + - roltoelichting + - roltype + - statussen + - url + - uuid + - zaak + discriminator: + propertyName: betrokkeneType + mapping: + medewerker: '#/components/schemas/medewerker_RolExpanded' + natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_RolExpanded' + niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_RolExpanded' + organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_RolExpanded' + vestiging: '#/components/schemas/vestiging_RolExpanded' + + # RolExpanded: + # allOf: + # - $ref: '#/components/schemas/Rol' + # - properties: + # _expand: + # $ref: '#/components/schemas/RolEmbedded' RolEmbedded: type: object properties: @@ -14145,7 +14305,7 @@ components: zaakobjecten: type: array items: - $ref: '#/components/schemas/ZaakObject' + $ref: '#/components/schemas/ZaakObjectExpanded' resultaat: oneOf: - $ref: '#/components/schemas/ResultaatExpanded' @@ -14547,8 +14707,6 @@ components: description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. title: relatieomschrijving maxLength: 80 - _expand: - $ref: '#/components/schemas/ZaakObjectEmbedded' required: - objectType - url @@ -14589,11 +14747,195 @@ components: zakelijk_recht: '#/components/schemas/zakelijk_recht_ZaakObject' overige: '#/components/schemas/overige_ZaakObject' ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - properties: - _expand: - $ref: '#/components/schemas/ZaakObjectEmbedded' + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + object: + type: string + format: uri + description: URL-referentie naar de resource die het OBJECT beschrijft. + title: object + maxLength: 1000 + zaakobjecttype: + type: string + format: uri + description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API). + title: zaakobjecttype + maxLength: 1000 + objectType: + allOf: + - $ref: '#/components/schemas/ObjectTypeEnum' + description: + 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er + geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. + + + Uitleg bij mogelijke waarden: + + + * `adres` - Adres + + * `besluit` - Besluit + + * `buurt` - Buurt + + * `enkelvoudig_document` - Enkelvoudig document + + * `gemeente` - Gemeente + + * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte + + * `huishouden` - Huishouden + + * `inrichtingselement` - Inrichtingselement + + * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak + + * `kunstwerkdeel` - Kunstwerkdeel + + * `maatschappelijke_activiteit` - Maatschappelijke activiteit + + * `medewerker` - Medewerker + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `openbare_ruimte` - Openbare ruimte + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `pand` - Pand + + * `spoorbaandeel` - Spoorbaandeel + + * `status` - Status + + * `terreindeel` - Terreindeel + + * `terrein_gebouwd_object` - Terrein gebouwd object + + * `vestiging` - Vestiging + + * `waterdeel` - Waterdeel + + * `wegdeel` - Wegdeel + + * `wijk` - Wijk + + * `woonplaats` - Woonplaats + + * `woz_deelobject` - Woz deel object + + * `woz_object` - Woz object + + * `woz_waarde` - Woz waarde + + * `zakelijk_recht` - Zakelijk recht + + * `overige` - Overige' + title: object type + objectTypeOverige: + type: string + description: + Beschrijft het type OBJECT als `objectType` de waarde "overige" + heeft. + title: object type overige + pattern: '[a-z\_]+' + maxLength: 100 + objectTypeOverigeDefinitie: + allOf: + - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie' + nullable: true + title: definitie object type overige + description: + 'Verwijzing naar het schema van het type OBJECT als `objectType` + de waarde "overige" heeft. + + + * De URL referentie moet naar een JSON endpoint wijzen waarin het objecttype + gedefinieerd is, inclusief het [JSON-schema](https://json-schema.org/). + + * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen de + objecttype resource (deze gebruikt het [jq](http://stedolan.github.io/jq/) + formaat. + + * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens binnen + het OBJECT. Deze gebruikt ook het [jq](http://stedolan.github.io/jq/) + formaat. + + + Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven + en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven + OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.' + relatieomschrijving: + type: string + description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. + title: relatieomschrijving + maxLength: 80 + _expand: + $ref: '#/components/schemas/ZaakObjectEmbedded' + required: + - objectType + - url + - uuid + - zaak + discriminator: + propertyName: objectType + mapping: + adres: '#/components/schemas/adres_ZaakObjectExpanded' + besluit: '#/components/schemas/besluit_ZaakObjectExpanded' + buurt: '#/components/schemas/buurt_ZaakObjectExpanded' + enkelvoudig_document: '#/components/schemas/enkelvoudig_document_ZaakObjectExpanded' + gemeente: '#/components/schemas/gemeente_ZaakObjectExpanded' + gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_ZaakObjectExpanded' + huishouden: '#/components/schemas/huishouden_ZaakObjectExpanded' + inrichtingselement: '#/components/schemas/inrichtingselement_ZaakObjectExpanded' + kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_ZaakObjectExpanded' + kunstwerkdeel: '#/components/schemas/kunstwerkdeel_ZaakObjectExpanded' + maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_ZaakObjectExpanded' + medewerker: '#/components/schemas/medewerker_ZaakObjectExpanded' + natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_ZaakObjectExpanded' + niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_ZaakObjectExpanded' + openbare_ruimte: '#/components/schemas/openbare_ruimte_ZaakObjectExpanded' + organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_ZaakObjectExpanded' + pand: '#/components/schemas/pand_ZaakObjectExpanded' + spoorbaandeel: '#/components/schemas/spoorbaandeel_ZaakObjectExpanded' + status: '#/components/schemas/status_ZaakObjectExpanded' + terreindeel: '#/components/schemas/terreindeel_ZaakObjectExpanded' + terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_ZaakObjectExpanded' + vestiging: '#/components/schemas/vestiging_ZaakObjectExpanded' + waterdeel: '#/components/schemas/waterdeel_ZaakObjectExpanded' + wegdeel: '#/components/schemas/wegdeel_ZaakObjectExpanded' + wijk: '#/components/schemas/wijk_ZaakObjectExpanded' + woonplaats: '#/components/schemas/woonplaats_ZaakObjectExpanded' + woz_deelobject: '#/components/schemas/woz_deelobject_ZaakObjectExpanded' + woz_object: '#/components/schemas/woz_object_ZaakObjectExpanded' + woz_waarde: '#/components/schemas/woz_waarde_ZaakObjectExpanded' + zakelijk_recht: '#/components/schemas/zakelijk_recht_ZaakObjectExpanded' + overige: '#/components/schemas/overige_ZaakObjectExpanded' ZaakObjectEmbedded: type: object properties: @@ -14926,8 +15268,10 @@ components: type: string example: "123456789" expand: - description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,' \ - \ hoofdzaak.deelzaken.status.statustype`Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt." + description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,` \ + \ hoofdzaak.deelzaken.status.statustype`Haal details van gelinkte resources direct op. + Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt." title: expand type: string example: zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype @@ -14964,6 +15308,10 @@ components: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectAdres' + adres_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectAdres' adres_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -14971,6 +15319,9 @@ components: besluit_ZaakObject: allOf: - $ref: '#/components/schemas/ZaakObject' + besluit_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' besluit_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15013,6 +15364,10 @@ components: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' + buurt_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' buurt_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15020,6 +15375,9 @@ components: enkelvoudig_document_ZaakObject: allOf: - $ref: '#/components/schemas/ZaakObject' + enkelvoudig_document_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' enkelvoudig_document_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15027,6 +15385,10 @@ components: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' + gemeente_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' gemeente_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15035,6 +15397,10 @@ components: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' + gemeentelijke_openbare_ruimte_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' gemeentelijke_openbare_ruimte_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15043,6 +15409,10 @@ components: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' + huishouden_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' huishouden_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15051,6 +15421,10 @@ components: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' + inrichtingselement_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' inrichtingselement_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15059,6 +15433,10 @@ components: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' + kadastrale_onroerende_zaak_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' kadastrale_onroerende_zaak_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15067,6 +15445,10 @@ components: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' + kunstwerkdeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' kunstwerkdeel_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15075,6 +15457,10 @@ components: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' + maatschappelijke_activiteit_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' maatschappelijke_activiteit_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15083,10 +15469,18 @@ components: allOf: - $ref: '#/components/schemas/Rol' - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' + medewerker_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' medewerker_ZaakObject: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' + medewerker_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' medewerker_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15095,10 +15489,18 @@ components: allOf: - $ref: '#/components/schemas/Rol' - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' + natuurlijk_persoon_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' natuurlijk_persoon_ZaakObject: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' + natuurlijk_persoon_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' natuurlijk_persoon_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15107,10 +15509,18 @@ components: allOf: - $ref: '#/components/schemas/Rol' - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' + niet_natuurlijk_persoon_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' niet_natuurlijk_persoon_ZaakObject: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' + niet_natuurlijk_persoon_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' niet_natuurlijk_persoon_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15315,6 +15725,10 @@ components: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' + openbare_ruimte_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' openbare_ruimte_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15323,10 +15737,18 @@ components: allOf: - $ref: '#/components/schemas/Rol' - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' + organisatorische_eenheid_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' organisatorische_eenheid_ZaakObject: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' + organisatorische_eenheid_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' organisatorische_eenheid_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15335,6 +15757,10 @@ components: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectOverige' + overige_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectOverige' overige_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15343,6 +15769,10 @@ components: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectPand' + pand_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectPand' pand_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15351,6 +15781,10 @@ components: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' + spoorbaandeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' spoorbaandeel_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15358,33 +15792,52 @@ components: status_ZaakObject: allOf: - $ref: '#/components/schemas/ZaakObject' + status_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' status_PatchedZaakObject: allOf: - - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/PatchedZaakObject' terrein_gebouwd_object_ZaakObject: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' + terrein_gebouwd_object_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' terrein_gebouwd_object_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' terreindeel_ZaakObject: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' + terreindeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' terreindeel_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' vestiging_Rol: allOf: - $ref: '#/components/schemas/Rol' - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' + vestiging_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' vestiging_ZaakObject: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' + vestiging_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' vestiging_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15393,38 +15846,58 @@ components: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' + waterdeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' waterdeel_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' + - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' wegdeel_ZaakObject: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' + wegdeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' wegdeel_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' + - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' wijk_ZaakObject: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectWijk' + wijk_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWijk' wijk_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWijk' + - $ref: '#/components/schemas/object_identificatie_ObjectWijk' woonplaats_ZaakObject: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' + woonplaats_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' woonplaats_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' + - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' woz_deelobject_ZaakObject: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' + woz_deelobject_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' woz_deelobject_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15433,14 +15906,22 @@ components: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' + woz_object_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' woz_object_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' woz_waarde_ZaakObject: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' + woz_waarde_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' woz_waarde_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' @@ -15449,6 +15930,10 @@ components: allOf: - $ref: '#/components/schemas/ZaakObject' - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' + zakelijk_recht_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' zakelijk_recht_PatchedZaakObject: allOf: - $ref: '#/components/schemas/PatchedZaakObject' From a09c2867216e7c3756a32602ad053d36424c2330 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Thu, 17 Oct 2024 16:42:05 +0200 Subject: [PATCH 04/36] Merged changes from branch catalogi-1_3_2 manually --- api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml | 48 +- api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml | 15581 ++++++++++++++++ 2 files changed, 15623 insertions(+), 6 deletions(-) create mode 100644 api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml index 74b949992..24e5b0cb8 100644 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Zaken API - version: 1.5.1 + version: 1.5.2 description: " Met expand mechanisme in plain json @@ -12904,7 +12904,9 @@ components: zaak: $ref: '#/components/schemas/ZaakExpanded' resultaattype: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/ResultaatType' + allOf: + - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/ResultaatType' + - $ref: '#/components/schemas/ExpandCatalogusObject' Rol: type: object properties: @@ -13239,7 +13241,10 @@ components: $ref: '#/components/schemas/ZaakExpanded' example: {} roltype: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/RolType' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/catalogi-1_3_2/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' + # allOf: + # - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/RolType' + # - $ref: '#/components/schemas/ExpandCatalogusObject' statussen: type: array items: @@ -13525,7 +13530,9 @@ components: type: object properties: statustype: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/StatusType' + allOf: + - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/StatusType' + - $ref: '#/components/schemas/ExpandCatalogusObject' gezetdoor: $ref: '#/components/schemas/Rol' zaakinformatieobjecten: @@ -14274,7 +14281,11 @@ components: Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." properties: zaaktype: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/ZaakType' + # Uiteindelijk is de onderstaande $ref de juiste maar werkt helaas niet in VSC Redoc Viewer + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/catalogi-1_3_2/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' + # allOf: + # - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/ZaakType' + # - $ref: '#/components/schemas/ExpandCatalogusObject' hoofdzaak: oneOf: - $ref: '#/components/schemas/ZaakExpanded' @@ -14293,7 +14304,7 @@ components: eigenschappen: type: array items: - $ref: '#/components/schemas/ZaakEigenschap' + $ref: '#/components/schemas/ZaakEigenschapExpanded' rollen: type: array items: @@ -14314,6 +14325,12 @@ components: type: object description: Leeg object. Dit wordt teruggeven indien het te expanderen veld een null waarde heeft. example: {} + ExpandCatalogusObject: + type: object + properties: + _expand: + type: object + description: Zie de Catalogus API hoe dit object verder geëxpandeerd kan worden. ZaakBesluit: type: object description: @@ -14444,6 +14461,25 @@ components: - uuid - waarde - zaak + ZaakEigenschapExpanded: + allOf: + - $ref: '#/components/schemas/ZaakEigenschap' + - properties: + _expand: + $ref: '#/components/schemas/ZaakEigenschapEmbedded' + ZaakEigenschapEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + zaak: + oneOf: + - $ref: '#/components/schemas/ZaakExpanded' + - $ref: '#/components/schemas/EmptyObject' + eigenschap: + allOf: + - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/Eigenschap' + - $ref: '#/components/schemas/ExpandCatalogusObject' ZaakInformatieObject: type: object properties: diff --git a/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml b/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml new file mode 100644 index 000000000..1832083bc --- /dev/null +++ b/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml @@ -0,0 +1,15581 @@ +openapi: 3.0.3 +info: + title: Catalogi API + version: 1.3.2 + description: + "Een API om een zaaktypecatalogus (ZTC) te benaderen.\n\nDe zaaktypecatalogus\ + \ helpt gemeenten om het proces vanuit de 'vraag van een\nklant' (productaanvraag,\ + \ melding, aangifte, informatieverzoek e.d.) tot en met\nhet leveren van een passend\ + \ antwoord daarop in te richten, inclusief de\nbijbehorende informatievoorziening.\n\ + \nEen CATALOGUS bestaat uit ZAAKTYPEn, INFORMATIEOBJECTTYPEn en BESLUITTYPEn en\n\ + wordt typisch gebruikt om een ZAAK (in de Zaken API), INFORMATIEOBJECT (in de\n\ + Documenten API) en BESLUIT (in de Besluiten API) te voorzien van type,\nstandaardwaarden\ + \ en processtructuur.\n\n**Afhankelijkheden**\n\nDeze API is afhankelijk van:\n\ + \n* Gemeentelijke Selectielijst API\n* Autorisaties API *(optioneel)*\n\n\n**Autorisatie**\n\ + \nDeze API vereist autorisatie. Je kan de\n[token-tool](https://zaken-auth.vng.cloud/)\ + \ gebruiken om een token te\ngenereren.\n\n_Zelf een token genereren_\n\nDe tokens\ + \ die gebruikt worden voor autorisatie zijn [jwt.io][JWT's] (JSON web\ntoken).\ + \ In de API calls moeten deze gebruikt worden in de `Authorization`\nheader:\n\ + \n```\nAuthorization: Bearer \n```\n\nOm een JWT te genereren heb je een\ + \ `client ID` en een `secret` nodig. Het JWT\nmoet gebouwd worden volgens het\ + \ `HS256` algoritme. De vereiste payload is:\n\n```json\n{\n \"iss\": \"\",\n \"iat\": 1572863906,\n \"client_id\": \"\",\n \"\ + user_id\": \"\",\n \"user_representation\": \"\"\ + \n}\n```\n\nAls `issuer` gebruik je dus je eigen client ID. De `iat` timestamp\ + \ is een\nUNIX-timestamp die aangeeft op welk moment het token gegenereerd is.\n\ + \n`user_id` en `user_representation` zijn nodig voor de audit trails. Het zijn\n\ + vrije velden met als enige beperking dat de lengte maximaal de lengte van\nde\ + \ overeenkomstige velden in de audit trail resources is (zie rest API spec).\n\ + \n\n### Notificaties\n\nDeze API publiceert notificaties op het kanaal `zaaktypen`.\n\ + \n**Main resource**\n\n`zaaktype`\n\n\n\n**Kenmerken**\n\n* `catalogus`: URL-referentie\ + \ naar de CATALOGUS waartoe dit ZAAKTYPE behoort.\n\n**Resources en acties**\n\ + \n\nDeze API publiceert notificaties op het kanaal `besluittypen`.\n\n**Main resource**\n\ + \n`besluittype`\n\n\n\n**Kenmerken**\n\n* `catalogus`: URL-referentie naar de\ + \ CATALOGUS waartoe dit BESLUITTYPE behoort.\n\n**Resources en acties**\n\n\n\ + Deze API publiceert notificaties op het kanaal `informatieobjecttypen`.\n\n**Main\ + \ resource**\n\n`informatieobjecttype`\n\n\n\n**Kenmerken**\n\n* `catalogus`:\ + \ URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE behoort.\n\ + \n**Resources en acties**\n\n\n**Handige links**\n\n* [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard)\n\ + * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken)\n" + contact: + email: standaarden.ondersteuning@vng.nl + url: https://vng-realisatie.github.io/gemma-zaken + license: + name: EUPL 1.2 + url: https://opensource.org/licenses/EUPL-1.2 +paths: + /besluittypen: + get: + operationId: besluittype_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle BESLUITTYPEn opvragen. + parameters: + - name: catalogus + required: false + in: query + description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. + schema: + type: string + format: uri + - name: zaaktypen + required: false + in: query + description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE + schema: + type: string + - name: informatieobjecttypen + required: false + in: query + description: + Het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten + van dit BESLUITTYPE worden vastgelegd. + schema: + type: string + - name: status + required: false + in: query + description: 'filter objects depending on their concept status: + + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + + ' + schema: + type: string + - name: omschrijving + required: false + in: query + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - besluittypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedBesluitTypeList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: besluittype_create + description: Maak een BESLUITTYPE aan. + summary: Maak een BESLUITTYPE aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - besluittypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BesluitTypeCreate' + required: true + security: + - JWT-Claims: + - catalogi.schrijven + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/BesluitType' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /besluittypen/{uuid}: + get: + operationId: besluittype_retrieve + description: Een specifieke BESLUITTYPE opvragen. + summary: Een specifieke BESLUITTYPE opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - besluittypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/BesluitType' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: besluittype_update + description: + Werk een BESLUITTYPE in zijn geheel bij. Dit kan alleen als het + een concept betreft. + summary: Werk een BESLUITTYPE in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - besluittypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/BesluitTypeUpdate' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/BesluitType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: besluittype_partial_update + description: + Werk een BESLUITTYPE deels bij. Dit kan alleen als het een concept + betreft. + summary: Werk een BESLUITTYPE deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - besluittypen + requestBody: + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified request body + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified response body + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: besluittype_destroy + description: Verwijder een BESLUITTYPE. Dit kan alleen als het een concept betreft. + summary: Verwijder een BESLUITTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - besluittypen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified response body + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: besluittype_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) BESLUITTYPE opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - besluittypen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /besluittypen/{uuid}/publish: + post: + operationId: besluittype_publish + description: + Publiceren van het besluittype zorgt ervoor dat dit in een Besluiten + API kan gebruikt worden. Na het publiceren van een besluittype zijn geen inhoudelijke + wijzigingen meer mogelijk. Indien er na het publiceren nog wat gewijzigd moet + worden, dan moet je een nieuwe versie aanmaken. + summary: Publiceer het concept BESLUITTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - besluittypen + security: + - JWT-Claims: + - catalogi.schrijven + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/BesluitType' + description: OK + '400': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '404': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '401': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /catalogussen: + get: + operationId: catalogus_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle CATALOGUSsen opvragen. + parameters: + - name: domein + required: false + in: query + description: domein + schema: + type: string + - name: domein__in + required: false + in: query + description: domein__in + schema: + type: string + - name: rsin + required: false + in: query + description: rsin + schema: + type: string + - name: rsin__in + required: false + in: query + description: rsin__in + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - catalogussen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedCatalogusList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: catalogus_create + description: Maak een CATALOGUS aan. + summary: Maak een CATALOGUS aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - catalogussen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Catalogus' + required: true + security: + - JWT-Claims: + - catalogi.schrijven + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Catalogus' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /catalogussen/{uuid}: + get: + operationId: catalogus_retrieve + description: Een specifieke CATALOGUS opvragen. + summary: Een specifieke CATALOGUS opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - catalogussen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Catalogus' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: catalogus_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) CATALOGUS opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - catalogussen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /eigenschappen: + get: + operationId: eigenschap_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle EIGENSCHAPpen opvragen. + parameters: + - name: zaaktype + required: false + in: query + description: + URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze + EIGENSCHAP van belang is. + schema: + type: string + format: uri + - name: zaaktypeIdentificatie + required: false + in: query + description: zaaktype_identificatie + schema: + type: string + - name: status + required: false + in: query + description: 'filter objects depending on their concept status: + + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + + ' + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - eigenschappen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedEigenschapList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: eigenschap_create + description: + Maak een EIGENSCHAP aan. Dit kan alleen als het bijbehorende ZAAKTYPE + een concept betreft. + summary: Maak een EIGENSCHAP aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - eigenschappen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Eigenschap' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Eigenschap' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /eigenschappen/{uuid}: + get: + operationId: eigenschap_retrieve + description: Een specifieke EIGENSCHAP opvragen. + summary: Een specifieke EIGENSCHAP opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - eigenschappen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Eigenschap' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: eigenschap_update + description: + Werk een EIGENSCHAP in zijn geheel bij. Dit kan alleen als het + bijbehorende ZAAKTYPE een concept betreft. + summary: Werk een EIGENSCHAP in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - eigenschappen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Eigenschap' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Eigenschap' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: eigenschap_partial_update + description: + Werk een EIGENSCHAP deels bij. Dit kan alleen als het bijbehorende + ZAAKTYPE een concept betreft. + summary: Werk een EIGENSCHAP deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - eigenschappen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedEigenschap' + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Eigenschap' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: eigenschap_destroy + description: + Verwijder een EIGENSCHAP. Dit kan alleen als het bijbehorende ZAAKTYPE + een concept betreft. + summary: Verwijder een EIGENSCHAP. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - eigenschappen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: eigenschap_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) EIGENSCHAP opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - eigenschappen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /informatieobjecttypen: + get: + operationId: informatieobjecttype_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle INFORMATIEOBJECTTYPEn opvragen. + parameters: + - name: catalogus + required: false + in: query + description: + URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE + behoort. + schema: + type: string + format: uri + - name: status + required: false + in: query + description: 'filter objects depending on their concept status: + + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + + ' + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: omschrijving + required: false + in: query + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - informatieobjecttypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedInformatieObjectTypeList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: informatieobjecttype_create + description: Maak een INFORMATIEOBJECTTYPE aan. + summary: Maak een INFORMATIEOBJECTTYPE aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - informatieobjecttypen + requestBody: + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified request body + security: + - JWT-Claims: + - catalogi.schrijven + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified response body + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /informatieobjecttypen/{uuid}: + get: + operationId: informatieobjecttype_retrieve + description: Een specifieke INFORMATIEOBJECTTYPE opvragen. + summary: Een specifieke INFORMATIEOBJECTTYPE opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - informatieobjecttypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/InformatieObjectType' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: informatieobjecttype_update + description: + Werk een INFORMATIEOBJECTTYPE in zijn geheel bij. Dit kan alleen + als het een concept betreft. + summary: Werk een INFORMATIEOBJECTTYPE in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - informatieobjecttypen + requestBody: + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified request body + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified response body + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: informatieobjecttype_partial_update + description: + Werk een INFORMATIEOBJECTTYPE deels bij. Dit kan alleen als het + een concept betreft. + summary: ' Werk een INFORMATIEOBJECTTYPE deels bij.' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - informatieobjecttypen + requestBody: + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified request body + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified response body + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: informatieobjecttype_destroy + description: + Verwijder een INFORMATIEOBJECTTYPE. Dit kan alleen als het een + concept betreft. + summary: Verwijder een INFORMATIEOBJECTTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - informatieobjecttypen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified response body + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: informatieobjecttype_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) INFORMATIEOBJECTTYPE opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - informatieobjecttypen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /informatieobjecttypen/{uuid}/publish: + post: + operationId: informatieobjecttype_publish + description: + Publiceren van het informatieobjecttype zorgt ervoor dat dit in + een Documenten API kan gebruikt worden. Na het publiceren van een informatieobjecttype + zijn geen inhoudelijke wijzigingen meer mogelijk. Indien er na het publiceren + nog wat gewijzigd moet worden, dan moet je een nieuwe versie aanmaken. + summary: Publiceer het concept INFORMATIEOBJECTTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - informatieobjecttypen + security: + - JWT-Claims: + - catalogi.schrijven + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/InformatieObjectType' + description: OK + '400': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '404': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '401': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /resultaattypen: + get: + operationId: resultaattype_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle RESULTAATTYPEn opvragen. + parameters: + - name: zaaktype + required: false + in: query + description: zaaktype + schema: + type: string + - name: zaaktype_identificatie + required: false + in: query + description: zaaktype_identificatie + schema: + type: string + - name: status + required: false + in: query + description: status + schema: + type: string + - name: datum_geldigheid + required: false + in: query + description: datum_geldigheid + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - resultaattypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedResultaatTypeList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: resultaattype_create + description: + Maak een RESULTAATTYPE aan. Dit kan alleen als het bijbehorende + ZAAKTYPE een concept betreft. + summary: Maak een RESULTAATTYPE aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - resultaattypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResultaatTypeCreate' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ResultaatType' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /resultaattypen/{uuid}: + get: + operationId: resultaattype_retrieve + description: Een specifieke RESULTAATTYPE opvragen. + summary: Een specifieke RESULTAATTYPE opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - resultaattypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ResultaatType' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: resultaattype_update + description: + Werk een RESULTAATTYPE in zijn geheel bij. Dit kan alleen als het + bijbehorende ZAAKTYPE een concept betreft. + summary: Werk een RESULTAATTYPE in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - resultaattypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ResultaatTypeCreate' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ResultaatTypeUpdate' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: resultaattype_partial_update + description: + Werk een RESULTAATTYPE deels bij. Dit kan alleen als het bijbehorende + ZAAKTYPE een concept betreft. + summary: Werk een RESULTAATTYPE deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - resultaattypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedResultaatType' + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ResultaatType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: resultaattype_destroy + description: + Verwijder een RESULTAATTYPE. Dit kan alleen als het bijbehorende + ZAAKTYPE een concept betreft. + summary: Verwijder een RESULTAATTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - resultaattypen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: resultaattype_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) RESULTAATTYPE opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - resultaattypen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /roltypen: + get: + operationId: roltype_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle ROLTYPEn opvragen. + parameters: + - name: zaaktype + required: false + in: query + description: + URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken + kunnen zijn. + schema: + type: string + format: uri + - name: zaaktypeIdentificatie + required: false + in: query + description: zaaktype_identificatie + schema: + type: string + - name: omschrijvingGeneriek + required: false + in: query + description: Algemeen gehanteerde omschrijving van de aard van de ROL. + schema: + type: string + enum: + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator + - name: status + required: false + in: query + description: 'filter objects depending on their concept status: + + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + + ' + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - roltypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRolTypeList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: roltype_create + description: + Maak een ROLTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE + een concept betreft. + summary: Maak een ROLTYPE aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - roltypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RolType' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/RolType' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /roltypen/{uuid}: + get: + operationId: roltype_retrieve + description: Een specifieke ROLTYPE opvragen. + summary: Een specifieke ROLTYPE opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - roltypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/RolType' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: roltype_update + description: + Werk een ROLTYPE in zijn geheel bij. Dit kan alleen als het een + concept betreft. + summary: Werk een ROLTYPE in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - roltypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/RolType' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/RolType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: roltype_partial_update + description: + Werk een ROLTYPE deels bij. Dit kan alleen als het een concept + betreft. + summary: Werk een ROLTYPE deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - roltypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedRolType' + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/RolType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: roltype_destroy + description: Verwijder een ROLTYPE. Dit kan alleen als het een concept betreft. + summary: Verwijder een ROLTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + title: uuid + required: true + tags: + - roltypen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: roltype_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ROLTYPE opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - roltypen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /statustypen: + get: + operationId: statustype_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle STATUSTYPEn opvragen. + parameters: + - name: zaaktype + required: false + in: query + description: + URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen + van dit STATUSTYPE bereikt kunnen worden. + schema: + type: string + format: uri + - name: zaaktypeIdentificatie + required: false + in: query + description: zaaktype_identificatie + schema: + type: string + - name: status + required: false + in: query + description: 'filter objects depending on their concept status: + + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + + ' + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - statustypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedStatusTypeList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: statustype_create + description: + Maak een STATUSTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE + een concept betreft. + summary: Maak een STATUSTYPE aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - statustypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StatusType' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/StatusType' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /statustypen/{uuid}: + get: + operationId: statustype_retrieve + description: Een specifieke STATUSTYPE opvragen. + summary: Een specifieke STATUSTYPE opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - statustypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/StatusType' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: statustype_update + description: + Werk een STATUSTYPE in zijn geheel bij. Dit kan alleen als het + bijbehorende ZAAKTYPE een concept betreft. + summary: Werk een STATUSTYPE in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - statustypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/StatusType' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/StatusType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: statustype_partial_update + description: + Werk een STATUSTYPE deels bij. Dit kan alleen als het bijbehorende + ZAAKTYPE een concept betreft. + summary: Werk een STATUSTYPE deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - statustypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedStatusType' + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/StatusType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: statustype_destroy + description: + Verwijder een STATUSTYPE. Dit kan alleen als het bijbehorende ZAAKTYPE + een concept betreft. + summary: Verwijder een STATUSTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - statustypen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: statustype_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) STATUSTYPE opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - statustypen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaakobjecttypen: + get: + operationId: zaakobjecttype_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle ZAAKOBJECTTYPEn opvragen. + parameters: + - name: anderObjecttype + required: false + in: query + description: + Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een + ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. + schema: + type: string + - name: catalogus + required: false + in: query + description: URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE behoort. + schema: + type: string + format: uri + - name: datumBeginGeldigheid + required: false + in: query + description: De datum waarop het is ontstaan. + schema: + type: string + - name: datumEindeGeldigheid + required: false + in: query + description: De datum waarop het is opgeheven. + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: objecttype + required: false + in: query + description: + URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE + behoort. + schema: + type: string + format: uri + - name: relatieOmschrijving + required: false + in: query + description: + Omschrijving van de betrekking van het Objecttype op zaken van + het gerelateerde ZAAKTYPE. + schema: + type: string + - name: zaaktype + required: false + in: query + description: URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE behoort. + schema: + type: string + format: uri + - name: zaaktypeIdentificatie + required: false + in: query + description: zaaktype_identificatie + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - zaakobjecttypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedZaakObjectTypeList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakobjecttype_create + description: Maak een ZAAKOBJECTTYPE aan. + summary: Maak een ZAAKOBJECTTYPE aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaakobjecttypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObjectType' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObjectType' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaakobjecttypen/{uuid}: + get: + operationId: zaakobjecttype_retrieve + description: Een specifieke ZAAKOBJECTTYPE opvragen. + summary: Een specifieke ZAAKOBJECTTYPE opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaakobjecttypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObjectType' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaakobjecttype_update + description: Werk een ZAAKOBJECTTYPE in zijn geheel bij. + summary: Werk een ZAAKOBJECTTYPE in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaakobjecttypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObjectType' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObjectType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaakobjecttype_partial_update + description: Werk een ZAAKOBJECTTYPE deels bij. + summary: Werk een ZAAKOBJECTTYPE deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaakobjecttypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedZaakObjectType' + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObjectType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakobjecttype_destroy + description: Verwijder een ZAAKOBJECTTYPE. + summary: Verwijder een ZAAKOBJECTTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - zaakobjecttypen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaakobjecttype_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAKOBJECTTYPE opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaakobjecttypen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaaktype-informatieobjecttypen: + get: + operationId: zaakinformatieobjecttype_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle ZAAKTYPE-INFORMATIEOBJECTTYPE relaties opvragen. + parameters: + - name: zaaktype + required: false + in: query + description: URL-referentie naar het ZAAKTYPE. + schema: + type: string + format: uri + - name: informatieobjecttype + required: false + in: query + description: informatieobjecttype + schema: + type: string + - name: richting + required: false + in: query + description: + Aanduiding van de richting van informatieobjecten van het gerelateerde + INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. + schema: + type: string + enum: + - inkomend + - intern + - uitgaand + - name: status + required: false + in: query + description: 'filter objects depending on their concept status: + + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + + ' + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - zaaktype-informatieobjecttypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedZaakTypeInformatieObjectTypeList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakinformatieobjecttype_create + description: + 'Maak een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie aan. Dit kan alleen + als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op: + + - `zaaktype` en `informatieobjecttype` behoren tot dezelfde `catalogus`' + summary: Maak een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaaktype-informatieobjecttypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaaktype-informatieobjecttypen/{uuid}: + get: + operationId: zaakinformatieobjecttype_retrieve + description: Een specifieke ZAAKTYPE-INFORMATIEOBJECTTYPE relatie opvragen. + summary: Een specifieke ZAAKTYPE-INFORMATIEOBJECTTYPE relatie opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaaktype-informatieobjecttypen + security: + - JWT-Claims: + - catalogi.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaakinformatieobjecttype_update + description: + "Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel\ + \ bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er\ + \ wordt gevalideerd op:\n - `zaaktype` en `informatieobjecttype` behoren tot\ + \ dezelfde `catalogus`" + summary: Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaaktype-informatieobjecttypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaakinformatieobjecttype_partial_update + description: + "Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij. Dit\ + \ kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt\ + \ gevalideerd op:\n - `zaaktype` en `informatieobjecttype` behoren tot dezelfde\ + \ `catalogus`" + summary: Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaaktype-informatieobjecttypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedZaakTypeInformatieObjectType' + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakinformatieobjecttype_destroy + description: + "Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie. Dit kan alleen\ + \ als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd\ + \ op:\n - `zaaktype` of `informatieobjecttype` is nog niet gepubliceerd" + summary: Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - zaaktype-informatieobjecttypen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaakinformatieobjecttype_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAK-INFORMATIEOBJECT-TYPE opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaaktype-informatieobjecttypen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaaktypen: + get: + operationId: zaaktype_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle ZAAKTYPEn opvragen. + parameters: + - name: catalogus + required: false + in: query + description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. + schema: + type: string + format: uri + - name: identificatie + required: false + in: query + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + schema: + type: string + - name: trefwoorden + required: false + in: query + description: Multiple values may be separated by commas. + schema: + type: array + items: + type: string + style: form + explode: false + - name: status + required: false + in: query + description: 'filter objects depending on their concept status: + + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + + ' + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - zaaktypen + security: + - JWT-Claims: + - (catalogi.lezen | documenten.lezen | zaken.lezen) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedZaakTypeList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaaktype_create + description: + "Er wordt gevalideerd op:\n- geldigheid `catalogus` URL, dit moet\ + \ een catalogus binnen dezelfde API zijn\n - Uniciteit `catalogus` en `zaaktypeidentificatie`.\ + \ Dezelfde zaaktypeidentificatie mag enkel opnieuw gebruikt worden als het zaaktype\ + \ een andere geldigheidsperiode kent dan bestaande zaaktypen.\n - `deelzaaktypen`\ + \ moeten tot dezelfde catalogus behoren als het ZAAKTYPE." + summary: Maak een ZAAKTYPE aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaaktypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakTypeCreate' + required: true + security: + - JWT-Claims: + - catalogi.schrijven + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakType' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaaktypen/{uuid}: + get: + operationId: zaaktype_retrieve + description: Een specifieke ZAAKTYPE opvragen. + summary: Een specifieke ZAAKTYPE opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: query + name: datumGeldigheid + schema: + type: string + description: + filter op datumGeldigheid voor het zelf en alle onderliggende + objecten + tags: + - zaaktypen + security: + - JWT-Claims: + - (catalogi.lezen | documenten.lezen | zaken.lezen) + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakType' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaaktype_update + description: + "Werk een ZAAKTYPE in zijn geheel bij. Dit kan alleen als het een\ + \ concept betreft. Er wordt gevalideerd op:\n - `deelzaaktypen` moeten tot\ + \ dezelfde catalogus behoren als het ZAAKTYPE." + summary: Werk een ZAAKTYPE in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaaktypen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakTypeUpdate' + required: true + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakType' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaaktype_partial_update + description: + "Werk een ZAAKTYPE deels bij. Dit kan alleen als het een concept\ + \ betreft. Er wordt gevalideerd op:\n - `deelzaaktypen` moeten tot dezelfde\ + \ catalogus behoren als het ZAAKTYPE." + summary: Werk een ZAAKTYPE deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaaktypen + requestBody: + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified request body + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified response body + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaaktype_destroy + description: Verwijder een ZAAKTYPE. Dit kan alleen als het een concept betreft. + summary: Verwijder een ZAAKTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - zaaktypen + security: + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified response body + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaaktype_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAKTYPE opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaaktypen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaaktypen/{uuid}/publish: + post: + operationId: zaaktype_publish + description: + Publiceren van het zaaktype zorgt ervoor dat dit in een Zaken API + kan gebruiktworden. Na het publiceren van een zaaktype zijn geen inhoudelijke + wijzigingenmeer mogelijk - ook niet de statustypen, eigenschappen... etc. + Indien er na hetpubliceren nog wat gewijzigd moet worden, dan moet je een + nieuwe versieaanmaken. + summary: Publiceer het concept ZAAKTYPE. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaaktypen + requestBody: + content: + application/json: + schema: + type: object + additionalProperties: {} + description: Unspecified request body + security: + - JWT-Claims: + - catalogi.schrijven + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakType' + description: OK + '400': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '404': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '401': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error +components: + responses: + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + schemas: + AardRelatieEnum: + enum: + - vervolg + - bijdrage + - onderwerp + type: string + AfleidingswijzeEnum: + enum: + - afgehandeld + - ander_datumkenmerk + - eigenschap + - gerelateerde_zaak + - hoofdzaak + - ingangsdatum_besluit + - termijn + - vervaldatum_besluit + - zaakobject + type: string + ArchiefnominatieEnum: + enum: + - blijvend_bewaren + - vernietigen + type: string + BesluitType: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + catalogus: + type: string + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. + title: catalogus + zaaktypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE + title: zaaktypen + uniqueItems: true + omschrijving: + type: string + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: + Algemeen gehanteerde omschrijving van de aard van BESLUITen + van het BESLUITTYPE + title: omschrijving generiek + maxLength: 80 + besluitcategorie: + type: string + description: Typering van de aard van BESLUITen van het BESLUITTYPE. + title: besluitcategorie + maxLength: 40 + reactietermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype + mogelijk is. + title: reactietermijn + format: duration + publicatieIndicatie: + type: boolean + description: + Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten + worden. + title: publicatie indicatie + publicatietekst: + type: string + description: + De generieke tekst van de publicatie van BESLUITen van dit + BESLUITTYPE + title: publicatietekst + publicatietermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten + blijven. + title: publicatietermijn + format: duration + toelichting: + type: string + description: Een eventuele toelichting op dit BESLUITTYPE. + title: toelichting + informatieobjecttypen: + type: array + items: + type: string + format: uri + title: '' + description: + URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten + waarin besluiten van dit BESLUITTYPE worden vastgelegd. + title: informatieobjecttypen + uniqueItems: true + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + concept: + type: boolean + readOnly: true + description: + Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + resultaattypen: + type: array + items: + type: string + format: uri + title: Is resultaat van + readOnly: true + title: Is resultaat van + description: + Het BESLUITTYPE van besluiten die gepaard gaan met resultaten + van het RESULTAATTYPE. + uniqueItems: true + resultaattypenOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: is resultaat van + uniqueItems: true + vastgelegdIn: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true + required: + - beginGeldigheid + - catalogus + - concept + - informatieobjecttypen + - publicatieIndicatie + - resultaattypen + - resultaattypenOmschrijving + - url + - vastgelegdIn + - zaaktypen + BesluitTypeExpanded: + allOf: + - $ref: '#/components/schemas/BesluitType' + - properties: + _expand: + $ref: '#/components/schemas/BesluitTypeEmbedded' + BesluitTypeEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypeExpanded' + informatieobjecttypen: + type: array + items: + $ref: '#/components/schemas/InformatieObjectTypeExpanded' + resultaattypen: + type: array + items: + $ref: '#/components/schemas/ResultaatTypeExpanded' + EmptyObject: + type: object + description: Leeg object. Dit wordt teruggeven indien het te expanderen veld een null waarde heeft. + example: {} + BesluitTypeCreate: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + catalogus: + type: string + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. + title: catalogus + zaaktypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE + title: zaaktypen + uniqueItems: true + omschrijving: + type: string + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: + Algemeen gehanteerde omschrijving van de aard van BESLUITen + van het BESLUITTYPE + title: omschrijving generiek + maxLength: 80 + besluitcategorie: + type: string + description: Typering van de aard van BESLUITen van het BESLUITTYPE. + title: besluitcategorie + maxLength: 40 + reactietermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype + mogelijk is. + title: reactietermijn + format: duration + publicatieIndicatie: + type: boolean + description: + Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten + worden. + title: publicatie indicatie + publicatietekst: + type: string + description: + De generieke tekst van de publicatie van BESLUITen van dit + BESLUITTYPE + title: publicatietekst + publicatietermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten + blijven. + title: publicatietermijn + format: duration + toelichting: + type: string + description: Een eventuele toelichting op dit BESLUITTYPE. + title: toelichting + informatieobjecttypen: + type: array + items: + type: string + title: '' + description: + '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten + waarin besluiten van dit BESLUITTYPE worden vastgelegd.' + title: informatieobjecttypen + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + concept: + type: boolean + readOnly: true + description: + Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + resultaattypen: + type: array + items: + type: string + format: uri + title: Is resultaat van + readOnly: true + title: Is resultaat van + description: + Het BESLUITTYPE van besluiten die gepaard gaan met resultaten + van het RESULTAATTYPE. + uniqueItems: true + resultaattypenOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: is resultaat van + uniqueItems: true + vastgelegdIn: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true + required: + - beginGeldigheid + - catalogus + - concept + - informatieobjecttypen + - publicatieIndicatie + - resultaattypen + - resultaattypenOmschrijving + - url + - vastgelegdIn + - zaaktypen + BesluitTypeUpdate: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + catalogus: + type: string + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. + title: catalogus + zaaktypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE + title: zaaktypen + uniqueItems: true + omschrijving: + type: string + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: + Algemeen gehanteerde omschrijving van de aard van BESLUITen + van het BESLUITTYPE + title: omschrijving generiek + maxLength: 80 + besluitcategorie: + type: string + description: Typering van de aard van BESLUITen van het BESLUITTYPE. + title: besluitcategorie + maxLength: 40 + reactietermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype + mogelijk is. + title: reactietermijn + format: duration + publicatieIndicatie: + type: boolean + description: + Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten + worden. + title: publicatie indicatie + publicatietekst: + type: string + description: + De generieke tekst van de publicatie van BESLUITen van dit + BESLUITTYPE + title: publicatietekst + publicatietermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten + blijven. + title: publicatietermijn + format: duration + toelichting: + type: string + description: Een eventuele toelichting op dit BESLUITTYPE. + title: toelichting + informatieobjecttypen: + type: array + items: + type: string + title: '' + description: + '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten + waarin besluiten van dit BESLUITTYPE worden vastgelegd.' + title: informatieobjecttypen + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + concept: + type: boolean + readOnly: true + description: + Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + resultaattypen: + type: array + items: + type: string + format: uri + title: Is resultaat van + readOnly: true + title: Is resultaat van + description: + Het BESLUITTYPE van besluiten die gepaard gaan met resultaten + van het RESULTAATTYPE. + uniqueItems: true + resultaattypenOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: is resultaat van + uniqueItems: true + vastgelegdIn: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true + required: + - beginGeldigheid + - catalogus + - concept + - informatieobjecttypen + - publicatieIndicatie + - resultaattypen + - resultaattypenOmschrijving + - url + - vastgelegdIn + - zaaktypen + BlankEnum: + enum: + - '' + BronCatalogus: + type: object + description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. + properties: + url: + type: string + format: uri + title: URL-referentie broncatalogus + maxLength: 200 + domein: + type: string + description: Het domein van de CATALOGUS waaraan het ZAAKTYPE is ontleend. + title: broncatalogus domein + maxLength: 5 + rsin: + type: string + description: + Het RSIN van de INGESCHREVEN NIET-NATUURLIJK PERSOON die beheerder + is van de CATALOGUS waaraan het ZAAKTYPE is ontleend. + title: broncatalogus rsin + maxLength: 9 + required: + - domein + - rsin + - url + BronZaaktype: + type: object + description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. + properties: + url: + type: string + format: uri + title: URL-referentie bronzaaktype + maxLength: 200 + identificatie: + type: string + description: De Zaaktype-identificatie van het bronzaaktype binnen de CATALOGUS. + title: bronzaaktype identificatie + maxLength: 50 + omschrijving: + type: string + description: + De Zaaktype-omschrijving van het bronzaaktype, zoals gehanteerd + in de Broncatalogus. + title: bronzaaktype omschrijving + maxLength: 80 + required: + - identificatie + - omschrijving + - url + BrondatumArchiefprocedure: + type: object + description: + Specificatie voor het bepalen van de brondatum voor de start van + de Archiefactietermijn (=brondatum) van het zaakdossier. + properties: + afleidingswijze: + allOf: + - $ref: '#/components/schemas/AfleidingswijzeEnum' + title: Afleidingswijze brondatum + description: + "Wijze van bepalen van de brondatum.\n\nUitleg bij mogelijke\ + \ waarden:\n\n* `afgehandeld` - (Afgehandeld) De termijn start op de datum\ + \ waarop de zaak is afgehandeld (ZAAK.Einddatum in het RGBZ).\n* `ander_datumkenmerk`\ + \ - (Ander datumkenmerk) De termijn start op de datum die is vastgelegd\ + \ in een ander datumveld dan de datumvelden waarop de overige waarden\ + \ (van deze attribuutsoort) betrekking hebben. `Objecttype`, `Registratie`\ + \ en `Datumkenmerk` zijn niet leeg.\n* `eigenschap` - (Eigenschap) De\ + \ termijn start op de datum die vermeld is in een zaaktype-specifieke\ + \ eigenschap (zijnde een `datumveld`). `ResultaatType.ZaakType` heeft\ + \ een `Eigenschap`; `Objecttype`, en `Datumkenmerk` zijn niet leeg.\n\ + * `gerelateerde_zaak` - (Gerelateerde zaak) De termijn start op de datum\ + \ waarop de gerelateerde zaak is afgehandeld (`ZAAK.Einddatum` of `ZAAK.Gerelateerde_zaak.Einddatum`\ + \ in het RGBZ). `ResultaatType.ZaakType` heeft gerelateerd `ZaakType`\n\ + * `hoofdzaak` - (Hoofdzaak) De termijn start op de datum waarop de gerelateerde\ + \ zaak is afgehandeld, waarvan de zaak een deelzaak is (`ZAAK.Einddatum`\ + \ van de hoofdzaak in het RGBZ). ResultaatType.ZaakType is deelzaaktype\ + \ van ZaakType.\n* `ingangsdatum_besluit` - (Ingangsdatum besluit) De\ + \ termijn start op de datum waarop het besluit van kracht wordt (`BESLUIT.Ingangsdatum`\ + \ in het RGBZ).\tResultaatType.ZaakType heeft relevant BesluitType\n*\ + \ `termijn` - (Termijn) De termijn start een vast aantal jaren na de datum\ + \ waarop de zaak is afgehandeld (`ZAAK.Einddatum` in het RGBZ).\n* `vervaldatum_besluit`\ + \ - (Vervaldatum besluit) De termijn start op de dag na de datum waarop\ + \ het besluit vervalt (`BESLUIT.Vervaldatum` in het RGBZ). ResultaatType.ZaakType\ + \ heeft relevant BesluitType\n* `zaakobject` - (Zaakobject) De termijn\ + \ start op de einddatum geldigheid van het zaakobject waarop de zaak betrekking\ + \ heeft (bijvoorbeeld de overlijdendatum van een Persoon). M.b.v. de attribuutsoort\ + \ `Objecttype` wordt vastgelegd om welke zaakobjecttype het gaat; m.b.v.\ + \ de attribuutsoort `Datumkenmerk` wordt vastgelegd welke datum-attribuutsoort\ + \ van het zaakobjecttype het betreft." + datumkenmerk: + type: string + description: + Naam van de attribuutsoort van het procesobject dat bepalend + is voor het einde van de procestermijn. + title: datumkenmerk + maxLength: 80 + einddatumBekend: + type: boolean + description: + Indicatie dat de einddatum van het procesobject gedurende de + uitvoering van de zaak bekend moet worden. Indien deze nog niet bekend + is en deze waarde staat op `true`, dan kan de zaak (nog) niet afgesloten + worden. + title: einddatum bekend + objecttype: + description: + 'Het soort object in de registratie dat het procesobject representeert. + + + Uitleg bij mogelijke waarden: + + + * `adres` - Adres + + * `besluit` - Besluit + + * `buurt` - Buurt + + * `enkelvoudig_document` - Enkelvoudig document + + * `gemeente` - Gemeente + + * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte + + * `huishouden` - Huishouden + + * `inrichtingselement` - Inrichtingselement + + * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak + + * `kunstwerkdeel` - Kunstwerkdeel + + * `maatschappelijke_activiteit` - Maatschappelijke activiteit + + * `medewerker` - Medewerker + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `openbare_ruimte` - Openbare ruimte + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `pand` - Pand + + * `spoorbaandeel` - Spoorbaandeel + + * `status` - Status + + * `terreindeel` - Terreindeel + + * `terrein_gebouwd_object` - Terrein gebouwd object + + * `vestiging` - Vestiging + + * `waterdeel` - Waterdeel + + * `wegdeel` - Wegdeel + + * `wijk` - Wijk + + * `woonplaats` - Woonplaats + + * `woz_deelobject` - Woz deel object + + * `woz_object` - Woz object + + * `woz_waarde` - Woz waarde + + * `zakelijk_recht` - Zakelijk recht + + * `overige` - Overige' + title: objecttype + oneOf: + - $ref: '#/components/schemas/ObjecttypeEnum' + - $ref: '#/components/schemas/BlankEnum' + registratie: + type: string + description: + De naam van de registratie waarvan het procesobject deel uit + maakt. + title: registratie + maxLength: 80 + procestermijn: + type: string + nullable: true + title: Brondatum procestermijn + description: + De periode dat het zaakdossier na afronding van de zaak actief + gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening + van de organisatie. Enkel relevant indien de afleidingswijze 'termijn' + is. + format: duration + required: + - afleidingswijze + nullable: true + Catalogus: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + domein: + type: string + description: + Een afkorting waarmee wordt aangegeven voor welk domein in + een CATALOGUS ZAAKTYPEn zijn uitgewerkt. + title: domein + maxLength: 5 + rsin: + type: string + description: + Het door een kamer toegekend uniek nummer voor de INGESCHREVEN + NIET-NATUURLIJK PERSOON die de eigenaar is van een CATALOGUS. + title: rsin + maxLength: 9 + contactpersoonBeheerNaam: + type: string + title: Naam contactpersoon + description: + De naam van de contactpersoon die verantwoordelijk is voor + het beheer van de CATALOGUS. + maxLength: 40 + contactpersoonBeheerTelefoonnummer: + type: string + title: Telefoonnummer + description: + Het telefoonnummer van de contactpersoon die verantwoordelijk + is voor het beheer van de CATALOGUS. + maxLength: 20 + contactpersoonBeheerEmailadres: + type: string + format: email + title: Emailadres + description: + Het emailadres van de contactpersoon die verantwoordelijk is + voor het beheer van de CATALOGUS. + maxLength: 254 + zaaktypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar ZAAKTYPEn die in deze CATALOGUS worden + ontsloten. + title: Catalogus + uniqueItems: true + besluittypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar BESLUITTYPEn die in deze CATALOGUS worden + ontsloten. + title: catalogus + uniqueItems: true + informatieobjecttypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar INFORMATIEOBJECTTYPEn die in deze CATALOGUS + worden ontsloten. + title: Catalogus + uniqueItems: true + naam: + type: string + nullable: true + description: De benaming die is gegeven aan de zaaktypecatalogus. + title: naam + maxLength: 200 + versie: + type: string + nullable: true + description: Versie-aanduiding van de van toepassing zijnde zaaktypecatalogus. + title: versie + maxLength: 20 + begindatumVersie: + type: string + format: date + nullable: true + description: + Datum waarop de versie van de zaaktypecatalogus van toepassing + is geworden. + title: begindatum versie + required: + - besluittypen + - contactpersoonBeheerNaam + - domein + - informatieobjecttypen + - rsin + - url + - zaaktypen + CatalogusExpanded: + allOf: + - $ref: '#/components/schemas/Catalogus' + - properties: + _expand: + $ref: '#/components/schemas/CatalogusEmbedded' + CatalogusEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + zaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypeExpanded' + besluittypen: + type: array + items: + $ref: '#/components/schemas/BesluitTypeExpanded' + informatieobjecttypen: + type: array + items: + $ref: '#/components/schemas/InformatieObjectTypeExpanded' + CheckListItem: + type: object + properties: + itemnaam: + type: string + description: De betekenisvolle benaming van het checklistitem + title: itemnaam + maxLength: 30 + toelichting: + type: string + nullable: true + description: + Beschrijving van de overwegingen bij het controleren van het + aandachtspunt + title: toelichting + maxLength: 1000 + vraagstelling: + type: string + description: + Een betekenisvolle vraag waaruit blijkt waarop het aandachtspunt + gecontroleerd moet worden. + title: vraagstelling + maxLength: 255 + verplicht: + type: boolean + description: + Het al dan niet verplicht zijn van controle van het aandachtspunt + voorafgaand aan het bereiken van de status van het gerelateerde STATUSTYPE. + title: verplicht + required: + - itemnaam + - vraagstelling + Eigenschap: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + naam: + type: string + description: De naam van de EIGENSCHAP + title: eigenschapnaam + maxLength: 20 + catalogus: + type: string + format: uri + readOnly: true + title: catalogus + definitie: + type: string + description: De beschrijving van de betekenis van deze EIGENSCHAP + title: definitie + maxLength: 255 + specificatie: + allOf: + - $ref: '#/components/schemas/EigenschapSpecificatie' + title: specificatie van eigenschap + toelichting: + type: string + description: + Een toelichting op deze EIGENSCHAP en het belang hiervan voor + zaken van dit ZAAKTYPE. + title: toelichting + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze + EIGENSCHAP van belang is. + title: Zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + statustype: + type: string + format: uri + nullable: true + title: Status type + description: + Status type moet (onder andere) deze EIGENSCHAP hebben, voordat + een STATUS van het STATUSTYPE kan worden gezet. + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de EIGENSCHAP is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de EIGENSCHAP is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + required: + - catalogus + - definitie + - naam + - specificatie + - url + - zaaktype + - zaaktypeIdentificatie + EigenschapExpanded: + allOf: + - $ref: '#/components/schemas/Eigenschap' + - properties: + _expand: + $ref: '#/components/schemas/EigenschapEmbedded' + EigenschapEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + statustype: + oneOf: + - $ref: '#/components/schemas/StatusTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + EigenschapSpecificatie: + type: object + properties: + groep: + type: string + description: + Benaming van het object of groepattribuut waarvan de EIGENSCHAP + een inhoudelijk gegeven specificeert. + title: groep + maxLength: 32 + formaat: + allOf: + - $ref: '#/components/schemas/FormaatEnum' + description: + 'Het soort tekens waarmee waarden van de EIGENSCHAP kunnen + worden vastgelegd. + + + Uitleg bij mogelijke waarden: + + + * `tekst` - Tekst + + * `getal` - Getal + + * `datum` - Datum + + * `datum_tijd` - Datum/tijd' + title: formaat + lengte: + type: string + description: + Het aantal karakters (lengte) waarmee waarden van de EIGENSCHAP + worden vastgelegd. + title: lengte + maxLength: 14 + kardinaliteit: + type: string + description: + Het aantal mogelijke voorkomens van waarden van deze EIGENSCHAP + bij een zaak van het ZAAKTYPE. + title: kardinaliteit + maxLength: 3 + waardenverzameling: + type: array + items: + type: string + maxLength: 100 + description: Waarden die deze EIGENSCHAP kan hebben. + title: waardenverzameling + required: + - formaat + - kardinaliteit + - lengte + FieldValidationError: + type: object + description: Formaat van validatiefouten. + properties: + name: + type: string + description: Naam van het veld met ongeldige gegevens + title: name + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + reason: + type: string + description: Uitleg wat er precies fout is met de gegevens + title: reason + required: + - code + - name + - reason + FormaatEnum: + enum: + - tekst + - getal + - datum + - datum_tijd + type: string + Fout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: + URI met referentie naar dit specifiek voorkomen van de fout. + Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + required: + - code + - detail + - instance + - status + - title + IndicatieInternOfExternEnum: + enum: + - intern + - extern + type: string + InformatieObjectType: + type: object + description: Serializer based on ``IOT-basis`` specified in XSD ``ztc0310_ent_basis.xsd``. + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + catalogus: + type: string + format: uri + description: + URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE + behoort. + title: Catalogus + omschrijving: + type: string + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: omschrijving + maxLength: 80 + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + description: + 'Aanduiding van de mate waarin informatieobjecten van dit INFORMATIEOBJECTTYPE + voor de openbaarheid bestemd zijn. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim' + title: vertrouwelijkheidaanduiding + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + concept: + type: boolean + readOnly: true + description: + Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + zaaktypen: + type: string + readOnly: true + title: zaaktypen + besluittypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten + waarin besluiten van dit BESLUITTYPE worden vastgelegd. + title: informatieobjecttypen + uniqueItems: true + informatieobjectcategorie: + type: string + title: Categorie + description: Typering van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + maxLength: 80 + trefwoord: + type: array + items: + type: string + maxLength: 30 + description: + Trefwoord(en) waarmee informatieobjecten van het INFORMATIEOBJECTTYPE + kunnen worden gekarakteriseerd. (Gebruik een komma om waarden van elkaar + te onderscheiden.) + title: trefwoord + omschrijvingGeneriek: + allOf: + - $ref: '#/components/schemas/InformatieObjectTypeOmschrijvingGeneriek' + title: omschrijving generiek + required: + - beginGeldigheid + - besluittypen + - catalogus + - concept + - informatieobjectcategorie + - omschrijving + - url + - vertrouwelijkheidaanduiding + - zaaktypen + InformatieObjectTypeExpanded: + allOf: + - $ref: '#/components/schemas/InformatieObjectType' + - properties: + _expand: + $ref: '#/components/schemas/InformatieObjectTypeEmbedded' + InformatieObjectTypeEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypeExpanded' + besluittypen: + type: array + items: + $ref: '#/components/schemas/BesluitTypeExpanded' + InformatieObjectTypeOmschrijvingGeneriek: + type: object + properties: + informatieobjecttypeOmschrijvingGeneriek: + type: string + description: Algemeen gehanteerde omschrijving van het type informatieobject. + title: informatieobjecttype omschrijving generiek + maxLength: 80 + definitieInformatieobjecttypeOmschrijvingGeneriek: + type: string + title: Definitie + description: Nauwkeurige beschrijving van het generieke type informatieobject + maxLength: 255 + herkomstInformatieobjecttypeOmschrijvingGeneriek: + type: string + title: Herkomst + description: + De naam van de waardenverzameling, of van de beherende organisatie + daarvan, waaruit de waarde is overgenomen. + maxLength: 12 + hierarchieInformatieobjecttypeOmschrijvingGeneriek: + type: string + title: Hierarchie + description: De plaats in de rangorde van het informatieobjecttype. + maxLength: 80 + opmerkingInformatieobjecttypeOmschrijvingGeneriek: + type: string + nullable: true + title: Opmerking + description: Zinvolle toelichting bij het informatieobjecttype + maxLength: 255 + required: + - definitieInformatieobjecttypeOmschrijvingGeneriek + - herkomstInformatieobjecttypeOmschrijvingGeneriek + - hierarchieInformatieobjecttypeOmschrijvingGeneriek + - informatieobjecttypeOmschrijvingGeneriek + ObjecttypeEnum: + enum: + - adres + - besluit + - buurt + - enkelvoudig_document + - gemeente + - gemeentelijke_openbare_ruimte + - huishouden + - inrichtingselement + - kadastrale_onroerende_zaak + - kunstwerkdeel + - maatschappelijke_activiteit + - medewerker + - natuurlijk_persoon + - niet_natuurlijk_persoon + - openbare_ruimte + - organisatorische_eenheid + - pand + - spoorbaandeel + - status + - terreindeel + - terrein_gebouwd_object + - vestiging + - waterdeel + - wegdeel + - wijk + - woonplaats + - woz_deelobject + - woz_object + - woz_waarde + - zakelijk_recht + - overige + type: string + OmschrijvingGeneriekEnum: + enum: + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator + type: string + PaginatedBesluitTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/BesluitType' + PaginatedCatalogusList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Catalogus' + PaginatedEigenschapList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Eigenschap' + PaginatedResultaatTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ResultaatType' + PaginatedInformatieObjectTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/InformatieObjectType' + PaginatedRolTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/RolType' + PaginatedStatusTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/StatusType' + PaginatedZaakObjectTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ZaakObjectType' + PaginatedZaakTypeInformatieObjectTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + PaginatedZaakTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ZaakType' + PatchedEigenschap: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + naam: + type: string + description: De naam van de EIGENSCHAP + title: eigenschapnaam + maxLength: 20 + catalogus: + type: string + format: uri + readOnly: true + title: catalogus + definitie: + type: string + description: De beschrijving van de betekenis van deze EIGENSCHAP + title: definitie + maxLength: 255 + specificatie: + allOf: + - $ref: '#/components/schemas/EigenschapSpecificatie' + title: specificatie van eigenschap + toelichting: + type: string + description: + Een toelichting op deze EIGENSCHAP en het belang hiervan voor + zaken van dit ZAAKTYPE. + title: toelichting + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze + EIGENSCHAP van belang is. + title: Zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + statustype: + type: string + format: uri + nullable: true + title: Status type + description: + Status type moet (onder andere) deze EIGENSCHAP hebben, voordat + een STATUS van het STATUSTYPE kan worden gezet. + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de EIGENSCHAP is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de EIGENSCHAP is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + PatchedResultaatType: + type: object + description: 'Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + title: is van + description: + URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten + van dit RESULTAATTYPE bereikt kunnen worden. + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: is relevant voor + omschrijving: + type: string + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: omschrijving + maxLength: 30 + resultaattypeomschrijving: + type: string + format: uri + description: + Algemeen gehanteerde omschrijving van de aard van resultaten + van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst + van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving + generiek' + title: resultaattypeomschrijving + maxLength: 1000 + omschrijvingGeneriek: + type: string + readOnly: true + description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) + title: omschrijving generiek + selectielijstklasse: + type: string + format: uri + description: + URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE + relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT + in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. + title: selectielijstklasse + maxLength: 1000 + toelichting: + type: string + description: + Een toelichting op dit RESULTAATTYPE en het belang hiervan + voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. + title: toelichting + archiefnominatie: + description: + 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit + RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden + vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de + selectielijst. + + + Uitleg bij mogelijke waarden: + + + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum + overgedragen worden naar een archiefbewaarplaats. + + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' + title: archiefnominatie + oneOf: + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' + archiefactietermijn: + type: string + nullable: true + description: + De termijn, na het vervallen van het bedrjfsvoeringsbelang, + waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) + van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht + (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers + betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend + te bewaren zaakdossiers betreft het de termijn vanaf afronding van de + zaak tot overbrenging (de procestermijn is dan nihil). + title: archiefactietermijn + format: duration + brondatumArchiefprocedure: + allOf: + - $ref: '#/components/schemas/BrondatumArchiefprocedure' + nullable: true + description: + Specificatie voor het bepalen van de brondatum voor de start + van de Archiefactietermijn (=brondatum) van het zaakdossier. + title: brondatumArchiefprocedure + procesobjectaard: + type: string + nullable: true + description: + Omschrijving van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking + heeft. + title: procesobjectaard + maxLength: 200 + catalogus: + type: string + format: uri + nullable: true + description: + URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE + behoort. + title: catalogus + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + indicatieSpecifiek: + type: boolean + nullable: true + description: + Aanduiding of het, vanuit archiveringsoptiek, een resultaattype + betreft dat specifiek is voor een bepaalde procesobjectaard. + title: indicatie specifiek + procestermijn: + type: string + nullable: true + description: + De periode dat het zaakdossier na afronding van de zaak actief + gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening + van de organisatie. + title: procestermijn + format: duration + besluittypen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + title: is resultaat van + uniqueItems: true + besluittypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: is resultaat van + uniqueItems: true + informatieobjecttypen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + description: + De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn + in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van + dit RESULTAATTYPE kan worden gezet. + title: informatieobjecttypen + uniqueItems: true + informatieobjecttypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true + PatchedRolType: + type: object + description: Adds nested create feature + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken + kunnen zijn. + title: Zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + omschrijving: + type: string + description: Omschrijving van de aard van de ROL. + title: omschrijving + maxLength: 100 + omschrijvingGeneriek: + allOf: + - $ref: '#/components/schemas/OmschrijvingGeneriekEnum' + description: + "Algemeen gehanteerde omschrijving van de aard van de ROL.\n\ + \nUitleg bij mogelijke waarden:\n\n* `adviseur` - (Adviseur) Kennis in\ + \ dienst stellen van de behandeling van (een deel van) een zaak.\n* `behandelaar`\ + \ - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van)\ + \ een zaak.\n* `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief\ + \ belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst\ + \ van een zaak.\n* `beslisser` - (Beslisser) Nemen van besluiten die voor\ + \ de uitkomst van een zaak noodzakelijk zijn.\n* `initiator` - (Initiator)\ + \ Aanleiding geven tot de start van een zaak ..\n* `klantcontacter` -\ + \ (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers\ + \ en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6rdinator) Er voor\ + \ zorg dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt\ + \ conform de daarover gemaakte afspraken.\n* `mede_initiator` - Mede-initiator" + title: omschrijving generiek + catalogus: + type: string + format: uri + nullable: true + description: URL-referentie naar de CATALOGUS waartoe dit ROLTYPE behoort. + title: catalogus + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + PatchedStatusType: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + omschrijving: + type: string + description: + Een korte, voor de initiator van de zaak relevante, omschrijving + van de aard van de STATUS van zaken van een ZAAKTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: + Algemeen gehanteerde omschrijving van de aard van STATUSsen + van het STATUSTYPE + title: omschrijving generiek + maxLength: 80 + statustekst: + type: string + description: + De tekst die wordt gebruikt om de Initiator te informeren over + het bereiken van een STATUS van dit STATUSTYPE bij het desbetreffende + ZAAKTYPE. + title: statustekst + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen + van dit STATUSTYPE bereikt kunnen worden. + title: Zaaktype + catalogus: + type: string + format: uri + readOnly: true + title: catalogus + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + volgnummer: + type: integer + maximum: 9999 + minimum: 1 + description: + Een volgnummer voor statussen van het STATUSTYPE binnen een + zaak. + title: statustypevolgnummer + isEindstatus: + type: boolean + readOnly: true + description: + Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven + is afgeleid uit alle STATUSTYPEn van dit ZAAKTYPE met het hoogste volgnummer. + title: isEindstatus + informeren: + type: boolean + description: + "Aanduiding die aangeeft of na het zetten van een STATUS van\ + \ dit STATUSTYPE de Initiator moet worden ge\xEFnformeerd over de statusovergang." + title: informeren + doorlooptijd: + type: string + nullable: true + description: + De door de zaakbehandelende organisatie(s) gestelde norm voor + de doorlooptijd voor het bereiken van STATUSsen van dit STATUSTYPE bij + het desbetreffende ZAAKTYPE. + title: doorlooptijd status + format: duration + toelichting: + type: string + nullable: true + description: Een eventuele toelichting op dit STATUSTYPE. + title: toelichting + maxLength: 1000 + checklistitemStatustype: + type: array + items: + $ref: '#/components/schemas/CheckListItem' + title: checklistitem + eigenschappen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + description: + de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen, + voordat een STATUS van dit STATUSTYPE kan worden gezet. + title: eigenschappen + uniqueItems: true + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + PatchedZaakObjectType: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + anderObjecttype: + type: boolean + description: + Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een + ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. + title: Ander objecttype + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + objecttype: + type: string + format: uri + description: + URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE + behoort. + title: Objecttype + maxLength: 200 + relatieOmschrijving: + type: string + description: + Omschrijving van de betrekking van het Objecttype op zaken + van het gerelateerde ZAAKTYPE. + title: Relatie omschrijving + maxLength: 80 + zaaktype: + type: string + format: uri + description: + URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE + behoort. + title: Zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + resultaattypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar de RESULTAATTYPEN. + title: Zaakobjecttypen + uniqueItems: true + statustypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar de STATUSTYPEN. + title: Zaakobjecttypen + uniqueItems: true + catalogus: + type: string + format: uri + description: + URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE + behoort. + title: Catalogus + PatchedZaakTypeInformatieObjectType: + type: object + description: 'Represent a ZaakTypeInformatieObjectType. + + + Relatie met informatieobjecttype dat relevant is voor zaaktype.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + description: URL-referentie naar het ZAAKTYPE. + title: zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: zaaktype + catalogus: + type: string + format: uri + readOnly: true + title: catalogus + informatieobjecttype: + type: string + title: informatieobjecttype + maxLength: 100 + volgnummer: + type: integer + maximum: 999 + minimum: 1 + description: + Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het + ZAAKTYPE. + title: volgnummer + richting: + allOf: + - $ref: '#/components/schemas/RichtingEnum' + description: + 'Aanduiding van de richting van informatieobjecten van het + gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. + + + Uitleg bij mogelijke waarden: + + + * `inkomend` - Inkomend + + * `intern` - Intern + + * `uitgaand` - Uitgaand' + title: richting + statustype: + type: string + format: uri + nullable: true + title: Status type + description: + URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn + verplicht aanwezig moeten zijn. + ReferentieProces: + type: object + description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. + properties: + naam: + type: string + title: Referentieprocesnaam + description: De naam van het Referentieproces. + maxLength: 80 + link: + type: string + format: uri + title: Referentieproceslink + description: De URL naar de beschrijving van het Referentieproces + maxLength: 200 + required: + - naam + ResultaatType: + type: object + description: 'Set gegevensgroepdata from validated nested data. + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + title: is van + description: + URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten + van dit RESULTAATTYPE bereikt kunnen worden. + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: is relevant voor + omschrijving: + type: string + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: omschrijving + maxLength: 30 + resultaattypeomschrijving: + type: string + format: uri + description: + Algemeen gehanteerde omschrijving van de aard van resultaten + van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst + van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving + generiek' + title: resultaattypeomschrijving + maxLength: 1000 + omschrijvingGeneriek: + type: string + readOnly: true + description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) + title: omschrijving generiek + selectielijstklasse: + type: string + format: uri + description: + URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE + relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT + in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. + title: selectielijstklasse + maxLength: 1000 + toelichting: + type: string + description: + Een toelichting op dit RESULTAATTYPE en het belang hiervan + voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. + title: toelichting + archiefnominatie: + description: + 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit + RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden + vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de + selectielijst. + + + Uitleg bij mogelijke waarden: + + + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum + overgedragen worden naar een archiefbewaarplaats. + + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' + title: archiefnominatie + oneOf: + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' + archiefactietermijn: + type: string + nullable: true + description: + De termijn, na het vervallen van het bedrjfsvoeringsbelang, + waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) + van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht + (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers + betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend + te bewaren zaakdossiers betreft het de termijn vanaf afronding van de + zaak tot overbrenging (de procestermijn is dan nihil). + title: archiefactietermijn + format: duration + brondatumArchiefprocedure: + allOf: + - $ref: '#/components/schemas/BrondatumArchiefprocedure' + nullable: true + description: + Specificatie voor het bepalen van de brondatum voor de start + van de Archiefactietermijn (=brondatum) van het zaakdossier. + title: brondatumArchiefprocedure + procesobjectaard: + type: string + nullable: true + description: + Omschrijving van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking + heeft. + title: procesobjectaard + maxLength: 200 + catalogus: + type: string + format: uri + nullable: true + description: + URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE + behoort. + title: catalogus + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + indicatieSpecifiek: + type: boolean + nullable: true + description: + Aanduiding of het, vanuit archiveringsoptiek, een resultaattype + betreft dat specifiek is voor een bepaalde procesobjectaard. + title: indicatie specifiek + procestermijn: + type: string + nullable: true + description: + De periode dat het zaakdossier na afronding van de zaak actief + gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening + van de organisatie. + title: procestermijn + format: duration + besluittypen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + title: is resultaat van + uniqueItems: true + besluittypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: is resultaat van + uniqueItems: true + informatieobjecttypen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + description: + De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn + in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van + dit RESULTAATTYPE kan worden gezet. + title: informatieobjecttypen + uniqueItems: true + informatieobjecttypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true + required: + - besluittypeOmschrijving + - informatieobjecttypeOmschrijving + - omschrijving + - omschrijvingGeneriek + - resultaattypeomschrijving + - selectielijstklasse + - url + - zaaktype + - zaaktypeIdentificatie + ResultaatTypeExpanded: + allOf: + - $ref: '#/components/schemas/ResultaatType' + - properties: + _expand: + $ref: '#/components/schemas/ResultaatTypeEmbedded' + ResultaatTypeEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + besluittypen: + type: array + items: + $ref: '#/components/schemas/BesluitTypeExpanded' + informatieobjecttypen: + type: array + items: + $ref: '#/components/schemas/InformatieObjectTypeExpanded' + ResultaatTypeCreate: + type: object + description: 'Set gegevensgroepdata from validated nested data. + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + title: is van + description: + URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten + van dit RESULTAATTYPE bereikt kunnen worden. + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: is relevant voor + omschrijving: + type: string + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: omschrijving + maxLength: 30 + resultaattypeomschrijving: + type: string + format: uri + description: + Algemeen gehanteerde omschrijving van de aard van resultaten + van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst + van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving + generiek' + title: resultaattypeomschrijving + maxLength: 1000 + omschrijvingGeneriek: + type: string + readOnly: true + description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) + title: omschrijving generiek + selectielijstklasse: + type: string + format: uri + description: + URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE + relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT + in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. + title: selectielijstklasse + maxLength: 1000 + toelichting: + type: string + description: + Een toelichting op dit RESULTAATTYPE en het belang hiervan + voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. + title: toelichting + archiefnominatie: + description: + 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit + RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden + vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de + selectielijst. + + + Uitleg bij mogelijke waarden: + + + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum + overgedragen worden naar een archiefbewaarplaats. + + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' + title: archiefnominatie + oneOf: + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' + archiefactietermijn: + type: string + nullable: true + description: + De termijn, na het vervallen van het bedrjfsvoeringsbelang, + waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) + van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht + (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers + betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend + te bewaren zaakdossiers betreft het de termijn vanaf afronding van de + zaak tot overbrenging (de procestermijn is dan nihil). + title: archiefactietermijn + format: duration + brondatumArchiefprocedure: + allOf: + - $ref: '#/components/schemas/BrondatumArchiefprocedure' + nullable: true + description: + Specificatie voor het bepalen van de brondatum voor de start + van de Archiefactietermijn (=brondatum) van het zaakdossier. + title: brondatumArchiefprocedure + procesobjectaard: + type: string + nullable: true + description: + Omschrijving van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking + heeft. + title: procesobjectaard + maxLength: 200 + catalogus: + type: string + format: uri + nullable: true + description: + URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE + behoort. + title: catalogus + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + indicatieSpecifiek: + type: boolean + nullable: true + description: + Aanduiding of het, vanuit archiveringsoptiek, een resultaattype + betreft dat specifiek is voor een bepaalde procesobjectaard. + title: indicatie specifiek + procestermijn: + type: string + nullable: true + description: + De periode dat het zaakdossier na afronding van de zaak actief + gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening + van de organisatie. + title: procestermijn + format: duration + besluittypen: + type: array + items: + type: string + title: '' + title: besluittypen + besluittypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: is resultaat van + uniqueItems: true + informatieobjecttypen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + description: + De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn + in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van + dit RESULTAATTYPE kan worden gezet. + title: informatieobjecttypen + uniqueItems: true + informatieobjecttypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true + required: + - besluittypeOmschrijving + - besluittypen + - informatieobjecttypeOmschrijving + - omschrijving + - omschrijvingGeneriek + - resultaattypeomschrijving + - selectielijstklasse + - url + - zaaktype + - zaaktypeIdentificatie + ResultaatTypeUpdate: + type: object + description: 'Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + title: is van + description: + URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten + van dit RESULTAATTYPE bereikt kunnen worden. + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: is relevant voor + omschrijving: + type: string + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: omschrijving + maxLength: 30 + resultaattypeomschrijving: + type: string + format: uri + description: + Algemeen gehanteerde omschrijving van de aard van resultaten + van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst + van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving + generiek' + title: resultaattypeomschrijving + maxLength: 1000 + omschrijvingGeneriek: + type: string + readOnly: true + description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) + title: omschrijving generiek + selectielijstklasse: + type: string + format: uri + description: + URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE + relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT + in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. + title: selectielijstklasse + maxLength: 1000 + toelichting: + type: string + description: + Een toelichting op dit RESULTAATTYPE en het belang hiervan + voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. + title: toelichting + archiefnominatie: + description: + 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit + RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden + vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de + selectielijst. + + + Uitleg bij mogelijke waarden: + + + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum + overgedragen worden naar een archiefbewaarplaats. + + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' + title: archiefnominatie + oneOf: + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' + archiefactietermijn: + type: string + nullable: true + description: + De termijn, na het vervallen van het bedrjfsvoeringsbelang, + waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) + van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht + (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers + betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend + te bewaren zaakdossiers betreft het de termijn vanaf afronding van de + zaak tot overbrenging (de procestermijn is dan nihil). + title: archiefactietermijn + format: duration + brondatumArchiefprocedure: + allOf: + - $ref: '#/components/schemas/BrondatumArchiefprocedure' + nullable: true + description: + Specificatie voor het bepalen van de brondatum voor de start + van de Archiefactietermijn (=brondatum) van het zaakdossier. + title: brondatumArchiefprocedure + procesobjectaard: + type: string + nullable: true + description: + Omschrijving van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking + heeft. + title: procesobjectaard + maxLength: 200 + catalogus: + type: string + format: uri + nullable: true + description: + URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE + behoort. + title: catalogus + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + indicatieSpecifiek: + type: boolean + nullable: true + description: + Aanduiding of het, vanuit archiveringsoptiek, een resultaattype + betreft dat specifiek is voor een bepaalde procesobjectaard. + title: indicatie specifiek + procestermijn: + type: string + nullable: true + description: + De periode dat het zaakdossier na afronding van de zaak actief + gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening + van de organisatie. + title: procestermijn + format: duration + besluittypen: + type: array + items: + type: string + title: '' + title: besluittypen + besluittypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: is resultaat van + uniqueItems: true + informatieobjecttypen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + description: + De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn + in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van + dit RESULTAATTYPE kan worden gezet. + title: informatieobjecttypen + uniqueItems: true + informatieobjecttypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true + required: + - besluittypeOmschrijving + - besluittypen + - informatieobjecttypeOmschrijving + - omschrijving + - omschrijvingGeneriek + - resultaattypeomschrijving + - selectielijstklasse + - url + - zaaktype + - zaaktypeIdentificatie + RichtingEnum: + enum: + - inkomend + - intern + - uitgaand + type: string + RolType: + type: object + description: Adds nested create feature + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken + kunnen zijn. + title: Zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + omschrijving: + type: string + description: Omschrijving van de aard van de ROL. + title: omschrijving + maxLength: 100 + omschrijvingGeneriek: + allOf: + - $ref: '#/components/schemas/OmschrijvingGeneriekEnum' + description: + "Algemeen gehanteerde omschrijving van de aard van de ROL.\n\ + \nUitleg bij mogelijke waarden:\n\n* `adviseur` - (Adviseur) Kennis in\ + \ dienst stellen van de behandeling van (een deel van) een zaak.\n* `behandelaar`\ + \ - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van)\ + \ een zaak.\n* `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief\ + \ belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst\ + \ van een zaak.\n* `beslisser` - (Beslisser) Nemen van besluiten die voor\ + \ de uitkomst van een zaak noodzakelijk zijn.\n* `initiator` - (Initiator)\ + \ Aanleiding geven tot de start van een zaak ..\n* `klantcontacter` -\ + \ (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers\ + \ en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6rdinator) Er voor\ + \ zorg dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt\ + \ conform de daarover gemaakte afspraken.\n* `mede_initiator` - Mede-initiator" + title: omschrijving generiek + catalogus: + type: string + format: uri + nullable: true + description: URL-referentie naar de CATALOGUS waartoe dit ROLTYPE behoort. + title: catalogus + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + required: + - omschrijving + - omschrijvingGeneriek + - url + - zaaktype + - zaaktypeIdentificatie + RolTypeExpanded: + allOf: + - $ref: '#/components/schemas/RolType' + - properties: + _expand: + $ref: '#/components/schemas/RolTypeEmbedded' + RolTypeEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + StatusType: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + omschrijving: + type: string + description: + Een korte, voor de initiator van de zaak relevante, omschrijving + van de aard van de STATUS van zaken van een ZAAKTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: + Algemeen gehanteerde omschrijving van de aard van STATUSsen + van het STATUSTYPE + title: omschrijving generiek + maxLength: 80 + statustekst: + type: string + description: + De tekst die wordt gebruikt om de Initiator te informeren over + het bereiken van een STATUS van dit STATUSTYPE bij het desbetreffende + ZAAKTYPE. + title: statustekst + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen + van dit STATUSTYPE bereikt kunnen worden. + title: Zaaktype + catalogus: + type: string + format: uri + readOnly: true + title: catalogus + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + volgnummer: + type: integer + maximum: 9999 + minimum: 1 + description: + Een volgnummer voor statussen van het STATUSTYPE binnen een + zaak. + title: statustypevolgnummer + isEindstatus: + type: boolean + readOnly: true + description: + Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven + is afgeleid uit alle STATUSTYPEn van dit ZAAKTYPE met het hoogste volgnummer. + title: isEindstatus + informeren: + type: boolean + description: + "Aanduiding die aangeeft of na het zetten van een STATUS van\ + \ dit STATUSTYPE de Initiator moet worden ge\xEFnformeerd over de statusovergang." + title: informeren + doorlooptijd: + type: string + nullable: true + description: + De door de zaakbehandelende organisatie(s) gestelde norm voor + de doorlooptijd voor het bereiken van STATUSsen van dit STATUSTYPE bij + het desbetreffende ZAAKTYPE. + title: doorlooptijd status + format: duration + toelichting: + type: string + nullable: true + description: Een eventuele toelichting op dit STATUSTYPE. + title: toelichting + maxLength: 1000 + checklistitemStatustype: + type: array + items: + $ref: '#/components/schemas/CheckListItem' + title: checklistitem + eigenschappen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + description: + de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen, + voordat een STATUS van dit STATUSTYPE kan worden gezet. + title: eigenschappen + uniqueItems: true + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + required: + - catalogus + - isEindstatus + - omschrijving + - url + - volgnummer + - zaaktype + - zaaktypeIdentificatie + StatusTypeExpanded: + allOf: + - $ref: '#/components/schemas/StatusType' + - properties: + _expand: + $ref: '#/components/schemas/StatusTypeEmbedded' + StatusTypeEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + eigenschappen: + type: array + items: + $ref: '#/components/schemas/EigenschapExpanded' + ValidatieFout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: + URI met referentie naar dit specifiek voorkomen van de fout. + Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + invalidParams: + type: array + items: + $ref: '#/components/schemas/FieldValidationError' + title: invalidParams + required: + - code + - detail + - instance + - invalidParams + - status + - title + VertrouwelijkheidaanduidingEnum: + enum: + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim + type: string + ZaakObjectType: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + anderObjecttype: + type: boolean + description: + Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een + ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. + title: Ander objecttype + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + objecttype: + type: string + format: uri + description: + URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE + behoort. + title: Objecttype + maxLength: 200 + relatieOmschrijving: + type: string + description: + Omschrijving van de betrekking van het Objecttype op zaken + van het gerelateerde ZAAKTYPE. + title: Relatie omschrijving + maxLength: 80 + zaaktype: + type: string + format: uri + description: + URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE + behoort. + title: Zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + resultaattypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar de RESULTAATTYPEN. + title: Zaakobjecttypen + uniqueItems: true + statustypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar de STATUSTYPEN. + title: Zaakobjecttypen + uniqueItems: true + catalogus: + type: string + format: uri + description: + URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE + behoort. + title: Catalogus + required: + - anderObjecttype + - beginGeldigheid + - catalogus + - objecttype + - relatieOmschrijving + - resultaattypen + - statustypen + - url + - zaaktype + - zaaktypeIdentificatie + ZaakObjectTypeExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectType' + - properties: + _expand: + $ref: '#/components/schemas/ZaakObjectTypeEmbedded' + ZaakObjectTypeEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + resultaattypen: + type: array + items: + $ref: '#/components/schemas/ResultaatTypeExpanded' + statustypen: + type: array + items: + $ref: '#/components/schemas/StatusTypeExpanded' + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + ZaakType: + type: object + description: 'Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: identificatie + maxLength: 50 + omschrijving: + type: string + description: Omschrijving van de aard van ZAAKen van het ZAAKTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: + Algemeen gehanteerde omschrijving van de aard van ZAAKen van + het ZAAKTYPE + title: omschrijving generiek + maxLength: 80 + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + description: + 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van + dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het + aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde + gezet. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim' + title: vertrouwelijkheidaanduiding + doel: + type: string + description: + Een omschrijving van hetgeen beoogd is te bereiken met een + zaak van dit zaaktype. + title: doel + aanleiding: + type: string + description: + Een omschrijving van de gebeurtenis die leidt tot het starten + van een ZAAK van dit ZAAKTYPE. + title: aanleiding + toelichting: + type: string + description: + Een eventuele toelichting op dit zaaktype, zoals een beschrijving + van het procesverloop op de hoofdlijnen. + title: toelichting + indicatieInternOfExtern: + allOf: + - $ref: '#/components/schemas/IndicatieInternOfExternEnum' + description: + "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\ + \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\ + \ beide sprake kan zijn, dan prevaleert de externe initiatie." + title: indicatie intern of extern + handelingInitiator: + type: string + description: + Werkwoord dat hoort bij de handeling die de initiator verricht + bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook + het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator + title: handeling initiator + maxLength: 20 + onderwerp: + type: string + description: + "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen + nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus + (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'. + Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp" + title: onderwerp + maxLength: 80 + handelingBehandelaar: + type: string + description: + Werkwoord dat hoort bij de handeling die de behandelaar verricht + bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', + 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar + title: handeling behandelaar + maxLength: 20 + doorlooptijd: + type: string + description: + De periode waarbinnen volgens wet- en regelgeving een ZAAK + van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. + title: doorlooptijd behandeling + format: duration + servicenorm: + type: string + nullable: true + description: + De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE + afgerond wordt conform de geldende servicenormen van de zaakbehandelende + organisatie(s). + title: servicenorm behandeling + format: duration + opschortingEnAanhoudingMogelijk: + type: boolean + title: Opschorting/aanhouding mogelijk + description: + Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE + kunnen worden opgeschort en/of aangehouden. + verlengingMogelijk: + type: boolean + description: + Aanduiding die aangeeft of de Doorlooptijd behandeling van + ZAAKen van dit ZAAKTYPE kan worden verlengd. + title: verlenging mogelijk + verlengingstermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling + van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde + bevatten als verlenging mogelijk is. + title: verlengingstermijn + format: duration + trefwoorden: + type: array + items: + type: string + title: Trefwoord + maxLength: 30 + description: + Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden + gekarakteriseerd. + title: trefwoorden + publicatieIndicatie: + type: boolean + description: + Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd + moet worden. + title: publicatie indicatie + publicatietekst: + type: string + description: De generieke tekst van de publicatie van ZAAKen van dit ZAAKTYPE. + title: publicatietekst + verantwoordingsrelatie: + type: array + items: + type: string + maxLength: 40 + description: + "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ + \ en/of financi\xEBle verantwoording." + title: verantwoordingsrelatie + productenOfDiensten: + type: array + items: + type: string + format: uri + title: URL naar product/dienst + maxLength: 1000 + description: + Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt + voortgebracht. + title: producten of diensten + selectielijstProcestype: + type: string + format: uri + description: + URL-referentie naar een vanuit archiveringsoptiek onderkende + groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst + API). + title: selectielijst procestype + maxLength: 200 + referentieproces: + allOf: + - $ref: '#/components/schemas/ReferentieProces' + description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. + title: referentieproces + verantwoordelijke: + type: string + description: + De (soort) organisatorische eenheid of (functie van) medewerker + die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. + title: verantwoordelijke + maxLength: 50 + zaakobjecttypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: Zaaktype + uniqueItems: true + broncatalogus: + allOf: + - $ref: '#/components/schemas/BronCatalogus' + description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. + title: broncatalogus + bronzaaktype: + allOf: + - $ref: '#/components/schemas/BronZaaktype' + description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. + title: bronzaaktype + catalogus: + type: string + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. + title: Catalogus + statustypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + title: Zaaktype + uniqueItems: true + resultaattypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + title: is relevant voor + uniqueItems: true + eigenschappen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn + in ZAKEN van dit ZAAKTYPE. + title: Zaaktype + uniqueItems: true + informatieobjecttypen: + type: string + readOnly: true + title: informatieobjecttypen + roltypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit + ZAAKTYPE. + title: Zaaktype + uniqueItems: true + besluittypen: + type: array + items: + type: string + format: uri + title: heeft relevante besluittypen + title: heeft relevante besluittypen + description: + URL-referenties naar de BESLUITTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + uniqueItems: true + deelzaaktypen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + description: + De ZAAKTYPE(n) waaronder ZAAKen als deelzaak kunnen voorkomen + bij ZAAKen van dit ZAAKTYPE. + title: deelzaaktypen + uniqueItems: true + gerelateerdeZaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypenRelatie' + description: + De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit + ZAAKTYPE. + title: zaaktype van + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + versiedatum: + type: string + format: date + description: + De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE + geldig zijn geworden + title: versiedatum + concept: + type: boolean + readOnly: true + description: + Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + required: + - aanleiding + - beginGeldigheid + - besluittypen + - catalogus + - concept + - doel + - doorlooptijd + - eigenschappen + - gerelateerdeZaaktypen + - handelingBehandelaar + - handelingInitiator + - identificatie + - indicatieInternOfExtern + - informatieobjecttypen + - omschrijving + - onderwerp + - opschortingEnAanhoudingMogelijk + - productenOfDiensten + - publicatieIndicatie + - referentieproces + - resultaattypen + - roltypen + - statustypen + - url + - verantwoordelijke + - verlengingMogelijk + - versiedatum + - vertrouwelijkheidaanduiding + - zaakobjecttypen + ZaakTypeExpanded: + allOf: + - $ref: '#/components/schemas/ZaakType' + - properties: + _expand: + $ref: '#/components/schemas/ZaakTypeEmbedded' + ZaakTypeEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + zaakobjecttypen: + type: array + items: + $ref: '#/components/schemas/ZaakObjectTypeExpanded' + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + statustypen: + type: array + items: + $ref: '#/components/schemas/StatusTypeExpanded' + resultaattypen: + type: array + items: + $ref: '#/components/schemas/ResultaatTypeExpanded' + eigenschappen: + type: array + items: + $ref: '#/components/schemas/EigenschapExpanded' + informatieobjecttypen: + type: array + items: + $ref: '#/components/schemas/InformatieObjectTypeExpanded' + roltypen: + type: array + items: + $ref: '#/components/schemas/RolTypeExpanded' + besluittypen: + type: array + items: + $ref: '#/components/schemas/BesluitTypeExpanded' + deelzaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypeExpanded' + gerelateerdeZaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypeExpanded' + ZaakTypeCreate: + type: object + description: 'Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: identificatie + maxLength: 50 + omschrijving: + type: string + description: Omschrijving van de aard van ZAAKen van het ZAAKTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: + Algemeen gehanteerde omschrijving van de aard van ZAAKen van + het ZAAKTYPE + title: omschrijving generiek + maxLength: 80 + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + description: + 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van + dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het + aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde + gezet. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim' + title: vertrouwelijkheidaanduiding + doel: + type: string + description: + Een omschrijving van hetgeen beoogd is te bereiken met een + zaak van dit zaaktype. + title: doel + aanleiding: + type: string + description: + Een omschrijving van de gebeurtenis die leidt tot het starten + van een ZAAK van dit ZAAKTYPE. + title: aanleiding + toelichting: + type: string + description: + Een eventuele toelichting op dit zaaktype, zoals een beschrijving + van het procesverloop op de hoofdlijnen. + title: toelichting + indicatieInternOfExtern: + allOf: + - $ref: '#/components/schemas/IndicatieInternOfExternEnum' + description: + "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\ + \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\ + \ beide sprake kan zijn, dan prevaleert de externe initiatie." + title: indicatie intern of extern + handelingInitiator: + type: string + description: + Werkwoord dat hoort bij de handeling die de initiator verricht + bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook + het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator + title: handeling initiator + maxLength: 20 + onderwerp: + type: string + description: + "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen + nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus + (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'. + Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp" + title: onderwerp + maxLength: 80 + handelingBehandelaar: + type: string + description: + Werkwoord dat hoort bij de handeling die de behandelaar verricht + bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', + 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar + title: handeling behandelaar + maxLength: 20 + doorlooptijd: + type: string + description: + De periode waarbinnen volgens wet- en regelgeving een ZAAK + van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. + title: doorlooptijd behandeling + format: duration + servicenorm: + type: string + nullable: true + description: + De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE + afgerond wordt conform de geldende servicenormen van de zaakbehandelende + organisatie(s). + title: servicenorm behandeling + format: duration + opschortingEnAanhoudingMogelijk: + type: boolean + title: Opschorting/aanhouding mogelijk + description: + Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE + kunnen worden opgeschort en/of aangehouden. + verlengingMogelijk: + type: boolean + description: + Aanduiding die aangeeft of de Doorlooptijd behandeling van + ZAAKen van dit ZAAKTYPE kan worden verlengd. + title: verlenging mogelijk + verlengingstermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling + van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde + bevatten als verlenging mogelijk is. + title: verlengingstermijn + format: duration + trefwoorden: + type: array + items: + type: string + title: Trefwoord + maxLength: 30 + description: + Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden + gekarakteriseerd. + title: trefwoorden + publicatieIndicatie: + type: boolean + description: + Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd + moet worden. + title: publicatie indicatie + publicatietekst: + type: string + description: De generieke tekst van de publicatie van ZAAKen van dit ZAAKTYPE. + title: publicatietekst + verantwoordingsrelatie: + type: array + items: + type: string + maxLength: 40 + description: + "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ + \ en/of financi\xEBle verantwoording." + title: verantwoordingsrelatie + productenOfDiensten: + type: array + items: + type: string + format: uri + title: URL naar product/dienst + maxLength: 1000 + description: + Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt + voortgebracht. + title: producten of diensten + selectielijstProcestype: + type: string + format: uri + description: + URL-referentie naar een vanuit archiveringsoptiek onderkende + groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst + API). + title: selectielijst procestype + maxLength: 200 + referentieproces: + allOf: + - $ref: '#/components/schemas/ReferentieProces' + description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. + title: referentieproces + verantwoordelijke: + type: string + description: + De (soort) organisatorische eenheid of (functie van) medewerker + die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. + title: verantwoordelijke + maxLength: 50 + zaakobjecttypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: Zaaktype + uniqueItems: true + broncatalogus: + allOf: + - $ref: '#/components/schemas/BronCatalogus' + description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. + title: broncatalogus + bronzaaktype: + allOf: + - $ref: '#/components/schemas/BronZaaktype' + description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. + title: bronzaaktype + catalogus: + type: string + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. + title: Catalogus + statustypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + title: Zaaktype + uniqueItems: true + resultaattypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + title: is relevant voor + uniqueItems: true + eigenschappen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn + in ZAKEN van dit ZAAKTYPE. + title: Zaaktype + uniqueItems: true + informatieobjecttypen: + type: string + readOnly: true + title: informatieobjecttypen + roltypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit + ZAAKTYPE. + title: Zaaktype + uniqueItems: true + besluittypen: + type: array + items: + type: string + title: '' + description: + '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen + dit ZAAKTYPE.' + title: zaaktypen + deelzaaktypen: + type: array + items: + type: string + title: '' + description: + De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak + kunnen voorkomen bij ZAAKen van dit ZAAKTYPE. + title: deelzaaktypen + gerelateerdeZaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypenRelatieCreate' + description: + De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit + ZAAKTYPE. + title: zaaktype van + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + versiedatum: + type: string + format: date + description: + De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE + geldig zijn geworden + title: versiedatum + concept: + type: boolean + readOnly: true + description: + Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + required: + - aanleiding + - beginGeldigheid + - besluittypen + - catalogus + - concept + - deelzaaktypen + - doel + - doorlooptijd + - eigenschappen + - gerelateerdeZaaktypen + - handelingBehandelaar + - handelingInitiator + - identificatie + - indicatieInternOfExtern + - informatieobjecttypen + - omschrijving + - onderwerp + - opschortingEnAanhoudingMogelijk + - productenOfDiensten + - publicatieIndicatie + - referentieproces + - resultaattypen + - roltypen + - statustypen + - url + - verantwoordelijke + - verlengingMogelijk + - versiedatum + - vertrouwelijkheidaanduiding + - zaakobjecttypen + ZaakTypeInformatieObjectType: + type: object + description: 'Represent a ZaakTypeInformatieObjectType. + + + Relatie met informatieobjecttype dat relevant is voor zaaktype.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + description: URL-referentie naar het ZAAKTYPE. + title: zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: zaaktype + catalogus: + type: string + format: uri + readOnly: true + title: catalogus + informatieobjecttype: + type: string + title: informatieobjecttype + maxLength: 100 + volgnummer: + type: integer + maximum: 999 + minimum: 1 + description: + Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het + ZAAKTYPE. + title: volgnummer + richting: + allOf: + - $ref: '#/components/schemas/RichtingEnum' + description: + 'Aanduiding van de richting van informatieobjecten van het + gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. + + + Uitleg bij mogelijke waarden: + + + * `inkomend` - Inkomend + + * `intern` - Intern + + * `uitgaand` - Uitgaand' + title: richting + statustype: + type: string + format: uri + nullable: true + title: Status type + description: + URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn + verplicht aanwezig moeten zijn. + required: + - catalogus + - informatieobjecttype + - richting + - url + - volgnummer + - zaaktype + - zaaktypeIdentificatie + ZaakTypeInformatieObjectTypeExpanded: + allOf: + - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + - properties: + _expand: + $ref: '#/components/schemas/ZaakTypeInformatieObjectTypeEmbedded' + ZaakTypeInformatieObjectTypeEmbedded: + type: object + description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. + Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." + properties: + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + informatieobjecttype: + oneOf: + - $ref: '#/components/schemas/InformatieObjectTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + statustype: + oneOf: + - $ref: '#/components/schemas/StatusTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + ZaakTypeUpdate: + type: object + description: 'Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: identificatie + maxLength: 50 + omschrijving: + type: string + description: Omschrijving van de aard van ZAAKen van het ZAAKTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: + Algemeen gehanteerde omschrijving van de aard van ZAAKen van + het ZAAKTYPE + title: omschrijving generiek + maxLength: 80 + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + description: + 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van + dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het + aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde + gezet. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim' + title: vertrouwelijkheidaanduiding + doel: + type: string + description: + Een omschrijving van hetgeen beoogd is te bereiken met een + zaak van dit zaaktype. + title: doel + aanleiding: + type: string + description: + Een omschrijving van de gebeurtenis die leidt tot het starten + van een ZAAK van dit ZAAKTYPE. + title: aanleiding + toelichting: + type: string + description: + Een eventuele toelichting op dit zaaktype, zoals een beschrijving + van het procesverloop op de hoofdlijnen. + title: toelichting + indicatieInternOfExtern: + allOf: + - $ref: '#/components/schemas/IndicatieInternOfExternEnum' + description: + "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\ + \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\ + \ beide sprake kan zijn, dan prevaleert de externe initiatie." + title: indicatie intern of extern + handelingInitiator: + type: string + description: + Werkwoord dat hoort bij de handeling die de initiator verricht + bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook + het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator + title: handeling initiator + maxLength: 20 + onderwerp: + type: string + description: + "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen + nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus + (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'. + Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp" + title: onderwerp + maxLength: 80 + handelingBehandelaar: + type: string + description: + Werkwoord dat hoort bij de handeling die de behandelaar verricht + bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', + 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar + title: handeling behandelaar + maxLength: 20 + doorlooptijd: + type: string + description: + De periode waarbinnen volgens wet- en regelgeving een ZAAK + van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. + title: doorlooptijd behandeling + format: duration + servicenorm: + type: string + nullable: true + description: + De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE + afgerond wordt conform de geldende servicenormen van de zaakbehandelende + organisatie(s). + title: servicenorm behandeling + format: duration + opschortingEnAanhoudingMogelijk: + type: boolean + title: Opschorting/aanhouding mogelijk + description: + Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE + kunnen worden opgeschort en/of aangehouden. + verlengingMogelijk: + type: boolean + description: + Aanduiding die aangeeft of de Doorlooptijd behandeling van + ZAAKen van dit ZAAKTYPE kan worden verlengd. + title: verlenging mogelijk + verlengingstermijn: + type: string + nullable: true + description: + Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling + van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde + bevatten als verlenging mogelijk is. + title: verlengingstermijn + format: duration + trefwoorden: + type: array + items: + type: string + title: Trefwoord + maxLength: 30 + description: + Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden + gekarakteriseerd. + title: trefwoorden + publicatieIndicatie: + type: boolean + description: + Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd + moet worden. + title: publicatie indicatie + publicatietekst: + type: string + description: De generieke tekst van de publicatie van ZAAKen van dit ZAAKTYPE. + title: publicatietekst + verantwoordingsrelatie: + type: array + items: + type: string + maxLength: 40 + description: + "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ + \ en/of financi\xEBle verantwoording." + title: verantwoordingsrelatie + productenOfDiensten: + type: array + items: + type: string + format: uri + title: URL naar product/dienst + maxLength: 1000 + description: + Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt + voortgebracht. + title: producten of diensten + selectielijstProcestype: + type: string + format: uri + description: + URL-referentie naar een vanuit archiveringsoptiek onderkende + groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst + API). + title: selectielijst procestype + maxLength: 200 + referentieproces: + allOf: + - $ref: '#/components/schemas/ReferentieProces' + description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. + title: referentieproces + verantwoordelijke: + type: string + description: + De (soort) organisatorische eenheid of (functie van) medewerker + die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. + title: verantwoordelijke + maxLength: 50 + zaakobjecttypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: Zaaktype + uniqueItems: true + broncatalogus: + allOf: + - $ref: '#/components/schemas/BronCatalogus' + description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. + title: broncatalogus + bronzaaktype: + allOf: + - $ref: '#/components/schemas/BronZaaktype' + description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. + title: bronzaaktype + catalogus: + type: string + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. + title: Catalogus + statustypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + title: Zaaktype + uniqueItems: true + resultaattypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + title: is relevant voor + uniqueItems: true + eigenschappen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn + in ZAKEN van dit ZAAKTYPE. + title: Zaaktype + uniqueItems: true + informatieobjecttypen: + type: string + readOnly: true + title: informatieobjecttypen + roltypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: + URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit + ZAAKTYPE. + title: Zaaktype + uniqueItems: true + besluittypen: + type: array + items: + type: string + title: '' + description: + '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen + dit ZAAKTYPE.' + title: zaaktypen + deelzaaktypen: + type: array + items: + type: string + title: '' + description: + De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak + kunnen voorkomen bij ZAAKen van dit ZAAKTYPE. + title: deelzaaktypen + gerelateerdeZaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypenRelatieCreate' + description: + De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit + ZAAKTYPE. + title: zaaktype van + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + versiedatum: + type: string + format: date + description: + De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE + geldig zijn geworden + title: versiedatum + concept: + type: boolean + readOnly: true + description: + Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + required: + - aanleiding + - beginGeldigheid + - besluittypen + - catalogus + - concept + - deelzaaktypen + - doel + - doorlooptijd + - eigenschappen + - gerelateerdeZaaktypen + - handelingBehandelaar + - handelingInitiator + - identificatie + - indicatieInternOfExtern + - informatieobjecttypen + - omschrijving + - onderwerp + - opschortingEnAanhoudingMogelijk + - productenOfDiensten + - publicatieIndicatie + - referentieproces + - resultaattypen + - roltypen + - statustypen + - url + - verantwoordelijke + - verlengingMogelijk + - versiedatum + - vertrouwelijkheidaanduiding + - zaakobjecttypen + + ZaakTypenRelatie: + type: object + properties: + zaaktype: + type: string + format: uri + description: + URL referentie naar het gerelateerde zaaktype, mogelijks in + een extern ZTC. + title: gerelateerd zaaktype + maxLength: 200 + aardRelatie: + allOf: + - $ref: '#/components/schemas/AardRelatieEnum' + description: + 'Omschrijving van de aard van de relatie van zaken van het + ZAAKTYPE tot zaken van het andere ZAAKTYPE + + + Uitleg bij mogelijke waarden: + + + * `vervolg` - Vervolg + + * `bijdrage` - Bijdrage + + * `onderwerp` - Onderwerp' + title: aard relatie + toelichting: + type: string + description: Een toelichting op de aard van de relatie tussen beide ZAAKTYPEN. + title: toelichting + maxLength: 255 + required: + - aardRelatie + - zaaktype + ZaakTypenRelatieCreate: + type: object + properties: + zaaktype: + type: string + description: '`zaaktype.identificatie` naar het ZAAKTYPE.' + title: zaaktype van + aardRelatie: + allOf: + - $ref: '#/components/schemas/AardRelatieEnum' + description: + 'Omschrijving van de aard van de relatie van zaken van het + ZAAKTYPE tot zaken van het andere ZAAKTYPE + + + Uitleg bij mogelijke waarden: + + + * `vervolg` - Vervolg + + * `bijdrage` - Bijdrage + + * `onderwerp` - Onderwerp' + title: aard relatie + toelichting: + type: string + description: Een toelichting op de aard van de relatie tussen beide ZAAKTYPEN. + title: toelichting + maxLength: 255 + required: + - aardRelatie + - zaaktype + securitySchemes: + JWT-Claims: + type: http + bearerFormat: JWT + scheme: bearer +servers: + # Added by API Auto Mocking Plugin + - description: SwaggerHub API Auto Mocking + url: https://virtserver.swaggerhub.com/michielverhoef/Catalogussen_API/1.3.0 + - url: https://catalogi-api.vng.cloud/api/v1 + description: Productie Omgeving +tags: + - name: besluittypen + description: + Opvragen en bewerken van BESLUITTYPEn nodig voor BESLUITEN in de Besluiten + API. Alle BESLUITTYPEn van de besluiten die het resultaat kunnen zijn van het + zaakgericht werken van de behandelende organisatie(s). + - name: catalogussen + description: + "Opvragen en bewerken van CATALOGUSsen. De verzameling van ZAAKTYPEn,\ + \ INFORMATIEOBJECTTYPEn en BESLUITTYPEn voor een domein die als \xE9\xE9n geheel\ + \ beheerd wordt." + - name: eigenschappen + description: + Opvragen en bewerken van EIGENSCHAPpen van een ZAAKTYPE. Een relevant + inhoudelijk gegeven dat bij ZAAKen van dit ZAAKTYPE geregistreerd moet kunnen + worden en geen standaard kenmerk is van een zaak. + - name: informatieobjecttypen + description: + Opvragen en bewerken van INFORMATIEOBJECTTYPEn nodig voor INFORMATIEOBJECTen + in de Documenten API. Een INFORMATIEOBJECTTYPE beschijft de karakteristieken van + een document of ander object dat informatie bevat. + - name: resultaattypen + description: + Opvragen en bewerken van RESULTAATTYPEn van een ZAAKTYPE. Het betreft + de indeling of groepering van resultaten van zaken van hetzelfde ZAAKTYPE naar + hun aard, zoals 'verleend', 'geweigerd', 'verwerkt', etc. + - name: roltypen + description: + Opvragen en bewerken van ROLTYPEn van een ZAAKTYPE. Generieke aanduiding + van de aard van een ROL die een BETROKKENE kan uitoefenen in ZAAKen van een ZAAKTYPE. + - name: statustypen + description: + Opvragen en bewerken van STATUSTYPEn van een ZAAKTYPE. Generieke aanduiding + van de aard van een status. + - name: zaakobjecttypen + description: + "Opvragen en bewerken van ZAAKOBJECTTYPEn. Er wordt gevalideerd op:\n\ + \ - `zaaktype` behoort tot dezelfde `catalogus`" + - name: zaaktype-informatieobjecttypen + description: + Opvragen en bewerken van ZAAKTYPE-INFORMATIEOBJECTTYPE relaties. Geeft + aan welke INFORMATIEOBJECTTYPEn binnen een ZAAKTYPE mogelijk zijn en hoe de richting + is. + - name: zaaktypen + description: + Opvragen en bewerken van ZAAKTYPEn nodig voor ZAKEN in de Zaken API.Een + ZAAKTYPE beschrijft het geheel van karakteristieke eigenschappen van zaken van + eenzelfde soort. From dca33ef01ffa235d8e23105950df2b999478115f Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Thu, 17 Oct 2024 16:43:36 +0200 Subject: [PATCH 05/36] Update gitignore --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index 2d5d79728..c0cc164f9 100644 --- a/.gitignore +++ b/.gitignore @@ -4,3 +4,4 @@ infra/env/ infra/fixtures/ deploy-bot/env/ +zrc-catalogi-1-3-2.yaml From 17ebc48c6fe726fe7c51af28b228e3ef0da5734e Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Mon, 21 Oct 2024 13:16:05 +0200 Subject: [PATCH 06/36] Alle expands zrc met betrekking to ztc expliciet laten doorverwijzen naar ztc --- api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml | 30 ++++--------------- 1 file changed, 6 insertions(+), 24 deletions(-) diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml index 24e5b0cb8..9d497bd6e 100644 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml @@ -12904,9 +12904,7 @@ components: zaak: $ref: '#/components/schemas/ZaakExpanded' resultaattype: - allOf: - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/ResultaatType' - - $ref: '#/components/schemas/ExpandCatalogusObject' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ResultaatTypeExpanded' Rol: type: object properties: @@ -13228,12 +13226,6 @@ components: organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_RolExpanded' vestiging: '#/components/schemas/vestiging_RolExpanded' - # RolExpanded: - # allOf: - # - $ref: '#/components/schemas/Rol' - # - properties: - # _expand: - # $ref: '#/components/schemas/RolEmbedded' RolEmbedded: type: object properties: @@ -13241,10 +13233,7 @@ components: $ref: '#/components/schemas/ZaakExpanded' example: {} roltype: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/catalogi-1_3_2/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' - # allOf: - # - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/RolType' - # - $ref: '#/components/schemas/ExpandCatalogusObject' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/RolTypeExpanded' statussen: type: array items: @@ -13530,9 +13519,7 @@ components: type: object properties: statustype: - allOf: - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/StatusType' - - $ref: '#/components/schemas/ExpandCatalogusObject' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/StatusTypeExpanded' gezetdoor: $ref: '#/components/schemas/Rol' zaakinformatieobjecten: @@ -14281,11 +14268,8 @@ components: Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." properties: zaaktype: - # Uiteindelijk is de onderstaande $ref de juiste maar werkt helaas niet in VSC Redoc Viewer - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/catalogi-1_3_2/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' - # allOf: - # - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/ZaakType' - # - $ref: '#/components/schemas/ExpandCatalogusObject' + # Onderstaande $ref is goed maar werkt helaas niet in VSC Redoc Viewer, wel in de VSC Swagger viewer. + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' hoofdzaak: oneOf: - $ref: '#/components/schemas/ZaakExpanded' @@ -14477,9 +14461,7 @@ components: - $ref: '#/components/schemas/ZaakExpanded' - $ref: '#/components/schemas/EmptyObject' eigenschap: - allOf: - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/Eigenschap' - - $ref: '#/components/schemas/ExpandCatalogusObject' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/EigenschapExpanded' ZaakInformatieObject: type: object properties: From 8e104e995cf86afca2ad09236c38964bba532455 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Wed, 23 Oct 2024 20:57:24 +0200 Subject: [PATCH 07/36] Expand toegevoegd aan ObjectInformatieObject (overgenomen uit PR #2371) --- api-specificatie/drc/1.5.x/1.6.0/openapi.yaml | 8542 +++++++++++++++++ .../drc/current_version/openapi.yaml | 38 +- 2 files changed, 8577 insertions(+), 3 deletions(-) create mode 100644 api-specificatie/drc/1.5.x/1.6.0/openapi.yaml diff --git a/api-specificatie/drc/1.5.x/1.6.0/openapi.yaml b/api-specificatie/drc/1.5.x/1.6.0/openapi.yaml new file mode 100644 index 000000000..f6d45c2e2 --- /dev/null +++ b/api-specificatie/drc/1.5.x/1.6.0/openapi.yaml @@ -0,0 +1,8542 @@ +openapi: 3.0.3 +info: + title: Documenten API + version: 1.6.0 + description: > + Een API om een documentregistratiecomponent (DRC) te benaderen. + + + In een documentregistratiecomponent worden INFORMATIEOBJECTen opgeslagen. + Een + + INFORMATIEOBJECT is een digitaal document voorzien van meta-gegevens. + + INFORMATIEOBJECTen kunnen aan andere objecten zoals zaken en besluiten + worden + + gerelateerd (maar dat hoeft niet) en kunnen gebruiksrechten hebben. + + + GEBRUIKSRECHTEN leggen voorwaarden op aan het gebruik van het + INFORMATIEOBJECT + + (buiten raadpleging). Deze GEBRUIKSRECHTEN worden niet door de API + gevalideerd + + of gehandhaafd. + + + De typering van INFORMATIEOBJECTen is in de Catalogi API (ZTC) ondergebracht + in + + de vorm van INFORMATIEOBJECTTYPEn. + + + **Uploaden van bestanden** + + + Binnen deze API bestaan een aantal endpoints die binaire data ontvangen, al + + dan niet base64-encoded. Webservers moeten op deze endpoints een minimale + + request body size van 4.0 GiB ondersteunen. Dit omvat de JSON van de + + metadata EN de base64-encoded bestandsdata. Hou hierbij rekening met de + + overhead van base64, die ongeveer 33% bedraagt in worst-case scenario's. Dit + + betekent dat bij een limiet van 4GB het bestand maximaal ongeveer 3GB groot + + mag zijn. + + + _Nieuw in 1.5.0_ + + 1. Het optionele attribuut "inhoudIsVervallen" is toegevoegd aan de resource `enkelvoudiginformatieobjecten`. + + 2. De voorwaarde "status NIET definitief" is verwijderd uit de beschrijvingen van de PUT- en PATCH-operatie + op `enkelvoudiginformatieobjecten`. Dit is een correctie van een fout in de OAS, want deze voorwaarde was al + geschrapt in de aanvullende specificatie van versie 1.4.0. + + + _Nieuw in 1.1.0_ + + + Bestanden kunnen groter zijn dan de minimale die door providers + + ondersteund moet worden. De consumer moet dan: + + + 1. Het INFORMATIEOBJECT aanmaken in de API, waarbij de totale + bestandsgrootte + meegestuurd wordt en de inhoud leeggelaten wordt. + De API antwoordt met een lijst van BESTANDSDEELen, elk met een volgnummer + en bestandsgrootte. De API lockt tegelijkertijd het INFORMATIEOBJECT. + 2. Het bestand opsplitsen: ieder BESTANDSDEEL moet de bestandsgrootte hebben + zoals dit aangegeven werd in de response bij 1. + 3. Voor elk stuk van het bestand de binaire data naar de overeenkomstige + BESTANDSDEEL-url gestuurd worden, samen met het lock ID. + 4. Het INFORMATIEOBJECT unlocken. De provider valideert op dat moment dat + alle + bestandsdelen correct opgestuurd werden, en voegt deze samen tot het + resulterende bestand. + + Het bijwerken van een INFORMATIEOBJECT heeft een gelijkaardig verloop. + + + De 1.0.x manier van uploaden is ook beschikbaar voor kleine(re) bestanden + die + + niet gesplitst hoeven te worden. + + + **Afhankelijkheden** + + + Deze API is afhankelijk van: + + + * Catalogi API + + * Notificaties API + + * Autorisaties API *(optioneel)* + + * Zaken API *(optioneel)* + + + **Autorisatie** + + + Deze API vereist autorisatie. Je kan de + + [token-tool](https://zaken-auth.vng.cloud/) gebruiken om JWT-tokens te + + genereren. + + + ### Notificaties + + + Deze API publiceert notificaties op het kanaal `documenten`. + + + **Main resource** + + + `enkelvoudiginformatieobject` + + + + + **Kenmerken** + + + * `bronorganisatie`: Het RSIN van de Niet-natuurlijk persoon zijnde de + organisatie die het informatieobject heeft gecreëerd of heeft ontvangen en + als eerste in een samenwerkingsketen heeft vastgelegd. + + * `informatieobjecttype`: URL-referentie naar het INFORMATIEOBJECTTYPE (in + de Catalogi API). + + * `vertrouwelijkheidaanduiding`: Aanduiding van de mate waarin het + INFORMATIEOBJECT voor de openbaarheid bestemd is. + + + **Resources en acties** + + + + **Handige links** + + + * [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard) + + * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken) + contact: + email: standaarden.ondersteuning@vng.nl + url: https://vng-realisatie.github.io/gemma-zaken + license: + name: EUPL 1.2 + url: https://opensource.org/licenses/EUPL-1.2 +paths: + /bestandsdelen/{uuid}: + put: + operationId: bestandsdeel_update + description: based on DRF mixin but without partial_update + summary: Upload een bestandsdeel. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/x-www-form-urlencoded + - multipart/form-data + description: Content type van de verzoekinhoud. + required: true + tags: + - bestandsdelen + requestBody: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/BestandsDeelRequest' + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/BestandsDeelRequest' + required: true + security: + - JWT-Claims: + - documenten.bijwerken + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/BestandsDeelResponse' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten: + get: + operationId: enkelvoudiginformatieobject_list + description: >- + Deze lijst kan gefilterd wordt met query-string parameters. + + De objecten bevatten metadata over de documenten en de downloadlink + (`inhoud`) naar de binary data. Alleen de laatste versie van + elk(ENKELVOUDIG) INFORMATIEOBJECT wordt getoond. Specifieke versies + kunnen alleen + summary: Alle (ENKELVOUDIGe) INFORMATIEOBJECTen opvragen. + parameters: + - name: identificatie + required: false + in: query + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + schema: + type: string + - name: bronorganisatie + required: false + in: query + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + schema: + type: string + - name: trefwoorden + required: false + in: query + description: Een lijst van trefwoorden gescheiden door comma's. + schema: + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + style: form + explode: false + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobjecttype + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedEnkelvoudigInformatieObjectList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: enkelvoudiginformatieobject_create + description: |- + **Er wordt gevalideerd op** + - geldigheid `informatieobjecttype` URL - de resource moet opgevraagd kunnen worden uit de catalogi API en de vorm van een INFORMATIEOBJECTTYPE hebben. + - publicatie `informatieobjecttype` - `concept` moet `false` zijn + summary: Maak een (ENKELVOUDIG) INFORMATIEOBJECT aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - enkelvoudiginformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/EnkelvoudigInformatieObjectCreateLockRequest + required: true + security: + - JWT-Claims: + - documenten.aanmaken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectCreateLock' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/{enkelvoudiginformatieobject_uuid}/audittrail: + get: + operationId: audittrail_list + description: Alle audit trail regels behorend bij het INFORMATIEOBJECT. + summary: Alle audit trail regels behorend bij het INFORMATIEOBJECT. + parameters: + - in: path + name: enkelvoudiginformatieobject_uuid + schema: + type: string + description: Unieke resource identifier (UUID4) + required: true + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - audittrails.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AuditTrail' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/{enkelvoudiginformatieobject_uuid}/audittrail/{uuid}: + get: + operationId: audittrail_retrieve + description: Een specifieke audit trail regel opvragen. + summary: Een specifieke audit trail regel opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke identificatie van de audit regel. + title: uuid + required: true + - in: path + name: enkelvoudiginformatieobject_uuid + schema: + type: string + description: Unieke resource identifier (UUID4) + required: true + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - audittrails.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/AuditTrail' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/{uuid}: + get: + operationId: enkelvoudiginformatieobject_retrieve + description: ' Het object bevat metadata over het document en de downloadlink (`inhoud`) naar de binary data. Dit geeft standaard de laatste versie van het (ENKELVOUDIG) INFORMATIEOBJECT. Specifieke versies kunnen middels query-string parameters worden opgevraagd.' + summary: Een specifiek (ENKELVOUDIG) INFORMATIEOBJECT opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + - in: query + name: versie + schema: + type: integer + description: Het (automatische) versienummer van het INFORMATIEOBJECT. + - in: query + name: registratieOp + schema: + type: string + description: >- + Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT + die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobjecttype + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: enkelvoudiginformatieobject_update + description: >- + Dit creëert altijd een nieuwe versie van het (ENKELVOUDIG) + INFORMATIEOBJECT. + + **Er wordt gevalideerd op** + + - correcte `lock` waarde + + summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - enkelvoudiginformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectWithLockRequest' + required: true + security: + - JWT-Claims: + - (documenten.bijwerken | documenten.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectWithLock' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: enkelvoudiginformatieobject_partial_update + description: >- + Dit creëert altijd een nieuwe versie van het (ENKELVOUDIG) + INFORMATIEOBJECT. + + + **Er wordt gevalideerd op** + - correcte `lock` waarde + summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - enkelvoudiginformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: >- + #/components/schemas/PatchedEnkelvoudigInformatieObjectWithLockRequest + security: + - JWT-Claims: + - (documenten.bijwerken | documenten.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectWithLock' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: enkelvoudiginformatieobject_destroy + description: >- + Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT en alle bijbehorende + versies, samen met alle gerelateerde resources binnen deze API. Dit is + alleen mogelijk als er geen OBJECTINFORMATIEOBJECTen relateerd zijn aan + het (ENKELVOUDIG) INFORMATIEOBJECT. + + + **Gerelateerde resources** + + - GEBRUIKSRECHTen + + - audit trail regels + summary: Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - documenten.verwijderen + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: enkelvoudiginformatieobject_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ENKELVOUDIG INFORMATIE OBJECT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + tags: + - enkelvoudiginformatieobjecten + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + description: OK + /enkelvoudiginformatieobjecten/{uuid}/download: + get: + operationId: enkelvoudiginformatieobject_download + description: Download de binaire data van het (ENKELVOUDIG) INFORMATIEOBJECT. + summary: Download de binaire data van het (ENKELVOUDIG) INFORMATIEOBJECT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: query + name: versie + schema: + type: integer + description: Het (automatische) versienummer van het INFORMATIEOBJECT. + - in: query + name: registratieOp + schema: + type: string + description: >- + Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT + die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/octet-stream: + schema: + type: string + format: binary + description: OK + '401': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '410': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/{uuid}/lock: + post: + operationId: enkelvoudiginformatieobject_lock + description: >- + Voert een 'checkout' uit waardoor het (ENKELVOUDIG) + INFORMATIEOBJECTvergrendeld wordt met een `lock` waarde. Alleen met deze + waarde kan het(ENKELVOUDIG) INFORMATIEOBJECT bijgewerkt (`PUT`, `PATCH`) + en weerontgrendeld worden. + summary: Vergrendel een (ENKELVOUDIG) INFORMATIEOBJECT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - enkelvoudiginformatieobjecten + security: + - JWT-Claims: + - documenten.lock + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/LockEnkelvoudigInformatieObject' + description: OK + '400': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Bad request + '401': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '410': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/{uuid}/unlock: + post: + operationId: enkelvoudiginformatieobject_unlock + description: >- + Heft de 'checkout' op waardoor het (ENKELVOUDIG) + INFORMATIEOBJECTontgrendeld wordt. + summary: Ontgrendel een (ENKELVOUDIG) INFORMATIEOBJECT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - enkelvoudiginformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UnlockEnkelvoudigInformatieObjectRequest' + security: + - JWT-Claims: + - (documenten.lock | documenten.geforceerd-unlock) + responses: + '204': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + description: No content + '400': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Bad request + '401': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '410': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /enkelvoudiginformatieobjecten/_zoek: + post: + operationId: enkelvoudiginformatieobject__zoek + description: >- + Zoeken/filteren gaat normaal via de `list` operatie, deze is echter niet + geschikt voor zoekopdrachten met UUIDs. + summary: Voer een zoekopdracht uit op (ENKELVOUDIG) INFORMATIEOBJECTen. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: query + name: page + schema: + type: integer + description: Een pagina binnen de gepagineerde set resultaten. + tags: + - enkelvoudiginformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EIOZoekRequest' + required: true + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedEnkelvoudigInformatieObjectList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /gebruiksrechten: + get: + operationId: gebruiksrechten_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle GEBRUIKSRECHTen opvragen. + parameters: + - name: informatieobject + required: false + in: query + description: URL-referentie naar het INFORMATIEOBJECT. + schema: + type: string + format: uri + - name: startdatum__lt + required: false + in: query + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + schema: + type: string + - name: startdatum__lte + required: false + in: query + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + schema: + type: string + - name: startdatum__gt + required: false + in: query + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + schema: + type: string + - name: startdatum__gte + required: false + in: query + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + schema: + type: string + - name: einddatum__lt + required: false + in: query + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: einddatum__lte + required: false + in: query + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: einddatum__gt + required: false + in: query + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: einddatum__gte + required: false + in: query + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobject + tags: + - gebruiksrechten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/GebruiksrechtenExpanded' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: gebruiksrechten_create + description: |- + Voeg GEBRUIKSRECHTen toe voor een INFORMATIEOBJECT. + **Opmerkingen** + - Het toevoegen van gebruiksrechten zorgt ervoor dat de `indicatieGebruiksrecht` op het informatieobject op `true` gezet wordt. + summary: Maak een GEBRUIKSRECHT aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - gebruiksrechten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GebruiksrechtenRequest' + required: true + security: + - JWT-Claims: + - documenten.aanmaken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Gebruiksrechten' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /gebruiksrechten/{uuid}: + get: + operationId: gebruiksrechten_retrieve + description: Een specifieke GEBRUIKSRECHT opvragen. + summary: Een specifieke GEBRUIKSRECHT opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobject + tags: + - gebruiksrechten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/GebruiksrechtenExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: gebruiksrechten_update + description: Werk een GEBRUIKSRECHT in zijn geheel bij. + summary: Werk een GEBRUIKSRECHT in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - gebruiksrechten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GebruiksrechtenRequest' + required: true + security: + - JWT-Claims: + - documenten.bijwerken + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Gebruiksrechten' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: gebruiksrechten_partial_update + description: Werk een GEBRUIKSRECHT relatie deels bij. + summary: Werk een GEBRUIKSRECHT relatie deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - gebruiksrechten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedGebruiksrechtenRequest' + security: + - JWT-Claims: + - documenten.bijwerken + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Gebruiksrechten' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: gebruiksrechten_destroy + description: |- + + **Opmerkingen** + - Indien het laatste GEBRUIKSRECHT van een INFORMATIEOBJECT verwijderd wordt, dan wordt de `indicatieGebruiksrecht` van het INFORMATIEOBJECT op`null` gezet. + summary: Verwijder een GEBRUIKSRECHT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - gebruiksrechten + security: + - JWT-Claims: + - documenten.verwijderen + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: gebruiksrechten_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: >- + De headers voor een specifiek(e) GEBRUIKSRECHT INFORMATIEOBJECT + opvragen + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + tags: + - gebruiksrechten + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + description: OK + /objectinformatieobjecten: + get: + operationId: objectinformatieobject_list + description: ' Deze lijst kan gefilterd wordt met query-string parameters.' + summary: Alle OBJECT-INFORMATIEOBJECT relaties opvragen. + parameters: + - name: object + required: false + in: query + description: >- + URL-referentie naar het gerelateerde OBJECT (in deze of een andere + API). + schema: + type: string + format: uri + - name: informatieobject + required: false + in: query + description: URL-referentie naar het INFORMATIEOBJECT. + schema: + type: string + format: uri + - name: expand + required: false + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobject + tags: + - objectinformatieobjecten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ObjectInformatieObjectExpanded' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: objectinformatieobject_create + description: >- + **LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** + Andere API's, zoals de Zaken API en de Besluiten API, gebruiken dit + endpoint bij het synchroniseren van relaties. **Er wordt gevalideerd + op** - geldigheid `informatieobject` URL - de combinatie + `informatieobject` en `object` moet uniek zijn - bestaan van `object` + URL + summary: Maak een OBJECT-INFORMATIEOBJECT relatie aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - objectinformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectInformatieObjectRequest' + required: true + security: + - JWT-Claims: + - documenten.aanmaken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectInformatieObject' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /objectinformatieobjecten/{uuid}: + get: + operationId: objectinformatieobject_retrieve + description: Een specifieke OBJECT-INFORMATIEOBJECT relatie opvragen. + summary: Een specifieke OBJECT-INFORMATIEOBJECT relatie opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + - in: query + name: expand + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobject + tags: + - objectinformatieobjecten + security: + - JWT-Claims: + - documenten.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/ObjectInformatieObjectExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: objectinformatieobject_destroy + description: >- + **LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** + Andere API's, zoals de Zaken API en de Besluiten API, gebruiken dit + endpoint bij het synchroniseren van relaties. + summary: Verwijder een OBJECT-INFORMATIEOBJECT relatie. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - objectinformatieobjecten + security: + - JWT-Claims: + - documenten.verwijderen + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: objectinformatieobject_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) OOBJECT-INFORMATIEOBJECT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + tags: + - objectinformatieobjecten + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + description: OK + /verzendingen: + get: + operationId: verzending_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle VERZENDINGen opvragen. + parameters: + - name: aardRelatie + required: false + in: query + description: >- + Omschrijving van de aard van de relatie van de BETROKKENE tot het + INFORMATIEOBJECT. + schema: + type: string + enum: + - afzender + - geadresseerde + - name: informatieobject + required: false + in: query + description: >- + URL-referentie naar het informatieobject dat is ontvangen of + verzonden. + schema: + type: string + format: uri + - name: betrokkene + required: false + in: query + description: >- + URL-referentie naar de betrokkene waarvan het informatieobject is + ontvangen of waaraan dit is verzonden. + schema: + type: string + format: uri + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobject + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - verzendingen + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedVerzendingList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: verzending_create + description: Voeg VERZENDINGen toe voor een INFORMATIEOBJECT en een BETROKKENE. + summary: Maak een VERZENDING aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - verzendingen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VerzendingRequest' + required: true + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Verzending' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /verzendingen/{uuid}: + get: + operationId: verzending_retrieve + description: Een specifieke VERZENDING opvragen. + summary: Een specifieke VERZENDING opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + - name: expand + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobject + tags: + - verzendingen + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/VerzendingExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: verzending_update + description: Werk een VERZENDING in zijn geheel bij. + summary: Werk een VERZENDING in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - verzendingen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/VerzendingRequest' + required: true + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Verzending' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: verzending_partial_update + description: Werk een VERZENDING relatie deels bij. + summary: Werk een VERZENDING relatie deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - verzendingen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedVerzendingRequest' + responses: + '200': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/json: + schema: + $ref: '#/components/schemas/Verzending' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: verzending_destroy + description: Verwijder een VERZENDING. + summary: Verwijder een VERZENDING + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - verzendingen + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: verzending_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) VERZENDING opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: >- + Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer + gecached heeft. Indien de waarde van de ETag van de huidige resource + voorkomt in deze set, dan antwoordt de provider met een lege HTTP + 304 request. Zie + [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: >- + "79054025255fb1a26e4bc422aef54eb4", + "e4d909c290d0fb1ca068ffaddf22cbd0" + summary: Meerdere ETag-waardes + tags: + - verzendingen + responses: + '200': + headers: + ETag: + schema: + type: string + description: >- + De ETag berekend op de response body JSON. Indien twee resources + exact dezelfde ETag hebben, dan zijn deze resources identiek aan + elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1. + description: OK +components: + responses: + '400': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: >- + Geeft een specifieke API-versie aan in de context van een specifieke + aanroep. Voorbeeld: 1.2.1. + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + schemas: + AardRelatieEnum: + enum: + - afzender + - geadresseerde + type: string + AlgoritmeEnum: + enum: + - crc_16 + - crc_32 + - crc_64 + - fletcher_4 + - fletcher_8 + - fletcher_16 + - fletcher_32 + - hmac + - md5 + - sha_1 + - sha_256 + - sha_512 + - sha_3 + type: string + AuditTrail: + type: object + properties: + uuid: + type: string + format: uuid + description: Unieke identificatie van de audit regel. + title: uuid + bron: + allOf: + - $ref: '#/components/schemas/BronEnum' + description: |- + De naam van het component waar de wijziging in is gedaan. + + Uitleg bij mogelijke waarden: + + * `ac` - Autorisaties API + * `nrc` - Notificaties API + * `zrc` - Zaken API + * `ztc` - Catalogi API + * `drc` - Documenten API + * `brc` - Besluiten API + * `cmc` - Contactmomenten API + * `kc` - Klanten API + * `vrc` - Verzoeken API + title: bron + applicatieId: + type: string + description: Unieke identificatie van de applicatie, binnen de organisatie. + title: applicatie id + maxLength: 100 + applicatieWeergave: + type: string + description: Vriendelijke naam van de applicatie. + title: applicatie weergave + maxLength: 200 + gebruikersId: + type: string + description: >- + Unieke identificatie van de gebruiker die binnen de organisatie + herleid kan worden naar een persoon. + title: gebruikers id + maxLength: 255 + gebruikersWeergave: + type: string + description: Vriendelijke naam van de gebruiker. + title: gebruikers weergave + maxLength: 255 + actie: + type: string + description: >- + De uitgevoerde handeling. + + + De bekende waardes voor dit veld zijn hieronder + aangegeven, maar andere waardes zijn ook + toegestaan + + + Uitleg bij mogelijke waarden: + + + * `create` - Object aangemaakt + + * `list` - Lijst van objecten opgehaald + + * `retrieve` - Object opgehaald + + * `destroy` - Object verwijderd + + * `update` - Object bijgewerkt + + * `partial_update` - Object deels bijgewerkt + title: actie + maxLength: 50 + actieWeergave: + type: string + description: Vriendelijke naam van de actie. + title: actie weergave + maxLength: 200 + resultaat: + type: integer + maximum: 599 + minimum: 100 + description: HTTP status code van de API response van de uitgevoerde handeling. + title: resultaat + hoofdObject: + type: string + format: uri + description: De URL naar het hoofdobject van een component. + title: hoofd object + maxLength: 1000 + resource: + type: string + description: Het type resource waarop de actie gebeurde. + title: resource + maxLength: 50 + resourceUrl: + type: string + format: uri + description: De URL naar het object. + title: resource url + maxLength: 1000 + toelichting: + type: string + description: Toelichting waarom de handeling is uitgevoerd. + title: toelichting + resourceWeergave: + type: string + description: Vriendelijke identificatie van het object. + title: resource weergave + maxLength: 200 + aanmaakdatum: + type: string + format: date-time + readOnly: true + description: De datum waarop de handeling is gedaan. + title: aanmaakdatum + wijzigingen: + allOf: + - $ref: '#/components/schemas/Wijzigingen' + title: wijzigingen + required: + - aanmaakdatum + - actie + - bron + - hoofdObject + - resource + - resourceUrl + - resourceWeergave + - resultaat + - wijzigingen + BestandsDeel: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + volgnummer: + type: integer + readOnly: true + description: Een volgnummer dat de volgorde van de bestandsdelen aangeeft. + title: volgnummer + omvang: + type: integer + readOnly: true + description: De grootte van dit specifieke bestandsdeel. + title: omvang + voltooid: + type: boolean + readOnly: true + description: >- + Indicatie of dit bestandsdeel volledig is geupload. Dat wil zeggen: + het aantal bytes dat staat genoemd bij grootte is daadwerkelijk + ontvangen. + title: voltooid + lock: + type: string + description: >- + Hash string, which represents id of the lock of related + informatieobject + title: lock + required: + - lock + - omvang + - url + - volgnummer + - voltooid + BestandsDeelRequest: + type: object + properties: + inhoud: + type: string + format: binary + writeOnly: true + description: De (binaire) bestandsinhoud van dit specifieke bestandsdeel. + title: inhoud + lock: + type: string + writeOnly: true + minLength: 1 + description: >- + Hash string, which represents id of the lock of related + informatieobject + title: lock + required: + - lock + BestandsDeelResponse: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + lock: + type: string + description: >- + Hash string, which represents id of the lock of related + informatieobject + title: lock + omvang: + type: integer + description: De grootte van dit specifieke bestandsdeel. + title: omvang + inhoud: + type: string + format: uri + description: De URL naar de bestandsinhoud van dit specifieke bestandsdeel. + title: inhoud + voltooid: + type: boolean + description: >- + Indicatie of dit bestandsdeel volledig is geupload. Dat wil zeggen: + het aantal bytes dat staat genoemd bij grootte is daadwerkelijk + ontvangen. + title: voltooid + volgnummer: + type: integer + description: Een volgnummer dat de volgorde van de bestandsdelen aangeeft. + title: volgnummer + required: + - lock + - url + BinnenlandsCorrespondentieadresVerzending: + type: object + description: >- + Het correspondentieadres, betreffende een adresseerbaar object, van de + BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het + ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van het + reguliere binnenlandse correspondentieadres van BETROKKENE. + properties: + huisletter: + type: string + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende toevoeging aan een huisnummer in + de vorm van een alfanumeriek teken. + title: huisletter + maxLength: 1 + huisnummer: + type: integer + maximum: 99999 + minimum: 1 + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende nummering. + title: huisnummer + huisnummerToevoeging: + type: string + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende nadere toevoeging aan een + huisnummer of een combinatie van huisnummer en huisletter. + title: huisnummer toevoeging + maxLength: 4 + naamOpenbareRuimte: + type: string + description: >- + Een door het bevoegde gemeentelijke orgaan aan een GEMEENTELIJKE + OPENBARE RUIMTE toegekende benaming. + title: naam openbare ruimte + maxLength: 80 + postcode: + type: string + description: >- + De door TNT Post vastgestelde code behorende bij een bepaalde + combinatie van een naam van een woonplaats, naam van een openbare + ruimte en een huisnummer. + title: postcode + maxLength: 6 + woonplaatsnaam: + type: string + description: >- + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + toegekende benaming. + title: woonplaatsnaam + maxLength: 80 + required: + - huisnummer + - naamOpenbareRuimte + - woonplaatsnaam + nullable: true + BinnenlandsCorrespondentieadresVerzendingRequest: + type: object + description: >- + Het correspondentieadres, betreffende een adresseerbaar object, van de + BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het + ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van het + reguliere binnenlandse correspondentieadres van BETROKKENE. + properties: + huisletter: + type: string + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende toevoeging aan een huisnummer in + de vorm van een alfanumeriek teken. + title: huisletter + maxLength: 1 + huisnummer: + type: integer + maximum: 99999 + minimum: 1 + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende nummering. + title: huisnummer + huisnummerToevoeging: + type: string + description: >- + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van + een adresseerbaar object toegekende nadere toevoeging aan een + huisnummer of een combinatie van huisnummer en huisletter. + title: huisnummer toevoeging + maxLength: 4 + naamOpenbareRuimte: + type: string + minLength: 1 + description: >- + Een door het bevoegde gemeentelijke orgaan aan een GEMEENTELIJKE + OPENBARE RUIMTE toegekende benaming. + title: naam openbare ruimte + maxLength: 80 + postcode: + type: string + description: >- + De door TNT Post vastgestelde code behorende bij een bepaalde + combinatie van een naam van een woonplaats, naam van een openbare + ruimte en een huisnummer. + title: postcode + maxLength: 6 + woonplaatsnaam: + type: string + minLength: 1 + description: >- + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + toegekende benaming. + title: woonplaatsnaam + maxLength: 80 + required: + - huisnummer + - naamOpenbareRuimte + - woonplaatsnaam + nullable: true + BlankEnum: + enum: + - '' + BronEnum: + enum: + - ac + - nrc + - zrc + - ztc + - drc + - brc + - cmc + - kc + - vrc + type: string + BuitenlandsCorrespondentieadresVerzending: + type: object + description: >- + De gegevens van het adres in het buitenland van BETROKKENE, zijnde + afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden + INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens + van BETROKKENE. + properties: + adresBuitenland1: + type: string + description: >- + Het eerste deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 1 + maxLength: 35 + adresBuitenland2: + type: string + description: >- + Het tweede deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 2 + maxLength: 35 + adresBuitenland3: + type: string + description: >- + Het derde deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 3 + maxLength: 35 + landPostadres: + type: string + format: uri + description: >- + Het LAND dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: land postadres + maxLength: 200 + required: + - adresBuitenland1 + - landPostadres + nullable: true + BuitenlandsCorrespondentieadresVerzendingRequest: + type: object + description: >- + De gegevens van het adres in het buitenland van BETROKKENE, zijnde + afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden + INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens + van BETROKKENE. + properties: + adresBuitenland1: + type: string + minLength: 1 + description: >- + Het eerste deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 1 + maxLength: 35 + adresBuitenland2: + type: string + description: >- + Het tweede deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 2 + maxLength: 35 + adresBuitenland3: + type: string + description: >- + Het derde deel dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: adres buitenland 3 + maxLength: 35 + landPostadres: + type: string + format: uri + minLength: 1 + description: >- + Het LAND dat behoort bij het afwijkend buitenlandse + correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. + title: land postadres + maxLength: 200 + required: + - adresBuitenland1 + - landPostadres + nullable: true + BuitenlandsCorrespondentiepostadresVerzending: + type: object + description: >- + De gegevens die tezamen een postbusadres of antwoordnummeradres vormen + van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het + ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere + correspondentiegegevens van BETROKKENE. + properties: + postBusOfAntwoordnummer: + type: integer + maximum: 9999 + minimum: 1 + title: Postbus-of antwoordnummer + description: >- + De numerieke aanduiding zoals deze door de Nederlandse PTT is + vastgesteld voor postbusadressen en antwoordnummeradressen. + postadresPostcode: + type: string + description: >- + De officiële Nederlandse PTT codering, bestaande uit een numerieke + woonplaatscode en een alfabetische lettercode. + title: postadres postcode + maxLength: 6 + postadresType: + allOf: + - $ref: '#/components/schemas/PostadresTypeEnum' + title: Postadrestype + description: Aanduiding van het soort postadres. + woonplaatsnaam: + type: string + description: >- + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + toegekende benaming. + title: woonplaatsnaam + maxLength: 80 + required: + - postBusOfAntwoordnummer + - postadresPostcode + - postadresType + - woonplaatsnaam + nullable: true + BuitenlandsCorrespondentiepostadresVerzendingRequest: + type: object + description: >- + De gegevens die tezamen een postbusadres of antwoordnummeradres vormen + van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het + ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere + correspondentiegegevens van BETROKKENE. + properties: + postBusOfAntwoordnummer: + type: integer + maximum: 9999 + minimum: 1 + title: Postbus-of antwoordnummer + description: >- + De numerieke aanduiding zoals deze door de Nederlandse PTT is + vastgesteld voor postbusadressen en antwoordnummeradressen. + postadresPostcode: + type: string + minLength: 1 + description: >- + De officiële Nederlandse PTT codering, bestaande uit een numerieke + woonplaatscode en een alfabetische lettercode. + title: postadres postcode + maxLength: 6 + postadresType: + allOf: + - $ref: '#/components/schemas/PostadresTypeEnum' + title: Postadrestype + description: Aanduiding van het soort postadres. + woonplaatsnaam: + type: string + minLength: 1 + description: >- + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + toegekende benaming. + title: woonplaatsnaam + maxLength: 80 + required: + - postBusOfAntwoordnummer + - postadresPostcode + - postadresType + - woonplaatsnaam + nullable: true + EIOZoekRequest: + type: object + properties: + uuid__in: + type: array + items: + type: string + format: uuid + title: '' + description: Array of unieke resource identifiers (UUID4) + title: uuid__in + identificatie: + title: Identificatie + description: + Een binnen een gegeven context ondubbelzinnige referentie naar + het INFORMATIEOBJECT. + type: string + example: "Document123" + bronorganisatie: + title: Bronorganisatie + description: + "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ + \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ + \ eerste in een samenwerkingsketen heeft vastgelegd." + type: string + example: "000000000" + expand: + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + type: string + example: informatieobjecttype + required: + - uuid__in + EnkelvoudigInformatieObject: + type: object + description: Serializer for the EnkelvoudigInformatieObject model + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De + waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het + attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + + + Uitleg bij mogelijke waarden: + + + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog + gewerkt. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed + maar moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of + iemand vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam + bewaarbaar gemaakt; een gearchiveerd informatie-element. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: + description: >- + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet + vervallen, dus niet langer geldig is. + + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. + + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: inhoud is vervallen + type: boolean + nullable: true + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + minLength: 3 + versie: + type: integer + readOnly: true + description: >- + Het (automatische) versienummer van het INFORMATIEOBJECT. Deze + begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. + title: versie + beginRegistratie: + type: string + format: date-time + readOnly: true + description: >- + Een datumtijd in ISO8601 formaat waarop deze versie van het + INFORMATIEOBJECT is aangemaakt of gewijzigd. + title: begin registratie + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: uri + description: Download URL van de binaire inhoud. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + DEPRECATED Dit attribuut is verplaatst naar resource + Verzending. De datum waarop het INFORMATIEOBJECT ontvangen is. + Verplicht te registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + DEPRECATED Dit attribuut is verplaatst naar resource + Verzending. De datum waarop het INFORMATIEOBJECT verzonden is, zoals + deze op het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel + inkomende als uitgaande INFORMATIEOBJECTen. Eenzelfde + informatieobject kan niet tegelijk inkomend en uitgaand zijn. + Ontvangst en verzending is voorbehouden aan documenten die van of + naar andere personen ontvangen of verzonden zijn waarbij die + personen niet deel uit maken van de behandeling van de zaak waarin + het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/Ondertekening' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/Integriteit' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + locked: + type: boolean + readOnly: true + description: >- + Geeft aan of het document gelocked is. Alleen als een document + gelocked is, mogen er aanpassingen gemaakt worden. + title: locked + bestandsdelen: + type: array + items: + $ref: '#/components/schemas/BestandsDeel' + readOnly: true + title: bestandsdelen + trefwoorden: + description: Een lijst van één of meer trefwoorden. + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + required: + - auteur + - beginRegistratie + - bestandsdelen + - bronorganisatie + - creatiedatum + - informatieobjecttype + - locked + - taal + - titel + - url + - versie + EnkelvoudigInformatieObjectCreateLock: + type: object + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + create operation for large files + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De + waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het + attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + + + Uitleg bij mogelijke waarden: + + + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog + gewerkt. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed + maar moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of + iemand vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam + bewaarbaar gemaakt; een gearchiveerd informatie-element. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: + description: >- + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet + vervallen, dus niet langer geldig is. + + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. + + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: inhoud is vervallen + type: boolean + nullable: true + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + minLength: 3 + versie: + type: integer + readOnly: true + description: >- + Het (automatische) versienummer van het INFORMATIEOBJECT. Deze + begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. + title: versie + beginRegistratie: + type: string + format: date-time + readOnly: true + description: >- + Een datumtijd in ISO8601 formaat waarop deze versie van het + INFORMATIEOBJECT is aangemaakt of gewijzigd. + title: begin registratie + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: uri + description: Download URL van de binaire inhoud. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/Ondertekening' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/Integriteit' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + locked: + type: boolean + readOnly: true + description: >- + Geeft aan of het document gelocked is. Alleen als een document + gelocked is, mogen er aanpassingen gemaakt worden. + title: locked + bestandsdelen: + type: array + items: + $ref: '#/components/schemas/BestandsDeel' + readOnly: true + title: bestandsdelen + trefwoorden: + description: Een lijst van één of meer trefwoorden. + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + lock: + type: string + readOnly: true + description: >- + Lock id generated if the large file is created and should be used + while updating the document. Documents with base64 encoded files are + created without lock + title: lock + required: + - auteur + - beginRegistratie + - bestandsdelen + - bronorganisatie + - creatiedatum + - informatieobjecttype + - lock + - locked + - taal + - titel + - url + - versie + EnkelvoudigInformatieObjectCreateLockRequest: + type: object + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + create operation for large files + properties: + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + minLength: 1 + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + minLength: 1 + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + minLength: 1 + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De + waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het + attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + + + Uitleg bij mogelijke waarden: + + + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog + gewerkt. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed + maar moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of + iemand vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam + bewaarbaar gemaakt; een gearchiveerd informatie-element. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: + description: >- + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet + vervallen, dus niet langer geldig is. + + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. + + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: inhoud is vervallen + type: boolean + nullable: true + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + minLength: 3 + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: byte + description: Binaire inhoud, in base64 geëncodeerd. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/OndertekeningRequest' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/IntegriteitRequest' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + minLength: 1 + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + trefwoorden: + description: Een lijst van één of meer trefwoorden. + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + required: + - auteur + - bronorganisatie + - creatiedatum + - informatieobjecttype + - taal + - titel + EnkelvoudigInformatieObjectWithLock: + type: object + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + update and partial_update operations + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De + waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het + attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + + + Uitleg bij mogelijke waarden: + + + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog + gewerkt. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed + maar moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of + iemand vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam + bewaarbaar gemaakt; een gearchiveerd informatie-element. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: + description: >- + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet + vervallen, dus niet langer geldig is. + + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. + + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: inhoud is vervallen + type: boolean + nullable: true + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + minLength: 3 + versie: + type: integer + readOnly: true + description: >- + Het (automatische) versienummer van het INFORMATIEOBJECT. Deze + begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. + title: versie + beginRegistratie: + type: string + format: date-time + readOnly: true + description: >- + Een datumtijd in ISO8601 formaat waarop deze versie van het + INFORMATIEOBJECT is aangemaakt of gewijzigd. + title: begin registratie + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: uri + description: Download URL van de binaire inhoud. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/Ondertekening' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/Integriteit' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + locked: + type: boolean + readOnly: true + description: >- + Geeft aan of het document gelocked is. Alleen als een document + gelocked is, mogen er aanpassingen gemaakt worden. + title: locked + bestandsdelen: + type: array + items: + $ref: '#/components/schemas/BestandsDeel' + readOnly: true + title: bestandsdelen + trefwoorden: + description: Een lijst van één of meer trefwoorden. + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + required: + - auteur + - beginRegistratie + - bestandsdelen + - bronorganisatie + - creatiedatum + - informatieobjecttype + - locked + - taal + - titel + - url + - versie + EnkelvoudigInformatieObjectWithLockRequest: + type: object + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + update and partial_update operations + properties: + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + minLength: 1 + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + minLength: 1 + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + minLength: 1 + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De + waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het + attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + + + Uitleg bij mogelijke waarden: + + + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog + gewerkt. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed + maar moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of + iemand vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam + bewaarbaar gemaakt; een gearchiveerd informatie-element. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: + description: >- + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet + vervallen, dus niet langer geldig is. + + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. + + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: inhoud is vervallen + type: boolean + nullable: true + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + minLength: 3 + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: byte + description: Binaire inhoud, in base64 geëncodeerd. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/OndertekeningRequest' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/IntegriteitRequest' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + minLength: 1 + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + trefwoorden: + description: Een lijst van één of meer trefwoorden. + type: array + items: + type: string + example: + - bouwtekening + - vergunning + - aanvraag + lock: + type: string + writeOnly: true + minLength: 1 + description: >- + Tijdens het updaten van een document (PATCH, PUT) moet het `lock` + veld opgegeven worden. Bij het aanmaken (POST) mag het geen waarde + hebben. + title: lock + required: + - auteur + - bronorganisatie + - creatiedatum + - informatieobjecttype + - lock + - taal + - titel + EnkelvoudigInformatieObjectExpanded: + allOf: + - $ref: '#/components/schemas/EnkelvoudigInformatieObject' + - properties: + _expand: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectEmbedded' + EnkelvoudigInformatieObjectEmbedded: + type: object + properties: + informatieobjecttype: + $ref: >- + https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/InformatieObjectType + FieldValidationError: + type: object + description: Formaat van validatiefouten. + properties: + name: + type: string + description: Naam van het veld met ongeldige gegevens + title: name + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + reason: + type: string + description: Uitleg wat er precies fout is met de gegevens + title: reason + required: + - code + - name + - reason + Fout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: >- + URI met referentie naar dit specifiek voorkomen van de fout. Deze + kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + required: + - code + - detail + - instance + - status + - title + Gebruiksrechten: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + informatieobject: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECT. + title: informatieobject + startdatum: + type: string + format: date-time + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + title: startdatum + einddatum: + type: string + format: date-time + nullable: true + title: Startdatum + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + omschrijvingVoorwaarden: + type: string + description: >- + Omschrijving van de van toepassing zijnde voorwaarden aan het + gebruik anders dan raadpleging + title: omschrijving voorwaarden + required: + - informatieobject + - omschrijvingVoorwaarden + - startdatum + - url + GebruiksrechtenExpanded: + allOf: + - $ref: '#/components/schemas/Gebruiksrechten' + - properties: + _expand: + $ref: '#/components/schemas/GebruiksrechtenEmbedded' + GebruiksrechtenEmbedded: + type: object + properties: + informatieobject: + $ref: '#/components/schemas/EnkelvoudigInformatieObject' + GebruiksrechtenRequest: + type: object + properties: + informatieobject: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECT. + title: informatieobject + startdatum: + type: string + format: date-time + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + title: startdatum + einddatum: + type: string + format: date-time + nullable: true + title: Startdatum + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + omschrijvingVoorwaarden: + type: string + minLength: 1 + description: >- + Omschrijving van de van toepassing zijnde voorwaarden aan het + gebruik anders dan raadpleging + title: omschrijving voorwaarden + required: + - informatieobject + - omschrijvingVoorwaarden + - startdatum + Integriteit: + type: object + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal + bestand. + properties: + algoritme: + allOf: + - $ref: '#/components/schemas/AlgoritmeEnum' + description: |- + Aanduiding van algoritme, gebruikt om de checksum te maken. + + Uitleg bij mogelijke waarden: + + * `crc_16` - CRC-16 + * `crc_32` - CRC-32 + * `crc_64` - CRC-64 + * `fletcher_4` - Fletcher-4 + * `fletcher_8` - Fletcher-8 + * `fletcher_16` - Fletcher-16 + * `fletcher_32` - Fletcher-32 + * `hmac` - HMAC + * `md5` - MD5 + * `sha_1` - SHA-1 + * `sha_256` - SHA-256 + * `sha_512` - SHA-512 + * `sha_3` - SHA-3 + title: integriteit algoritme + waarde: + type: string + description: De waarde van de checksum. + title: integriteit waarde + maxLength: 128 + datum: + type: string + format: date + description: Datum waarop de checksum is gemaakt. + title: integriteit datum + required: + - algoritme + - datum + - waarde + nullable: true + IntegriteitRequest: + type: object + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal + bestand. + properties: + algoritme: + allOf: + - $ref: '#/components/schemas/AlgoritmeEnum' + description: |- + Aanduiding van algoritme, gebruikt om de checksum te maken. + + Uitleg bij mogelijke waarden: + + * `crc_16` - CRC-16 + * `crc_32` - CRC-32 + * `crc_64` - CRC-64 + * `fletcher_4` - Fletcher-4 + * `fletcher_8` - Fletcher-8 + * `fletcher_16` - Fletcher-16 + * `fletcher_32` - Fletcher-32 + * `hmac` - HMAC + * `md5` - MD5 + * `sha_1` - SHA-1 + * `sha_256` - SHA-256 + * `sha_512` - SHA-512 + * `sha_3` - SHA-3 + title: integriteit algoritme + waarde: + type: string + minLength: 1 + description: De waarde van de checksum. + title: integriteit waarde + maxLength: 128 + datum: + type: string + format: date + description: Datum waarop de checksum is gemaakt. + title: integriteit datum + required: + - algoritme + - datum + - waarde + nullable: true + LockEnkelvoudigInformatieObject: + type: object + description: |- + Serializer for the lock action of EnkelvoudigInformatieObjectCanonical + model + properties: + lock: + type: string + readOnly: true + description: Hash string, wordt gebruikt als ID voor de lock + title: lock + required: + - lock + ObjectInformatieObject: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + informatieobject: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECT. + title: informatieobject + object: + type: string + format: uri + description: >- + URL-referentie naar het gerelateerde OBJECT (in deze of een andere + API). + title: object + maxLength: 1000 + objectType: + allOf: + - $ref: '#/components/schemas/ObjectTypeEnum' + title: Objecttype + description: |- + Het type van het gerelateerde OBJECT. + + Uitleg bij mogelijke waarden: + + * `besluit` - Besluit + * `zaak` - Zaak + required: + - informatieobject + - object + - objectType + - url + ObjectInformatieObjectExpanded: + allOf: + - $ref: '#/components/schemas/ObjectInformatieObject' + - properties: + _expand: + $ref: '#/components/schemas/ObjectInformatieObjectEmbedded' + ObjectInformatieObjectEmbedded: + type: object + properties: + informatieobject: + $ref: '#/components/schemas/EnkelvoudigInformatieObject' + ObjectInformatieObjectRequest: + type: object + properties: + informatieobject: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECT. + title: informatieobject + object: + type: string + format: uri + minLength: 1 + description: >- + URL-referentie naar het gerelateerde OBJECT (in deze of een andere + API). + title: object + maxLength: 1000 + objectType: + allOf: + - $ref: '#/components/schemas/ObjectTypeEnum' + title: Objecttype + description: |- + Het type van het gerelateerde OBJECT. + + Uitleg bij mogelijke waarden: + + * `besluit` - Besluit + * `zaak` - Zaak + required: + - informatieobject + - object + - objectType + ObjectTypeEnum: + enum: + - besluit + - zaak + - verzoek + type: string + Ondertekening: + type: object + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet van + een waarde zijn voorzien als de `status` de waarde 'in bewerking' of + 'ter vaststelling' heeft. + properties: + soort: + allOf: + - $ref: '#/components/schemas/SoortEnum' + title: Ondertekeningsoort + description: |- + Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT + + Uitleg bij mogelijke waarden: + + * `analoog` - Analoog + * `digitaal` - Digitaal + * `pki` - PKI + datum: + type: string + format: date + title: Ondertekeningdatum + description: >- + De datum waarop de ondertekening van het INFORMATIEOBJECT heeft + plaatsgevonden. + required: + - datum + - soort + nullable: true + OndertekeningRequest: + type: object + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet van + een waarde zijn voorzien als de `status` de waarde 'in bewerking' of + 'ter vaststelling' heeft. + properties: + soort: + allOf: + - $ref: '#/components/schemas/SoortEnum' + title: Ondertekeningsoort + description: |- + Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT + + Uitleg bij mogelijke waarden: + + * `analoog` - Analoog + * `digitaal` - Digitaal + * `pki` - PKI + datum: + type: string + format: date + title: Ondertekeningdatum + description: >- + De datum waarop de ondertekening van het INFORMATIEOBJECT heeft + plaatsgevonden. + required: + - datum + - soort + nullable: true + PaginatedEnkelvoudigInformatieObjectList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/EnkelvoudigInformatieObjectExpanded' + PaginatedVerzendingList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/VerzendingExpanded' + PatchedEnkelvoudigInformatieObjectWithLockRequest: + type: object + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + update and partial_update operations + properties: + identificatie: + type: string + description: >- + Een binnen een gegeven context ondubbelzinnige referentie naar het + INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + minLength: 1 + description: >- + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die + het informatieobject heeft gecreëerd of heeft ontvangen en als + eerste in een samenwerkingsketen heeft vastgelegd. + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: >- + Een datum of een gebeurtenis in de levenscyclus van het + INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + minLength: 1 + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: >- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + minLength: 1 + description: >- + De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. + title: auteur + maxLength: 200 + status: + description: >- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De + waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het + attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + + + Uitleg bij mogelijke waarden: + + + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog + gewerkt. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed + maar moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of + iemand vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam + bewaarbaar gemaakt; een gearchiveerd informatie-element. + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' + inhoudIsVervallen: + description: >- + Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet + vervallen, dus niet langer geldig is. + + * `true` De inhoud van het INFORMATIEOBJECT is vervallen. + + * `false` De inhoud van het INFORMATIEOBJECT is niet vervallen. + title: inhoud is vervallen + type: boolean + nullable: true + formaat: + type: string + description: >- + Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een + computerbestand. Voorbeeld: `application/msword`. Zie: + https://www.iana.org/assignments/media-types/media-types.xhtml + title: formaat + maxLength: 255 + taal: + type: string + minLength: 3 + description: >- + Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: + https://www.iso.org/standard/4767.html + title: taal + maxLength: 3 + bestandsnaam: + type: string + description: >- + De naam van het fysieke bestand waarin de inhoud van het + informatieobject is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: byte + description: Binaire inhoud, in base64 geëncodeerd. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854776000 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: >- + Indicatie of er beperkingen gelden aangaande het gebruik van het + informatieobject anders dan raadpleging. Dit veld mag `null` zijn om + aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn + raadplegen via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/OndertekeningRequest' + nullable: true + description: >- + Aanduiding van de rechtskracht van een informatieobject. Mag niet + van een waarde zijn voorzien als de `status` de waarde 'in + bewerking' of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/IntegriteitRequest' + nullable: true + description: >- + Uitdrukking van mate van volledigheid en onbeschadigd zijn van + digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + minLength: 1 + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + title: informatieobjecttype + maxLength: 200 + lock: + type: string + writeOnly: true + minLength: 1 + description: >- + Tijdens het updaten van een document (PATCH, PUT) moet het `lock` + veld opgegeven worden. Bij het aanmaken (POST) mag het geen waarde + hebben. + title: lock + PatchedGebruiksrechtenRequest: + type: object + properties: + informatieobject: + type: string + format: uri + description: URL-referentie naar het INFORMATIEOBJECT. + title: informatieobject + startdatum: + type: string + format: date-time + description: >- + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. Doorgaans is de datum van creatie van het + informatieobject de startdatum. + title: startdatum + einddatum: + type: string + format: date-time + nullable: true + title: Startdatum + description: >- + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + omschrijvingVoorwaarden: + type: string + minLength: 1 + description: >- + Omschrijving van de van toepassing zijnde voorwaarden aan het + gebruik anders dan raadpleging + title: omschrijving voorwaarden + PatchedVerzendingRequest: + type: object + description: >- + Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has + gegevensgroepen. + properties: + betrokkene: + type: string + format: uri + minLength: 1 + description: >- + URL-referentie naar de betrokkene waarvan het informatieobject is + ontvangen of waaraan dit is verzonden. + title: betrokkene + maxLength: 200 + informatieobject: + type: string + format: uri + description: >- + URL-referentie naar het informatieobject dat is ontvangen of + verzonden. + title: informatieobject + aardRelatie: + allOf: + - $ref: '#/components/schemas/AardRelatieEnum' + description: >- + Omschrijving van de aard van de relatie van de BETROKKENE tot het + INFORMATIEOBJECT. + title: aard relatie + toelichting: + type: string + description: Verduidelijking van de afzender- of geadresseerde-relatie. + title: toelichting + maxLength: 200 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. Vervangt het gelijknamige attribuut uit Informatieobject. + Verplicht gevuld wanneer aardRelatie de waarde 'afzender' heeft. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + Vervangt het gelijknamige attribuut uit Informatieobject. Verplicht + gevuld wanneer aardRelatie de waarde 'geadresseerde' heeft. + title: verzenddatum + contactPersoon: + type: string + format: uri + minLength: 1 + title: Contactpersoon + description: >- + URL-referentie naar de persoon die als aanspreekpunt fungeert voor + de BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. + maxLength: 1000 + contactpersoonnaam: + type: string + description: >- + De opgemaakte naam van de persoon die als aanspreekpunt fungeert + voorde BETROKKENE inzake het ontvangen of verzonden + INFORMATIEOBJECT. + title: contactpersoonnaam + maxLength: 40 + binnenlandsCorrespondentieadres: + allOf: + - $ref: >- + #/components/schemas/BinnenlandsCorrespondentieadresVerzendingRequest + nullable: true + description: >- + Het correspondentieadres, betreffende een adresseerbaar object, van + de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in + het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van + het reguliere binnenlandse correspondentieadres van BETROKKENE. + title: binnenlandsCorrespondentieadres + buitenlandsCorrespondentieadres: + allOf: + - $ref: >- + #/components/schemas/BuitenlandsCorrespondentieadresVerzendingRequest + nullable: true + description: >- + De gegevens van het adres in het buitenland van BETROKKENE, zijnde + afzender of geadresseerde, zoals vermeld in het ontvangen of + verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere + correspondentiegegevens van BETROKKENE. + title: buitenlandsCorrespondentieadres + correspondentiePostadres: + allOf: + - $ref: >- + #/components/schemas/BuitenlandsCorrespondentiepostadresVerzendingRequest + nullable: true + description: >- + De gegevens die tezamen een postbusadres of antwoordnummeradres + vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals + vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat + afwijkt van de reguliere correspondentiegegevens van BETROKKENE. + title: correspondentiePostadres + faxnummer: + type: string + nullable: true + description: faxnummer van de ontvanger of afzender. + title: faxnummer + maxLength: 15 + emailadres: + type: string + nullable: true + description: emailadres van de ontvanger of afzender. + title: emailadres + maxLength: 100 + mijnOverheid: + type: boolean + description: >- + is het informatieobject verzonden via mijnOverheid naar de + ontvanger. + title: mijn overheid + telefoonnummer: + type: string + nullable: true + description: telefoonnummer van de ontvanger of afzender. + title: telefoonnummer + maxLength: 15 + PostadresTypeEnum: + enum: + - antwoordnummer + - postbusnummer + type: string + SoortEnum: + enum: + - analoog + - digitaal + - pki + type: string + StatusEnum: + enum: + - in_bewerking + - ter_vaststelling + - definitief + - gearchiveerd + type: string + UnlockEnkelvoudigInformatieObjectRequest: + type: object + description: |- + Serializer for the unlock action of EnkelvoudigInformatieObjectCanonical + model + properties: + lock: + type: string + description: Hash string, wordt gebruikt als ID voor de lock + title: lock + maxLength: 100 + ValidatieFout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: >- + URI met referentie naar dit specifiek voorkomen van de fout. Deze + kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + invalidParams: + type: array + items: + $ref: '#/components/schemas/FieldValidationError' + title: invalidParams + required: + - code + - detail + - instance + - invalidParams + - status + - title + VertrouwelijkheidaanduidingEnum: + enum: + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim + type: string + Verzending: + type: object + description: >- + Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has + gegevensgroepen. + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: >- + URL-referentie naar dit object. Dit is de unieke identificatie en + locatie van dit object. + minLength: 1 + maxLength: 1000 + betrokkene: + type: string + format: uri + description: >- + URL-referentie naar de betrokkene waarvan het informatieobject is + ontvangen of waaraan dit is verzonden. + title: betrokkene + maxLength: 200 + informatieobject: + type: string + format: uri + description: >- + URL-referentie naar het informatieobject dat is ontvangen of + verzonden. + title: informatieobject + aardRelatie: + allOf: + - $ref: '#/components/schemas/AardRelatieEnum' + description: >- + Omschrijving van de aard van de relatie van de BETROKKENE tot het + INFORMATIEOBJECT. + title: aard relatie + toelichting: + type: string + description: Verduidelijking van de afzender- of geadresseerde-relatie. + title: toelichting + maxLength: 200 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. Vervangt het gelijknamige attribuut uit Informatieobject. + Verplicht gevuld wanneer aardRelatie de waarde 'afzender' heeft. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + Vervangt het gelijknamige attribuut uit Informatieobject. Verplicht + gevuld wanneer aardRelatie de waarde 'geadresseerde' heeft. + title: verzenddatum + contactPersoon: + type: string + format: uri + title: Contactpersoon + description: >- + URL-referentie naar de persoon die als aanspreekpunt fungeert voor + de BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. + maxLength: 1000 + contactpersoonnaam: + type: string + description: >- + De opgemaakte naam van de persoon die als aanspreekpunt fungeert + voorde BETROKKENE inzake het ontvangen of verzonden + INFORMATIEOBJECT. + title: contactpersoonnaam + maxLength: 40 + binnenlandsCorrespondentieadres: + allOf: + - $ref: '#/components/schemas/BinnenlandsCorrespondentieadresVerzending' + nullable: true + description: >- + Het correspondentieadres, betreffende een adresseerbaar object, van + de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in + het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van + het reguliere binnenlandse correspondentieadres van BETROKKENE. + title: binnenlandsCorrespondentieadres + buitenlandsCorrespondentieadres: + allOf: + - $ref: '#/components/schemas/BuitenlandsCorrespondentieadresVerzending' + nullable: true + description: >- + De gegevens van het adres in het buitenland van BETROKKENE, zijnde + afzender of geadresseerde, zoals vermeld in het ontvangen of + verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere + correspondentiegegevens van BETROKKENE. + title: buitenlandsCorrespondentieadres + correspondentiePostadres: + allOf: + - $ref: >- + #/components/schemas/BuitenlandsCorrespondentiepostadresVerzending + nullable: true + description: >- + De gegevens die tezamen een postbusadres of antwoordnummeradres + vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals + vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat + afwijkt van de reguliere correspondentiegegevens van BETROKKENE. + title: correspondentiePostadres + faxnummer: + type: string + nullable: true + description: faxnummer van de ontvanger of afzender. + title: faxnummer + maxLength: 15 + emailadres: + type: string + nullable: true + description: emailadres van de ontvanger of afzender. + title: emailadres + maxLength: 100 + mijnOverheid: + type: boolean + description: >- + is het informatieobject verzonden via mijnOverheid naar de + ontvanger. + title: mijn overheid + telefoonnummer: + type: string + nullable: true + description: telefoonnummer van de ontvanger of afzender. + title: telefoonnummer + maxLength: 15 + required: + - aardRelatie + - betrokkene + - contactPersoon + - informatieobject + - url + VerzendingExpanded: + allOf: + - $ref: '#/components/schemas/Verzending' + - properties: + _expand: + $ref: '#/components/schemas/VerzendingEmbedded' + VerzendingEmbedded: + type: object + properties: + informatieobject: + $ref: '#/components/schemas/EnkelvoudigInformatieObject' + VerzendingRequest: + type: object + description: >- + Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has + gegevensgroepen. + properties: + betrokkene: + type: string + format: uri + minLength: 1 + description: >- + URL-referentie naar de betrokkene waarvan het informatieobject is + ontvangen of waaraan dit is verzonden. + title: betrokkene + maxLength: 200 + informatieobject: + type: string + format: uri + description: >- + URL-referentie naar het informatieobject dat is ontvangen of + verzonden. + title: informatieobject + aardRelatie: + allOf: + - $ref: '#/components/schemas/AardRelatieEnum' + description: >- + Omschrijving van de aard van de relatie van de BETROKKENE tot het + INFORMATIEOBJECT. + title: aard relatie + toelichting: + type: string + description: Verduidelijking van de afzender- of geadresseerde-relatie. + title: toelichting + maxLength: 200 + ontvangstdatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te + registreren voor INFORMATIEOBJECTen die van buiten de + zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en + verzending is voorbehouden aan documenten die van of naar andere + personen ontvangen of verzonden zijn waarbij die personen niet deel + uit maken van de behandeling van de zaak waarin het document een rol + speelt. Vervangt het gelijknamige attribuut uit Informatieobject. + Verplicht gevuld wanneer aardRelatie de waarde 'afzender' heeft. + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: >- + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het + INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als + uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet + tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is + voorbehouden aan documenten die van of naar andere personen + ontvangen of verzonden zijn waarbij die personen niet deel uit maken + van de behandeling van de zaak waarin het document een rol speelt. + Vervangt het gelijknamige attribuut uit Informatieobject. Verplicht + gevuld wanneer aardRelatie de waarde 'geadresseerde' heeft. + title: verzenddatum + contactPersoon: + type: string + format: uri + minLength: 1 + title: Contactpersoon + description: >- + URL-referentie naar de persoon die als aanspreekpunt fungeert voor + de BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. + maxLength: 1000 + contactpersoonnaam: + type: string + description: >- + De opgemaakte naam van de persoon die als aanspreekpunt fungeert + voorde BETROKKENE inzake het ontvangen of verzonden + INFORMATIEOBJECT. + title: contactpersoonnaam + maxLength: 40 + binnenlandsCorrespondentieadres: + allOf: + - $ref: >- + #/components/schemas/BinnenlandsCorrespondentieadresVerzendingRequest + nullable: true + description: >- + Het correspondentieadres, betreffende een adresseerbaar object, van + de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in + het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van + het reguliere binnenlandse correspondentieadres van BETROKKENE. + title: binnenlandsCorrespondentieadres + buitenlandsCorrespondentieadres: + allOf: + - $ref: >- + #/components/schemas/BuitenlandsCorrespondentieadresVerzendingRequest + nullable: true + description: >- + De gegevens van het adres in het buitenland van BETROKKENE, zijnde + afzender of geadresseerde, zoals vermeld in het ontvangen of + verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere + correspondentiegegevens van BETROKKENE. + title: buitenlandsCorrespondentieadres + correspondentiePostadres: + allOf: + - $ref: >- + #/components/schemas/BuitenlandsCorrespondentiepostadresVerzendingRequest + nullable: true + description: >- + De gegevens die tezamen een postbusadres of antwoordnummeradres + vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals + vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat + afwijkt van de reguliere correspondentiegegevens van BETROKKENE. + title: correspondentiePostadres + faxnummer: + type: string + nullable: true + description: faxnummer van de ontvanger of afzender. + title: faxnummer + maxLength: 15 + emailadres: + type: string + nullable: true + description: emailadres van de ontvanger of afzender. + title: emailadres + maxLength: 100 + mijnOverheid: + type: boolean + description: >- + is het informatieobject verzonden via mijnOverheid naar de + ontvanger. + title: mijn overheid + telefoonnummer: + type: string + nullable: true + description: telefoonnummer van de ontvanger of afzender. + title: telefoonnummer + maxLength: 15 + required: + - aardRelatie + - betrokkene + - contactPersoon + - informatieobject + Wijzigingen: + type: object + properties: + oud: + type: object + additionalProperties: {} + description: >- + Volledige JSON body van het object zoals dat bestond voordat de + actie heeft plaatsgevonden. + title: oud + nieuw: + type: object + additionalProperties: {} + description: Volledige JSON body van het object na de actie. + title: nieuw + securitySchemes: + JWT-Claims: + type: http + bearerFormat: JWT + scheme: bearer +servers: + - description: SwaggerHub API Auto Mocking + url: https://virtserver.swaggerhub.com/michielverhoef/Documenten_API/1.4.2 + - url: https://documenten-api.vng.cloud/api/v1 + description: Productie Omgeving +tags: + - name: enkelvoudiginformatieobjecten + description: Opvragen en bewerken van (ENKELVOUDIG) INFORMATIEOBJECTen (documenten). + - name: gebruiksrechten + description: Opvragen en bewerken van GEBRUIKSRECHTen bij een INFORMATIEOBJECT. + - name: objectinformatieobjecten + description: >- + Opvragen en verwijderen van OBJECT-INFORMATIEOBJECT relaties. Het betreft + een relatie tussen een willekeurig OBJECT, bijvoorbeeld een ZAAK in de + Zaken API, en een INFORMATIEOBJECT. + - name: verzendingen + description: Opvragen en bewerken van VERZENDINGen. diff --git a/api-specificatie/drc/current_version/openapi.yaml b/api-specificatie/drc/current_version/openapi.yaml index 05ac87947..f6d45c2e2 100644 --- a/api-specificatie/drc/current_version/openapi.yaml +++ b/api-specificatie/drc/current_version/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Documenten API - version: 1.5.0 + version: 1.6.0 description: > Een API om een documentregistratiecomponent (DRC) te benaderen. @@ -3443,6 +3443,17 @@ paths: schema: type: string format: uri + - name: expand + required: false + in: query + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobject tags: - objectinformatieobjecten security: @@ -3462,7 +3473,7 @@ paths: schema: type: array items: - $ref: '#/components/schemas/ObjectInformatieObject' + $ref: '#/components/schemas/ObjectInformatieObjectExpanded' description: OK '400': headers: @@ -3782,6 +3793,16 @@ paths: "79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0" summary: Meerdere ETag-waardes + - in: query + name: expand + description: >- + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt + de punt-notatie gebruikt. + schema: + type: string + example: informatieobject tags: - objectinformatieobjecten security: @@ -3806,7 +3827,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ObjectInformatieObject' + $ref: '#/components/schemas/ObjectInformatieObjectExpanded' description: OK '401': headers: @@ -7540,6 +7561,17 @@ components: - object - objectType - url + ObjectInformatieObjectExpanded: + allOf: + - $ref: '#/components/schemas/ObjectInformatieObject' + - properties: + _expand: + $ref: '#/components/schemas/ObjectInformatieObjectEmbedded' + ObjectInformatieObjectEmbedded: + type: object + properties: + informatieobject: + $ref: '#/components/schemas/EnkelvoudigInformatieObject' ObjectInformatieObjectRequest: type: object properties: From e33795b9d894ca90b6b50fe7d47391a8fd91c077 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Tue, 5 Nov 2024 11:26:55 +0100 Subject: [PATCH 08/36] Misschien diff files later nog nodig --- diff | 0 diff_output.txt | 0 output_diff.txt | Bin 0 -> 58968 bytes 3 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 diff create mode 100644 diff_output.txt create mode 100644 output_diff.txt diff --git a/diff b/diff new file mode 100644 index 000000000..e69de29bb diff --git a/diff_output.txt b/diff_output.txt new file mode 100644 index 000000000..e69de29bb diff --git a/output_diff.txt b/output_diff.txt new file mode 100644 index 0000000000000000000000000000000000000000..14093fce801322ddb9f5788b9b5556ed0056f93f GIT binary patch literal 58968 zcmeI5TW=J}703HIQocbRMkJ9Ffo+TpUiM+d#Vqk=St1r#DN$tkG6u805ZkZ|Nxo7( zVv_%_jt^aZsqUG1dPJH;K%skMRL;MPidMUv^dQXJO?{z`)6eGW7Iyu`kTLQ%hUAp4RHQs+wQx?fK$F*I}`(@6@)f=cl?3 zRsOxcZR@%n>IcV%da@x{hHCFbrH=GuQO}0DI}MmT4e%H)&cB5PwL*VKt$(d}P<&sk z7Y~c?1m}*Rra$y#KlGD+(5rd}*>h2oWZNN-1Nc~sn4x%m&& zF#K-@+QISj;)@OO$%e2S!}CsW9H`W&@Oa<*Xt}3aHzifW(DH(Mf2g~QYvrO^fUcXO zD)d~?|DAL1Lz;_Dq88IStY11tr5QX5zgmq8;#cDh(?b{E4%`vz*H!WCs$dvOm!f6S zuS=4p74h)0w9Iy|ew_}?v9_L0i>~{Zr14jS?)Pt{=C4xoOO;v{{;un9Iq3&`mR|~rm^zDUe@iw5I}2Qg zk^sCGbgjV|{|+qi+u#C?eA;-*FUBw4WBR!+9D~oe&b~G`#5;z&l0T@OPnu$L`gKi^ zz1QC$)PSADOZ!nhJJc1p@hkTA6x{CU*-xSGJE0u+7{dZL~l1j^G}=yX@uL2?JhCTIV+}i>AP`fc-j8Rb^vU(s5m~ zaZ7Jpm9FypRXugz)~I<})aAolt6$L*FV!+~l7g`Q&hG+Nb_29?#czZETGs)1%5mM? ze=Xd-5ic5N)oZo;v?QzxOUB_~YhO4x5!}aTIu@;UtPe5|){Ji#N74j!8XF!;&W|-i z`4o85nxRh{z&X`+tNNkZP8ut7pOAKF%H89dthC7!)I|UIZ$nWO&1QCkZ}c8qm3BF; z)lC|!*h@=ewHy?!OJg4$OJ1wg#mbG+#WEPWx89 z0g7GyaRsMnG1E7Ob7UXu(AUp4yn2sgIj_r(m+|YVG%~(4J&dhTx{tgW+j8DyG`^R> zVV#2X9Nq6+b@u~Dt?OG{Gq{N@dK#wBi?($Pzya-YmGYN9U+SA~*^xBFcKlPN?3$p2 zHpnJ^objyrhpr#ppZz>&a;m<(kff*d0@B*2dz!ZLq(%18sy6q+I1RtAoyxTMP4PqU z|L#jOY^wc(4hUUy@m_sIWd0x81^@i8rA1_q`9DStK$ynFoW}0Vht4G-2NLu(vo2`# zbX^X!jYsFtd?cSwOku{~;yR8__xC2#?Yy0~V_(UJwbRjC_3K071Y3tS^AT)y=5?qs z6Y|x>ic1~iDY(%kjH4K*uM9{_{Z`G8jdmNyN+HtWw|2Lj8gh}K7MP` zkxHLu(9}q6qh*IA&E1cSKPUP>7sh&78`S5ovNo8OHh3Mh(^l}E4>X?k^_h#(4wK62 zb7>KD*^aI@zNyYLG{<Zh?N^i1rEIeU=CLA-&a%y(p3VMT zr1axt@|iemGt3>n3_j9c@V9-%(WTL^CY8%sDzjA1$dkStQi)76UcvTaPus@7$fU{R ztt^jO9srP$Ow*tS|>?6fKQWPYlB?!YATc9zU6nOQO~ zP%`gJGFfY~Ik&FSBr&mh2AFYt9!*Yv2KaLLtq%ilb=kxvMXzTm%u+a;b(qT`h0N&? zF~nLF<4D$bn0F-(j+pLEefJf`wD)>LJ4~{qW=YMGdU4~*r;^X3AepRLztgws+DKb8 zhRyrj%n=RJWO)s9RuK)C!;%uMFm7Zt@`>GLZL@7fck;+)bc5~vBc75Sbv$8hw$0;C zufyKeJBJ}Iov0mRay%N&qkF0?#Zj%*5@qaX9QW8Cch(kh(~NO`Bsez}SyVRfwEMm4xoOFxA@IhSJwE64XT{`V|UF7IvEER|U*C(XD~ zohfwgN^?|>@9m#4NMkRLIHxz_yc||C$M-T1nk^-}uj7oOzOUV8WIwGv<(ES;b9}F7 z+;Xp?e$93=`>oURTXTGGUHbe!OJSD6X-Q#@@BNsy;Vh|HQl}-UIlgziC^M{Smd`Ao z(~?i(7RHV5ohX>re)@M)}d*?j9^Y>{I1TXH{*h50mY=zzr07z@br9l9Qo@Uk}f^YO7&#%b1?-i zZqB$i4O6$)##<#`-7-WrW95(ti&3yse2CrUoP%fjtSbliiq1OdZks(?<@pi)I0S~# zBYo+e=TZe9* z`|)3e*!^lWHW{X&7I`_>RL)Lch;hn3MOq-=#&3TApYTU3N5WznUr>qtjX*~G(3n#= zo(k75g#8#c&Ke*WD7zj`_3>V?E5deQabA)~b5fdJlhjAe15pl2nqH!%Zm7`hM9bP~ z0PMr0w;mlj5Ra3Go%(6rT8N>oN4I;Q>d#-ESr^U~1IoIjbwl}9ePXZZkNSTQaE~@O zc#KBGL!au51fChD_c-JMRD*fG@@<=`AychNsf~^t@ zqvgk~;$ifa>hr+YwH_IAoLvc+-wE`&E&Q|7`?}?F+^OUzeS!BQeUfT1!V3(?P9Xkp4H|=t2kGJE- zucpO0gR8X4`;tpA5JQi5v84~TDz?_xvsXbc@`l;;x{rXb6Z_-f!1qKpWzr#wuh>z} z&tiWJ*7=(Nou8;xhZPTCOC|9MeJ`q=l;$22UI-^?;iUnaTQPh+AG`Cd%l-jh-e=Pm z*U-cYShi>f^D~_5%YB78Uw_Q+ljZB5{a#4=fHb!2&c5vV=ewV<$%TxsewnuBp>Uqh z(m-?f(Kod}`EtZP<+y#b{QX`>T8oW7`pQyivtU^&yY1q5ar-Mde_EJHF>9VrubAeE zQ6yjNpn zd`2og7Rvi*@;;hv&7be;&tq}2G|oyI^FA8aSoLdKgXP(ryz4t&TPE`6<7{HyN0ax_ z)b)?u=Uw3Kc$t;G%=>8aKAM;#vwX(bh`&!7S@3a|lvpQLkdAdF4wR?}?kx73{O!m3 z5Jg*E&%@gz>Wz2X)`LAFmpE-Zw`^T=yvPEpgUtFKD3_@!n9{q~=wps1cO7_{~cn50Qw!7b#BbM7% zcbizry9o|8OMSUwKNywgSS;5R)oa@8&#PN`b?barw>&m7$71DJtTt<%J=a-zt~nMf z$71DJtg2_k-E7vbax7Mp680o}t2q~aRur?|gRNJy&rTxz5TJd4tf{ajgg4W(;y)?zFN zvC3d(@FCZ4w|>c4i#;cIdrWj&)U$J7&RQI6rfxpVS&J`w*5YyFldt#0C;Mmso7o=^ zmGcAV{J`BBs?_Q^KX9Jub#AC$+sDS|8>f&S@s&Am;bensQ8NPNp0ZI!>22pcmA%Aw z^c;)jQ@*8lx{U+DhO{*;Fn>{=@N}oRqZa0s(SJ$jE8J36@LRgS8Z!Lf)U#{)yP+pm zj!e&F*^VRXZBD2PaeT)}lPu_Ol;xZ~E0)WYJQ4XWks zj<<|2-m0%QBh;>cz&JRuQ>U1PvGZZp)k@#~!M2$&hbGQgPp)&IXxmZf<!1zU$NvD9L#g zkJY<<;TzcDc1|g2atx)b=R7sb&_ClQaw`p0lkHKB`)}Wk#~J^@p-)tnZ_o?cvp>~f zh^37)G-7GHrIR+UN!C`?>iE(I1a{UHI8FD3K6L$V@^x?%(4mf$q-y4N8qX&HYee)(2>21o9Oo+6*d zGXs4?gE2RS*NyyBj=2U-ld+xE=sWUTnl|f~|1Q}#9-@AF)hCZliaACPgpEV>i@v-N z+%H3YO9>2FpIlPTmr`lWuL(NGr?*||SI76{dUipzr!iE;G&-X^{V@F&_#pKMvG&Xb(d+06X)ntsc0wX*)_y=`sKf`m|CzZh5mR6O{9MInm`X_)+_! z8J-nq#Jy;h*2j^LdOy?&rw=8WoKW`T86TB3^DWkfb^Tl|nU<}8i35SzE#9hjJ+DR< z?~AY#`noLMO0ldqC$o6n&;cu$j7vS0XMjDa;?sLY>C!@$6z$W4NM)5?ZSvWL*Rm~O z8OQD!ylw4yui|zu#=6n>F5j!#yArPI*_`f~w3klvTL1o-QEe=8gpG|k1}(mJ_8g7r ztIO!!IQ3QJgeKMo9=d6nTzMDs)cOI zU`!=WaZ2N58ocBFLLXM4D!fs8bezX!BZt@0KKOLl4LGgjgQlm_<;9&ZAKaTUAEc=_ zs$5S_o1rLyZ+%{r>Er2YrlLV{uY;?{qjJA}a&0ueWTz>#Cf=_5GI$to#NT+I%x>^D z&-@g;J_)k7h{!SD&`#yE9dh&%e~x;or>uQbo)A8EU8;Pph_gKz_t;3PzNf#`&Rud> zrS6l^p4)-6cB0K+nokcMM)i@~JTB+OQGDo><{#zVlzj1SRbrr@L&Z6`<=pSO=oili e;1$Hb!v|$7nR#kuO?- Date: Thu, 7 Nov 2024 14:29:50 +0100 Subject: [PATCH 09/36] Corrected the folder structure by adding folder 1.6.x --- api-specificatie/drc/{1.5.x => 1.6.x}/1.6.0/openapi.yaml | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename api-specificatie/drc/{1.5.x => 1.6.x}/1.6.0/openapi.yaml (100%) diff --git a/api-specificatie/drc/1.5.x/1.6.0/openapi.yaml b/api-specificatie/drc/1.6.x/1.6.0/openapi.yaml similarity index 100% rename from api-specificatie/drc/1.5.x/1.6.0/openapi.yaml rename to api-specificatie/drc/1.6.x/1.6.0/openapi.yaml From d341dfb2ca548ba5ed9534fc6db8b476690abf3f Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Thu, 7 Nov 2024 15:25:14 +0100 Subject: [PATCH 10/36] Expand path naar zaaktype in Catalogi API relatief gemaakt --- api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml index 9d497bd6e..6166fcca0 100644 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml @@ -14269,7 +14269,8 @@ components: properties: zaaktype: # Onderstaande $ref is goed maar werkt helaas niet in VSC Redoc Viewer, wel in de VSC Swagger viewer. - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' + # $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' hoofdzaak: oneOf: - $ref: '#/components/schemas/ZaakExpanded' From 78cd26bae274cd640ced001e9eed3631c3931087 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Thu, 7 Nov 2024 15:42:12 +0100 Subject: [PATCH 11/36] zaaktypeRelative --- api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml index 6166fcca0..0b069f39f 100644 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml @@ -14267,7 +14267,7 @@ components: description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." properties: - zaaktype: + zaaktypeRelative: # Onderstaande $ref is goed maar werkt helaas niet in VSC Redoc Viewer, wel in de VSC Swagger viewer. # $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' From bbabff8bc800a05aca51b6198f069d14e11bddc3 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Fri, 22 Nov 2024 12:16:47 +0100 Subject: [PATCH 12/36] Alle verwijzingen naar ztc relatief gemaakt --- api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml index 0b069f39f..3c8216ca2 100644 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml @@ -12904,7 +12904,7 @@ components: zaak: $ref: '#/components/schemas/ZaakExpanded' resultaattype: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ResultaatTypeExpanded' + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ResultaatTypeExpanded' Rol: type: object properties: @@ -13233,7 +13233,7 @@ components: $ref: '#/components/schemas/ZaakExpanded' example: {} roltype: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/RolTypeExpanded' + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/RolTypeExpanded' statussen: type: array items: @@ -13519,7 +13519,7 @@ components: type: object properties: statustype: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/StatusTypeExpanded' + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/StatusTypeExpanded' gezetdoor: $ref: '#/components/schemas/Rol' zaakinformatieobjecten: @@ -14267,9 +14267,8 @@ components: description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." properties: - zaaktypeRelative: - # Onderstaande $ref is goed maar werkt helaas niet in VSC Redoc Viewer, wel in de VSC Swagger viewer. - # $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' + zaaktype: + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' hoofdzaak: oneOf: @@ -14462,7 +14461,7 @@ components: - $ref: '#/components/schemas/ZaakExpanded' - $ref: '#/components/schemas/EmptyObject' eigenschap: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/EigenschapExpanded' + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/EigenschapExpanded' ZaakInformatieObject: type: object properties: @@ -14959,7 +14958,7 @@ components: type: object properties: zaakobjecttype: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/ZaakObjectType' + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakObjectType' ZaakVerzoek: type: object properties: From ad7b404ccf2a7137c6118e2fc91a395d150b0d60 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Fri, 22 Nov 2024 15:41:02 +0100 Subject: [PATCH 13/36] Disclaimer-teksten weggehaald omdat het recursieprobleem met expand nu is opgelost. --- api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml | 4 ---- api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml | 20 ------------------- 2 files changed, 24 deletions(-) diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml index 3c8216ca2..3b0e550a9 100644 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml @@ -14264,8 +14264,6 @@ components: $ref: '#/components/schemas/ZaakEmbedded' ZaakEmbedded: type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." properties: zaaktype: @@ -14453,8 +14451,6 @@ components: $ref: '#/components/schemas/ZaakEigenschapEmbedded' ZaakEigenschapEmbedded: type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." properties: zaak: oneOf: diff --git a/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml b/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml index 1832083bc..699a51ac0 100644 --- a/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml +++ b/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml @@ -10941,8 +10941,6 @@ components: $ref: '#/components/schemas/BesluitTypeEmbedded' BesluitTypeEmbedded: type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." properties: catalogus: oneOf: @@ -11606,8 +11604,6 @@ components: $ref: '#/components/schemas/CatalogusEmbedded' CatalogusEmbedded: type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." properties: zaaktypen: type: array @@ -11754,8 +11750,6 @@ components: $ref: '#/components/schemas/EigenschapEmbedded' EigenschapEmbedded: type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." properties: catalogus: oneOf: @@ -12028,8 +12022,6 @@ components: $ref: '#/components/schemas/InformatieObjectTypeEmbedded' InformatieObjectTypeEmbedded: type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." properties: catalogus: oneOf: @@ -13231,8 +13223,6 @@ components: $ref: '#/components/schemas/ResultaatTypeEmbedded' ResultaatTypeEmbedded: type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." properties: catalogus: oneOf: @@ -13773,8 +13763,6 @@ components: $ref: '#/components/schemas/RolTypeEmbedded' RolTypeEmbedded: type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." properties: catalogus: oneOf: @@ -13931,8 +13919,6 @@ components: $ref: '#/components/schemas/StatusTypeEmbedded' StatusTypeEmbedded: type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." properties: catalogus: oneOf: @@ -14116,8 +14102,6 @@ components: $ref: '#/components/schemas/ZaakObjectTypeEmbedded' ZaakObjectTypeEmbedded: type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." properties: zaaktype: oneOf: @@ -14532,8 +14516,6 @@ components: $ref: '#/components/schemas/ZaakTypeEmbedded' ZaakTypeEmbedded: type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." properties: zaakobjecttypen: type: array @@ -15047,8 +15029,6 @@ components: $ref: '#/components/schemas/ZaakTypeInformatieObjectTypeEmbedded' ZaakTypeInformatieObjectTypeEmbedded: type: object - description: "Let op: de definities van onderstaande attributen kunnen recursie bevatten en worden mogelijk niet goed weergegeven in de gegenereerde voorbeeldberichten van Redoc of Swagger. - Check altijd de yaml-specificitie voor correcte interpretatie en gebruik de referentie-implementatie om correcte responsberichten te genereren." properties: zaaktype: oneOf: From 2c26212211bc9e08dbcbf52ec6742863522ea406 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Tue, 26 Nov 2024 10:56:49 +0100 Subject: [PATCH 14/36] Added redocly.yaml config file --- .gitignore | 1 + 1 file changed, 1 insertion(+) diff --git a/.gitignore b/.gitignore index c0cc164f9..d0740c043 100644 --- a/.gitignore +++ b/.gitignore @@ -5,3 +5,4 @@ infra/env/ infra/fixtures/ deploy-bot/env/ zrc-catalogi-1-3-2.yaml +redocly.yaml \ No newline at end of file From b507e71c3b02dafa7aa74751d0f39de9d97954cd Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Tue, 26 Nov 2024 11:42:57 +0100 Subject: [PATCH 15/36] Handmatige merge van PR #2393 (branch Verduidelijken-eigenschappen) --- docs/standaard/catalogi/index.md | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/docs/standaard/catalogi/index.md b/docs/standaard/catalogi/index.md index b5ece7a2b..ca01788f1 100644 --- a/docs/standaard/catalogi/index.md +++ b/docs/standaard/catalogi/index.md @@ -319,6 +319,26 @@ De voorwaarden waaronder een correctie uitgevoerd mag worden zijn: #### Leesrechten Zaken en Documenten ook voor Catalogi ([ztc-014](#ztc-014)) Wanneer de ZRC of DRC met respectievelijk de scopes zaken.lezen of documenten.lezen de ZTC raadplegen moet de provider deze verzoeken behandelen alsof de scope catalogi.lezen gebruikt is. + + Nieuw in versie 1.3.2 + + +#### Datumvelden bij het specificeren van eigenschappen ([ztc-015](#ztc-015)) + +Als het attribuut `eigenschap.specificatie.formaat` de waarde `datum` heeft, dan moet er worden voldaan aan de volgende twee voorwaarden. + +* Het attribuut `eigenschap.specificatie.lengte` is gelijk aan `8`. + +* Het datumveld dat als eigenschap gedefinieerd is voldoet aan het formaat "YYYYMMDD", bijvoorbeeld `20220728` (in ISO-notatie `2022-07-28`). + +Als het attribuut `eigenschap.specificatie.formaat` de waarde `datum-tijd` heeft, dan moet er worden voldaan aan de volgende twee voorwaarden. + +* Het attribuut `eigenschap.specificatie.lengte` is gelijk aan `14`. + +* Het datumtijdveld dat als eigenschap gedefinieerd is voldoet aan het formaat "YYYYMMDDhhmmss", bijvoorbeeld `20220728134022` (in ISO-notatie `2022-07-28T13:40:22`). + +Let op: Bij het specificeren van custom eigenschappen voor een zaakobject wijkt het formaat van datumvelden af ten op zichte van de reguliere attributen van een zaakobject. In het reguliere geval wordt het standaard ISO-formaat gevolgd. In de toekomst hopen we deze inconsistentie op te lossen, maar voor nu hebben we te maken met deze legacy uit het [ImZTC](https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/eigenschap.specificatie_van_eigenschap.lengte). + ## Overige documentatie From b61aeb00401e5dc8fcb9cc324410201c10843161 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Tue, 26 Nov 2024 14:49:15 +0100 Subject: [PATCH 16/36] countExact toegevoegd conform PR #2484 en issue #2284 aan zaken endpoint --- api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml index 3b0e550a9..a7c1538b7 100644 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml @@ -6526,6 +6526,15 @@ paths: description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle ZAAKen opvragen. parameters: + - name: countExact + required: false + in: query + description: Geeft aan of de `count` van de resultaten exact moet zijn, of dat deze wegens performance doeleinden niet exact hoeft te worden berekend. + schema: + type: boolean + default: true + example: false + deprecated: true - name: identificatie required: false in: query @@ -11987,7 +11996,13 @@ components: properties: count: type: integer + deprecated: true example: 123 + countExact: + description: Geeft aan of de `count` exact is, of dat deze wegens performance doeleinden niet exact berekend is. + type: boolean + deprecated: true + example: false next: type: string nullable: true From 713d1442b5c5aa87f55739007454ea61ead3a486 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Fri, 29 Nov 2024 13:12:09 +0100 Subject: [PATCH 17/36] PR #2470 (n.a.v. issue #2456) handmatig doorgevoerd --- docs/standaard/catalogi/index.md | 29 +++++++++++------------------ 1 file changed, 11 insertions(+), 18 deletions(-) diff --git a/docs/standaard/catalogi/index.md b/docs/standaard/catalogi/index.md index ca01788f1..19c151531 100644 --- a/docs/standaard/catalogi/index.md +++ b/docs/standaard/catalogi/index.md @@ -184,32 +184,25 @@ Bovendien gelden er beperkingen op verdere acties die uitgevoerd kunnen worden o * deels bijgewerkt worden (PATCH), m.u.v. het bijwerken van enkel het attribuut `eindeGeldigheid` of een ([correctie](#correctie)) * verwijderd worden (DELETE) -* Beperkingen voor objecttypen gerelateerd aan een objecttype met `concept=false` **([ztc-010](#ztc-010))**: - * - Aangepast in versie 1.2.0 -
- - Het objecttype mag NIET: - * geheel bijgewerkt worden (PUT) m.u.v een ([correctie](#correctie)) - * deels bijgewerkt worden (PATCH) of een ([correctie](#correctie)) - * verwijderd worden (DELETE) - * Voor `ZaakType-InformatieObjectType` gelden bovenstaande regels **(ztc-010)** alleen in het geval waarbij zowel het `ZaakType` - als het `InformatieObjectType` `concept=False` hebben +* Aangepast in versie 1.2.0
Beperkingen voor de volgende objecttypen: Roltype, Statustype, Eigenschap, Zaaktype-Informatieobjecttype, Resultaattype en Zaakobjecttype **([ztc-010](#ztc-010))**. Als een van deze objecttypen, aangeduid met `x`, gerelateerd is aan een `zaaktype` met `concept=false`, dan mag objecttype `x` NIET: + * aangemaakt worden (POST) met uitzondering van een [correctie](#correctie). + * geheel bijgewerkt worden (PUT) met uitzondering van een [correctie](#correctie). + * deels bijgewerkt worden (PATCH) met uitzondering van een [correctie](#correctie). + * verwijderd worden (DELETE). - * - Aangepast in versie 1.3.0 -
- +* + Aangepast in versie 1.3.0
~~* Beperkingen die gelden voor objecttypen die NIET gerelateerd zijn aan een objecttype met `concept=false` **([ztc-011](#ztc-011))**: * Er mag GEEN nieuw objecttype aangemaakt worden met een relatie naar een objecttype met `concept=false` (create) * Er mag GEEN nieuwe relatie worden gelegd tussen een objecttype en een objecttype met `concept=false` (update, partial_update) * Voor `ZaakType-InformatieObjectType` gelden bovenstaande regels **(ztc-011)** alleen in het geval waarbij zowel het `ZaakType` als het `InformatieObjectType` `concept=False` hebben~~ -* - Nieuw in versie 1.3.0 -
+ + Nieuw in versie 1.3.0 +
+
[![Historiemodel Catalogi API ImZTC 2.2](catalogi_history.png)](catalogi_history.png "Historiemodel Calogi API ImZTC versie 2.2 - klik voor groot") From 429821e796e6e932f91011836c35956b03221a65 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Mon, 10 Feb 2025 13:53:27 +0100 Subject: [PATCH 18/36] Add release notes for Zaken, Catalogi, and Documenten APIs in version updates --- docs/standaard/release_notes.md | 34 +++++++++++++++++++++++++++++++++ 1 file changed, 34 insertions(+) create mode 100644 docs/standaard/release_notes.md diff --git a/docs/standaard/release_notes.md b/docs/standaard/release_notes.md new file mode 100644 index 000000000..a0cc21a92 --- /dev/null +++ b/docs/standaard/release_notes.md @@ -0,0 +1,34 @@ +# Release Notes + +## Zaken API (`zrc 1.5.2`) + +- **Oplossen fouten in OAS m.b.t. expand** + + N.a.v. de volgende issues: + + - #2412: Wat is de bedoeling bij _expand bij anderzaakobject in ZRC 1.5? + + - #2414: ZRC 1.5 laat (onterecht) _expand zien op rol. + + In de resources rollen en zaakobjecten komt het attribuut _expand (onterecht) voor. Dit is verwarrend want dit attribuut kan alleen indirect gebruikt worden via de zaken resource. Dit attribuut is verwijderd daar waar het niet van toepassing is. Deze correctie heeft geen functionele gevolgen. + +- **Geneste expansion naar ztc expliciet zichtbaar gemaakt in de OAS** + + Hiervoor was het geneste expansie-mechanisme textueel beschreven maar niet formeel gemodelleerd in de OAS. + + +## Catalogi API (`ztc 1.3.2`) + +- **Geneste expansion toegevoegd aan Catalogi API** + + Zie ook Zaken API. + +- **Aanscherping specificatie eigenschappen met datumvelden** + + Regel `zt-015` toegevoegd aan de aanvullende specificatie naar aanleiding van issue #1751 (As a developer, I want to have standardized schema descriptions for eigenschappen). + +## Documenten API (`drc 1.6.0`) + +- **Expand toegevoegd aan ObjectInformatieObject** + + Zie issues #1891 en #2370 waar de wens wordt geuit om in de Documenten API (DRC) de resource objectinformatiobjecten te kunnen expanden op het veld "informatieobject". \ No newline at end of file From 5bde0fd60e8e4a2d707ab240621d7c585f27ce39 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Mon, 10 Feb 2025 16:51:07 +0100 Subject: [PATCH 19/36] Revert "countExact toegevoegd conform PR #2484 en issue #2284 aan zaken endpoint" This reverts commit b61aeb00401e5dc8fcb9cc324410201c10843161. --- api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml index a7c1538b7..3b0e550a9 100644 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml @@ -6526,15 +6526,6 @@ paths: description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle ZAAKen opvragen. parameters: - - name: countExact - required: false - in: query - description: Geeft aan of de `count` van de resultaten exact moet zijn, of dat deze wegens performance doeleinden niet exact hoeft te worden berekend. - schema: - type: boolean - default: true - example: false - deprecated: true - name: identificatie required: false in: query @@ -11996,13 +11987,7 @@ components: properties: count: type: integer - deprecated: true example: 123 - countExact: - description: Geeft aan of de `count` exact is, of dat deze wegens performance doeleinden niet exact berekend is. - type: boolean - deprecated: true - example: false next: type: string nullable: true From ebb396e05795a52d9373294000d923deece4c8c0 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Mon, 10 Feb 2025 16:52:27 +0100 Subject: [PATCH 20/36] Update release notes for Catalogi and Documenten APIs with clarifications and issue references --- docs/standaard/release_notes.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/standaard/release_notes.md b/docs/standaard/release_notes.md index a0cc21a92..e6fc80c5d 100644 --- a/docs/standaard/release_notes.md +++ b/docs/standaard/release_notes.md @@ -16,7 +16,6 @@ Hiervoor was het geneste expansie-mechanisme textueel beschreven maar niet formeel gemodelleerd in de OAS. - ## Catalogi API (`ztc 1.3.2`) - **Geneste expansion toegevoegd aan Catalogi API** @@ -25,10 +24,17 @@ - **Aanscherping specificatie eigenschappen met datumvelden** - Regel `zt-015` toegevoegd aan de aanvullende specificatie naar aanleiding van issue #1751 (As a developer, I want to have standardized schema descriptions for eigenschappen). + Regel `zt-015` toegevoegd aan de aanvullende specificatie naar aanleiding van het volgende issue: + + - #1751: As a developer, I want to have standardized schema descriptions for eigenschappen. +- **Verheldering en aanscherping rule ztc-010** + + Naar aanleiding van issue [#2456](https://github.com/VNG-Realisatie/gemma-zaken/issues/2456) (Business rule ztc-010 herschrijven). + ## Documenten API (`drc 1.6.0`) - **Expand toegevoegd aan ObjectInformatieObject** - Zie issues #1891 en #2370 waar de wens wordt geuit om in de Documenten API (DRC) de resource objectinformatiobjecten te kunnen expanden op het veld "informatieobject". \ No newline at end of file + Zie issues #1891 en #2370 waar de wens wordt geuit om in de Documenten API (DRC) de resource objectinformatiobjecten te kunnen expanden op het veld "informatieobject". + \ No newline at end of file From 35f11c3ba091f7f225bec495872436b6d8836c3b Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Wed, 12 Feb 2025 15:26:14 +0100 Subject: [PATCH 21/36] recursieve expansie uitgeschakeld in kopie openapi_fast.yaml --- .../zrc/1.5.x/1.5.2/openapi_fast.yaml | 15983 ++++++++++++++++ 1 file changed, 15983 insertions(+) create mode 100644 api-specificatie/zrc/1.5.x/1.5.2/openapi_fast.yaml diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi_fast.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi_fast.yaml new file mode 100644 index 000000000..c1bb33995 --- /dev/null +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi_fast.yaml @@ -0,0 +1,15983 @@ +openapi: 3.0.3 +info: + title: Zaken API + version: 1.5.2 + description: " Met expand mechanisme in plain json + + + Een API om een zaakregistratiecomponent (ZRC) te benaderen. + + + De ZAAK is het kernobject in deze API, waaraan verschillende andere + + resources gerelateerd zijn. De Zaken API werkt samen met andere API's voor + + Zaakgericht werken om tot volledige functionaliteit te komen. + + + **Wat is nieuw?** + + * Query parameters en zoekvelden voor archivering. + + + **Afhankelijkheden** + + + Deze API is afhankelijk van: + + + * Catalogi API + + * Notificaties API + + * Documenten API *(optioneel)* + + * Besluiten API *(optioneel)* + + * Autorisaties API *(optioneel)* + + + **Autorisatie** + + + Deze API vereist autorisatie. Je kan de + + [token-tool](https://zaken-auth.vng.cloud/) gebruiken om JWT-tokens te + + genereren. + + + ### Notificaties + + + Deze API publiceert notificaties op het kanaal `zaken`. + + + **Main resource** + + + `zaak` + + + + + **Kenmerken** + + + * `bronorganisatie`: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers en voldoen + aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + + * `zaaktype`: URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS + waar deze voorkomt + + * `vertrouwelijkheidaanduiding`: Aanduiding van de mate waarin het zaakdossier + van de ZAAK voor de openbaarheid bestemd is. + + + **Resources en acties** + + - `zaak`: create, update, destroy + + - `status`: create + + - `zaakobject`: create, update, destroy + + - `zaakinformatieobject`: create + + - `zaakeigenschap`: create, update, destroy + + - `klantcontact`: create + + - `rol`: create, destroy + + - `resultaat`: create, update, destroy + + - `zaakbesluit`: create + + - `zaakcontactmoment`: create + + - `zaakverzoek`: create + + + + **Handige links** + + + * [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard) + + * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken) + + " + contact: + email: standaarden.ondersteuning@vng.nl + url: https://vng-realisatie.github.io/gemma-zaken + license: + name: EUPL 1.2 + url: https://opensource.org/licenses/EUPL-1.2 +paths: + /klantcontacten: + get: + operationId: klantcontact_list + description: 'Alle KLANTCONTACTen opvragen. + + + **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' + summary: 'Alle KLANTCONTACTen opvragen. ' + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - klantcontacten + security: + - JWT-Claims: + - zaken.lezen + deprecated: true + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedKlantContactList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: klantcontact_create + description: + 'Indien geen identificatie gegeven is, dan wordt deze automatisch + gegenereerd. + + + **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' + summary: Maak een KLANTCONTACT bij een ZAAK aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - klantcontacten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KlantContact' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + deprecated: true + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/KlantContact' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /klantcontacten/{uuid}: + get: + operationId: klantcontact_retrieve + description: 'Een specifieke KLANTCONTACT opvragen. + + + **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' + summary: Een specifieke KLANTCONTACT opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - klantcontacten + security: + - JWT-Claims: + - zaken.lezen + deprecated: true + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/KlantContact' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /resultaten: + get: + operationId: resultaat_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle RESULTAATen van ZAAKen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: resultaattype + required: false + in: query + description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API). + schema: + type: string + format: uri + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - resultaten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedResultaatList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: resultaat_create + description: '**Er wordt gevalideerd op:** + + - geldigheid URL naar de ZAAK + + - geldigheid URL naar het RESULTAATTYPE' + summary: Maak een RESULTAAT bij een ZAAK aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - resultaten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /resultaten/{uuid}: + get: + operationId: resultaat_retrieve + description: Een specifieke RESULTAAT opvragen. + summary: Een specifieke RESULTAAT opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - resultaten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: resultaat_update + description: + "**Er wordt gevalideerd op** \n- geldigheid URL naar de ZAAK\n\ + - het RESULTAATTYPE mag niet gewijzigd worden" + summary: Werk een RESULTAAT in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - resultaten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: resultaat_partial_update + description: + "**Er wordt gevalideerd op** \n- geldigheid URL naar de ZAAK\n\ + - het RESULTAATTYPE mag niet gewijzigd worden" + summary: Werk een RESULTAAT deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - resultaten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedResultaat' + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: resultaat_destroy + description: Verwijder een RESULTAAT van een ZAAK. + summary: Verwijder een RESULTAAT van een ZAAK. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - resultaten + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: resultaat_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) RESULTAAT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - resultaten + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /rollen: + get: + operationId: rol_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle ROLlen bij ZAAKen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: betrokkene + required: false + in: query + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + schema: + type: string + format: uri + - name: betrokkeneType + required: false + in: query + description: Type van de `betrokkene`. + schema: + type: string + enum: + - natuurlijk_persoon + - niet_natuurlijk_persoon + - vestiging + - organisatorische_eenheid + - medewerker + - name: betrokkeneIdentificatie__natuurlijkPersoon__inpBsn + required: false + in: query + description: + Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene + bepalingen burgerservicenummer. + schema: + type: string + - name: betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie + required: false + in: query + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NATUURLIJK PERSOON + schema: + type: string + - name: betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer + required: false + in: query + description: Het administratienummer van de persoon, bedoeld in de Wet BRP + schema: + type: string + - name: betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId + required: false + in: query + description: + Het door een kamer toegekend uniek nummer voor de INGESCHREVEN + NIET-NATUURLIJK PERSOON + schema: + type: string + - name: betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie + required: false + in: query + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NIET-NATUURLIJK PERSOON + schema: + type: string + - name: betrokkeneIdentificatie__vestiging__vestigingsNummer + required: false + in: query + description: Een korte unieke aanduiding van de Vestiging. + schema: + type: string + - name: betrokkeneIdentificatie__organisatorischeEenheid__identificatie + required: false + in: query + description: Een korte identificatie van de organisatorische eenheid. + schema: + type: string + - name: betrokkeneIdentificatie__medewerker__identificatie + required: false + in: query + description: Een korte unieke aanduiding van de MEDEWERKER. + schema: + type: string + - name: roltype + required: false + in: query + description: URL-referentie naar een roltype binnen het ZAAKTYPE van de ZAAK. + schema: + type: string + format: uri + - name: omschrijving + required: false + in: query + description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. + schema: + type: string + - name: omschrijvingGeneriek + required: false + in: query + description: + Algemeen gehanteerde benaming van de aard van de ROL, afgeleid + uit het ROLTYPE. + schema: + type: string + enum: + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - rollen + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRolList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: rol_create + description: Maak een ROL aan bij een ZAAK. + summary: Maak een ROL aan bij een ZAAK. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - rollen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Rol' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Rol' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /rollen/{uuid}: + get: + operationId: rol_retrieve + description: Een specifieke ROL bij een ZAAK opvragen. + summary: Een specifieke ROL bij een ZAAK opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - rollen + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Rol' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: rol_destroy + description: Verwijder een ROL van een ZAAK. + summary: Verwijder een ROL van een ZAAK. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - rollen + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: rol_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ROL opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - rollen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /statussen: + get: + operationId: status_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle STATUSsen bij ZAAKen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: statustype + required: false + in: query + description: URL-referentie naar het STATUSTYPE (in de Catalogi API). + schema: + type: string + format: uri + - name: indicatieLaatstGezetteStatus + required: false + in: query + description: + Het gegeven is afleidbaar uit de historie van de attribuutsoort + Datum status gezet van van alle statussen bij de desbetreffende zaak. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - statussen + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedStatusList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: status_create + description: '**Er wordt gevalideerd op** + + - geldigheid URL naar de ZAAK + + - geldigheid URL naar het STATUSTYPE + + - indien het de eindstatus betreft, dan moet het attribuut `indicatieGebruiksrecht` + gezet zijn op alle informatieobjecten dieaan de zaak gerelateerd zijn + + + **Opmerkingen** + + - Indien het statustype de eindstatus is (volgens het ZTC), dan wordt de zaak + afgesloten door de einddatum te zetten.' + summary: Maak een STATUS aan voor een ZAAK. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - statussen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Status' + required: true + security: + - JWT-Claims: + - (zaken.aanmaken | zaken.statussen.toevoegen | zaken.heropenen) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/StatusRequestbody' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /statussen/{uuid}: + get: + operationId: status_retrieve + description: Een specifieke STATUS van een ZAAK opvragen. + summary: Een specifieke STATUS van een ZAAK opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - statussen + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Status' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: status_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) STATUS opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - statussen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaakcontactmomenten: + get: + operationId: zaakcontactmoment_list + description: Alle ZAAKCONTACTMOMENTen opvragen. + summary: Alle ZAAKCONTACTMOMENTen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: contactmoment + required: false + in: query + description: + URL-referentie naar het CONTACTMOMENT (in de Klantinteractie + API) + schema: + type: string + format: uri + tags: + - zaakcontactmomenten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ZaakContactMoment' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakcontactmoment_create + description: '**Er wordt gevalideerd op:** + + - geldigheid URL naar het CONTACTMOMENT' + summary: Maak een ZAAKCONTACTMOMENT aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakcontactmomenten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakContactMoment' + required: true + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakContactMoment' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaakcontactmomenten/{uuid}: + get: + operationId: zaakcontactmoment_retrieve + description: Een specifiek ZAAKCONTACTMOMENT opvragen. + summary: 'Een specifiek ZAAKCONTACTMOMENT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - zaakcontactmomenten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakContactMoment' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakcontactmoment_destroy + description: Verwijder een ZAAKCONTACTMOMENT. + summary: Verwijder een ZAAKCONTACTMOMENT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakcontactmomenten + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaakinformatieobjecten: + get: + operationId: zaakinformatieobject_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: 'Alle ZAAK-INFORMATIEOBJECT relaties opvragen ' + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: informatieobject + required: false + in: query + description: + URL-referentie naar het INFORMATIEOBJECT (in de Documenten API), + waar ook de relatieinformatie opgevraagd kan worden. + schema: + type: string + format: uri + tags: + - zaakinformatieobjecten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ZaakInformatieObject' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakinformatieobject_create + description: + "Maak een ZAAK-INFORMATIEOBJECT relatie aan.\n\n**Er wordt gevalideerd\ + \ op**\n- geldigheid zaak URL\n- geldigheid informatieobject URL\n- `zaak.archiefstatus`\ + \ moet gelijk zijn aan 'nog_te_archiveren' \n- de combinatie informatieobject\ + \ en zaak moet uniek zijn\n\n**Opmerkingen**\n- De registratiedatum wordt\ + \ door het systeem op 'NU' gezet. De `aardRelatie` wordt ook door het systeem\ + \ gezet.\n- Bij het aanmaken wordt ook in de Documenten API de gespiegelde\ + \ relatie aangemaakt, echter zonder de relatie-informatie.\n" + summary: Maak een ZAAK-INFORMATIEOBJECT relatie aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakinformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + required: true + security: + - JWT-Claims: + - (zaken.aanmaken | zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaakinformatieobjecten/{uuid}: + get: + operationId: zaakinformatieobject_retrieve + description: Een specifieke ZAAK-INFORMATIEOBJECT relatie opvragen. + summary: Een specifieke ZAAK-INFORMATIEOBJECT relatie opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaakinformatieobjecten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaakinformatieobject_update + description: + "Je mag enkel de gegevens van de relatie bewerken, en niet de relatie\ + \ zelf aanpassen.\n\n**Er wordt gevalideerd op** \n- informatieobject URL\ + \ en zaak URL mogen niet veranderen" + summary: Werk een ZAAK-INFORMATIEOBJECT relatie in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakinformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaakinformatieobject_partial_update + description: + "Je mag enkel de gegevens van de relatie bewerken, en niet de relatie\ + \ zelf aanpassen.\n\n**Er wordt gevalideerd op** \n- informatieobject URL\ + \ en zaak URL mogen niet veranderen" + summary: Werk een ZAAK-INFORMATIEOBJECT relatie deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakinformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedZaakInformatieObject' + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakinformatieobject_destroy + description: + De gespiegelde relatie in de Documenten API wordt door de Zaken + API verwijderd. Consumers kunnen dit niet handmatig doen. + summary: Verwijder een ZAAK-INFORMATIEOBJECT relatie. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakinformatieobjecten + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken | zaken.verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaakinformatieobject_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAKINFORMATIEOBJECT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaakinformatieobjecten + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaakobjecten: + get: + operationId: zaakobject_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle ZAAKOBJECTen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: object + required: false + in: query + description: URL-referentie naar de resource die het OBJECT beschrijft. + schema: + type: string + format: uri + - name: objectType + required: false + in: query + description: + Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er geen + passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. + schema: + type: string + enum: + - adres + - besluit + - buurt + - enkelvoudig_document + - gemeente + - gemeentelijke_openbare_ruimte + - huishouden + - inrichtingselement + - kadastrale_onroerende_zaak + - kunstwerkdeel + - maatschappelijke_activiteit + - medewerker + - natuurlijk_persoon + - niet_natuurlijk_persoon + - openbare_ruimte + - organisatorische_eenheid + - pand + - spoorbaandeel + - status + - terreindeel + - terrein_gebouwd_object + - vestiging + - waterdeel + - wegdeel + - wijk + - woonplaats + - woz_deelobject + - woz_object + - woz_waarde + - zakelijk_recht + - overige + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - zaakobjecten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedZaakObjectList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakobject_create + description: 'Maak een ZAAKOBJECT aan. + + + **Er wordt gevalideerd op** + + - Indien de `object` URL opgegeveven is, dan moet deze een geldige response + (HTTP 200) geven. + + - Indien opgegeven, dan wordt `objectIdentificatie` gevalideerd tegen de `objectType` + discriminator.' + summary: Maak een ZAAKOBJECT aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + required: true + security: + - JWT-Claims: + - (zaken.aanmaken | zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaakobjecten/{uuid}: + get: + operationId: zaakobject_retrieve + description: Een specifieke ZAAKOBJECT opvragen. + summary: Een specifieke ZAAKOBJECT opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaakobjecten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaakobject_update + description: + "**Er wordt gevalideerd op** \n- De attributen `zaak`, `object`\ + \ en `objectType` mogen niet gewijzigd worden.\n- Indien opgegeven, dan wordt\ + \ `objectIdentificatie` gevalideerd tegen de objectType discriminator." + summary: Werk een ZAAKOBJECT zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaakobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaakobject_partial_update + description: + "**Er wordt gevalideerd op** \n- De attributen `zaak`, `object`\ + \ en `objectType` mogen niet gewijzigd worden.\n- Indien opgegeven, dan wordt\ + \ `objectIdentificatie` gevalideerd tegen de objectType discriminator." + summary: Werk een ZAAKOBJECT deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaakobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedZaakObject' + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakobject_destroy + description: + Verbreek de relatie tussen een ZAAK en een OBJECT door de ZAAKOBJECT + resource te verwijderen. + summary: Verwijder een ZAAKOBJECT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - zaakobjecten + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken | zaken.verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaakobject_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAKOBJECT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaakobjecten + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaakverzoeken: + get: + operationId: zaakverzoek_list + description: Alle ZAAK-VERZOEKen opvragen. + summary: Alle ZAAK-VERZOEKen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: verzoek + required: false + in: query + description: URL-referentie naar het VERZOEK (in de Klantinteractie API) + schema: + type: string + format: uri + tags: + - zaakverzoeken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ZaakVerzoek' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakverzoek_create + description: '**Er wordt gevalideerd op** + + - geldigheid URL naar de VERZOEK' + summary: Maak een ZAAK-VERZOEK aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakverzoeken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakVerzoek' + required: true + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakVerzoek' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaakverzoeken/{uuid}: + get: + operationId: zaakverzoek_retrieve + description: Een specifieke ZAAK-VERZOEK opvragen. + summary: Een specifieke ZAAK-VERZOEK opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - zaakverzoeken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakVerzoek' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakverzoek_destroy + description: Verwijder een ZAAK-VERZOEK. + summary: Verwijder een ZAAK-VERZOEK. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakverzoeken + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken: + get: + operationId: zaak_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle ZAAKen opvragen. + parameters: + - name: identificatie + required: false + in: query + description: + De unieke identificatie van de ZAAK binnen de organisatie die + verantwoordelijk is voor de behandeling van de ZAAK. + schema: + type: string + example: "zaak123" + - name: bronorganisatie + required: false + in: query + description: + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers + en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + schema: + type: string + example: "000000000" + - name: bronorganisatie__in + required: false + in: query + description: Multiple values may be separated by commas. + schema: + type: array + items: + type: string + example: ["000000000","479559740","875883461"] + style: form + explode: false + - name: zaaktype + required: false + in: query + description: + URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS + waar deze voorkomt + schema: + type: string + format: uri + example: "https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/e80b7507-199a-484c-ad49-c41a1e43a6e7" + - name: archiefnominatie + required: false + in: query + description: + Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + schema: + type: string + enum: + - blijvend_bewaren + - vernietigen + example: "blijvend_bewaren" + - name: archiefnominatie__in + required: false + in: query + description: Multiple values may be separated by commas. + schema: + type: array + items: + type: string + example: ["blijvend_bewaren", "vernietigen"] + style: form + explode: false + - name: archiefactiedatum + required: false + in: query + description: + De datum waarop het gearchiveerde zaakdossier vernietigd moet + worden dan wel overgebracht moet worden naar een archiefbewaarplaats. Wordt + automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT aan + deze ZAAK indien nog leeg. + schema: + type: string + example: "2019-01-02" + - name: archiefactiedatum__isnull + required: false + in: query + description: De archiefactiedatum is leeg. + schema: + type: boolean + example: false + - name: archiefactiedatum__lt + required: false + in: query + description: De archiefactiedatum is kleiner dan de opgegeven datum. + schema: + type: string + example: "2020-01-02" + - name: archiefactiedatum__gt + required: false + in: query + description: De archiefactiedatum is groter dan de opgegeven datum. + schema: + type: string + example: "2018-01-02" + - name: archiefstatus + required: false + in: query + description: + Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + schema: + type: string + enum: + - nog_te_archiveren + - gearchiveerd + - gearchiveerd_procestermijn_onbekend + - overgedragen + example: "nog_te_archiveren" + - name: archiefstatus__in + required: false + in: query + description: Multiple values may be separated by commas. + schema: + type: array + items: + type: string + example: ["nog_te_archiveren","gearchiveerd","gearchiveerd_procestermijn_onbekend","overgedragen"] + style: form + explode: false + - name: startdatum + required: false + in: query + description: De datum waarop met de uitvoering van de zaak is gestart + schema: + type: string + example: "2017-01-02" + - name: startdatum__gt + required: false + in: query + description: De startdatum is groter dan de opgegeven datum. + schema: + type: string + example: "2018-01-02" + - name: startdatum__gte + required: false + in: query + description: De startdatum is groter dan of gelijk dan de opgegeven datum. + schema: + type: string + example: "2016-01-02" + - name: startdatum__lt + required: false + in: query + description: De startdatum is kleiner dan de opgegeven datum. + schema: + type: string + example: "2018-01-02" + - name: startdatum__lte + required: false + in: query + description: De startdatum is kleiner of gelijk dan de opgegeven datum. + schema: + type: string + example: "2018-01-02" + - name: registratiedatum + required: false + in: query + description: + De datum waarop de zaakbehandelende organisatie de ZAAK heeft + geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag + gebruikt. + schema: + type: string + example: "2015-01-02" + - name: registratiedatum__gt + required: false + in: query + description: + De registratiedatum is groter dan de opgegeven datum. + schema: + type: string + example: "2014-01-02" + - name: registratiedatum__lt + required: false + in: query + description: + De registratiedatum is kleiner dan de opgegeven datum. + schema: + type: string + example: "2016-01-02" + - name: einddatum + required: false + in: query + description: De datum waarop de uitvoering van de zaak afgerond is. + schema: + type: string + example: "2022-01-02" + - name: einddatum__isnull + required: false + in: query + description: De einddatum is leeg. + schema: + type: boolean + example: false + - name: einddatum__gt + required: false + in: query + description: De einddatum is groter dan de opgegeven datum. + schema: + type: string + example: "2021-01-02" + - name: einddatum__lt + required: false + in: query + description: De einddatum is kleiner dan de opgegeven datum. + schema: + type: string + example: "2023-01-02" + - name: einddatumGepland + required: false + in: query + description: + De datum waarop volgens de planning verwacht wordt dat de zaak + afgerond wordt. + schema: + type: string + example: "2022-01-02" + - name: einddatumGepland__gt + required: false + in: query + description: + De geplande einddatum is groter dan de opgegeven datum. + schema: + type: string + example: "2021-01-02" + - name: einddatumGepland__lt + required: false + in: query + description: + De geplande einddatum is kleiner dan de opgegeven datum. + schema: + type: string + example: "2024-01-02" + - name: uiterlijkeEinddatumAfdoening + required: false + in: query + description: + De laatste datum waarop volgens wet- en regelgeving de zaak afgerond + dient te zijn. + schema: + type: string + example: "2024-01-02" + - name: uiterlijkeEinddatumAfdoening__gt + required: false + in: query + description: + De uiterlijke einddatumafdoening is groter dan de opgegeven datum. + schema: + type: string + example: "2023-01-02" + - name: uiterlijkeEinddatumAfdoening__lt + required: false + in: query + description: + De uiterlijke einddatumafdoening is kleiner dan de opgegeven datum. + schema: + type: string + example: "2025-01-02" + - name: rol__betrokkeneType + required: false + in: query + description: Type van de `betrokkene`. + schema: + type: string + enum: + - natuurlijk_persoon + - niet_natuurlijk_persoon + - vestiging + - organisatorische_eenheid + - medewerker + example: "natuurlijk_persoon" + - name: rol__betrokkene + required: false + in: query + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + schema: + type: string + format: uri + example: "https://example.com" + - name: rol__omschrijvingGeneriek + required: false + in: query + description: + Algemeen gehanteerde benaming van de aard van de ROL, afgeleid + uit het ROLTYPE. + schema: + type: string + enum: + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator + example: "initiator" + - name: maximaleVertrouwelijkheidaanduiding + required: false + in: query + description: + Zaken met een vertrouwelijkheidaanduiding die beperkter is dan + de aangegeven aanduiding worden uit de resultaten gefiltered. + schema: + type: string + enum: + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim + example: "zaakvertrouwelijk" + - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn + required: false + in: query + description: + Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene + bepalingen burgerservicenummer. + schema: + type: string + maxLength: 9 + example: "123456789" + - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie + required: false + in: query + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NATUURLIJK PERSOON + schema: + type: string + maxLength: 17 + example: "123456789" + - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer + required: false + in: query + description: Het administratienummer van de persoon, bedoeld in de Wet BRP + schema: + type: string + maxLength: 10 + example: "123456789" + - name: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId + required: false + in: query + description: + Het door een kamer toegekend uniek nummer voor de INGESCHREVEN + NIET-NATUURLIJK PERSOON + schema: + type: string + example: "123456789" + - name: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie + required: false + in: query + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NIET-NATUURLIJK PERSOON + schema: + type: string + maxLength: 17 + example: "123456789" + - name: rol__betrokkeneIdentificatie__vestiging__vestigingsNummer + required: false + in: query + description: Een korte unieke aanduiding van de Vestiging. + schema: + type: string + maxLength: 24 + example: "123456789" + - name: rol__betrokkeneIdentificatie__medewerker__identificatie + required: false + in: query + description: Een korte unieke aanduiding van de MEDEWERKER. + schema: + type: string + maxLength: 24 + example: "123456789" + - name: rol__betrokkeneIdentificatie__organisatorischeEenheid__identificatie + required: false + in: query + description: Een korte identificatie van de organisatorische eenheid. + schema: + type: string + example: "123456789" + - name: expand + in: query + description: Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt. + schema: + type: string + example: zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype + - name: ordering + required: false + in: query + description: Het veld waarop de resultaten geordend worden. Het minnetje betekent omgekeerde volgorde. + schema: + type: array + items: + type: string + enum: + - startdatum + - -startdatum + - einddatum + - -einddatum + - publicatiedatum + - -publicatiedatum + - archiefactiedatum + - -archiefactiedatum + - registratiedatum + - -registratiedatum + - identificatie + - -identificatie + example: "-startdatum" + style: form + explode: false + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + example: 1 + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedZaakList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaak_create + description: + 'Indien geen identificatie gegeven is, dan wordt deze automatisch + gegenereerd. De identificatie moet uniek zijn binnen de bronorganisatie. + + + **Er wordt gevalideerd op:** + + - geldigheid `zaaktype` URL - de resource moet opgevraagd kunnen worden uit + de Catalogi API en de vorm van een ZAAKTYPE hebben. + + - `zaaktype` is geen concept (`zaaktype.concept = False`) + + - `laatsteBetaaldatum` mag niet in de toekomst liggen. + + - `laatsteBetaaldatum` mag niet gezet worden als de betalingsindicatie "nvt" + is. + + - `barchiefnominatie` moet een waarde hebben indien archiefstatus niet de + waarde "nog_te_archiveren" heeft. + + - `archiefactiedatum` moet een waarde hebben indien archiefstatus niet de + waarde "nog_te_archiveren" heeft. + + - `archiefstatus` kan alleen een waarde anders dan "nog_te_archiveren" hebben + indien van alle gerelateeerde INFORMATIEOBJECTen het attribuut `status` de + waarde "gearchiveerd" heeft.' + summary: Maak een ZAAK aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Zaak' + required: true + security: + - JWT-Claims: + - zaken.aanmaken + responses: + '201': + headers: + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Zaak' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{uuid}: + get: + operationId: zaak_retrieve + description: Een specifieke ZAAK opvragen. + summary: Een specifieke ZAAK opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + - name: expand + in: query + description: Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt. + schema: + type: string + example: zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaak_update + description: + "**Er wordt gevalideerd op** \n- `identificatie` mag niet gewijzigd worden.\n- `laatsteBetaaldatum`\ + \ mag niet in de toekomst liggen.\n- `laatsteBetaaldatum` mag niet gezet worden\ + \ als de betalingsindicatie\n\"nvt\" is.\n- `archiefnominatie` moet een waarde\ + \ hebben indien `archiefstatus` niet de\nwaarde \"nog_te_archiveren\" heeft.\n\ + - `archiefactiedatum` moet een waarde hebben indien `archiefstatus` niet de\n\ + \ waarde \"nog_te_archiveren\" heeft.\n- `archiefstatus` kan alleen een waarde\ + \ anders dan \"nog_te_archiveren\"\n hebben indien van alle gerelateeerde\ + \ INFORMATIEOBJECTen het attribuut\n `status` de waarde \"gearchiveerd\"\ + \ heeft.\n**Opmerkingen**\n- er worden enkel zaken getoond van de zaaktypes\ + \ waar u toe geautoriseerd\n bent.\n- indien een zaak heropend moet worden,\ + \ doe dit dan door een nieuwe status\n toe te voegen die NIET de eindstatus\ + \ is. Zie de `Status` resource." + summary: Werk een ZAAK in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Zaak' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Zaak' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaak_partial_update + description: + "**Er wordt gevalideerd op** \n- `identificatie` mag niet gewijzigd worden.\n- `laatsteBetaaldatum`\ + \ mag niet in de toekomst liggen.\n- `laatsteBetaaldatum` mag niet gezet worden\ + \ als de betalingsindicatie\n\"nvt\" is.\n- `archiefnominatie` moet een waarde\ + \ hebben indien `archiefstatus` niet de\nwaarde \"nog_te_archiveren\" heeft.\n\ + - `archiefactiedatum` moet een waarde hebben indien `archiefstatus` niet de\n\ + \ waarde \"nog_te_archiveren\" heeft.\n- `archiefstatus` kan alleen een waarde\ + \ anders dan \"nog_te_archiveren\"\n hebben indien van alle gerelateeerde\ + \ INFORMATIEOBJECTen het attribuut\n `status` de waarde \"gearchiveerd\"\ + \ heeft.\n**Opmerkingen**\n- er worden enkel zaken getoond van de zaaktypes\ + \ waar u toe geautoriseerd\n bent.\n- indien een zaak heropend moet worden,\ + \ doe dit dan door een nieuwe status\n toe te voegen die NIET de eindstatus\ + \ is. Zie de `Status` resource." + summary: Werk een ZAAK deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedZaak' + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Zaak' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaak_destroy + description: '***De gerelateerde resources zijn hierbij*** + + - `zaak` - de deelzaken van de verwijderde hoofzaak + + - `status` - alle statussen van de verwijderde zaak + + - `resultaat` - het resultaat van de verwijderde zaak + + - `rol` - alle rollen bij de zaak + + - `zaakobject` - alle zaakobjecten bij de zaak + + - `zaakeigenschap` - alle eigenschappen van de zaak + + - `zaakkenmerk` - alle kenmerken van de zaak + + - `zaakinformatieobject` - dit moet door-cascaden naar de Documenten API, + zie ook: https://github.com/VNG-Realisatie/gemma-zaken/issues/791 (TODO) + + - `klantcontact` - alle klantcontacten bij een zaak' + summary: Verwijder een ZAAK. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.verwijderen + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaak_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAK opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaken/{zaak_uuid}/audittrail: + get: + operationId: audittrail_list + description: Alle audit trail regels behorend bij de ZAAK. + summary: Alle audit trail regels behorend bij de ZAAK. + parameters: + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - audittrails.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AuditTrail' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{zaak_uuid}/audittrail/{uuid}: + get: + operationId: audittrail_retrieve + description: Een specifieke audit trail regel opvragen. + summary: 'Een specifieke audit trail regel opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke identificatie van de audit regel. + title: uuid + required: true + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - audittrails.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/AuditTrail' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{zaak_uuid}/besluiten: + get: + operationId: zaakbesluit_list + description: Alle ZAAKBESLUITen opvragen. + summary: Alle ZAAKBESLUITen opvragen. + parameters: + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ZaakBesluit' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakbesluit_create + description: + '**LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** + + + De Besluiten API gebruikt dit endpoint om relaties te synchroniseren, daarom + is dit endpoint in de Zaken API geimplementeerd. + + + **Er wordt gevalideerd op:** + + - geldigheid URL naar de ZAAK' + summary: Maak een ZAAKBESLUIT aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakBesluit' + required: true + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakBesluit' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{zaak_uuid}/besluiten/{uuid}: + get: + operationId: zaakbesluit_retrieve + description: Een specifiek ZAAKBESLUIT opvragen. + summary: 'Een specifiek ZAAKBESLUIT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakBesluit' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakbesluit_destroy + description: + '***LET OP: Dit endpoint hoor je als consumer niet zelf aan te + spreken.*** + + + De Besluiten API gebruikt dit endpoint om relaties te synchroniseren, daarom + is dit endpoint in de Zaken API geimplementeerd. + + ' + summary: Verwijder een ZAAKBESLUIT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{zaak_uuid}/zaakeigenschappen: + get: + operationId: zaakeigenschap_list + description: Alle ZAAKEIGENSCHAPpen opvragen. + summary: 'Alle ZAAKEIGENSCHAPpen opvragen. ' + parameters: + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ZaakEigenschap' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakeigenschap_create + description: 'Maak een ZAAKEIGENSCHAP aan. + + + **Er wordt gevalideerd op:** + + - geldigheid `eigenschap` URL - de resource moet opgevraagd kunnen worden + uit de Catalogi API en de vorm van een EIGENSCHAP hebben. + + - de `eigenschap` moet bij het `ZAAK.zaaktype` horen' + summary: Maak een ZAAKEIGENSCHAP aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{zaak_uuid}/zaakeigenschappen/{uuid}: + get: + operationId: zaakeigenschap_retrieve + description: Een specifieke ZAAKEIGENSCHAP opvragen. + summary: Een specifieke ZAAKEIGENSCHAP opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaakeigenschap_update + description: + "**Er wordt gevalideerd op** \n- Alleen de `waarde` mag gewijzigd\ + \ worden" + summary: Werk een ZAAKEIGENSCHAP in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaakeigenschap_partial_update + description: + "**Er wordt gevalideerd op** \n- Alleen de `waarde` mag gewijzigd\ + \ worden" + summary: Werk een ZAAKEIGENSCHAP deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedZaakEigenschap' + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakeigenschap_destroy + description: Verwijder een ZAAKEIGENSCHAP + summary: Verwijder een ZAAKEIGENSCHAP. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaakeigenschap_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAKEIGENSCHAP opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaken/_zoek: + post: + operationId: zaak__zoek + description: + Zoeken/filteren gaat normaal via de `list` operatie, deze is echter + niet geschikt voor geo-zoekopdrachten. + summary: Voer een (geo)-zoekopdracht uit op ZAAKen. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: query + name: page + schema: + type: integer + description: Een pagina binnen de gepagineerde set resultaten. + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakZoek' + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedZaakList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error +components: + responses: + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + schemas: + AardRelatieEnum: + enum: + - vervolg + - onderwerp + - bijdrage + type: string + AardRelatieWeergaveEnum: + enum: + - 'Hoort bij, omgekeerd: kent' + - 'Legt vast, omgekeerd: kan vastgelegd zijn als' + type: string + ArchiefnominatieEnum: + enum: + - blijvend_bewaren + - vernietigen + type: string + ArchiefstatusEnum: + enum: + - nog_te_archiveren + - gearchiveerd + - gearchiveerd_procestermijn_onbekend + - overgedragen + type: string + AuditTrail: + type: object + properties: + uuid: + type: string + format: uuid + description: Unieke identificatie van de audit regel. + title: uuid + bron: + allOf: + - $ref: '#/components/schemas/BronEnum' + description: + 'De naam van het component waar de wijziging in is gedaan. + + + Uitleg bij mogelijke waarden: + + + * `ac` - Autorisaties API + + * `nrc` - Notificaties API + + * `zrc` - Zaken API + + * `ztc` - Catalogi API + + * `drc` - Documenten API + + * `brc` - Besluiten API + + * `cmc` - Contactmomenten API + + * `kc` - Klanten API + + * `vrc` - Verzoeken API' + title: bron + applicatieId: + type: string + description: Unieke identificatie van de applicatie, binnen de organisatie. + title: applicatie id + maxLength: 100 + applicatieWeergave: + type: string + description: Vriendelijke naam van de applicatie. + title: applicatie weergave + maxLength: 200 + gebruikersId: + type: string + description: + Unieke identificatie van de gebruiker die binnen de organisatie + herleid kan worden naar een persoon. + title: gebruikers id + maxLength: 255 + gebruikersWeergave: + type: string + description: Vriendelijke naam van de gebruiker. + title: gebruikers weergave + maxLength: 255 + actie: + type: string + description: 'De uitgevoerde handeling. + + + De bekende waardes voor dit veld zijn hieronder aangegeven, maar + andere waardes zijn ook toegestaan + + + Uitleg bij mogelijke waarden: + + + * `create` - Object aangemaakt + + * `list` - Lijst van objecten opgehaald + + * `retrieve` - Object opgehaald + + * `destroy` - Object verwijderd + + * `update` - Object bijgewerkt + + * `partial_update` - Object deels bijgewerkt' + title: actie + maxLength: 50 + actieWeergave: + type: string + description: Vriendelijke naam van de actie. + title: actie weergave + maxLength: 200 + resultaat: + type: integer + maximum: 599 + minimum: 100 + description: HTTP status code van de API response van de uitgevoerde handeling. + title: resultaat + hoofdObject: + type: string + format: uri + description: De URL naar het hoofdobject van een component. + title: hoofd object + maxLength: 1000 + resource: + type: string + description: Het type resource waarop de actie gebeurde. + title: resource + maxLength: 50 + resourceUrl: + type: string + format: uri + description: De URL naar het object. + title: resource url + maxLength: 1000 + toelichting: + type: string + description: Toelichting waarom de handeling is uitgevoerd. + title: toelichting + resourceWeergave: + type: string + description: Vriendelijke identificatie van het object. + title: resource weergave + maxLength: 200 + aanmaakdatum: + type: string + format: date-time + readOnly: true + description: De datum waarop de handeling is gedaan. + title: aanmaakdatum + wijzigingen: + allOf: + - $ref: '#/components/schemas/Wijzigingen' + title: wijzigingen + required: + - aanmaakdatum + - actie + - bron + - hoofdObject + - resource + - resourceUrl + - resourceWeergave + - resultaat + - wijzigingen + BetalingsindicatieEnum: + enum: + - nvt + - nog_niet + - gedeeltelijk + - geheel + type: string + BetrokkeneTypeEnum: + enum: + - natuurlijk_persoon + - niet_natuurlijk_persoon + - vestiging + - organisatorische_eenheid + - medewerker + type: string + BlankEnum: + enum: + - '' + BronEnum: + enum: + - ac + - nrc + - zrc + - ztc + - drc + - brc + - cmc + - kc + - vrc + type: string + ContactPersoonRol: + type: object + description: + De gegevens van de persoon die anderen desgevraagd in contact brengt + met medewerkers van de BETROKKENE, een NIET-NATUURLIJK PERSOON of VESTIGING + zijnde, of met BETROKKENE zelf, een NATUURLIJK PERSOON zijnde , vanuit het + belang van BETROKKENE in haar ROL bij een ZAAK. + properties: + emailadres: + type: string + format: email + title: Email + description: + Elektronich postadres waaronder de contactpersoon in de regel + bereikbaar is. + maxLength: 254 + functie: + type: string + description: + 'De aanduiding van de taken, rechten en plichten die de contactpersoon + heeft binnen de organisatie van BETROKKENE. ' + title: functie + maxLength: 50 + telefoonnummer: + type: string + description: + Telefoonnummer waaronder de contactpersoon in de regel bereikbaar + is. + title: telefoonnummer + maxLength: 20 + naam: + type: string + description: De opgemaakte naam van de contactpersoon namens de BETROKKENE. + title: naam + maxLength: 40 + required: + - naam + nullable: true + FieldValidationError: + type: object + description: Formaat van validatiefouten. + properties: + name: + type: string + description: Naam van het veld met ongeldige gegevens + title: name + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + reason: + type: string + description: Uitleg wat er precies fout is met de gegevens + title: reason + required: + - code + - name + - reason + Fout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: + URI met referentie naar dit specifiek voorkomen van de fout. + Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + required: + - code + - detail + - instance + - status + - title + GeoJSONGeometry: + title: GeoJSONGeometry + type: object + oneOf: + - $ref: '#/components/schemas/Point' + - $ref: '#/components/schemas/MultiPoint' + - $ref: '#/components/schemas/LineString' + - $ref: '#/components/schemas/MultiLineString' + - $ref: '#/components/schemas/Polygon' + - $ref: '#/components/schemas/MultiPolygon' + - $ref: '#/components/schemas/GeometryCollection' + discriminator: + propertyName: type + GeoWithin: + type: object + properties: + within: + allOf: + - $ref: '#/components/schemas/GeoJSONGeometry' + title: within + Geometry: + title: Geometry + description: GeoJSON geometry + type: object + required: + - type + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1 + properties: + type: + allOf: + - $ref: '#/components/schemas/GeometryTypeEnum' + description: The geometry type + GeometryCollection: + title: Geometry collection + description: GeoJSON multi-polygon geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.8 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - geometries + properties: + geometries: + type: array + items: + $ref: '#/components/schemas/Geometry' + GeometryTypeEnum: + type: string + enum: + - Point + - MultiPoint + - LineString + - MultiLineString + - Polygon + - MultiPolygon + - Feature + - FeatureCollection + - GeometryCollection + GeslachtsaanduidingEnum: + enum: + - m + - v + - o + type: string + IndicatieMachtigingEnum: + enum: + - gemachtigde + - machtiginggever + type: string + InnRechtsvormEnum: + enum: + - besloten_vennootschap + - cooperatie_europees_economische_samenwerking + - europese_cooperatieve_venootschap + - europese_naamloze_vennootschap + - kerkelijke_organisatie + - naamloze_vennootschap + - onderlinge_waarborg_maatschappij + - overig_privaatrechtelijke_rechtspersoon + - stichting + - vereniging + - vereniging_van_eigenaars + - publiekrechtelijke_rechtspersoon + - vennootschap_onder_firma + - maatschap + - rederij + - commanditaire_vennootschap + - kapitaalvennootschap_binnen_eer + - overige_buitenlandse_rechtspersoon_vennootschap + - kapitaalvennootschap_buiten_eer + type: string + KlantContact: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: De unieke aanduiding van een KLANTCONTACT + title: identificatie + maxLength: 14 + datumtijd: + type: string + format: date-time + description: De datum en het tijdstip waarop het KLANTCONTACT begint + title: datumtijd + kanaal: + type: string + description: Het communicatiekanaal waarlangs het KLANTCONTACT gevoerd wordt + title: kanaal + maxLength: 20 + onderwerp: + type: string + description: Het onderwerp waarover contact is geweest met de klant. + title: onderwerp + maxLength: 200 + toelichting: + type: string + description: Een toelichting die inhoudelijk het contact met de klant beschrijft. + title: toelichting + maxLength: 1000 + required: + - datumtijd + - url + - uuid + - zaak + LineString: + title: Line-string + description: GeoJSON line-string geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.4 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + type: array + items: + $ref: '#/components/schemas/Point2D' + minItems: 2 + MultiLineString: + title: Multi-line string + description: GeoJSON multi-line-string geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.5 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + type: array + items: + type: array + items: + $ref: '#/components/schemas/Point2D' + MultiPoint: + title: MultiPoint + description: GeoJSON multi-point geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.3 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + type: array + items: + $ref: '#/components/schemas/Point2D' + MultiPolygon: + title: Multi-polygon + description: GeoJSON multi-polygon geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.7 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + type: array + items: + type: array + items: + type: array + items: + $ref: '#/components/schemas/Point2D' + NullEnum: + enum: + - null + ObjectAdres: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + wplWoonplaatsNaam: + type: string + title: wpl woonplaats naam + maxLength: 80 + gorOpenbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: gor openbare ruimte naam + maxLength: 80 + huisnummer: + type: integer + maximum: 99999 + minimum: 0 + title: huisnummer + huisletter: + type: string + title: huisletter + maxLength: 1 + huisnummertoevoeging: + type: string + title: huisnummertoevoeging + maxLength: 4 + postcode: + type: string + title: postcode + maxLength: 7 + required: + - gorOpenbareRuimteNaam + - huisnummer + - identificatie + - wplWoonplaatsNaam + ObjectBuurt: + type: object + properties: + buurtCode: + type: string + description: De code behorende bij de naam van de buurt + title: buurt code + maxLength: 2 + buurtNaam: + type: string + description: De naam van de buurt, zoals die door het CBS wordt gebruikt. + title: buurt naam + maxLength: 40 + gemGemeenteCode: + type: string + description: + Een numerieke aanduiding waarmee een Nederlandse gemeente uniek + wordt aangeduid + title: gem gemeente code + maxLength: 4 + wykWijkCode: + type: string + description: De code behorende bij de naam van de wijk + title: wyk wijk code + maxLength: 2 + required: + - buurtCode + - buurtNaam + - gemGemeenteCode + - wykWijkCode + ObjectGemeente: + type: object + properties: + gemeenteNaam: + type: string + description: "De offici\xEBle door de gemeente vastgestelde gemeentenaam." + title: gemeente naam + maxLength: 80 + gemeenteCode: + type: string + description: + Een numerieke aanduiding waarmee een Nederlandse gemeente uniek + wordt aangeduid + title: gemeente code + maxLength: 4 + required: + - gemeenteCode + - gemeenteNaam + ObjectGemeentelijkeOpenbareRuimte: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + openbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: openbare ruimte naam + maxLength: 80 + required: + - identificatie + - openbareRuimteNaam + ObjectHuishouden: + type: object + properties: + nummer: + type: string + description: + Uniek identificerend administratienummer van een huishouden + zoals toegekend door de gemeente waarin het huishouden woonachtig is. + title: nummer + maxLength: 12 + isGehuisvestIn: + allOf: + - $ref: '#/components/schemas/ObjectTerreinGebouwdObject' + nullable: true + title: isGehuisvestIn + required: + - nummer + ObjectInrichtingselement: + type: object + properties: + type: + allOf: + - $ref: '#/components/schemas/ObjectInrichtingselementTypeEnum' + description: 'Specificatie van de aard van het inrichtingselement. + + + Uitleg bij mogelijke waarden: + + + * `bak` - Bak + + * `bord` - Bord + + * `installatie` - Installatie + + * `kast` - Kast + + * `mast` - Mast + + * `paal` - Paal + + * `sensor` - Sensor + + * `straatmeubilair` - Straatmeubilair + + * `waterinrichtingselement` - Waterinrichtingselement + + * `weginrichtingselement` - Weginrichtingselement' + title: type + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + description: De benaming van het OBJECT + title: naam + maxLength: 500 + required: + - identificatie + - type + ObjectInrichtingselementTypeEnum: + enum: + - bak + - bord + - installatie + - kast + - mast + - paal + - sensor + - straatmeubilair + - waterinrichtingselement + - weginrichtingselement + type: string + ObjectKadastraleOnroerendeZaak: + type: object + properties: + kadastraleIdentificatie: + type: string + description: De unieke identificatie van het OBJECT + title: kadastrale identificatie + maxLength: 100 + kadastraleAanduiding: + type: string + description: + De typering van de kadastrale aanduiding van een onroerende + zaak conform Kadaster + title: kadastrale aanduiding + maxLength: 1000 + required: + - kadastraleAanduiding + - kadastraleIdentificatie + ObjectKunstwerkdeel: + type: object + properties: + type: + allOf: + - $ref: '#/components/schemas/ObjectKunstwerkdeelTypeEnum' + description: + 'Specificatie van het soort Kunstwerk waartoe het kunstwerkdeel + behoort. + + + Uitleg bij mogelijke waarden: + + + * `keermuur` - Keermuur + + * `overkluizing` - Overkluizing + + * `duiker` - Duiker + + * `faunavoorziening` - Faunavoorziening + + * `vispassage` - Vispassage + + * `bodemval` - Bodemval + + * `coupure` - Coupure + + * `ponton` - Ponton + + * `voorde` - Voorde + + * `hoogspanningsmast` - Hoogspanningsmast + + * `gemaal` - Gemaal + + * `perron` - Perron + + * `sluis` - Sluis + + * `strekdam` - Strekdam + + * `steiger` - Steiger + + * `stuw` - Stuw' + title: type + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + title: naam + maxLength: 80 + required: + - identificatie + - naam + - type + ObjectKunstwerkdeelTypeEnum: + enum: + - keermuur + - overkluizing + - duiker + - faunavoorziening + - vispassage + - bodemval + - coupure + - ponton + - voorde + - hoogspanningsmast + - gemaal + - perron + - sluis + - strekdam + - steiger + - stuw + type: string + ObjectMaatschappelijkeActiviteit: + type: object + properties: + kvkNummer: + type: string + description: + Landelijk uniek identificerend administratienummer van een + MAATSCHAPPELIJKE ACTIVITEIT zoals toegewezen door de Kamer van Koophandel + (KvK). + title: kvk nummer + maxLength: 8 + handelsnaam: + type: string + description: De naam waaronder de onderneming handelt. + title: handelsnaam + maxLength: 200 + required: + - handelsnaam + - kvkNummer + ObjectOpenbareRuimte: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + wplWoonplaatsNaam: + type: string + title: wpl woonplaats naam + maxLength: 80 + gorOpenbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: gor openbare ruimte naam + maxLength: 80 + required: + - gorOpenbareRuimteNaam + - identificatie + - wplWoonplaatsNaam + ObjectOverige: + type: object + properties: + overigeData: + type: object + additionalProperties: {} + title: overige data + required: + - overigeData + ObjectPand: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + required: + - identificatie + ObjectSpoorbaandeel: + type: object + properties: + type: + allOf: + - $ref: '#/components/schemas/ObjectSpoorbaandeelTypeEnum' + description: 'Specificatie van het soort Spoorbaan + + + Uitleg bij mogelijke waarden: + + + * `breedspoor` - breedspoor + + * `normaalspoor` - normaalspoor + + * `smalspoor` - smalspoor + + * `spoorbaan` - spoorbaan' + title: type + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + description: De benaming van het OBJECT + title: naam + maxLength: 500 + required: + - identificatie + - type + ObjectSpoorbaandeelTypeEnum: + enum: + - breedspoor + - normaalspoor + - smalspoor + - spoorbaan + type: string + ObjectTerreinGebouwdObject: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + adresAanduidingGrp: + allOf: + - $ref: '#/components/schemas/TerreinGebouwdObjectAdres' + nullable: true + title: adresAanduidingGrp + required: + - identificatie + ObjectTerreindeel: + type: object + properties: + type: + type: string + title: type + maxLength: 40 + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + description: De benaming van het OBJECT + title: naam + maxLength: 500 + required: + - identificatie + - type + ObjectTypeEnum: + enum: + - adres + - besluit + - buurt + - enkelvoudig_document + - gemeente + - gemeentelijke_openbare_ruimte + - huishouden + - inrichtingselement + - kadastrale_onroerende_zaak + - kunstwerkdeel + - maatschappelijke_activiteit + - medewerker + - natuurlijk_persoon + - niet_natuurlijk_persoon + - openbare_ruimte + - organisatorische_eenheid + - pand + - spoorbaandeel + - status + - terreindeel + - terrein_gebouwd_object + - vestiging + - waterdeel + - wegdeel + - wijk + - woonplaats + - woz_deelobject + - woz_object + - woz_waarde + - zakelijk_recht + - overige + type: string + ObjectTypeOverigeDefinitie: + type: object + properties: + url: + type: string + format: uri + title: Objecttype-URL + description: + URL-referentie naar de objecttype resource in een API. Deze + resource moet de [JSON-schema](https://json-schema.org/)-definitie van + het objecttype bevatten. + maxLength: 1000 + schema: + type: string + title: schema-pad + description: + 'Een geldige [jq](http://stedolan.github.io/jq/) expressie. + Dit wordt gecombineerd met de resource uit het `url`-attribuut om het + schema van het objecttype uit te lezen. Bijvoorbeeld: `.jsonSchema`.' + maxLength: 100 + objectData: + type: string + title: objectgegevens-pad + description: + 'Een geldige [jq](http://stedolan.github.io/jq/) expressie. + Dit wordt gecombineerd met de JSON data uit de OBJECT url om de objectgegevens + uit te lezen en de vorm van de gegevens tegen het schema te valideren. + Bijvoorbeeld: `.record.data`.' + maxLength: 100 + required: + - objectData + - schema + - url + ObjectWaterdeel: + type: object + properties: + typeWaterdeel: + allOf: + - $ref: '#/components/schemas/TypeWaterdeelEnum' + description: 'Specificatie van het soort water + + + Uitleg bij mogelijke waarden: + + + * `zee` - Zee + + * `waterloop` - Waterloop + + * `watervlakte` - Watervlakte + + * `greppel_droge_sloot` - Greppel, droge sloot' + title: type waterdeel + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + description: De benaming van het OBJECT + title: naam + maxLength: 500 + required: + - identificatie + - typeWaterdeel + ObjectWegdeel: + type: object + properties: + type: + type: string + title: type + maxLength: 100 + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + description: De benaming van het OBJECT + title: naam + maxLength: 500 + required: + - identificatie + - type + ObjectWijk: + type: object + properties: + wijkCode: + type: string + description: De code behorende bij de naam van de wijk. + title: wijk code + maxLength: 2 + wijkNaam: + type: string + description: De naam van de wijk, zoals die door het CBS wordt gebruikt. + title: wijk naam + maxLength: 40 + gemGemeenteCode: + type: string + description: + Een numerieke aanduiding waarmee een Nederlandse gemeente uniek + wordt aangeduid + title: gem gemeente code + maxLength: 4 + required: + - gemGemeenteCode + - wijkCode + - wijkNaam + ObjectWoonplaats: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + woonplaatsNaam: + type: string + description: + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + toegekende benaming. + title: woonplaats naam + maxLength: 80 + required: + - identificatie + - woonplaatsNaam + ObjectWozDeelobject: + type: object + properties: + nummerWozDeelObject: + type: string + description: Uniek identificatienummer voor het deelobject binnen een WOZ-object. + title: nummer woz deel object + maxLength: 6 + isOnderdeelVan: + allOf: + - $ref: '#/components/schemas/ObjectWozObject' + title: isOnderdeelVan + required: + - nummerWozDeelObject + ObjectWozObject: + type: object + properties: + wozObjectNummer: + type: string + description: De unieke identificatie van het OBJECT + title: woz object nummer + maxLength: 100 + aanduidingWozObject: + allOf: + - $ref: '#/components/schemas/WozObjectAdres' + nullable: true + title: aanduidingWozObject + required: + - wozObjectNummer + ObjectWozWaarde: + type: object + properties: + waardepeildatum: + type: string + description: De datum waarnaar de waarde van het WOZ-object wordt bepaald. + title: waardepeildatum + maxLength: 9 + isVoor: + allOf: + - $ref: '#/components/schemas/ObjectWozObject' + title: isVoor + required: + - waardepeildatum + ObjectZakelijkRecht: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + avgAard: + type: string + description: aanduiding voor de aard van het recht + title: avg aard + maxLength: 1000 + heeftBetrekkingOp: + allOf: + - $ref: '#/components/schemas/ObjectKadastraleOnroerendeZaak' + title: heeftBetrekkingOp + heeftAlsGerechtigde: + allOf: + - $ref: '#/components/schemas/ZakelijkRechtHeeftAlsGerechtigde' + title: heeftAlsGerechtigde + required: + - avgAard + - identificatie + Opschorting: + type: object + description: + Gegevens omtrent het tijdelijk opschorten van de behandeling van + de ZAAK + properties: + indicatie: + type: boolean + description: Aanduiding of de behandeling van de ZAAK tijdelijk is opgeschort. + title: indicatie opschorting + reden: + type: string + description: + Omschrijving van de reden voor het opschorten van de behandeling + van de zaak. + title: reden opschorting + maxLength: 200 + required: + - indicatie + - reden + nullable: true + PaginatedKlantContactList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/KlantContact' + PaginatedResultaatList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Resultaat' + PaginatedRolList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Rol' + PaginatedStatusList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Status' + PaginatedZaakList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ZaakExpanded' + PaginatedZaakObjectList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ZaakObject' + PatchedResultaat: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + resultaattype: + type: string + format: uri + description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API). + title: resultaattype + maxLength: 1000 + toelichting: + type: string + description: Een toelichting op wat het resultaat van de zaak inhoudt. + title: toelichting + maxLength: 1000 + PatchedZaak: + type: object + description: 'Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + identificatie: + type: string + description: + De unieke identificatie van de ZAAK binnen de organisatie die + verantwoordelijk is voor de behandeling van de ZAAK. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + description: + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers + en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + title: bronorganisatie + maxLength: 9 + omschrijving: + type: string + description: Een korte omschrijving van de zaak. + title: omschrijving + maxLength: 80 + toelichting: + type: string + description: Een toelichting op de zaak. + title: toelichting + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de + CATALOGUS waar deze voorkomt + title: zaaktype + maxLength: 1000 + registratiedatum: + type: string + format: date + description: + De datum waarop de zaakbehandelende organisatie de ZAAK heeft + geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag + gebruikt. + title: registratiedatum + verantwoordelijkeOrganisatie: + type: string + description: + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die eindverantwoordelijk is voor de behandeling van de zaak. Dit moet + een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + title: verantwoordelijke organisatie + maxLength: 9 + startdatum: + type: string + format: date + description: De datum waarop met de uitvoering van de zaak is gestart + title: startdatum + einddatum: + type: string + format: date + readOnly: true + nullable: true + description: De datum waarop de uitvoering van de zaak afgerond is. + title: einddatum + einddatumGepland: + type: string + format: date + nullable: true + description: + De datum waarop volgens de planning verwacht wordt dat de zaak + afgerond wordt. + title: einddatum gepland + uiterlijkeEinddatumAfdoening: + type: string + format: date + nullable: true + description: + De laatste datum waarop volgens wet- en regelgeving de zaak + afgerond dient te zijn. + title: uiterlijke einddatum afdoening + publicatiedatum: + type: string + format: date + nullable: true + description: Datum waarop (het starten van) de zaak gepubliceerd is of wordt. + title: publicatiedatum + communicatiekanaal: + type: string + format: uri + description: + Het medium waarlangs de aanleiding om een zaak te starten is + ontvangen. URL naar een communicatiekanaal in de VNG-Referentielijst van + communicatiekanalen. + title: communicatiekanaal + maxLength: 1000 + productenOfDiensten: + type: array + items: + type: string + format: uri + title: URL naar product/dienst + maxLength: 1000 + description: + De producten en/of diensten die door de zaak worden voortgebracht. + Dit zijn URLs naar de resources zoals die door de producten- en dienstencatalogus-API + wordt ontsloten. De producten/diensten moeten bij het zaaktype vermeld + zijn. + title: producten of diensten + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + title: Vertrouwlijkheidaanduiding + description: + Aanduiding van de mate waarin het zaakdossier van de ZAAK voor + de openbaarheid bestemd is. Optioneel - indien geen waarde gekozen wordt, + dan wordt de waarde van het ZAAKTYPE overgenomen. Dit betekent dat de + API _altijd_ een waarde teruggeeft. + betalingsindicatie: + description: + 'Indicatie of de, met behandeling van de zaak gemoeide, kosten + betaald zijn door de desbetreffende betrokkene. + + + Uitleg bij mogelijke waarden: + + + * `nvt` - Er is geen sprake van te betalen, met de zaak gemoeide, kosten. + + * `nog_niet` - De met de zaak gemoeide kosten zijn (nog) niet betaald. + + * `gedeeltelijk` - De met de zaak gemoeide kosten zijn gedeeltelijk betaald. + + * `geheel` - De met de zaak gemoeide kosten zijn geheel betaald.' + title: betalingsindicatie + oneOf: + - $ref: '#/components/schemas/BetalingsindicatieEnum' + - $ref: '#/components/schemas/BlankEnum' + betalingsindicatieWeergave: + type: string + readOnly: true + description: Uitleg bij `betalingsindicatie`. + title: betalingsindicatieWeergave + laatsteBetaaldatum: + type: string + format: date-time + nullable: true + description: + De datum waarop de meest recente betaling is verwerkt van kosten + die gemoeid zijn met behandeling van de zaak. + title: laatste betaaldatum + zaakgeometrie: + allOf: + - $ref: '#/components/schemas/GeoJSONGeometry' + nullable: true + description: Punt, lijn of (multi-)vlak geometrie-informatie, in GeoJSON. + title: zaakgeometrie + verlenging: + allOf: + - $ref: '#/components/schemas/Verlenging' + nullable: true + description: + Gegevens omtrent het verlengen van de doorlooptijd van de behandeling + van de ZAAK + title: verlenging + opschorting: + allOf: + - $ref: '#/components/schemas/Opschorting' + nullable: true + description: + Gegevens omtrent het tijdelijk opschorten van de behandeling + van de ZAAK + title: opschorting + selectielijstklasse: + type: string + format: uri + description: + URL-referentie naar de categorie in de gehanteerde 'Selectielijst + Archiefbescheiden' die, gezien het zaaktype en het resultaattype van de + zaak, bepalend is voor het archiefregime van de zaak. + title: selectielijstklasse + maxLength: 1000 + hoofdzaak: + type: string + format: uri + nullable: true + title: Is deelzaak van + description: + "URL-referentie naar de ZAAK, waarom verzocht is door de initiator\ + \ daarvan, die behandeld wordt in twee of meer separate ZAAKen waarvan\ + \ de onderhavige ZAAK er \xE9\xE9n is." + minLength: 1 + maxLength: 1000 + deelzaken: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar deel ZAAKen. + title: is deelzaak van + uniqueItems: true + relevanteAndereZaken: + type: array + items: + $ref: '#/components/schemas/RelevanteZaak' + description: Een lijst van relevante andere zaken. + title: zaak + eigenschappen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + rollen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + status: + type: string + format: uri + readOnly: true + nullable: true + description: Indien geen status bekend is, dan is de waarde 'null' + title: status + zaakinformatieobjecten: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + zaakobjecten: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + kenmerken: + type: array + items: + $ref: '#/components/schemas/ZaakKenmerk' + description: + Lijst van kenmerken. Merk op dat refereren naar gerelateerde + objecten beter kan via `ZaakObject`. + title: zaak + archiefnominatie: + nullable: true + description: + 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + + + Uitleg bij mogelijke waarden: + + + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum + overgedragen worden naar een archiefbewaarplaats. + + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' + title: archiefnominatie + oneOf: + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/NullEnum' + archiefstatus: + allOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + description: + 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + + + Uitleg bij mogelijke waarden: + + + * `nog_te_archiveren` - De zaak cq. het zaakdossier is nog niet als geheel + gearchiveerd. + + * `gearchiveerd` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar + bewaarbaar gemaakt. + + * `gearchiveerd_procestermijn_onbekend` - De zaak cq. het zaakdossier + is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum + kan nog niet bepaald worden. + + * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een + archiefbewaarplaats.' + title: archiefstatus + archiefactiedatum: + type: string + format: date + nullable: true + description: + De datum waarop het gearchiveerde zaakdossier vernietigd moet + worden dan wel overgebracht moet worden naar een archiefbewaarplaats. + Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT + aan deze ZAAK indien nog leeg. + title: archiefactiedatum + resultaat: + type: string + format: uri + readOnly: true + nullable: true + description: + URL-referentie naar het RESULTAAT. Indien geen resultaat bekend + is, dan is de waarde 'null' + title: resultaat + opdrachtgevendeOrganisatie: + type: string + description: + De krachtens publiekrecht ingestelde rechtspersoon dan wel + ander niet-natuurlijk persoon waarbinnen het (bestuurs)orgaan zetelt dat + opdracht heeft gegeven om taken uit te voeren waaraan de zaak invulling + geeft. + title: opdrachtgevende organisatie + maxLength: 9 + processobjectaard: + type: string + nullable: true + title: Procesobjectaard + description: + Omschrijving van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, de zaak betrekking heeft. + maxLength: 200 + startdatumBewaartermijn: + type: string + format: date + nullable: true + description: + De datum die de start markeert van de termijn waarop het zaakdossier + vernietigd moet worden. + title: startdatum bewaartermijn + processobject: + allOf: + - $ref: '#/components/schemas/Processobject' + nullable: true + description: + Specificatie van de attribuutsoort van het object, subject + of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking + heeft en dat bepalend is voor de start van de archiefactietermijn. + title: processobject + PatchedZaakEigenschap: + type: object + description: + "A type of `ModelSerializer` that uses hyperlinked relationships + with compound keys instead + + of primary key relationships. Specifically: + + + * A 'url' field is included instead of the 'id' field. + + * Relationships to other instances are hyperlinks, instead of primary keys. + + + NOTE: this only works with DRF 3.1.0 and above." + properties: + url: + type: string + format: uri + readOnly: true + title: url + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + title: zaak + eigenschap: + type: string + format: uri + description: URL-referentie naar de EIGENSCHAP (in de Catalogi API). + title: eigenschap + maxLength: 1000 + naam: + type: string + readOnly: true + description: De naam van de EIGENSCHAP (overgenomen uit de Catalogi API). + title: ' naam' + waarde: + type: string + title: waarde + PatchedZaakInformatieObject: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + informatieobject: + type: string + format: uri + description: + URL-referentie naar het INFORMATIEOBJECT (in de Documenten + API), waar ook de relatieinformatie opgevraagd kan worden. + title: informatieobject + maxLength: 1000 + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + aardRelatieWeergave: + allOf: + - $ref: '#/components/schemas/AardRelatieWeergaveEnum' + readOnly: true + title: aardRelatieWeergave + titel: + type: string + description: + De naam waaronder het INFORMATIEOBJECT binnen het OBJECT bekend + is. + title: titel + maxLength: 200 + beschrijving: + type: string + description: + Een op het object gerichte beschrijving van de inhoud vanhet + INFORMATIEOBJECT. + title: beschrijving + registratiedatum: + type: string + format: date-time + readOnly: true + description: + De datum waarop de behandelende organisatie het INFORMATIEOBJECT + heeft geregistreerd bij het OBJECT. Geldige waardes zijn datumtijden gelegen + op of voor de huidige datum en tijd. + title: registratiedatum + vernietigingsdatum: + type: string + format: date-time + nullable: true + description: + De datum waarop het informatieobject uit het zaakdossier verwijderd + moet worden. + title: vernietigingsdatum + status: + type: string + format: uri + nullable: true + description: + De bij de desbetreffende ZAAK behorende STATUS waarvoor het + ZAAK-INFORMATIEOBJECT relevant is (geweest) met het oog op het bereiken + van die STATUS en/of de communicatie daarover. + title: status + minLength: 1 + maxLength: 1000 + PatchedZaakObject: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + object: + type: string + format: uri + description: URL-referentie naar de resource die het OBJECT beschrijft. + title: object + maxLength: 1000 + zaakobjecttype: + type: string + format: uri + description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API). + title: zaakobjecttype + maxLength: 1000 + objectType: + allOf: + - $ref: '#/components/schemas/ObjectTypeEnum' + description: + 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er + geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. + + + Uitleg bij mogelijke waarden: + + + * `adres` - Adres + + * `besluit` - Besluit + + * `buurt` - Buurt + + * `enkelvoudig_document` - Enkelvoudig document + + * `gemeente` - Gemeente + + * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte + + * `huishouden` - Huishouden + + * `inrichtingselement` - Inrichtingselement + + * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak + + * `kunstwerkdeel` - Kunstwerkdeel + + * `maatschappelijke_activiteit` - Maatschappelijke activiteit + + * `medewerker` - Medewerker + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `openbare_ruimte` - Openbare ruimte + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `pand` - Pand + + * `spoorbaandeel` - Spoorbaandeel + + * `status` - Status + + * `terreindeel` - Terreindeel + + * `terrein_gebouwd_object` - Terrein gebouwd object + + * `vestiging` - Vestiging + + * `waterdeel` - Waterdeel + + * `wegdeel` - Wegdeel + + * `wijk` - Wijk + + * `woonplaats` - Woonplaats + + * `woz_deelobject` - Woz deel object + + * `woz_object` - Woz object + + * `woz_waarde` - Woz waarde + + * `zakelijk_recht` - Zakelijk recht + + * `overige` - Overige' + title: object type + objectTypeOverige: + type: string + description: + Beschrijft het type OBJECT als `objectType` de waarde "overige" + heeft. + title: object type overige + pattern: '[a-z\_]+' + maxLength: 100 + objectTypeOverigeDefinitie: + allOf: + - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie' + nullable: true + title: definitie object type overige + description: + 'Verwijzing naar het schema van het type OBJECT als `objectType` + de waarde "overige" heeft. + + + * De URL referentie moet naar een JSON endpoint wijzen waarin het objecttype + gedefinieerd is, inclusief het [JSON-schema](https://json-schema.org/). + + * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen de + objecttype resource (deze gebruikt het [jq](http://stedolan.github.io/jq/) + formaat. + + * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens binnen + het OBJECT. Deze gebruikt ook het [jq](http://stedolan.github.io/jq/) + formaat. + + + Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven + en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven + OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.' + relatieomschrijving: + type: string + description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. + title: relatieomschrijving + maxLength: 80 + discriminator: + propertyName: objectType + mapping: + adres: '#/components/schemas/adres_PatchedZaakObject' + besluit: '#/components/schemas/besluit_PatchedZaakObject' + buurt: '#/components/schemas/buurt_PatchedZaakObject' + enkelvoudig_document: '#/components/schemas/enkelvoudig_document_PatchedZaakObject' + gemeente: '#/components/schemas/gemeente_PatchedZaakObject' + gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_PatchedZaakObject' + huishouden: '#/components/schemas/huishouden_PatchedZaakObject' + inrichtingselement: '#/components/schemas/inrichtingselement_PatchedZaakObject' + kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_PatchedZaakObject' + kunstwerkdeel: '#/components/schemas/kunstwerkdeel_PatchedZaakObject' + maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_PatchedZaakObject' + medewerker: '#/components/schemas/medewerker_PatchedZaakObject' + natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_PatchedZaakObject' + niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_PatchedZaakObject' + openbare_ruimte: '#/components/schemas/openbare_ruimte_PatchedZaakObject' + organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_PatchedZaakObject' + pand: '#/components/schemas/pand_PatchedZaakObject' + spoorbaandeel: '#/components/schemas/spoorbaandeel_PatchedZaakObject' + status: '#/components/schemas/status_PatchedZaakObject' + terreindeel: '#/components/schemas/terreindeel_PatchedZaakObject' + terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_PatchedZaakObject' + vestiging: '#/components/schemas/vestiging_PatchedZaakObject' + waterdeel: '#/components/schemas/waterdeel_PatchedZaakObject' + wegdeel: '#/components/schemas/wegdeel_PatchedZaakObject' + wijk: '#/components/schemas/wijk_PatchedZaakObject' + woonplaats: '#/components/schemas/woonplaats_PatchedZaakObject' + woz_deelobject: '#/components/schemas/woz_deelobject_PatchedZaakObject' + woz_object: '#/components/schemas/woz_object_PatchedZaakObject' + woz_waarde: '#/components/schemas/woz_waarde_PatchedZaakObject' + zakelijk_recht: '#/components/schemas/zakelijk_recht_PatchedZaakObject' + overige: '#/components/schemas/overige_PatchedZaakObject' + Point: + title: Point + description: GeoJSON point geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.2 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + $ref: '#/components/schemas/Point2D' + Point2D: + title: Point2D + type: array + items: + type: number + maxItems: 2 + minItems: 2 + Polygon: + title: Polygon + description: GeoJSON polygon geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.6 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + type: array + items: + type: array + items: + $ref: '#/components/schemas/Point2D' + Processobject: + type: object + description: + Specificatie van de attribuutsoort van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, de zaak betrekking heeft en dat bepalend is voor + de start van de archiefactietermijn. + properties: + datumkenmerk: + type: string + description: + De naam van de attribuutsoort van het procesobject dat bepalend + is voor het einde van de procestermijn. + title: datumkenmerk + maxLength: 250 + identificatie: + type: string + description: De unieke aanduiding van het procesobject. + title: identificatie + maxLength: 250 + objecttype: + type: string + description: Het soort object dat het procesobject representeert. + title: objecttype + maxLength: 250 + registratie: + type: string + description: + De naam van de registratie waarvan het procesobject deel uit + maakt. + title: registratie + maxLength: 250 + required: + - datumkenmerk + - identificatie + - objecttype + - registratie + nullable: true + RelevanteZaak: + type: object + properties: + url: + type: string + format: uri + title: URL-referentie naar de ZAAK. + maxLength: 1000 + aardRelatie: + allOf: + - $ref: '#/components/schemas/AardRelatieEnum' + description: + 'Benamingen van de aard van de relaties van andere zaken tot + (onderhanden) zaken. + + + Uitleg bij mogelijke waarden: + + + * `vervolg` - De andere zaak gaf aanleiding tot het starten van de onderhanden + zaak. + + * `onderwerp` - De andere zaak is relevant voor cq. is onderwerp van de + onderhanden zaak. + + * `bijdrage` - Aan het bereiken van de uitkomst van de andere zaak levert + de onderhanden zaak een bijdrage.' + title: aard relatie + required: + - aardRelatie + - url + Resultaat: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + resultaattype: + type: string + format: uri + description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API). + title: resultaattype + maxLength: 1000 + toelichting: + type: string + description: Een toelichting op wat het resultaat van de zaak inhoudt. + title: toelichting + maxLength: 1000 + required: + - resultaattype + - url + - uuid + - zaak + ResultaatExpanded: + allOf: + - $ref: '#/components/schemas/Resultaat' + - properties: + _expand: + $ref: '#/components/schemas/ResultaatEmbedded' + ResultaatEmbedded: + type: object + properties: + zaak: + $ref: '#/components/schemas/ZaakExpanded' + resultaattype: + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ResultaatType' + Rol: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + betrokkene: + type: string + format: uri + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + title: betrokkene + maxLength: 1000 + betrokkeneType: + allOf: + - $ref: '#/components/schemas/BetrokkeneTypeEnum' + description: 'Type van de `betrokkene`. + + + Uitleg bij mogelijke waarden: + + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `vestiging` - Vestiging + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `medewerker` - Medewerker' + title: betrokkene type + afwijkendeNaamBetrokkene: + type: string + description: + De naam van de betrokkene waaronder deze in relatie tot de + zaak aangesproken wil worden. + title: afwijkende naam betrokkene + maxLength: 625 + roltype: + type: string + format: uri + description: + URL-referentie naar een roltype binnen het ZAAKTYPE van de + ZAAK. + title: roltype + maxLength: 1000 + omschrijving: + type: string + readOnly: true + description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. + title: omschrijving + omschrijvingGeneriek: + type: string + readOnly: true + description: + "Algemeen gehanteerde benaming van de aard van de ROL, afgeleid\ + \ uit het ROLTYPE.\n\nUitleg bij mogelijke waarden:\n\n* `adviseur` -\ + \ (Adviseur) Kennis in dienst stellen van de behandeling van (een deel\ + \ van) een zaak.\n* `behandelaar` - (Behandelaar) De vakinhoudelijke behandeling\ + \ doen van (een deel van) een zaak.\n* `belanghebbende` - (Belanghebbende)\ + \ Vanuit eigen en objectief belang rechtstreeks betrokken zijn bij de\ + \ behandeling en/of de uitkomst van een zaak.\n* `beslisser` - (Beslisser)\ + \ Nemen van besluiten die voor de uitkomst van een zaak noodzakelijk zijn.\n\ + * `initiator` - (Initiator) Aanleiding geven tot de start van een zaak\ + \ ..\n* `klantcontacter` - (Klantcontacter) Het eerste aanspreekpunt zijn\ + \ voor vragen van burgers en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6\ + rdinator) Er voor zorg dragen dat de behandeling van de zaak in samenhang\ + \ uitgevoerd wordt conform de daarover gemaakte afspraken.\n* `mede_initiator`\ + \ - Mede-initiator" + title: omschrijving generiek + roltoelichting: + type: string + title: roltoelichting + maxLength: 1000 + registratiedatum: + type: string + format: date-time + readOnly: true + description: De datum waarop dit object is geregistreerd. + title: registratiedatum + indicatieMachtiging: + description: 'Indicatie machtiging + + + Uitleg bij mogelijke waarden: + + + * `gemachtigde` - De betrokkene in de rol bij de zaak is door een andere + betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen + + * `machtiginggever` - De betrokkene in de rol bij de zaak heeft een andere + betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen' + title: indicatie machtiging + oneOf: + - $ref: '#/components/schemas/IndicatieMachtigingEnum' + - $ref: '#/components/schemas/BlankEnum' + contactpersoonRol: + allOf: + - $ref: '#/components/schemas/ContactPersoonRol' + nullable: true + description: + De gegevens van de persoon die anderen desgevraagd in contact + brengt met medewerkers van de BETROKKENE, een NIET-NATUURLIJK PERSOON + of VESTIGING zijnde, of met BETROKKENE zelf, een NATUURLIJK PERSOON zijnde + , vanuit het belang van BETROKKENE in haar ROL bij een ZAAK. + title: contactpersoonRol + statussen: + type: array + items: + type: string + format: uri + title: '' + minLength: 1 + maxLength: 1000 + readOnly: true + description: + De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd + dat STATUSsen in die ZAAK bereikt zijn. + title: statussen + uniqueItems: true + required: + - betrokkeneType + - omschrijving + - omschrijvingGeneriek + - registratiedatum + - roltoelichting + - roltype + - statussen + - url + - uuid + - zaak + discriminator: + propertyName: betrokkeneType + mapping: + medewerker: '#/components/schemas/medewerker_Rol' + natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_Rol' + niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_Rol' + organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_Rol' + vestiging: '#/components/schemas/vestiging_Rol' + RolExpanded: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + betrokkene: + type: string + format: uri + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + title: betrokkene + maxLength: 1000 + betrokkeneType: + allOf: + - $ref: '#/components/schemas/BetrokkeneTypeEnum' + description: 'Type van de `betrokkene`. + + + Uitleg bij mogelijke waarden: + + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `vestiging` - Vestiging + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `medewerker` - Medewerker' + title: betrokkene type + afwijkendeNaamBetrokkene: + type: string + description: + De naam van de betrokkene waaronder deze in relatie tot de + zaak aangesproken wil worden. + title: afwijkende naam betrokkene + maxLength: 625 + roltype: + type: string + format: uri + description: + URL-referentie naar een roltype binnen het ZAAKTYPE van de + ZAAK. + title: roltype + maxLength: 1000 + omschrijving: + type: string + readOnly: true + description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. + title: omschrijving + omschrijvingGeneriek: + type: string + readOnly: true + description: + "Algemeen gehanteerde benaming van de aard van de ROL, afgeleid\ + \ uit het ROLTYPE.\n\nUitleg bij mogelijke waarden:\n\n* `adviseur` -\ + \ (Adviseur) Kennis in dienst stellen van de behandeling van (een deel\ + \ van) een zaak.\n* `behandelaar` - (Behandelaar) De vakinhoudelijke behandeling\ + \ doen van (een deel van) een zaak.\n* `belanghebbende` - (Belanghebbende)\ + \ Vanuit eigen en objectief belang rechtstreeks betrokken zijn bij de\ + \ behandeling en/of de uitkomst van een zaak.\n* `beslisser` - (Beslisser)\ + \ Nemen van besluiten die voor de uitkomst van een zaak noodzakelijk zijn.\n\ + * `initiator` - (Initiator) Aanleiding geven tot de start van een zaak\ + \ ..\n* `klantcontacter` - (Klantcontacter) Het eerste aanspreekpunt zijn\ + \ voor vragen van burgers en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6\ + rdinator) Er voor zorg dragen dat de behandeling van de zaak in samenhang\ + \ uitgevoerd wordt conform de daarover gemaakte afspraken.\n* `mede_initiator`\ + \ - Mede-initiator" + title: omschrijving generiek + roltoelichting: + type: string + title: roltoelichting + maxLength: 1000 + registratiedatum: + type: string + format: date-time + readOnly: true + description: De datum waarop dit object is geregistreerd. + title: registratiedatum + indicatieMachtiging: + description: 'Indicatie machtiging + + + Uitleg bij mogelijke waarden: + + + * `gemachtigde` - De betrokkene in de rol bij de zaak is door een andere + betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen + + * `machtiginggever` - De betrokkene in de rol bij de zaak heeft een andere + betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen' + title: indicatie machtiging + oneOf: + - $ref: '#/components/schemas/IndicatieMachtigingEnum' + - $ref: '#/components/schemas/BlankEnum' + contactpersoonRol: + allOf: + - $ref: '#/components/schemas/ContactPersoonRol' + nullable: true + description: + De gegevens van de persoon die anderen desgevraagd in contact + brengt met medewerkers van de BETROKKENE, een NIET-NATUURLIJK PERSOON + of VESTIGING zijnde, of met BETROKKENE zelf, een NATUURLIJK PERSOON zijnde + , vanuit het belang van BETROKKENE in haar ROL bij een ZAAK. + title: contactpersoonRol + statussen: + type: array + items: + type: string + format: uri + title: '' + minLength: 1 + maxLength: 1000 + readOnly: true + description: + De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd + dat STATUSsen in die ZAAK bereikt zijn. + title: statussen + uniqueItems: true + _expand: + $ref: '#/components/schemas/RolEmbedded' + required: + - betrokkeneType + - omschrijving + - omschrijvingGeneriek + - registratiedatum + - roltoelichting + - roltype + - statussen + - url + - uuid + - zaak + discriminator: + propertyName: betrokkeneType + mapping: + medewerker: '#/components/schemas/medewerker_RolExpanded' + natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_RolExpanded' + niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_RolExpanded' + organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_RolExpanded' + vestiging: '#/components/schemas/vestiging_RolExpanded' + + RolEmbedded: + type: object + properties: + zaak: + $ref: '#/components/schemas/ZaakExpanded' + example: {} + roltype: + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/RolType' + statussen: + type: array + items: + $ref: '#/components/schemas/StatusExpanded' + RolMedewerker: + type: object + properties: + identificatie: + type: string + description: Een korte unieke aanduiding van de MEDEWERKER. + title: identificatie + maxLength: 24 + achternaam: + type: string + description: + De achternaam zoals de MEDEWERKER die in het dagelijkse verkeer + gebruikt. + title: achternaam + maxLength: 200 + voorletters: + type: string + description: + De verzameling letters die gevormd wordt door de eerste letter + van alle in volgorde voorkomende voornamen. + title: voorletters + maxLength: 20 + voorvoegselAchternaam: + type: string + description: + Dat deel van de geslachtsnaam dat voorkomt in Tabel 36 (GBA), + voorvoegseltabel, en door een spatie van de geslachtsnaam is + title: voorvoegsel achternaam + maxLength: 10 + RolNatuurlijkPersoon: + type: object + properties: + inpBsn: + type: string + description: + Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet + algemene bepalingen burgerservicenummer. + title: inp bsn + maxLength: 9 + anpIdentificatie: + type: string + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NATUURLIJK PERSOON + title: anp identificatie + maxLength: 17 + inpA_nummer: + type: string + description: Het administratienummer van de persoon, bedoeld in de Wet BRP + title: inp a nummer + pattern: ^[1-9][0-9]{9}$ + maxLength: 10 + geslachtsnaam: + type: string + description: De stam van de geslachtsnaam. + title: geslachtsnaam + maxLength: 200 + voorvoegselGeslachtsnaam: + type: string + title: voorvoegsel geslachtsnaam + maxLength: 80 + voorletters: + type: string + description: + De verzameling letters die gevormd wordt door de eerste letter + van alle in volgorde voorkomende voornamen. + title: voorletters + maxLength: 20 + voornamen: + type: string + description: Voornamen bij de naam die de persoon wenst te voeren. + title: voornamen + maxLength: 200 + geslachtsaanduiding: + description: + 'Een aanduiding die aangeeft of de persoon een man of een vrouw + is, of dat het geslacht nog onbekend is. + + + Uitleg bij mogelijke waarden: + + + * `m` - Man + + * `v` - Vrouw + + * `o` - Onbekend' + title: geslachtsaanduiding + oneOf: + - $ref: '#/components/schemas/GeslachtsaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + geboortedatum: + type: string + title: geboortedatum + maxLength: 18 + verblijfsadres: + allOf: + - $ref: '#/components/schemas/VerblijfsAdres' + nullable: true + title: verblijfsadres + subVerblijfBuitenland: + allOf: + - $ref: '#/components/schemas/SubVerblijfBuitenland' + nullable: true + title: subVerblijfBuitenland + RolNietNatuurlijkPersoon: + type: object + properties: + innNnpId: + type: string + description: + Het door een kamer toegekend uniek nummer voor de INGESCHREVEN + NIET-NATUURLIJK PERSOON + title: inn nnp id + maxLength: 9 + annIdentificatie: + type: string + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NIET-NATUURLIJK PERSOON + title: ann identificatie + maxLength: 17 + statutaireNaam: + type: string + description: + Naam van de niet-natuurlijke persoon zoals deze is vastgelegd + in de statuten (rechtspersoon) of in de vennootschapsovereenkomst is overeengekomen + (Vennootschap onder firma of Commanditaire vennootschap). + title: statutaire naam + maxLength: 500 + innRechtsvorm: + description: De juridische vorm van de NIET-NATUURLIJK PERSOON. + title: inn rechtsvorm + oneOf: + - $ref: '#/components/schemas/InnRechtsvormEnum' + - $ref: '#/components/schemas/BlankEnum' + bezoekadres: + type: string + description: De gegevens over het adres van de NIET-NATUURLIJK PERSOON + title: bezoekadres + maxLength: 1000 + subVerblijfBuitenland: + allOf: + - $ref: '#/components/schemas/SubVerblijfBuitenland' + nullable: true + title: subVerblijfBuitenland + RolOrganisatorischeEenheid: + type: object + properties: + identificatie: + type: string + description: Een korte identificatie van de organisatorische eenheid. + title: identificatie + maxLength: 24 + naam: + type: string + description: De feitelijke naam van de organisatorische eenheid. + title: naam + maxLength: 50 + isGehuisvestIn: + type: string + title: is gehuisvest in + maxLength: 24 + RolVestiging: + type: object + properties: + vestigingsNummer: + type: string + description: Een korte unieke aanduiding van de Vestiging. + title: vestigings nummer + maxLength: 24 + handelsnaam: + type: array + items: + type: string + maxLength: 625 + description: De naam van de vestiging waaronder gehandeld wordt. + title: handelsnaam + verblijfsadres: + allOf: + - $ref: '#/components/schemas/VerblijfsAdres' + nullable: true + title: verblijfsadres + subVerblijfBuitenland: + allOf: + - $ref: '#/components/schemas/SubVerblijfBuitenland' + nullable: true + title: subVerblijfBuitenland + kvkNummer: + type: string + description: Een uniek nummer gekoppeld aan de onderneming. + title: kvk nummer + maxLength: 8 + Status: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + statustype: + type: string + format: uri + description: URL-referentie naar het STATUSTYPE (in de Catalogi API). + title: statustype + maxLength: 1000 + datumStatusGezet: + type: string + format: date-time + description: De datum waarop de ZAAK de status heeft verkregen. + title: datum status gezet + statustoelichting: + type: string + description: + Een, voor de initiator van de zaak relevante, toelichting op + de status van een zaak. + title: statustoelichting + maxLength: 1000 + indicatieLaatstGezetteStatus: + type: boolean + readOnly: true + description: + Het gegeven is afleidbaar uit de historie van de attribuutsoort + Datum status gezet van van alle statussen bij de desbetreffende zaak. + title: indicatieLaatstGezetteStatus + gezetdoor: + type: string + format: uri + title: Gezet door + description: + De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd + dat STATUSsen in die ZAAK bereikt zijn. + maxLength: 200 + zaakinformatieobjecten: + type: array + items: + type: string + format: uri + title: '' + minLength: 1 + maxLength: 1000 + readOnly: true + title: zaakInformatieobjecten + uniqueItems: true + required: + - datumStatusGezet + - indicatieLaatstGezetteStatus + - statustype + - url + - uuid + - zaak + - zaakinformatieobjecten + StatusExpanded: + allOf: + - $ref: '#/components/schemas/Status' + - properties: + _expand: + $ref: '#/components/schemas/StatusEmbedded' + StatusEmbedded: + type: object + properties: + statustype: + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/StatusType' + gezetdoor: + $ref: '#/components/schemas/Rol' + zaakinformatieobjecten: + type: array + items: + $ref: '#/components/schemas/ZaakInformatieObject' + StatusRequestbody: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + statustype: + type: string + format: uri + description: URL-referentie naar het STATUSTYPE (in de Catalogi API). + title: statustype + maxLength: 1000 + datumStatusGezet: + type: string + format: date-time + description: De datum waarop de ZAAK de status heeft verkregen. + title: datum status gezet + statustoelichting: + type: string + description: + Een, voor de initiator van de zaak relevante, toelichting op + de status van een zaak. + title: statustoelichting + maxLength: 1000 + indicatieLaatstGezetteStatus: + type: boolean + readOnly: true + description: + Het gegeven is afleidbaar uit de historie van de attribuutsoort + Datum status gezet van van alle statussen bij de desbetreffende zaak. + title: indicatieLaatstGezetteStatus + gezetdoor: + type: string + format: uri + title: Gezet door + description: + De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd + dat STATUSsen in die ZAAK bereikt zijn. + maxLength: 200 + required: + - datumStatusGezet + - indicatieLaatstGezetteStatus + - statustype + - url + - uuid + - zaak + - zaakinformatieobjecten + SubVerblijfBuitenland: + type: object + properties: + lndLandcode: + type: string + description: + De code, behorende bij de landnaam, zoals opgenomen in de Land/Gebied-tabel + van de BRP. + title: lnd landcode + maxLength: 4 + lndLandnaam: + type: string + description: + De naam van het land, zoals opgenomen in de Land/Gebied-tabel + van de BRP. + title: lnd landnaam + maxLength: 40 + subAdresBuitenland_1: + type: string + title: sub adres buitenland 1 + maxLength: 35 + subAdresBuitenland_2: + type: string + title: sub adres buitenland 2 + maxLength: 35 + subAdresBuitenland_3: + type: string + title: sub adres buitenland 3 + maxLength: 35 + required: + - lndLandcode + - lndLandnaam + TerreinGebouwdObjectAdres: + type: object + properties: + numIdentificatie: + type: string + title: num identificatie + maxLength: 100 + oaoIdentificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + wplWoonplaatsNaam: + type: string + title: wpl woonplaats naam + maxLength: 80 + gorOpenbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: gor openbare ruimte naam + maxLength: 80 + aoaPostcode: + type: string + title: postcode + maxLength: 7 + aoaHuisnummer: + type: integer + maximum: 99999 + minimum: 0 + title: huisnummer + aoaHuisletter: + type: string + title: huisletter + maxLength: 1 + aoaHuisnummertoevoeging: + type: string + title: huisnummertoevoeging + maxLength: 4 + ogoLocatieAanduiding: + type: string + title: locatie aanduiding + maxLength: 100 + required: + - aoaHuisnummer + - gorOpenbareRuimteNaam + - oaoIdentificatie + - wplWoonplaatsNaam + TypeWaterdeelEnum: + enum: + - zee + - waterloop + - watervlakte + - greppel_droge_sloot + type: string + ValidatieFout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: + URI met referentie naar dit specifiek voorkomen van de fout. + Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + invalidParams: + type: array + items: + $ref: '#/components/schemas/FieldValidationError' + title: invalidParams + required: + - code + - detail + - instance + - invalidParams + - status + - title + VerblijfsAdres: + type: object + properties: + aoaIdentificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + wplWoonplaatsNaam: + type: string + title: wpl woonplaats naam + maxLength: 80 + gorOpenbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: gor openbare ruimte naam + maxLength: 80 + aoaPostcode: + type: string + title: postcode + maxLength: 7 + aoaHuisnummer: + type: integer + maximum: 99999 + minimum: 0 + title: huisnummer + aoaHuisletter: + type: string + title: huisletter + maxLength: 1 + aoaHuisnummertoevoeging: + type: string + title: huisnummertoevoeging + maxLength: 4 + inpLocatiebeschrijving: + type: string + title: locatie omschrijving + maxLength: 1000 + required: + - aoaHuisnummer + - aoaIdentificatie + - gorOpenbareRuimteNaam + - wplWoonplaatsNaam + Verlenging: + type: object + description: + Gegevens omtrent het verlengen van de doorlooptijd van de behandeling + van de ZAAK + properties: + reden: + type: string + description: + Omschrijving van de reden voor het verlengen van de behandeling + van de zaak. + title: reden verlenging + maxLength: 200 + duur: + type: string + description: + Het aantal werkbare dagen waarmee de doorlooptijd van de behandeling + van de ZAAK is verlengd (of verkort) ten opzichte van de eerder gecommuniceerde + doorlooptijd. + title: duur verlenging + format: duration + required: + - duur + - reden + nullable: true + VertrouwelijkheidaanduidingEnum: + enum: + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim + type: string + Wijzigingen: + type: object + properties: + oud: + type: object + additionalProperties: {} + description: + Volledige JSON body van het object zoals dat bestond voordat + de actie heeft plaatsgevonden. + title: oud + nieuw: + type: object + additionalProperties: {} + description: Volledige JSON body van het object na de actie. + title: nieuw + WozObjectAdres: + type: object + properties: + aoaIdentificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + wplWoonplaatsNaam: + type: string + title: wpl woonplaats naam + maxLength: 80 + gorOpenbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: gor openbare ruimte naam + maxLength: 80 + aoaPostcode: + type: string + title: postcode + maxLength: 7 + aoaHuisnummer: + type: integer + maximum: 99999 + minimum: 0 + title: huisnummer + aoaHuisletter: + type: string + title: huisletter + maxLength: 1 + aoaHuisnummertoevoeging: + type: string + title: huisnummertoevoeging + maxLength: 4 + locatieOmschrijving: + type: string + title: locatie omschrijving + maxLength: 1000 + required: + - aoaHuisnummer + - aoaIdentificatie + - gorOpenbareRuimteNaam + - wplWoonplaatsNaam + Zaak: + type: object + description: 'Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + identificatie: + type: string + description: + De unieke identificatie van de ZAAK binnen de organisatie die + verantwoordelijk is voor de behandeling van de ZAAK. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + description: + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers + en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + title: bronorganisatie + maxLength: 9 + omschrijving: + type: string + description: Een korte omschrijving van de zaak. + title: omschrijving + maxLength: 80 + toelichting: + type: string + description: Een toelichting op de zaak. + title: toelichting + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de + CATALOGUS waar deze voorkomt + title: zaaktype + maxLength: 1000 + registratiedatum: + type: string + format: date + description: + De datum waarop de zaakbehandelende organisatie de ZAAK heeft + geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag + gebruikt. + title: registratiedatum + verantwoordelijkeOrganisatie: + type: string + description: + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die eindverantwoordelijk is voor de behandeling van de zaak. Dit moet + een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + title: verantwoordelijke organisatie + maxLength: 9 + startdatum: + type: string + format: date + description: De datum waarop met de uitvoering van de zaak is gestart + title: startdatum + einddatum: + type: string + format: date + readOnly: true + nullable: true + description: De datum waarop de uitvoering van de zaak afgerond is. + title: einddatum + einddatumGepland: + type: string + format: date + nullable: true + description: + De datum waarop volgens de planning verwacht wordt dat de zaak + afgerond wordt. + title: einddatum gepland + uiterlijkeEinddatumAfdoening: + type: string + format: date + nullable: true + description: + De laatste datum waarop volgens wet- en regelgeving de zaak + afgerond dient te zijn. + title: uiterlijke einddatum afdoening + publicatiedatum: + type: string + format: date + nullable: true + description: Datum waarop (het starten van) de zaak gepubliceerd is of wordt. + title: publicatiedatum + communicatiekanaal: + type: string + format: uri + description: + Het medium waarlangs de aanleiding om een zaak te starten is + ontvangen. URL naar een communicatiekanaal in de VNG-Referentielijst van + communicatiekanalen. + title: communicatiekanaal + maxLength: 1000 + productenOfDiensten: + type: array + items: + type: string + format: uri + title: URL naar product/dienst + maxLength: 1000 + description: + De producten en/of diensten die door de zaak worden voortgebracht. + Dit zijn URLs naar de resources zoals die door de producten- en dienstencatalogus-API + wordt ontsloten. De producten/diensten moeten bij het zaaktype vermeld + zijn. + title: producten of diensten + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + title: Vertrouwlijkheidaanduiding + description: + Aanduiding van de mate waarin het zaakdossier van de ZAAK voor + de openbaarheid bestemd is. Optioneel - indien geen waarde gekozen wordt, + dan wordt de waarde van het ZAAKTYPE overgenomen. Dit betekent dat de + API _altijd_ een waarde teruggeeft. + betalingsindicatie: + description: + 'Indicatie of de, met behandeling van de zaak gemoeide, kosten + betaald zijn door de desbetreffende betrokkene. + + + Uitleg bij mogelijke waarden: + + + * `nvt` - Er is geen sprake van te betalen, met de zaak gemoeide, kosten. + + * `nog_niet` - De met de zaak gemoeide kosten zijn (nog) niet betaald. + + * `gedeeltelijk` - De met de zaak gemoeide kosten zijn gedeeltelijk betaald. + + * `geheel` - De met de zaak gemoeide kosten zijn geheel betaald.' + title: betalingsindicatie + oneOf: + - $ref: '#/components/schemas/BetalingsindicatieEnum' + - $ref: '#/components/schemas/BlankEnum' + betalingsindicatieWeergave: + type: string + readOnly: true + description: Uitleg bij `betalingsindicatie`. + title: betalingsindicatieWeergave + laatsteBetaaldatum: + type: string + format: date-time + nullable: true + description: + De datum waarop de meest recente betaling is verwerkt van kosten + die gemoeid zijn met behandeling van de zaak. + title: laatste betaaldatum + zaakgeometrie: + allOf: + - $ref: '#/components/schemas/GeoJSONGeometry' + nullable: true + description: Punt, lijn of (multi-)vlak geometrie-informatie, in GeoJSON. + title: zaakgeometrie + verlenging: + allOf: + - $ref: '#/components/schemas/Verlenging' + nullable: true + description: + Gegevens omtrent het verlengen van de doorlooptijd van de behandeling + van de ZAAK + title: verlenging + opschorting: + allOf: + - $ref: '#/components/schemas/Opschorting' + nullable: true + description: + Gegevens omtrent het tijdelijk opschorten van de behandeling + van de ZAAK + title: opschorting + selectielijstklasse: + type: string + format: uri + description: + URL-referentie naar de categorie in de gehanteerde 'Selectielijst + Archiefbescheiden' die, gezien het zaaktype en het resultaattype van de + zaak, bepalend is voor het archiefregime van de zaak. + title: selectielijstklasse + maxLength: 1000 + hoofdzaak: + type: string + format: uri + nullable: true + title: Is deelzaak van + description: + "URL-referentie naar de ZAAK, waarom verzocht is door de initiator\ + \ daarvan, die behandeld wordt in twee of meer separate ZAAKen waarvan\ + \ de onderhavige ZAAK er \xE9\xE9n is." + minLength: 1 + maxLength: 1000 + deelzaken: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar deel ZAAKen. + title: is deelzaak van + uniqueItems: true + relevanteAndereZaken: + type: array + items: + $ref: '#/components/schemas/RelevanteZaak' + description: Een lijst van relevante andere zaken. + title: zaak + eigenschappen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + rollen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + status: + type: string + format: uri + readOnly: true + nullable: true + description: Indien geen status bekend is, dan is de waarde 'null' + title: status + zaakinformatieobjecten: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + zaakobjecten: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + kenmerken: + type: array + items: + $ref: '#/components/schemas/ZaakKenmerk' + description: + Lijst van kenmerken. Merk op dat refereren naar gerelateerde + objecten beter kan via `ZaakObject`. + title: zaak + archiefnominatie: + nullable: true + description: + 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + + + Uitleg bij mogelijke waarden: + + + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum + overgedragen worden naar een archiefbewaarplaats. + + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' + title: archiefnominatie + oneOf: + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/NullEnum' + archiefstatus: + allOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + description: + 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + + + Uitleg bij mogelijke waarden: + + + * `nog_te_archiveren` - De zaak cq. het zaakdossier is nog niet als geheel + gearchiveerd. + + * `gearchiveerd` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar + bewaarbaar gemaakt. + + * `gearchiveerd_procestermijn_onbekend` - De zaak cq. het zaakdossier + is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum + kan nog niet bepaald worden. + + * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een + archiefbewaarplaats.' + title: archiefstatus + archiefactiedatum: + type: string + format: date + nullable: true + description: + De datum waarop het gearchiveerde zaakdossier vernietigd moet + worden dan wel overgebracht moet worden naar een archiefbewaarplaats. + Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT + aan deze ZAAK indien nog leeg. + title: archiefactiedatum + resultaat: + type: string + format: uri + readOnly: true + nullable: true + description: + URL-referentie naar het RESULTAAT. Indien geen resultaat bekend + is, dan is de waarde 'null' + title: resultaat + opdrachtgevendeOrganisatie: + type: string + description: + De krachtens publiekrecht ingestelde rechtspersoon dan wel + ander niet-natuurlijk persoon waarbinnen het (bestuurs)orgaan zetelt dat + opdracht heeft gegeven om taken uit te voeren waaraan de zaak invulling + geeft. + title: opdrachtgevende organisatie + maxLength: 9 + processobjectaard: + type: string + nullable: true + title: Procesobjectaard + description: + Omschrijving van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, de zaak betrekking heeft. + maxLength: 200 + startdatumBewaartermijn: + type: string + format: date + nullable: true + description: + De datum die de start markeert van de termijn waarop het zaakdossier + vernietigd moet worden. + title: startdatum bewaartermijn + processobject: + allOf: + - $ref: '#/components/schemas/Processobject' + nullable: true + description: + Specificatie van de attribuutsoort van het object, subject + of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking + heeft en dat bepalend is voor de start van de archiefactietermijn. + title: processobject + required: + - betalingsindicatieWeergave + - bronorganisatie + - deelzaken + - eigenschappen + - einddatum + - resultaat + - rollen + - startdatum + - status + - url + - uuid + - verantwoordelijkeOrganisatie + - zaakinformatieobjecten + - zaakobjecten + - zaaktype + ZaakExpanded: + allOf: + - $ref: '#/components/schemas/Zaak' + - properties: + _expand: + $ref: '#/components/schemas/ZaakEmbedded' + ZaakEmbedded: + type: object + properties: + zaaktype: + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakType' + hoofdzaak: + oneOf: + - $ref: '#/components/schemas/ZaakExpanded' + - $ref: '#/components/schemas/EmptyObject' + example: {} + deelzaken: + type: array + items: + $ref: '#/components/schemas/ZaakExpanded' + example: [{}] + relevanteAndereZaken: + type: array + items: + $ref: '#/components/schemas/ZaakExpanded' + example: [{}] + eigenschappen: + type: array + items: + $ref: '#/components/schemas/ZaakEigenschapExpanded' + rollen: + type: array + items: + $ref: '#/components/schemas/RolExpanded' + status: + oneOf: + - $ref: '#/components/schemas/StatusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaakobjecten: + type: array + items: + $ref: '#/components/schemas/ZaakObjectExpanded' + resultaat: + oneOf: + - $ref: '#/components/schemas/ResultaatExpanded' + - $ref: '#/components/schemas/EmptyObject' + EmptyObject: + type: object + description: Leeg object. Dit wordt teruggeven indien het te expanderen veld een null waarde heeft. + example: {} + ExpandCatalogusObject: + type: object + properties: + _expand: + type: object + description: Zie de Catalogus API hoe dit object verder geëxpandeerd kan worden. + ZaakBesluit: + type: object + description: + "A type of `ModelSerializer` that uses hyperlinked relationships + with compound keys instead + + of primary key relationships. Specifically: + + + * A 'url' field is included instead of the 'id' field. + + * Relationships to other instances are hyperlinks, instead of primary keys. + + + NOTE: this only works with DRF 3.1.0 and above." + properties: + url: + type: string + format: uri + readOnly: true + title: url + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + besluit: + type: string + format: uri + description: + URL-referentie naar het BESLUIT (in de Besluiten API), waar + ook de relatieinformatie opgevraagd kan worden. + title: besluit + maxLength: 1000 + required: + - besluit + - url + - uuid + ZaakContactMoment: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + contactmoment: + type: string + format: uri + description: + URL-referentie naar het CONTACTMOMENT (in de Klantinteractie + API) + title: contactmoment + maxLength: 1000 + required: + - contactmoment + - url + - uuid + - zaak + ZaakEigenschap: + type: object + description: + "A type of `ModelSerializer` that uses hyperlinked relationships + with compound keys instead + + of primary key relationships. Specifically: + + + * A 'url' field is included instead of the 'id' field. + + * Relationships to other instances are hyperlinks, instead of primary keys. + + + NOTE: this only works with DRF 3.1.0 and above." + properties: + url: + type: string + format: uri + readOnly: true + title: url + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + title: zaak + eigenschap: + type: string + format: uri + description: URL-referentie naar de EIGENSCHAP (in de Catalogi API). + title: eigenschap + maxLength: 1000 + naam: + type: string + readOnly: true + description: De naam van de EIGENSCHAP (overgenomen uit de Catalogi API). + title: ' naam' + waarde: + type: string + title: waarde + required: + - eigenschap + - naam + - url + - uuid + - waarde + - zaak + ZaakEigenschapExpanded: + allOf: + - $ref: '#/components/schemas/ZaakEigenschap' + - properties: + _expand: + $ref: '#/components/schemas/ZaakEigenschapEmbedded' + ZaakEigenschapEmbedded: + type: object + properties: + zaak: + oneOf: + - $ref: '#/components/schemas/ZaakExpanded' + - $ref: '#/components/schemas/EmptyObject' + eigenschap: + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/Eigenschap' + ZaakInformatieObject: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + informatieobject: + type: string + format: uri + description: + URL-referentie naar het INFORMATIEOBJECT (in de Documenten + API), waar ook de relatieinformatie opgevraagd kan worden. + title: informatieobject + maxLength: 1000 + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + aardRelatieWeergave: + allOf: + - $ref: '#/components/schemas/AardRelatieWeergaveEnum' + readOnly: true + title: aardRelatieWeergave + titel: + type: string + description: + De naam waaronder het INFORMATIEOBJECT binnen het OBJECT bekend + is. + title: titel + maxLength: 200 + beschrijving: + type: string + description: + Een op het object gerichte beschrijving van de inhoud vanhet + INFORMATIEOBJECT. + title: beschrijving + registratiedatum: + type: string + format: date-time + readOnly: true + description: + De datum waarop de behandelende organisatie het INFORMATIEOBJECT + heeft geregistreerd bij het OBJECT. Geldige waardes zijn datumtijden gelegen + op of voor de huidige datum en tijd. + title: registratiedatum + vernietigingsdatum: + type: string + format: date-time + nullable: true + description: + De datum waarop het informatieobject uit het zaakdossier verwijderd + moet worden. + title: vernietigingsdatum + status: + type: string + format: uri + nullable: true + description: + De bij de desbetreffende ZAAK behorende STATUS waarvoor het + ZAAK-INFORMATIEOBJECT relevant is (geweest) met het oog op het bereiken + van die STATUS en/of de communicatie daarover. + title: status + minLength: 1 + maxLength: 1000 + required: + - aardRelatieWeergave + - informatieobject + - registratiedatum + - url + - uuid + - zaak + ZaakInformatieObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakInformatieObject' + - properties: + _expand: + $ref: '#/components/schemas/ZaakInformatieObjectEmbedded' + ZaakInformatieObjectEmbedded: + type: object + properties: + status: + $ref: '#/components/schemas/StatusExpanded' + ZaakKenmerk: + type: object + properties: + kenmerk: + type: string + description: Identificeert uniek de zaak in een andere administratie. + title: kenmerk + maxLength: 40 + bron: + type: string + description: De aanduiding van de administratie waar het kenmerk op slaat. + title: bron + maxLength: 40 + required: + - bron + - kenmerk + ZaakObject: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + object: + type: string + format: uri + description: URL-referentie naar de resource die het OBJECT beschrijft. + title: object + maxLength: 1000 + zaakobjecttype: + type: string + format: uri + description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API). + title: zaakobjecttype + maxLength: 1000 + objectType: + allOf: + - $ref: '#/components/schemas/ObjectTypeEnum' + description: + 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er + geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. + + + Uitleg bij mogelijke waarden: + + + * `adres` - Adres + + * `besluit` - Besluit + + * `buurt` - Buurt + + * `enkelvoudig_document` - Enkelvoudig document + + * `gemeente` - Gemeente + + * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte + + * `huishouden` - Huishouden + + * `inrichtingselement` - Inrichtingselement + + * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak + + * `kunstwerkdeel` - Kunstwerkdeel + + * `maatschappelijke_activiteit` - Maatschappelijke activiteit + + * `medewerker` - Medewerker + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `openbare_ruimte` - Openbare ruimte + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `pand` - Pand + + * `spoorbaandeel` - Spoorbaandeel + + * `status` - Status + + * `terreindeel` - Terreindeel + + * `terrein_gebouwd_object` - Terrein gebouwd object + + * `vestiging` - Vestiging + + * `waterdeel` - Waterdeel + + * `wegdeel` - Wegdeel + + * `wijk` - Wijk + + * `woonplaats` - Woonplaats + + * `woz_deelobject` - Woz deel object + + * `woz_object` - Woz object + + * `woz_waarde` - Woz waarde + + * `zakelijk_recht` - Zakelijk recht + + * `overige` - Overige' + title: object type + objectTypeOverige: + type: string + description: + Beschrijft het type OBJECT als `objectType` de waarde "overige" + heeft. + title: object type overige + pattern: '[a-z\_]+' + maxLength: 100 + objectTypeOverigeDefinitie: + allOf: + - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie' + nullable: true + title: definitie object type overige + description: + 'Verwijzing naar het schema van het type OBJECT als `objectType` + de waarde "overige" heeft. + + + * De URL referentie moet naar een JSON endpoint wijzen waarin het objecttype + gedefinieerd is, inclusief het [JSON-schema](https://json-schema.org/). + + * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen de + objecttype resource (deze gebruikt het [jq](http://stedolan.github.io/jq/) + formaat. + + * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens binnen + het OBJECT. Deze gebruikt ook het [jq](http://stedolan.github.io/jq/) + formaat. + + + Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven + en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven + OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.' + relatieomschrijving: + type: string + description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. + title: relatieomschrijving + maxLength: 80 + required: + - objectType + - url + - uuid + - zaak + discriminator: + propertyName: objectType + mapping: + adres: '#/components/schemas/adres_ZaakObject' + besluit: '#/components/schemas/besluit_ZaakObject' + buurt: '#/components/schemas/buurt_ZaakObject' + enkelvoudig_document: '#/components/schemas/enkelvoudig_document_ZaakObject' + gemeente: '#/components/schemas/gemeente_ZaakObject' + gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_ZaakObject' + huishouden: '#/components/schemas/huishouden_ZaakObject' + inrichtingselement: '#/components/schemas/inrichtingselement_ZaakObject' + kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_ZaakObject' + kunstwerkdeel: '#/components/schemas/kunstwerkdeel_ZaakObject' + maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_ZaakObject' + medewerker: '#/components/schemas/medewerker_ZaakObject' + natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_ZaakObject' + niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_ZaakObject' + openbare_ruimte: '#/components/schemas/openbare_ruimte_ZaakObject' + organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_ZaakObject' + pand: '#/components/schemas/pand_ZaakObject' + spoorbaandeel: '#/components/schemas/spoorbaandeel_ZaakObject' + status: '#/components/schemas/status_ZaakObject' + terreindeel: '#/components/schemas/terreindeel_ZaakObject' + terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_ZaakObject' + vestiging: '#/components/schemas/vestiging_ZaakObject' + waterdeel: '#/components/schemas/waterdeel_ZaakObject' + wegdeel: '#/components/schemas/wegdeel_ZaakObject' + wijk: '#/components/schemas/wijk_ZaakObject' + woonplaats: '#/components/schemas/woonplaats_ZaakObject' + woz_deelobject: '#/components/schemas/woz_deelobject_ZaakObject' + woz_object: '#/components/schemas/woz_object_ZaakObject' + woz_waarde: '#/components/schemas/woz_waarde_ZaakObject' + zakelijk_recht: '#/components/schemas/zakelijk_recht_ZaakObject' + overige: '#/components/schemas/overige_ZaakObject' + ZaakObjectExpanded: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + object: + type: string + format: uri + description: URL-referentie naar de resource die het OBJECT beschrijft. + title: object + maxLength: 1000 + zaakobjecttype: + type: string + format: uri + description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API). + title: zaakobjecttype + maxLength: 1000 + objectType: + allOf: + - $ref: '#/components/schemas/ObjectTypeEnum' + description: + 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er + geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. + + + Uitleg bij mogelijke waarden: + + + * `adres` - Adres + + * `besluit` - Besluit + + * `buurt` - Buurt + + * `enkelvoudig_document` - Enkelvoudig document + + * `gemeente` - Gemeente + + * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte + + * `huishouden` - Huishouden + + * `inrichtingselement` - Inrichtingselement + + * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak + + * `kunstwerkdeel` - Kunstwerkdeel + + * `maatschappelijke_activiteit` - Maatschappelijke activiteit + + * `medewerker` - Medewerker + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `openbare_ruimte` - Openbare ruimte + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `pand` - Pand + + * `spoorbaandeel` - Spoorbaandeel + + * `status` - Status + + * `terreindeel` - Terreindeel + + * `terrein_gebouwd_object` - Terrein gebouwd object + + * `vestiging` - Vestiging + + * `waterdeel` - Waterdeel + + * `wegdeel` - Wegdeel + + * `wijk` - Wijk + + * `woonplaats` - Woonplaats + + * `woz_deelobject` - Woz deel object + + * `woz_object` - Woz object + + * `woz_waarde` - Woz waarde + + * `zakelijk_recht` - Zakelijk recht + + * `overige` - Overige' + title: object type + objectTypeOverige: + type: string + description: + Beschrijft het type OBJECT als `objectType` de waarde "overige" + heeft. + title: object type overige + pattern: '[a-z\_]+' + maxLength: 100 + objectTypeOverigeDefinitie: + allOf: + - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie' + nullable: true + title: definitie object type overige + description: + 'Verwijzing naar het schema van het type OBJECT als `objectType` + de waarde "overige" heeft. + + + * De URL referentie moet naar een JSON endpoint wijzen waarin het objecttype + gedefinieerd is, inclusief het [JSON-schema](https://json-schema.org/). + + * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen de + objecttype resource (deze gebruikt het [jq](http://stedolan.github.io/jq/) + formaat. + + * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens binnen + het OBJECT. Deze gebruikt ook het [jq](http://stedolan.github.io/jq/) + formaat. + + + Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven + en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven + OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.' + relatieomschrijving: + type: string + description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. + title: relatieomschrijving + maxLength: 80 + _expand: + $ref: '#/components/schemas/ZaakObjectEmbedded' + required: + - objectType + - url + - uuid + - zaak + discriminator: + propertyName: objectType + mapping: + adres: '#/components/schemas/adres_ZaakObjectExpanded' + besluit: '#/components/schemas/besluit_ZaakObjectExpanded' + buurt: '#/components/schemas/buurt_ZaakObjectExpanded' + enkelvoudig_document: '#/components/schemas/enkelvoudig_document_ZaakObjectExpanded' + gemeente: '#/components/schemas/gemeente_ZaakObjectExpanded' + gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_ZaakObjectExpanded' + huishouden: '#/components/schemas/huishouden_ZaakObjectExpanded' + inrichtingselement: '#/components/schemas/inrichtingselement_ZaakObjectExpanded' + kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_ZaakObjectExpanded' + kunstwerkdeel: '#/components/schemas/kunstwerkdeel_ZaakObjectExpanded' + maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_ZaakObjectExpanded' + medewerker: '#/components/schemas/medewerker_ZaakObjectExpanded' + natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_ZaakObjectExpanded' + niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_ZaakObjectExpanded' + openbare_ruimte: '#/components/schemas/openbare_ruimte_ZaakObjectExpanded' + organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_ZaakObjectExpanded' + pand: '#/components/schemas/pand_ZaakObjectExpanded' + spoorbaandeel: '#/components/schemas/spoorbaandeel_ZaakObjectExpanded' + status: '#/components/schemas/status_ZaakObjectExpanded' + terreindeel: '#/components/schemas/terreindeel_ZaakObjectExpanded' + terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_ZaakObjectExpanded' + vestiging: '#/components/schemas/vestiging_ZaakObjectExpanded' + waterdeel: '#/components/schemas/waterdeel_ZaakObjectExpanded' + wegdeel: '#/components/schemas/wegdeel_ZaakObjectExpanded' + wijk: '#/components/schemas/wijk_ZaakObjectExpanded' + woonplaats: '#/components/schemas/woonplaats_ZaakObjectExpanded' + woz_deelobject: '#/components/schemas/woz_deelobject_ZaakObjectExpanded' + woz_object: '#/components/schemas/woz_object_ZaakObjectExpanded' + woz_waarde: '#/components/schemas/woz_waarde_ZaakObjectExpanded' + zakelijk_recht: '#/components/schemas/zakelijk_recht_ZaakObjectExpanded' + overige: '#/components/schemas/overige_ZaakObjectExpanded' + ZaakObjectEmbedded: + type: object + properties: + zaakobjecttype: + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakObjectType' + ZaakVerzoek: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + verzoek: + type: string + format: uri + description: URL-referentie naar het VERZOEK (in de Klantinteractie API) + title: verzoek + maxLength: 1000 + required: + - url + - uuid + - verzoek + - zaak + ZaakZoek: + type: object + properties: + zaakgeometrie: + $ref: '#/components/schemas/GeoWithin' + uuid__in: + description: Array of unieke resource identifiers (UUID4) + type: array + items: + type: string + format: uuid + example: ["e80b7507-199a-484c-ad49-c41a1e43a6e7", "78e12133-c467-4202-91ba-4417baa52801"] + identificatie: + title: Identificatie + description: De unieke identificatie van de ZAAK binnen de organisatie die + verantwoordelijk is voor de behandeling van de ZAAK. + type: string + example: "zaak123" + bronorganisatie: + title: Bronorganisatie + description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers + en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + type: string + example: "000000000" + bronorganisatie__in: + description: Array van bronorganisaties. + type: array + items: + type: string + format: string + example: ["000000000","479559740","875883461"] + zaaktype: + title: Zaaktype + description: URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de + CATALOGUS waar deze voorkomt + type: string + example: "https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/e80b7507-199a-484c-ad49-c41a1e43a6e7" + zaaktype__in: + description: Array van zaaktypen. + type: array + items: + type: string + format: uri + example: ["https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/e80b7507-199a-484c-ad49-c41a1e43a6e7","https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/78e12133-c467-4202-91ba-4417baa52801"] + archiefnominatie: + title: Archiefnominatie + description: 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + Uitleg bij mogelijke waarden: + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum + overgedragen worden naar een archiefbewaarplaats. + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' + type: string + enum: + - blijvend_bewaren + - vernietigen + example: "blijvend_bewaren" + archiefnominatie__in: + title: Archiefnominatie in + description: Multiple values may be separated by commas. + type: array + items: + type: string + example: [ "blijvend_bewaren", "vernietigen" ] + archiefactiedatum: + title: Archiefactiedatum + description: De datum waarop het gearchiveerde zaakdossier vernietigd moet + worden dan wel overgebracht moet worden naar een archiefbewaarplaats. + Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT + aan deze ZAAK indien nog leeg. + type: string + example: "2019-01-02" + archiefactiedatum__isnull: + title: Archiefactiedatum is leeg + type: boolean + example: false + archiefactiedatum__lt: + title: Archiefactiedatum kleiner dan + type: string + example: "2020-01-02" + archiefactiedatum__gt: + title: Archiefactiedatum groter dan + type: string + example: "2018-01-02" + archiefstatus: + title: Archiefstatus + description: 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + Uitleg bij mogelijke waarden: + * `nog_te_archiveren` - De zaak cq. het zaakdossier is nog niet als geheel + gearchiveerd. + * `gearchiveerd` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar + bewaarbaar gemaakt. + * `gearchiveerd_procestermijn_onbekend` - De zaak cq. het zaakdossier + is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum + kan nog niet bepaald worden. + * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een + archiefbewaarplaats.' + type: string + enum: + - nog_te_archiveren + - gearchiveerd + - gearchiveerd_procestermijn_onbekend + - overgedragen + example: "nog_te_archiveren" + archiefstatus__in: + title: Archiefstatus in + description: Multiple values may be separated by commas. + type: array + items: + type: string + example: [ "nog_te_archiveren","gearchiveerd","gearchiveerd_procestermijn_onbekend","overgedragen" ] + startdatum: + title: Startdatum + description: De datum waarop met de uitvoering van de zaak is gestart + type: string + example: "2017-01-02" + startdatum__gt: + title: Startdatum groter dan + type: string + example: "2018-01-02" + startdatum__gte: + title: Startdatum groter dan of gelijk + type: string + example: "2016-01-02" + startdatum__lt: + title: Startdatum kleiner dan + type: string + example: "2018-01-02" + startdatum__lte: + title: Startdatum kleiner dan of gelijk + type: string + example: "2018-01-02" + registratiedatum: + title: Registratiedatum + description: De datum waarop de zaakbehandelende organisatie de ZAAK heeft geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag gebruikt. + type: string + example: "2015-01-02" + registratiedatum__gt: + title: Registratiedatum groter dan + type: string + example: "2014-01-02" + registratiedatum__lt: + title: Registratiedatum kleiner dan + type: string + example: "2016-01-02" + einddatum: + title: Einddatum + description: De datum waarop de uitvoering van de zaak afgerond is. + type: string + example: "2022-01-02" + einddatum__isnull: + title: Einddatum is leeg + type: boolean + example: false + einddatum__gt: + title: Einddatum groter dan + type: string + example: "2021-01-02" + einddatum__lt: + title: Einddatum kleiner dan + type: string + minLength: 1 + example: "2023-01-02" + einddatumGepland: + title: Einddatum gepland + description: De datum waarop volgens de planning verwacht wordt dat de zaak afgerond wordt. + type: string + example: "2022-01-02" + einddatumGepland__gt: + title: Einddatum gepland groter dan + type: string + example: "2021-01-02" + einddatumGepland__lt: + title: Einddatum gepland kleiner dan + type: string + example: "2024-01-02" + uiterlijkeEinddatumAfdoening: + title: Uiterlijke einddatumAfdoening + description: De laatste datum waarop volgens wet- en regelgeving de zaak afgerond dient te zijn. + type: string + example: "2024-01-02" + uiterlijkeEinddatumAfdoening__gt: + title: Uiterlijke einddatumAfdoening groter dan + type: string + example: "2023-01-02" + uiterlijkeEinddatumAfdoening__lt: + title: Uiterlijke einddatumAfdoening kleiner dan + type: string + example: "2025-01-02" + rol__betrokkeneType: + title: Rol betrokkenetype + description: 'Type van de `betrokkene`. + Uitleg bij mogelijke waarden: + * `natuurlijk_persoon` - Natuurlijk persoon + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + * `vestiging` - Vestiging + * `organisatorische_eenheid` - Organisatorische eenheid + * `medewerker` - Medewerker' + type: string + enum: + - natuurlijk_persoon + - niet_natuurlijk_persoon + - vestiging + - organisatorische_eenheid + - medewerker + example: "natuurlijk_persoon" + rol__betrokkene: + title: Rol betrokkene + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + type: string + example: "https://example.com" + rol__omschrijvingGeneriek: + title: Rol omschrijvinggeneriek + description: + Algemeen gehanteerde benaming van de aard van de ROL, afgeleid uit het ROLTYPE. + type: string + enum: + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator + example: "initiator" + maximaleVertrouwelijkheidaanduiding: + title: Maximalevertrouwelijkheidaanduiding + description: + Zaken met een vertrouwelijkheidaanduiding die beperkter is + dan de aangegeven aanduiding worden uit de resultaten gefiltered. + type: string + enum: + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim + example: "zaakvertrouwelijk" + rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn: + title: Rol betrokkeneidentificatie natuurlijkpersoon inpbsn + description: Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet + algemene bepalingen burgerservicenummer. + type: string + example: "123456789" + rol__betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie: + title: Rol betrokkeneidentificatie natuurlijkpersoon anpidentificatie + description: Het door de gemeente uitgegeven unieke nummer voor een ANDER + NATUURLIJK PERSOON + type: string + example: "123456789" + rol__betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer: + title: Rol betrokkeneidentificatie natuurlijkpersoon inpa nummer + description: Het administratienummer van de persoon, bedoeld in de Wet BRP + type: string + example: "123456789" + rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId: + title: Rol betrokkeneidentificatie nietnatuurlijkpersoon innnnpid + description: Het door een kamer toegekend uniek nummer voor de INGESCHREVEN + NIET-NATUURLIJK PERSOON + type: string + example: "123456789" + rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie: + title: Rol betrokkeneidentificatie nietnatuurlijkpersoon annidentificatie + description: Het door de gemeente uitgegeven unieke nummer voor een ANDER + NIET-NATUURLIJK PERSOON + type: string + example: "123456789" + rol__betrokkeneIdentificatie__vestiging__vestigingsNummer: + title: Rol betrokkeneidentificatie vestiging vestigingsnummer + description: Een korte unieke aanduiding van de Vestiging. + type: string + example: "123456789" + rol__betrokkeneIdentificatie__medewerker__identificatie: + title: Rol betrokkeneidentificatie medewerker identificatie + description: Een korte unieke aanduiding van de MEDEWERKER. + type: string + example: "123456789" + rol__betrokkeneIdentificatie__organisatorischeEenheid__identificatie: + title: Rol betrokkeneidentificatie organisatorischeeenheid identificatie + description: Een korte identificatie van de organisatorische eenheid. + type: string + example: "123456789" + expand: + description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,` \ + \ hoofdzaak.deelzaken.status.statustype`Haal details van gelinkte resources direct op. + Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt." + title: expand + type: string + example: zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype + ordering: + title: Ordering + description: Het veld waarop de resultaten geordend worden. Het minnetje betekent omgekeerde volgorde. + type: string + enum: + - startdatum + - -startdatum + - einddatum + - -einddatum + - publicatiedatum + - -publicatiedatum + - archiefactiedatum + - -archiefactiedatum + - registratiedatum + - -registratiedatum + - identificatie + - -identificatie + example: "-startdatum" + ZakelijkRechtHeeftAlsGerechtigde: + type: object + properties: + natuurlijkPersoon: + allOf: + - $ref: '#/components/schemas/RolNatuurlijkPersoon' + title: natuurlijkPersoon + nietNatuurlijkPersoon: + allOf: + - $ref: '#/components/schemas/RolNietNatuurlijkPersoon' + title: nietNatuurlijkPersoon + adres_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectAdres' + adres_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectAdres' + adres_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectAdres' + besluit_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + besluit_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + besluit_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + betrokkene_identificatie_RolMedewerker: + type: object + properties: + betrokkeneIdentificatie: + allOf: + - $ref: '#/components/schemas/RolMedewerker' + title: betrokkeneIdentificatie + betrokkene_identificatie_RolNatuurlijkPersoon: + type: object + properties: + betrokkeneIdentificatie: + allOf: + - $ref: '#/components/schemas/RolNatuurlijkPersoon' + title: betrokkeneIdentificatie + betrokkene_identificatie_RolNietNatuurlijkPersoon: + type: object + properties: + betrokkeneIdentificatie: + allOf: + - $ref: '#/components/schemas/RolNietNatuurlijkPersoon' + title: betrokkeneIdentificatie + betrokkene_identificatie_RolOrganisatorischeEenheid: + type: object + properties: + betrokkeneIdentificatie: + allOf: + - $ref: '#/components/schemas/RolOrganisatorischeEenheid' + title: betrokkeneIdentificatie + betrokkene_identificatie_RolVestiging: + type: object + properties: + betrokkeneIdentificatie: + allOf: + - $ref: '#/components/schemas/RolVestiging' + title: betrokkeneIdentificatie + buurt_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' + buurt_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' + buurt_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' + enkelvoudig_document_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + enkelvoudig_document_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + enkelvoudig_document_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + gemeente_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' + gemeente_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' + gemeente_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' + gemeentelijke_openbare_ruimte_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' + gemeentelijke_openbare_ruimte_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' + gemeentelijke_openbare_ruimte_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' + huishouden_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' + huishouden_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' + huishouden_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' + inrichtingselement_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' + inrichtingselement_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' + inrichtingselement_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' + kadastrale_onroerende_zaak_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' + kadastrale_onroerende_zaak_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' + kadastrale_onroerende_zaak_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' + kunstwerkdeel_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' + kunstwerkdeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' + kunstwerkdeel_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' + maatschappelijke_activiteit_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' + maatschappelijke_activiteit_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' + maatschappelijke_activiteit_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' + medewerker_Rol: + allOf: + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' + medewerker_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' + medewerker_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' + medewerker_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' + medewerker_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' + natuurlijk_persoon_Rol: + allOf: + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' + natuurlijk_persoon_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' + natuurlijk_persoon_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' + natuurlijk_persoon_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' + natuurlijk_persoon_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' + niet_natuurlijk_persoon_Rol: + allOf: + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' + niet_natuurlijk_persoon_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' + niet_natuurlijk_persoon_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' + niet_natuurlijk_persoon_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' + niet_natuurlijk_persoon_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' + object_identificatie_ObjectAdres: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectAdres' + title: objectIdentificatie + object_identificatie_ObjectBuurt: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectBuurt' + title: objectIdentificatie + object_identificatie_ObjectGemeente: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectGemeente' + title: objectIdentificatie + object_identificatie_ObjectGemeentelijkeOpenbareRuimte: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectGemeentelijkeOpenbareRuimte' + title: objectIdentificatie + object_identificatie_ObjectHuishouden: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectHuishouden' + title: objectIdentificatie + object_identificatie_ObjectInrichtingselement: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectInrichtingselement' + title: objectIdentificatie + object_identificatie_ObjectKadastraleOnroerendeZaak: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectKadastraleOnroerendeZaak' + title: objectIdentificatie + object_identificatie_ObjectKunstwerkdeel: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectKunstwerkdeel' + title: objectIdentificatie + object_identificatie_ObjectMaatschappelijkeActiviteit: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectMaatschappelijkeActiviteit' + title: objectIdentificatie + object_identificatie_ObjectOpenbareRuimte: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectOpenbareRuimte' + title: objectIdentificatie + object_identificatie_ObjectOverige: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectOverige' + title: objectIdentificatie + object_identificatie_ObjectPand: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectPand' + title: objectIdentificatie + object_identificatie_ObjectSpoorbaandeel: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectSpoorbaandeel' + title: objectIdentificatie + object_identificatie_ObjectTerreinGebouwdObject: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectTerreinGebouwdObject' + title: objectIdentificatie + object_identificatie_ObjectTerreindeel: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectTerreindeel' + title: objectIdentificatie + object_identificatie_ObjectWaterdeel: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWaterdeel' + title: objectIdentificatie + object_identificatie_ObjectWegdeel: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWegdeel' + title: objectIdentificatie + object_identificatie_ObjectWijk: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWijk' + title: objectIdentificatie + object_identificatie_ObjectWoonplaats: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWoonplaats' + title: objectIdentificatie + object_identificatie_ObjectWozDeelobject: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWozDeelobject' + title: objectIdentificatie + object_identificatie_ObjectWozObject: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWozObject' + title: objectIdentificatie + object_identificatie_ObjectWozWaarde: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWozWaarde' + title: objectIdentificatie + object_identificatie_ObjectZakelijkRecht: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectZakelijkRecht' + title: objectIdentificatie + object_identificatie_RolMedewerker: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/RolMedewerker' + title: objectIdentificatie + object_identificatie_RolNatuurlijkPersoon: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/RolNatuurlijkPersoon' + title: objectIdentificatie + object_identificatie_RolNietNatuurlijkPersoon: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/RolNietNatuurlijkPersoon' + title: objectIdentificatie + object_identificatie_RolOrganisatorischeEenheid: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/RolOrganisatorischeEenheid' + title: objectIdentificatie + object_identificatie_RolVestiging: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/RolVestiging' + title: objectIdentificatie + openbare_ruimte_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' + openbare_ruimte_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' + openbare_ruimte_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' + organisatorische_eenheid_Rol: + allOf: + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' + organisatorische_eenheid_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' + organisatorische_eenheid_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' + organisatorische_eenheid_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' + organisatorische_eenheid_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' + overige_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectOverige' + overige_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectOverige' + overige_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectOverige' + pand_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectPand' + pand_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectPand' + pand_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectPand' + spoorbaandeel_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' + spoorbaandeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' + spoorbaandeel_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' + status_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + status_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + status_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + terrein_gebouwd_object_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' + terrein_gebouwd_object_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' + terrein_gebouwd_object_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' + terreindeel_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' + terreindeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' + terreindeel_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' + vestiging_Rol: + allOf: + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' + vestiging_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' + vestiging_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' + vestiging_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' + vestiging_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' + waterdeel_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' + waterdeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' + waterdeel_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' + wegdeel_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' + wegdeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' + wegdeel_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' + wijk_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWijk' + wijk_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWijk' + wijk_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWijk' + woonplaats_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' + woonplaats_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' + woonplaats_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' + woz_deelobject_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' + woz_deelobject_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' + woz_deelobject_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' + woz_object_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' + woz_object_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' + woz_object_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' + woz_waarde_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' + woz_waarde_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' + woz_waarde_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' + zakelijk_recht_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' + zakelijk_recht_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' + zakelijk_recht_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' + securitySchemes: + JWT-Claims: + type: http + bearerFormat: JWT + scheme: bearer +servers: + - url: https://zaken-api.test.vng.cloud/api/v1 + - url: https://zaken-api.vng.cloud/api/v1 +tags: + - name: klantcontacten + description: '' + - name: resultaten + description: '' + - name: rollen + description: '' + - name: statussen + description: '' + - name: zaakcontactmomenten + description: '' + - name: zaakinformatieobjecten + description: '' + - name: zaakobjecten + description: '' + - name: zaakverzoeken + description: '' + - name: zaken + description: + Een zaak mag (in principe) niet meer gewijzigd worden als de `archiefstatus` + een andere status heeft dan "nog_te_archiveren". Voor praktische redenen is er + geen harde validatie regel aan de provider kant. From c71bd60e9216a46a5da458df3fa02f7e86af3885 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Wed, 12 Feb 2025 20:29:03 +0100 Subject: [PATCH 22/36] Update current version Catalogi API to 1.3.2 --- .../zrc/1.5.x/1.5.2/openapi _abs_paths.yaml | 15984 ++++++++++++++++ .../ztc/current_version/openapi.yaml | 260 +- 2 files changed, 16239 insertions(+), 5 deletions(-) create mode 100644 api-specificatie/zrc/1.5.x/1.5.2/openapi _abs_paths.yaml diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi _abs_paths.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi _abs_paths.yaml new file mode 100644 index 000000000..113f3d4db --- /dev/null +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi _abs_paths.yaml @@ -0,0 +1,15984 @@ +openapi: 3.0.3 +info: + title: Zaken API + version: 1.5.2 + description: " Met expand mechanisme in plain json + + + Een API om een zaakregistratiecomponent (ZRC) te benaderen. + + + De ZAAK is het kernobject in deze API, waaraan verschillende andere + + resources gerelateerd zijn. De Zaken API werkt samen met andere API's voor + + Zaakgericht werken om tot volledige functionaliteit te komen. + + + **Wat is nieuw?** + + * Query parameters en zoekvelden voor archivering. + + + **Afhankelijkheden** + + + Deze API is afhankelijk van: + + + * Catalogi API + + * Notificaties API + + * Documenten API *(optioneel)* + + * Besluiten API *(optioneel)* + + * Autorisaties API *(optioneel)* + + + **Autorisatie** + + + Deze API vereist autorisatie. Je kan de + + [token-tool](https://zaken-auth.vng.cloud/) gebruiken om JWT-tokens te + + genereren. + + + ### Notificaties + + + Deze API publiceert notificaties op het kanaal `zaken`. + + + **Main resource** + + + `zaak` + + + + + **Kenmerken** + + + * `bronorganisatie`: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers en voldoen + aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + + * `zaaktype`: URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS + waar deze voorkomt + + * `vertrouwelijkheidaanduiding`: Aanduiding van de mate waarin het zaakdossier + van de ZAAK voor de openbaarheid bestemd is. + + + **Resources en acties** + + - `zaak`: create, update, destroy + + - `status`: create + + - `zaakobject`: create, update, destroy + + - `zaakinformatieobject`: create + + - `zaakeigenschap`: create, update, destroy + + - `klantcontact`: create + + - `rol`: create, destroy + + - `resultaat`: create, update, destroy + + - `zaakbesluit`: create + + - `zaakcontactmoment`: create + + - `zaakverzoek`: create + + + + **Handige links** + + + * [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard) + + * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken) + + " + contact: + email: standaarden.ondersteuning@vng.nl + url: https://vng-realisatie.github.io/gemma-zaken + license: + name: EUPL 1.2 + url: https://opensource.org/licenses/EUPL-1.2 +paths: + /klantcontacten: + get: + operationId: klantcontact_list + description: 'Alle KLANTCONTACTen opvragen. + + + **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' + summary: 'Alle KLANTCONTACTen opvragen. ' + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - klantcontacten + security: + - JWT-Claims: + - zaken.lezen + deprecated: true + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedKlantContactList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: klantcontact_create + description: + 'Indien geen identificatie gegeven is, dan wordt deze automatisch + gegenereerd. + + + **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' + summary: Maak een KLANTCONTACT bij een ZAAK aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - klantcontacten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/KlantContact' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + deprecated: true + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/KlantContact' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /klantcontacten/{uuid}: + get: + operationId: klantcontact_retrieve + description: 'Een specifieke KLANTCONTACT opvragen. + + + **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' + summary: Een specifieke KLANTCONTACT opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - klantcontacten + security: + - JWT-Claims: + - zaken.lezen + deprecated: true + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/KlantContact' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /resultaten: + get: + operationId: resultaat_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle RESULTAATen van ZAAKen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: resultaattype + required: false + in: query + description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API). + schema: + type: string + format: uri + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - resultaten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedResultaatList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: resultaat_create + description: '**Er wordt gevalideerd op:** + + - geldigheid URL naar de ZAAK + + - geldigheid URL naar het RESULTAATTYPE' + summary: Maak een RESULTAAT bij een ZAAK aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - resultaten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /resultaten/{uuid}: + get: + operationId: resultaat_retrieve + description: Een specifieke RESULTAAT opvragen. + summary: Een specifieke RESULTAAT opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - resultaten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: resultaat_update + description: + "**Er wordt gevalideerd op** \n- geldigheid URL naar de ZAAK\n\ + - het RESULTAATTYPE mag niet gewijzigd worden" + summary: Werk een RESULTAAT in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - resultaten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: resultaat_partial_update + description: + "**Er wordt gevalideerd op** \n- geldigheid URL naar de ZAAK\n\ + - het RESULTAATTYPE mag niet gewijzigd worden" + summary: Werk een RESULTAAT deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - resultaten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedResultaat' + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Resultaat' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: resultaat_destroy + description: Verwijder een RESULTAAT van een ZAAK. + summary: Verwijder een RESULTAAT van een ZAAK. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - resultaten + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: resultaat_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) RESULTAAT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - resultaten + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /rollen: + get: + operationId: rol_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle ROLlen bij ZAAKen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: betrokkene + required: false + in: query + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + schema: + type: string + format: uri + - name: betrokkeneType + required: false + in: query + description: Type van de `betrokkene`. + schema: + type: string + enum: + - natuurlijk_persoon + - niet_natuurlijk_persoon + - vestiging + - organisatorische_eenheid + - medewerker + - name: betrokkeneIdentificatie__natuurlijkPersoon__inpBsn + required: false + in: query + description: + Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene + bepalingen burgerservicenummer. + schema: + type: string + - name: betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie + required: false + in: query + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NATUURLIJK PERSOON + schema: + type: string + - name: betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer + required: false + in: query + description: Het administratienummer van de persoon, bedoeld in de Wet BRP + schema: + type: string + - name: betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId + required: false + in: query + description: + Het door een kamer toegekend uniek nummer voor de INGESCHREVEN + NIET-NATUURLIJK PERSOON + schema: + type: string + - name: betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie + required: false + in: query + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NIET-NATUURLIJK PERSOON + schema: + type: string + - name: betrokkeneIdentificatie__vestiging__vestigingsNummer + required: false + in: query + description: Een korte unieke aanduiding van de Vestiging. + schema: + type: string + - name: betrokkeneIdentificatie__organisatorischeEenheid__identificatie + required: false + in: query + description: Een korte identificatie van de organisatorische eenheid. + schema: + type: string + - name: betrokkeneIdentificatie__medewerker__identificatie + required: false + in: query + description: Een korte unieke aanduiding van de MEDEWERKER. + schema: + type: string + - name: roltype + required: false + in: query + description: URL-referentie naar een roltype binnen het ZAAKTYPE van de ZAAK. + schema: + type: string + format: uri + - name: omschrijving + required: false + in: query + description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. + schema: + type: string + - name: omschrijvingGeneriek + required: false + in: query + description: + Algemeen gehanteerde benaming van de aard van de ROL, afgeleid + uit het ROLTYPE. + schema: + type: string + enum: + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - rollen + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedRolList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: rol_create + description: Maak een ROL aan bij een ZAAK. + summary: Maak een ROL aan bij een ZAAK. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - rollen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Rol' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Rol' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /rollen/{uuid}: + get: + operationId: rol_retrieve + description: Een specifieke ROL bij een ZAAK opvragen. + summary: Een specifieke ROL bij een ZAAK opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - rollen + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Rol' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: rol_destroy + description: Verwijder een ROL van een ZAAK. + summary: Verwijder een ROL van een ZAAK. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - rollen + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: rol_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ROL opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - rollen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /statussen: + get: + operationId: status_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle STATUSsen bij ZAAKen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: statustype + required: false + in: query + description: URL-referentie naar het STATUSTYPE (in de Catalogi API). + schema: + type: string + format: uri + - name: indicatieLaatstGezetteStatus + required: false + in: query + description: + Het gegeven is afleidbaar uit de historie van de attribuutsoort + Datum status gezet van van alle statussen bij de desbetreffende zaak. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - statussen + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedStatusList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: status_create + description: '**Er wordt gevalideerd op** + + - geldigheid URL naar de ZAAK + + - geldigheid URL naar het STATUSTYPE + + - indien het de eindstatus betreft, dan moet het attribuut `indicatieGebruiksrecht` + gezet zijn op alle informatieobjecten dieaan de zaak gerelateerd zijn + + + **Opmerkingen** + + - Indien het statustype de eindstatus is (volgens het ZTC), dan wordt de zaak + afgesloten door de einddatum te zetten.' + summary: Maak een STATUS aan voor een ZAAK. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - statussen + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Status' + required: true + security: + - JWT-Claims: + - (zaken.aanmaken | zaken.statussen.toevoegen | zaken.heropenen) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/StatusRequestbody' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /statussen/{uuid}: + get: + operationId: status_retrieve + description: Een specifieke STATUS van een ZAAK opvragen. + summary: Een specifieke STATUS van een ZAAK opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - statussen + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Status' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: status_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) STATUS opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - statussen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaakcontactmomenten: + get: + operationId: zaakcontactmoment_list + description: Alle ZAAKCONTACTMOMENTen opvragen. + summary: Alle ZAAKCONTACTMOMENTen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: contactmoment + required: false + in: query + description: + URL-referentie naar het CONTACTMOMENT (in de Klantinteractie + API) + schema: + type: string + format: uri + tags: + - zaakcontactmomenten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ZaakContactMoment' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakcontactmoment_create + description: '**Er wordt gevalideerd op:** + + - geldigheid URL naar het CONTACTMOMENT' + summary: Maak een ZAAKCONTACTMOMENT aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakcontactmomenten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakContactMoment' + required: true + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakContactMoment' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaakcontactmomenten/{uuid}: + get: + operationId: zaakcontactmoment_retrieve + description: Een specifiek ZAAKCONTACTMOMENT opvragen. + summary: 'Een specifiek ZAAKCONTACTMOMENT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - zaakcontactmomenten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakContactMoment' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakcontactmoment_destroy + description: Verwijder een ZAAKCONTACTMOMENT. + summary: Verwijder een ZAAKCONTACTMOMENT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakcontactmomenten + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaakinformatieobjecten: + get: + operationId: zaakinformatieobject_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: 'Alle ZAAK-INFORMATIEOBJECT relaties opvragen ' + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: informatieobject + required: false + in: query + description: + URL-referentie naar het INFORMATIEOBJECT (in de Documenten API), + waar ook de relatieinformatie opgevraagd kan worden. + schema: + type: string + format: uri + tags: + - zaakinformatieobjecten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ZaakInformatieObject' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakinformatieobject_create + description: + "Maak een ZAAK-INFORMATIEOBJECT relatie aan.\n\n**Er wordt gevalideerd\ + \ op**\n- geldigheid zaak URL\n- geldigheid informatieobject URL\n- `zaak.archiefstatus`\ + \ moet gelijk zijn aan 'nog_te_archiveren' \n- de combinatie informatieobject\ + \ en zaak moet uniek zijn\n\n**Opmerkingen**\n- De registratiedatum wordt\ + \ door het systeem op 'NU' gezet. De `aardRelatie` wordt ook door het systeem\ + \ gezet.\n- Bij het aanmaken wordt ook in de Documenten API de gespiegelde\ + \ relatie aangemaakt, echter zonder de relatie-informatie.\n" + summary: Maak een ZAAK-INFORMATIEOBJECT relatie aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakinformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + required: true + security: + - JWT-Claims: + - (zaken.aanmaken | zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaakinformatieobjecten/{uuid}: + get: + operationId: zaakinformatieobject_retrieve + description: Een specifieke ZAAK-INFORMATIEOBJECT relatie opvragen. + summary: Een specifieke ZAAK-INFORMATIEOBJECT relatie opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaakinformatieobjecten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaakinformatieobject_update + description: + "Je mag enkel de gegevens van de relatie bewerken, en niet de relatie\ + \ zelf aanpassen.\n\n**Er wordt gevalideerd op** \n- informatieobject URL\ + \ en zaak URL mogen niet veranderen" + summary: Werk een ZAAK-INFORMATIEOBJECT relatie in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakinformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaakinformatieobject_partial_update + description: + "Je mag enkel de gegevens van de relatie bewerken, en niet de relatie\ + \ zelf aanpassen.\n\n**Er wordt gevalideerd op** \n- informatieobject URL\ + \ en zaak URL mogen niet veranderen" + summary: Werk een ZAAK-INFORMATIEOBJECT relatie deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakinformatieobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedZaakInformatieObject' + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakInformatieObject' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakinformatieobject_destroy + description: + De gespiegelde relatie in de Documenten API wordt door de Zaken + API verwijderd. Consumers kunnen dit niet handmatig doen. + summary: Verwijder een ZAAK-INFORMATIEOBJECT relatie. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakinformatieobjecten + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken | zaken.verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaakinformatieobject_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAKINFORMATIEOBJECT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaakinformatieobjecten + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaakobjecten: + get: + operationId: zaakobject_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle ZAAKOBJECTen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: object + required: false + in: query + description: URL-referentie naar de resource die het OBJECT beschrijft. + schema: + type: string + format: uri + - name: objectType + required: false + in: query + description: + Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er geen + passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. + schema: + type: string + enum: + - adres + - besluit + - buurt + - enkelvoudig_document + - gemeente + - gemeentelijke_openbare_ruimte + - huishouden + - inrichtingselement + - kadastrale_onroerende_zaak + - kunstwerkdeel + - maatschappelijke_activiteit + - medewerker + - natuurlijk_persoon + - niet_natuurlijk_persoon + - openbare_ruimte + - organisatorische_eenheid + - pand + - spoorbaandeel + - status + - terreindeel + - terrein_gebouwd_object + - vestiging + - waterdeel + - wegdeel + - wijk + - woonplaats + - woz_deelobject + - woz_object + - woz_waarde + - zakelijk_recht + - overige + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + tags: + - zaakobjecten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedZaakObjectList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakobject_create + description: 'Maak een ZAAKOBJECT aan. + + + **Er wordt gevalideerd op** + + - Indien de `object` URL opgegeveven is, dan moet deze een geldige response + (HTTP 200) geven. + + - Indien opgegeven, dan wordt `objectIdentificatie` gevalideerd tegen de `objectType` + discriminator.' + summary: Maak een ZAAKOBJECT aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + required: true + security: + - JWT-Claims: + - (zaken.aanmaken | zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaakobjecten/{uuid}: + get: + operationId: zaakobject_retrieve + description: Een specifieke ZAAKOBJECT opvragen. + summary: Een specifieke ZAAKOBJECT opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaakobjecten + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaakobject_update + description: + "**Er wordt gevalideerd op** \n- De attributen `zaak`, `object`\ + \ en `objectType` mogen niet gewijzigd worden.\n- Indien opgegeven, dan wordt\ + \ `objectIdentificatie` gevalideerd tegen de objectType discriminator." + summary: Werk een ZAAKOBJECT zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaakobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaakobject_partial_update + description: + "**Er wordt gevalideerd op** \n- De attributen `zaak`, `object`\ + \ en `objectType` mogen niet gewijzigd worden.\n- Indien opgegeven, dan wordt\ + \ `objectIdentificatie` gevalideerd tegen de objectType discriminator." + summary: Werk een ZAAKOBJECT deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + tags: + - zaakobjecten + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedZaakObject' + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakObject' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakobject_destroy + description: + Verbreek de relatie tussen een ZAAK en een OBJECT door de ZAAKOBJECT + resource te verwijderen. + summary: Verwijder een ZAAKOBJECT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - zaakobjecten + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken | zaken.verwijderen) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaakobject_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAKOBJECT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + tags: + - zaakobjecten + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaakverzoeken: + get: + operationId: zaakverzoek_list + description: Alle ZAAK-VERZOEKen opvragen. + summary: Alle ZAAK-VERZOEKen opvragen. + parameters: + - name: zaak + required: false + in: query + description: URL-referentie naar de ZAAK. + schema: + type: string + format: uri + - name: verzoek + required: false + in: query + description: URL-referentie naar het VERZOEK (in de Klantinteractie API) + schema: + type: string + format: uri + tags: + - zaakverzoeken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ZaakVerzoek' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakverzoek_create + description: '**Er wordt gevalideerd op** + + - geldigheid URL naar de VERZOEK' + summary: Maak een ZAAK-VERZOEK aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakverzoeken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakVerzoek' + required: true + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakVerzoek' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaakverzoeken/{uuid}: + get: + operationId: zaakverzoek_retrieve + description: Een specifieke ZAAK-VERZOEK opvragen. + summary: Een specifieke ZAAK-VERZOEK opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + tags: + - zaakverzoeken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakVerzoek' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakverzoek_destroy + description: Verwijder een ZAAK-VERZOEK. + summary: Verwijder een ZAAK-VERZOEK. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + tags: + - zaakverzoeken + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken: + get: + operationId: zaak_list + description: Deze lijst kan gefilterd wordt met query-string parameters. + summary: Alle ZAAKen opvragen. + parameters: + - name: identificatie + required: false + in: query + description: + De unieke identificatie van de ZAAK binnen de organisatie die + verantwoordelijk is voor de behandeling van de ZAAK. + schema: + type: string + example: "zaak123" + - name: bronorganisatie + required: false + in: query + description: + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers + en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + schema: + type: string + example: "000000000" + - name: bronorganisatie__in + required: false + in: query + description: Multiple values may be separated by commas. + schema: + type: array + items: + type: string + example: ["000000000","479559740","875883461"] + style: form + explode: false + - name: zaaktype + required: false + in: query + description: + URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS + waar deze voorkomt + schema: + type: string + format: uri + example: "https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/e80b7507-199a-484c-ad49-c41a1e43a6e7" + - name: archiefnominatie + required: false + in: query + description: + Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + schema: + type: string + enum: + - blijvend_bewaren + - vernietigen + example: "blijvend_bewaren" + - name: archiefnominatie__in + required: false + in: query + description: Multiple values may be separated by commas. + schema: + type: array + items: + type: string + example: ["blijvend_bewaren", "vernietigen"] + style: form + explode: false + - name: archiefactiedatum + required: false + in: query + description: + De datum waarop het gearchiveerde zaakdossier vernietigd moet + worden dan wel overgebracht moet worden naar een archiefbewaarplaats. Wordt + automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT aan + deze ZAAK indien nog leeg. + schema: + type: string + example: "2019-01-02" + - name: archiefactiedatum__isnull + required: false + in: query + description: De archiefactiedatum is leeg. + schema: + type: boolean + example: false + - name: archiefactiedatum__lt + required: false + in: query + description: De archiefactiedatum is kleiner dan de opgegeven datum. + schema: + type: string + example: "2020-01-02" + - name: archiefactiedatum__gt + required: false + in: query + description: De archiefactiedatum is groter dan de opgegeven datum. + schema: + type: string + example: "2018-01-02" + - name: archiefstatus + required: false + in: query + description: + Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + schema: + type: string + enum: + - nog_te_archiveren + - gearchiveerd + - gearchiveerd_procestermijn_onbekend + - overgedragen + example: "nog_te_archiveren" + - name: archiefstatus__in + required: false + in: query + description: Multiple values may be separated by commas. + schema: + type: array + items: + type: string + example: ["nog_te_archiveren","gearchiveerd","gearchiveerd_procestermijn_onbekend","overgedragen"] + style: form + explode: false + - name: startdatum + required: false + in: query + description: De datum waarop met de uitvoering van de zaak is gestart + schema: + type: string + example: "2017-01-02" + - name: startdatum__gt + required: false + in: query + description: De startdatum is groter dan de opgegeven datum. + schema: + type: string + example: "2018-01-02" + - name: startdatum__gte + required: false + in: query + description: De startdatum is groter dan of gelijk dan de opgegeven datum. + schema: + type: string + example: "2016-01-02" + - name: startdatum__lt + required: false + in: query + description: De startdatum is kleiner dan de opgegeven datum. + schema: + type: string + example: "2018-01-02" + - name: startdatum__lte + required: false + in: query + description: De startdatum is kleiner of gelijk dan de opgegeven datum. + schema: + type: string + example: "2018-01-02" + - name: registratiedatum + required: false + in: query + description: + De datum waarop de zaakbehandelende organisatie de ZAAK heeft + geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag + gebruikt. + schema: + type: string + example: "2015-01-02" + - name: registratiedatum__gt + required: false + in: query + description: + De registratiedatum is groter dan de opgegeven datum. + schema: + type: string + example: "2014-01-02" + - name: registratiedatum__lt + required: false + in: query + description: + De registratiedatum is kleiner dan de opgegeven datum. + schema: + type: string + example: "2016-01-02" + - name: einddatum + required: false + in: query + description: De datum waarop de uitvoering van de zaak afgerond is. + schema: + type: string + example: "2022-01-02" + - name: einddatum__isnull + required: false + in: query + description: De einddatum is leeg. + schema: + type: boolean + example: false + - name: einddatum__gt + required: false + in: query + description: De einddatum is groter dan de opgegeven datum. + schema: + type: string + example: "2021-01-02" + - name: einddatum__lt + required: false + in: query + description: De einddatum is kleiner dan de opgegeven datum. + schema: + type: string + example: "2023-01-02" + - name: einddatumGepland + required: false + in: query + description: + De datum waarop volgens de planning verwacht wordt dat de zaak + afgerond wordt. + schema: + type: string + example: "2022-01-02" + - name: einddatumGepland__gt + required: false + in: query + description: + De geplande einddatum is groter dan de opgegeven datum. + schema: + type: string + example: "2021-01-02" + - name: einddatumGepland__lt + required: false + in: query + description: + De geplande einddatum is kleiner dan de opgegeven datum. + schema: + type: string + example: "2024-01-02" + - name: uiterlijkeEinddatumAfdoening + required: false + in: query + description: + De laatste datum waarop volgens wet- en regelgeving de zaak afgerond + dient te zijn. + schema: + type: string + example: "2024-01-02" + - name: uiterlijkeEinddatumAfdoening__gt + required: false + in: query + description: + De uiterlijke einddatumafdoening is groter dan de opgegeven datum. + schema: + type: string + example: "2023-01-02" + - name: uiterlijkeEinddatumAfdoening__lt + required: false + in: query + description: + De uiterlijke einddatumafdoening is kleiner dan de opgegeven datum. + schema: + type: string + example: "2025-01-02" + - name: rol__betrokkeneType + required: false + in: query + description: Type van de `betrokkene`. + schema: + type: string + enum: + - natuurlijk_persoon + - niet_natuurlijk_persoon + - vestiging + - organisatorische_eenheid + - medewerker + example: "natuurlijk_persoon" + - name: rol__betrokkene + required: false + in: query + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + schema: + type: string + format: uri + example: "https://example.com" + - name: rol__omschrijvingGeneriek + required: false + in: query + description: + Algemeen gehanteerde benaming van de aard van de ROL, afgeleid + uit het ROLTYPE. + schema: + type: string + enum: + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator + example: "initiator" + - name: maximaleVertrouwelijkheidaanduiding + required: false + in: query + description: + Zaken met een vertrouwelijkheidaanduiding die beperkter is dan + de aangegeven aanduiding worden uit de resultaten gefiltered. + schema: + type: string + enum: + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim + example: "zaakvertrouwelijk" + - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn + required: false + in: query + description: + Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene + bepalingen burgerservicenummer. + schema: + type: string + maxLength: 9 + example: "123456789" + - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie + required: false + in: query + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NATUURLIJK PERSOON + schema: + type: string + maxLength: 17 + example: "123456789" + - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer + required: false + in: query + description: Het administratienummer van de persoon, bedoeld in de Wet BRP + schema: + type: string + maxLength: 10 + example: "123456789" + - name: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId + required: false + in: query + description: + Het door een kamer toegekend uniek nummer voor de INGESCHREVEN + NIET-NATUURLIJK PERSOON + schema: + type: string + example: "123456789" + - name: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie + required: false + in: query + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NIET-NATUURLIJK PERSOON + schema: + type: string + maxLength: 17 + example: "123456789" + - name: rol__betrokkeneIdentificatie__vestiging__vestigingsNummer + required: false + in: query + description: Een korte unieke aanduiding van de Vestiging. + schema: + type: string + maxLength: 24 + example: "123456789" + - name: rol__betrokkeneIdentificatie__medewerker__identificatie + required: false + in: query + description: Een korte unieke aanduiding van de MEDEWERKER. + schema: + type: string + maxLength: 24 + example: "123456789" + - name: rol__betrokkeneIdentificatie__organisatorischeEenheid__identificatie + required: false + in: query + description: Een korte identificatie van de organisatorische eenheid. + schema: + type: string + example: "123456789" + - name: expand + in: query + description: Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt. + schema: + type: string + example: zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype + - name: ordering + required: false + in: query + description: Het veld waarop de resultaten geordend worden. Het minnetje betekent omgekeerde volgorde. + schema: + type: array + items: + type: string + enum: + - startdatum + - -startdatum + - einddatum + - -einddatum + - publicatiedatum + - -publicatiedatum + - archiefactiedatum + - -archiefactiedatum + - registratiedatum + - -registratiedatum + - identificatie + - -identificatie + example: "-startdatum" + style: form + explode: false + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer + example: 1 + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedZaakList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaak_create + description: + 'Indien geen identificatie gegeven is, dan wordt deze automatisch + gegenereerd. De identificatie moet uniek zijn binnen de bronorganisatie. + + + **Er wordt gevalideerd op:** + + - geldigheid `zaaktype` URL - de resource moet opgevraagd kunnen worden uit + de Catalogi API en de vorm van een ZAAKTYPE hebben. + + - `zaaktype` is geen concept (`zaaktype.concept = False`) + + - `laatsteBetaaldatum` mag niet in de toekomst liggen. + + - `laatsteBetaaldatum` mag niet gezet worden als de betalingsindicatie "nvt" + is. + + - `barchiefnominatie` moet een waarde hebben indien archiefstatus niet de + waarde "nog_te_archiveren" heeft. + + - `archiefactiedatum` moet een waarde hebben indien archiefstatus niet de + waarde "nog_te_archiveren" heeft. + + - `archiefstatus` kan alleen een waarde anders dan "nog_te_archiveren" hebben + indien van alle gerelateeerde INFORMATIEOBJECTen het attribuut `status` de + waarde "gearchiveerd" heeft.' + summary: Maak een ZAAK aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Zaak' + required: true + security: + - JWT-Claims: + - zaken.aanmaken + responses: + '201': + headers: + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Zaak' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{uuid}: + get: + operationId: zaak_retrieve + description: Een specifieke ZAAK opvragen. + summary: Een specifieke ZAAK opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + - name: expand + in: query + description: Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt. + schema: + type: string + example: zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakExpanded' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaak_update + description: + "**Er wordt gevalideerd op** \n- `identificatie` mag niet gewijzigd worden.\n- `laatsteBetaaldatum`\ + \ mag niet in de toekomst liggen.\n- `laatsteBetaaldatum` mag niet gezet worden\ + \ als de betalingsindicatie\n\"nvt\" is.\n- `archiefnominatie` moet een waarde\ + \ hebben indien `archiefstatus` niet de\nwaarde \"nog_te_archiveren\" heeft.\n\ + - `archiefactiedatum` moet een waarde hebben indien `archiefstatus` niet de\n\ + \ waarde \"nog_te_archiveren\" heeft.\n- `archiefstatus` kan alleen een waarde\ + \ anders dan \"nog_te_archiveren\"\n hebben indien van alle gerelateeerde\ + \ INFORMATIEOBJECTen het attribuut\n `status` de waarde \"gearchiveerd\"\ + \ heeft.\n**Opmerkingen**\n- er worden enkel zaken getoond van de zaaktypes\ + \ waar u toe geautoriseerd\n bent.\n- indien een zaak heropend moet worden,\ + \ doe dit dan door een nieuwe status\n toe te voegen die NIET de eindstatus\ + \ is. Zie de `Status` resource." + summary: Werk een ZAAK in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Zaak' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Zaak' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaak_partial_update + description: + "**Er wordt gevalideerd op** \n- `identificatie` mag niet gewijzigd worden.\n- `laatsteBetaaldatum`\ + \ mag niet in de toekomst liggen.\n- `laatsteBetaaldatum` mag niet gezet worden\ + \ als de betalingsindicatie\n\"nvt\" is.\n- `archiefnominatie` moet een waarde\ + \ hebben indien `archiefstatus` niet de\nwaarde \"nog_te_archiveren\" heeft.\n\ + - `archiefactiedatum` moet een waarde hebben indien `archiefstatus` niet de\n\ + \ waarde \"nog_te_archiveren\" heeft.\n- `archiefstatus` kan alleen een waarde\ + \ anders dan \"nog_te_archiveren\"\n hebben indien van alle gerelateeerde\ + \ INFORMATIEOBJECTen het attribuut\n `status` de waarde \"gearchiveerd\"\ + \ heeft.\n**Opmerkingen**\n- er worden enkel zaken getoond van de zaaktypes\ + \ waar u toe geautoriseerd\n bent.\n- indien een zaak heropend moet worden,\ + \ doe dit dan door een nieuwe status\n toe te voegen die NIET de eindstatus\ + \ is. Zie de `Status` resource." + summary: Werk een ZAAK deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedZaak' + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Zaak' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaak_destroy + description: '***De gerelateerde resources zijn hierbij*** + + - `zaak` - de deelzaken van de verwijderde hoofzaak + + - `status` - alle statussen van de verwijderde zaak + + - `resultaat` - het resultaat van de verwijderde zaak + + - `rol` - alle rollen bij de zaak + + - `zaakobject` - alle zaakobjecten bij de zaak + + - `zaakeigenschap` - alle eigenschappen van de zaak + + - `zaakkenmerk` - alle kenmerken van de zaak + + - `zaakinformatieobject` - dit moet door-cascaden naar de Documenten API, + zie ook: https://github.com/VNG-Realisatie/gemma-zaken/issues/791 (TODO) + + - `klantcontact` - alle klantcontacten bij een zaak' + summary: Verwijder een ZAAK. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.verwijderen + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaak_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAK opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaken/{zaak_uuid}/audittrail: + get: + operationId: audittrail_list + description: Alle audit trail regels behorend bij de ZAAK. + summary: Alle audit trail regels behorend bij de ZAAK. + parameters: + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - audittrails.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/AuditTrail' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{zaak_uuid}/audittrail/{uuid}: + get: + operationId: audittrail_retrieve + description: Een specifieke audit trail regel opvragen. + summary: 'Een specifieke audit trail regel opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke identificatie van de audit regel. + title: uuid + required: true + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - audittrails.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/AuditTrail' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{zaak_uuid}/besluiten: + get: + operationId: zaakbesluit_list + description: Alle ZAAKBESLUITen opvragen. + summary: Alle ZAAKBESLUITen opvragen. + parameters: + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ZaakBesluit' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakbesluit_create + description: + '**LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** + + + De Besluiten API gebruikt dit endpoint om relaties te synchroniseren, daarom + is dit endpoint in de Zaken API geimplementeerd. + + + **Er wordt gevalideerd op:** + + - geldigheid URL naar de ZAAK' + summary: Maak een ZAAKBESLUIT aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakBesluit' + required: true + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakBesluit' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{zaak_uuid}/besluiten/{uuid}: + get: + operationId: zaakbesluit_retrieve + description: Een specifiek ZAAKBESLUIT opvragen. + summary: 'Een specifiek ZAAKBESLUIT opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakBesluit' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakbesluit_destroy + description: + '***LET OP: Dit endpoint hoor je als consumer niet zelf aan te + spreken.*** + + + De Besluiten API gebruikt dit endpoint om relaties te synchroniseren, daarom + is dit endpoint in de Zaken API geimplementeerd. + + ' + summary: Verwijder een ZAAKBESLUIT. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.bijwerken + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{zaak_uuid}/zaakeigenschappen: + get: + operationId: zaakeigenschap_list + description: Alle ZAAKEIGENSCHAPpen opvragen. + summary: 'Alle ZAAKEIGENSCHAPpen opvragen. ' + parameters: + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ZaakEigenschap' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + post: + operationId: zaakeigenschap_create + description: 'Maak een ZAAKEIGENSCHAP aan. + + + **Er wordt gevalideerd op:** + + - geldigheid `eigenschap` URL - de resource moet opgevraagd kunnen worden + uit de Catalogi API en de vorm van een EIGENSCHAP hebben. + + - de `eigenschap` moet bij het `ZAAK.zaaktype` horen' + summary: Maak een ZAAKEIGENSCHAP aan. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '201': + headers: + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + description: Created + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + /zaken/{zaak_uuid}/zaakeigenschappen/{uuid}: + get: + operationId: zaakeigenschap_retrieve + description: Een specifieke ZAAKEIGENSCHAP opvragen. + summary: Een specifieke ZAAKEIGENSCHAP opvragen. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + description: OK + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + put: + operationId: zaakeigenschap_update + description: + "**Er wordt gevalideerd op** \n- Alleen de `waarde` mag gewijzigd\ + \ worden" + summary: Werk een ZAAKEIGENSCHAP in zijn geheel bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + required: true + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + patch: + operationId: zaakeigenschap_partial_update + description: + "**Er wordt gevalideerd op** \n- Alleen de `waarde` mag gewijzigd\ + \ worden" + summary: Werk een ZAAKEIGENSCHAP deels bij. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/PatchedZaakEigenschap' + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '200': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakEigenschap' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + delete: + operationId: zaakeigenschap_destroy + description: Verwijder een ZAAKEIGENSCHAP + summary: Verwijder een ZAAKEIGENSCHAP. + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + security: + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) + responses: + '204': + description: No content + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + head: + operationId: zaakeigenschap_headers + description: Vraag de headers op die je bij een GET request zou krijgen. + summary: 'De headers voor een specifiek(e) ZAAKEIGENSCHAP opvragen ' + parameters: + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: path + name: zaak_uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + required: true + tags: + - zaken + responses: + '200': + headers: + ETag: + schema: + type: string + description: + De ETag berekend op de response body JSON. Indien twee + resources exact dezelfde ETag hebben, dan zijn deze resources identiek + aan elkaar. Je kan de ETag gebruiken om caching te implementeren. + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + description: OK + /zaken/_zoek: + post: + operationId: zaak__zoek + description: + Zoeken/filteren gaat normaal via de `list` operatie, deze is echter + niet geschikt voor geo-zoekopdrachten. + summary: Voer een (geo)-zoekopdracht uit op ZAAKen. + parameters: + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: query + name: page + schema: + type: integer + description: Een pagina binnen de gepagineerde set resultaten. + - in: header + name: Accept-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het gewenste 'Coordinate Reference System' (CRS) van de geometrie + in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + required: true + - in: header + name: Content-Crs + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie in de + vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 + is hetzelfde als WGS84). + required: true + tags: + - zaken + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/ZaakZoek' + security: + - JWT-Claims: + - zaken.lezen + responses: + '200': + headers: + Content-Crs: + schema: + type: string + enum: + - EPSG:4326 + description: + Het 'Coordinate Reference System' (CRS) van de geometrie + in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default + (EPSG:4326 is hetzelfde als WGS84). + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/PaginatedZaakList' + description: OK + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error +components: + responses: + '400': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + description: Bad request + '401': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unauthorized + '403': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Forbidden + '404': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not found + '406': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Not acceptable + '409': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Conflict + '410': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Gone + '412': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Precondition failed + '415': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Unsupported media type + '429': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Too many requests + '500': + headers: + API-version: + schema: + type: string + description: + 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + description: Internal server error + schemas: + AardRelatieEnum: + enum: + - vervolg + - onderwerp + - bijdrage + type: string + AardRelatieWeergaveEnum: + enum: + - 'Hoort bij, omgekeerd: kent' + - 'Legt vast, omgekeerd: kan vastgelegd zijn als' + type: string + ArchiefnominatieEnum: + enum: + - blijvend_bewaren + - vernietigen + type: string + ArchiefstatusEnum: + enum: + - nog_te_archiveren + - gearchiveerd + - gearchiveerd_procestermijn_onbekend + - overgedragen + type: string + AuditTrail: + type: object + properties: + uuid: + type: string + format: uuid + description: Unieke identificatie van de audit regel. + title: uuid + bron: + allOf: + - $ref: '#/components/schemas/BronEnum' + description: + 'De naam van het component waar de wijziging in is gedaan. + + + Uitleg bij mogelijke waarden: + + + * `ac` - Autorisaties API + + * `nrc` - Notificaties API + + * `zrc` - Zaken API + + * `ztc` - Catalogi API + + * `drc` - Documenten API + + * `brc` - Besluiten API + + * `cmc` - Contactmomenten API + + * `kc` - Klanten API + + * `vrc` - Verzoeken API' + title: bron + applicatieId: + type: string + description: Unieke identificatie van de applicatie, binnen de organisatie. + title: applicatie id + maxLength: 100 + applicatieWeergave: + type: string + description: Vriendelijke naam van de applicatie. + title: applicatie weergave + maxLength: 200 + gebruikersId: + type: string + description: + Unieke identificatie van de gebruiker die binnen de organisatie + herleid kan worden naar een persoon. + title: gebruikers id + maxLength: 255 + gebruikersWeergave: + type: string + description: Vriendelijke naam van de gebruiker. + title: gebruikers weergave + maxLength: 255 + actie: + type: string + description: 'De uitgevoerde handeling. + + + De bekende waardes voor dit veld zijn hieronder aangegeven, maar + andere waardes zijn ook toegestaan + + + Uitleg bij mogelijke waarden: + + + * `create` - Object aangemaakt + + * `list` - Lijst van objecten opgehaald + + * `retrieve` - Object opgehaald + + * `destroy` - Object verwijderd + + * `update` - Object bijgewerkt + + * `partial_update` - Object deels bijgewerkt' + title: actie + maxLength: 50 + actieWeergave: + type: string + description: Vriendelijke naam van de actie. + title: actie weergave + maxLength: 200 + resultaat: + type: integer + maximum: 599 + minimum: 100 + description: HTTP status code van de API response van de uitgevoerde handeling. + title: resultaat + hoofdObject: + type: string + format: uri + description: De URL naar het hoofdobject van een component. + title: hoofd object + maxLength: 1000 + resource: + type: string + description: Het type resource waarop de actie gebeurde. + title: resource + maxLength: 50 + resourceUrl: + type: string + format: uri + description: De URL naar het object. + title: resource url + maxLength: 1000 + toelichting: + type: string + description: Toelichting waarom de handeling is uitgevoerd. + title: toelichting + resourceWeergave: + type: string + description: Vriendelijke identificatie van het object. + title: resource weergave + maxLength: 200 + aanmaakdatum: + type: string + format: date-time + readOnly: true + description: De datum waarop de handeling is gedaan. + title: aanmaakdatum + wijzigingen: + allOf: + - $ref: '#/components/schemas/Wijzigingen' + title: wijzigingen + required: + - aanmaakdatum + - actie + - bron + - hoofdObject + - resource + - resourceUrl + - resourceWeergave + - resultaat + - wijzigingen + BetalingsindicatieEnum: + enum: + - nvt + - nog_niet + - gedeeltelijk + - geheel + type: string + BetrokkeneTypeEnum: + enum: + - natuurlijk_persoon + - niet_natuurlijk_persoon + - vestiging + - organisatorische_eenheid + - medewerker + type: string + BlankEnum: + enum: + - '' + BronEnum: + enum: + - ac + - nrc + - zrc + - ztc + - drc + - brc + - cmc + - kc + - vrc + type: string + ContactPersoonRol: + type: object + description: + De gegevens van de persoon die anderen desgevraagd in contact brengt + met medewerkers van de BETROKKENE, een NIET-NATUURLIJK PERSOON of VESTIGING + zijnde, of met BETROKKENE zelf, een NATUURLIJK PERSOON zijnde , vanuit het + belang van BETROKKENE in haar ROL bij een ZAAK. + properties: + emailadres: + type: string + format: email + title: Email + description: + Elektronich postadres waaronder de contactpersoon in de regel + bereikbaar is. + maxLength: 254 + functie: + type: string + description: + 'De aanduiding van de taken, rechten en plichten die de contactpersoon + heeft binnen de organisatie van BETROKKENE. ' + title: functie + maxLength: 50 + telefoonnummer: + type: string + description: + Telefoonnummer waaronder de contactpersoon in de regel bereikbaar + is. + title: telefoonnummer + maxLength: 20 + naam: + type: string + description: De opgemaakte naam van de contactpersoon namens de BETROKKENE. + title: naam + maxLength: 40 + required: + - naam + nullable: true + FieldValidationError: + type: object + description: Formaat van validatiefouten. + properties: + name: + type: string + description: Naam van het veld met ongeldige gegevens + title: name + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + reason: + type: string + description: Uitleg wat er precies fout is met de gegevens + title: reason + required: + - code + - name + - reason + Fout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: + URI met referentie naar dit specifiek voorkomen van de fout. + Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + required: + - code + - detail + - instance + - status + - title + GeoJSONGeometry: + title: GeoJSONGeometry + type: object + oneOf: + - $ref: '#/components/schemas/Point' + - $ref: '#/components/schemas/MultiPoint' + - $ref: '#/components/schemas/LineString' + - $ref: '#/components/schemas/MultiLineString' + - $ref: '#/components/schemas/Polygon' + - $ref: '#/components/schemas/MultiPolygon' + - $ref: '#/components/schemas/GeometryCollection' + discriminator: + propertyName: type + GeoWithin: + type: object + properties: + within: + allOf: + - $ref: '#/components/schemas/GeoJSONGeometry' + title: within + Geometry: + title: Geometry + description: GeoJSON geometry + type: object + required: + - type + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1 + properties: + type: + allOf: + - $ref: '#/components/schemas/GeometryTypeEnum' + description: The geometry type + GeometryCollection: + title: Geometry collection + description: GeoJSON multi-polygon geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.8 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - geometries + properties: + geometries: + type: array + items: + $ref: '#/components/schemas/Geometry' + GeometryTypeEnum: + type: string + enum: + - Point + - MultiPoint + - LineString + - MultiLineString + - Polygon + - MultiPolygon + - Feature + - FeatureCollection + - GeometryCollection + GeslachtsaanduidingEnum: + enum: + - m + - v + - o + type: string + IndicatieMachtigingEnum: + enum: + - gemachtigde + - machtiginggever + type: string + InnRechtsvormEnum: + enum: + - besloten_vennootschap + - cooperatie_europees_economische_samenwerking + - europese_cooperatieve_venootschap + - europese_naamloze_vennootschap + - kerkelijke_organisatie + - naamloze_vennootschap + - onderlinge_waarborg_maatschappij + - overig_privaatrechtelijke_rechtspersoon + - stichting + - vereniging + - vereniging_van_eigenaars + - publiekrechtelijke_rechtspersoon + - vennootschap_onder_firma + - maatschap + - rederij + - commanditaire_vennootschap + - kapitaalvennootschap_binnen_eer + - overige_buitenlandse_rechtspersoon_vennootschap + - kapitaalvennootschap_buiten_eer + type: string + KlantContact: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: De unieke aanduiding van een KLANTCONTACT + title: identificatie + maxLength: 14 + datumtijd: + type: string + format: date-time + description: De datum en het tijdstip waarop het KLANTCONTACT begint + title: datumtijd + kanaal: + type: string + description: Het communicatiekanaal waarlangs het KLANTCONTACT gevoerd wordt + title: kanaal + maxLength: 20 + onderwerp: + type: string + description: Het onderwerp waarover contact is geweest met de klant. + title: onderwerp + maxLength: 200 + toelichting: + type: string + description: Een toelichting die inhoudelijk het contact met de klant beschrijft. + title: toelichting + maxLength: 1000 + required: + - datumtijd + - url + - uuid + - zaak + LineString: + title: Line-string + description: GeoJSON line-string geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.4 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + type: array + items: + $ref: '#/components/schemas/Point2D' + minItems: 2 + MultiLineString: + title: Multi-line string + description: GeoJSON multi-line-string geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.5 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + type: array + items: + type: array + items: + $ref: '#/components/schemas/Point2D' + MultiPoint: + title: MultiPoint + description: GeoJSON multi-point geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.3 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + type: array + items: + $ref: '#/components/schemas/Point2D' + MultiPolygon: + title: Multi-polygon + description: GeoJSON multi-polygon geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.7 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + type: array + items: + type: array + items: + type: array + items: + $ref: '#/components/schemas/Point2D' + NullEnum: + enum: + - null + ObjectAdres: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + wplWoonplaatsNaam: + type: string + title: wpl woonplaats naam + maxLength: 80 + gorOpenbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: gor openbare ruimte naam + maxLength: 80 + huisnummer: + type: integer + maximum: 99999 + minimum: 0 + title: huisnummer + huisletter: + type: string + title: huisletter + maxLength: 1 + huisnummertoevoeging: + type: string + title: huisnummertoevoeging + maxLength: 4 + postcode: + type: string + title: postcode + maxLength: 7 + required: + - gorOpenbareRuimteNaam + - huisnummer + - identificatie + - wplWoonplaatsNaam + ObjectBuurt: + type: object + properties: + buurtCode: + type: string + description: De code behorende bij de naam van de buurt + title: buurt code + maxLength: 2 + buurtNaam: + type: string + description: De naam van de buurt, zoals die door het CBS wordt gebruikt. + title: buurt naam + maxLength: 40 + gemGemeenteCode: + type: string + description: + Een numerieke aanduiding waarmee een Nederlandse gemeente uniek + wordt aangeduid + title: gem gemeente code + maxLength: 4 + wykWijkCode: + type: string + description: De code behorende bij de naam van de wijk + title: wyk wijk code + maxLength: 2 + required: + - buurtCode + - buurtNaam + - gemGemeenteCode + - wykWijkCode + ObjectGemeente: + type: object + properties: + gemeenteNaam: + type: string + description: "De offici\xEBle door de gemeente vastgestelde gemeentenaam." + title: gemeente naam + maxLength: 80 + gemeenteCode: + type: string + description: + Een numerieke aanduiding waarmee een Nederlandse gemeente uniek + wordt aangeduid + title: gemeente code + maxLength: 4 + required: + - gemeenteCode + - gemeenteNaam + ObjectGemeentelijkeOpenbareRuimte: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + openbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: openbare ruimte naam + maxLength: 80 + required: + - identificatie + - openbareRuimteNaam + ObjectHuishouden: + type: object + properties: + nummer: + type: string + description: + Uniek identificerend administratienummer van een huishouden + zoals toegekend door de gemeente waarin het huishouden woonachtig is. + title: nummer + maxLength: 12 + isGehuisvestIn: + allOf: + - $ref: '#/components/schemas/ObjectTerreinGebouwdObject' + nullable: true + title: isGehuisvestIn + required: + - nummer + ObjectInrichtingselement: + type: object + properties: + type: + allOf: + - $ref: '#/components/schemas/ObjectInrichtingselementTypeEnum' + description: 'Specificatie van de aard van het inrichtingselement. + + + Uitleg bij mogelijke waarden: + + + * `bak` - Bak + + * `bord` - Bord + + * `installatie` - Installatie + + * `kast` - Kast + + * `mast` - Mast + + * `paal` - Paal + + * `sensor` - Sensor + + * `straatmeubilair` - Straatmeubilair + + * `waterinrichtingselement` - Waterinrichtingselement + + * `weginrichtingselement` - Weginrichtingselement' + title: type + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + description: De benaming van het OBJECT + title: naam + maxLength: 500 + required: + - identificatie + - type + ObjectInrichtingselementTypeEnum: + enum: + - bak + - bord + - installatie + - kast + - mast + - paal + - sensor + - straatmeubilair + - waterinrichtingselement + - weginrichtingselement + type: string + ObjectKadastraleOnroerendeZaak: + type: object + properties: + kadastraleIdentificatie: + type: string + description: De unieke identificatie van het OBJECT + title: kadastrale identificatie + maxLength: 100 + kadastraleAanduiding: + type: string + description: + De typering van de kadastrale aanduiding van een onroerende + zaak conform Kadaster + title: kadastrale aanduiding + maxLength: 1000 + required: + - kadastraleAanduiding + - kadastraleIdentificatie + ObjectKunstwerkdeel: + type: object + properties: + type: + allOf: + - $ref: '#/components/schemas/ObjectKunstwerkdeelTypeEnum' + description: + 'Specificatie van het soort Kunstwerk waartoe het kunstwerkdeel + behoort. + + + Uitleg bij mogelijke waarden: + + + * `keermuur` - Keermuur + + * `overkluizing` - Overkluizing + + * `duiker` - Duiker + + * `faunavoorziening` - Faunavoorziening + + * `vispassage` - Vispassage + + * `bodemval` - Bodemval + + * `coupure` - Coupure + + * `ponton` - Ponton + + * `voorde` - Voorde + + * `hoogspanningsmast` - Hoogspanningsmast + + * `gemaal` - Gemaal + + * `perron` - Perron + + * `sluis` - Sluis + + * `strekdam` - Strekdam + + * `steiger` - Steiger + + * `stuw` - Stuw' + title: type + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + title: naam + maxLength: 80 + required: + - identificatie + - naam + - type + ObjectKunstwerkdeelTypeEnum: + enum: + - keermuur + - overkluizing + - duiker + - faunavoorziening + - vispassage + - bodemval + - coupure + - ponton + - voorde + - hoogspanningsmast + - gemaal + - perron + - sluis + - strekdam + - steiger + - stuw + type: string + ObjectMaatschappelijkeActiviteit: + type: object + properties: + kvkNummer: + type: string + description: + Landelijk uniek identificerend administratienummer van een + MAATSCHAPPELIJKE ACTIVITEIT zoals toegewezen door de Kamer van Koophandel + (KvK). + title: kvk nummer + maxLength: 8 + handelsnaam: + type: string + description: De naam waaronder de onderneming handelt. + title: handelsnaam + maxLength: 200 + required: + - handelsnaam + - kvkNummer + ObjectOpenbareRuimte: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + wplWoonplaatsNaam: + type: string + title: wpl woonplaats naam + maxLength: 80 + gorOpenbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: gor openbare ruimte naam + maxLength: 80 + required: + - gorOpenbareRuimteNaam + - identificatie + - wplWoonplaatsNaam + ObjectOverige: + type: object + properties: + overigeData: + type: object + additionalProperties: {} + title: overige data + required: + - overigeData + ObjectPand: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + required: + - identificatie + ObjectSpoorbaandeel: + type: object + properties: + type: + allOf: + - $ref: '#/components/schemas/ObjectSpoorbaandeelTypeEnum' + description: 'Specificatie van het soort Spoorbaan + + + Uitleg bij mogelijke waarden: + + + * `breedspoor` - breedspoor + + * `normaalspoor` - normaalspoor + + * `smalspoor` - smalspoor + + * `spoorbaan` - spoorbaan' + title: type + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + description: De benaming van het OBJECT + title: naam + maxLength: 500 + required: + - identificatie + - type + ObjectSpoorbaandeelTypeEnum: + enum: + - breedspoor + - normaalspoor + - smalspoor + - spoorbaan + type: string + ObjectTerreinGebouwdObject: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + adresAanduidingGrp: + allOf: + - $ref: '#/components/schemas/TerreinGebouwdObjectAdres' + nullable: true + title: adresAanduidingGrp + required: + - identificatie + ObjectTerreindeel: + type: object + properties: + type: + type: string + title: type + maxLength: 40 + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + description: De benaming van het OBJECT + title: naam + maxLength: 500 + required: + - identificatie + - type + ObjectTypeEnum: + enum: + - adres + - besluit + - buurt + - enkelvoudig_document + - gemeente + - gemeentelijke_openbare_ruimte + - huishouden + - inrichtingselement + - kadastrale_onroerende_zaak + - kunstwerkdeel + - maatschappelijke_activiteit + - medewerker + - natuurlijk_persoon + - niet_natuurlijk_persoon + - openbare_ruimte + - organisatorische_eenheid + - pand + - spoorbaandeel + - status + - terreindeel + - terrein_gebouwd_object + - vestiging + - waterdeel + - wegdeel + - wijk + - woonplaats + - woz_deelobject + - woz_object + - woz_waarde + - zakelijk_recht + - overige + type: string + ObjectTypeOverigeDefinitie: + type: object + properties: + url: + type: string + format: uri + title: Objecttype-URL + description: + URL-referentie naar de objecttype resource in een API. Deze + resource moet de [JSON-schema](https://json-schema.org/)-definitie van + het objecttype bevatten. + maxLength: 1000 + schema: + type: string + title: schema-pad + description: + 'Een geldige [jq](http://stedolan.github.io/jq/) expressie. + Dit wordt gecombineerd met de resource uit het `url`-attribuut om het + schema van het objecttype uit te lezen. Bijvoorbeeld: `.jsonSchema`.' + maxLength: 100 + objectData: + type: string + title: objectgegevens-pad + description: + 'Een geldige [jq](http://stedolan.github.io/jq/) expressie. + Dit wordt gecombineerd met de JSON data uit de OBJECT url om de objectgegevens + uit te lezen en de vorm van de gegevens tegen het schema te valideren. + Bijvoorbeeld: `.record.data`.' + maxLength: 100 + required: + - objectData + - schema + - url + ObjectWaterdeel: + type: object + properties: + typeWaterdeel: + allOf: + - $ref: '#/components/schemas/TypeWaterdeelEnum' + description: 'Specificatie van het soort water + + + Uitleg bij mogelijke waarden: + + + * `zee` - Zee + + * `waterloop` - Waterloop + + * `watervlakte` - Watervlakte + + * `greppel_droge_sloot` - Greppel, droge sloot' + title: type waterdeel + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + description: De benaming van het OBJECT + title: naam + maxLength: 500 + required: + - identificatie + - typeWaterdeel + ObjectWegdeel: + type: object + properties: + type: + type: string + title: type + maxLength: 100 + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + naam: + type: string + description: De benaming van het OBJECT + title: naam + maxLength: 500 + required: + - identificatie + - type + ObjectWijk: + type: object + properties: + wijkCode: + type: string + description: De code behorende bij de naam van de wijk. + title: wijk code + maxLength: 2 + wijkNaam: + type: string + description: De naam van de wijk, zoals die door het CBS wordt gebruikt. + title: wijk naam + maxLength: 40 + gemGemeenteCode: + type: string + description: + Een numerieke aanduiding waarmee een Nederlandse gemeente uniek + wordt aangeduid + title: gem gemeente code + maxLength: 4 + required: + - gemGemeenteCode + - wijkCode + - wijkNaam + ObjectWoonplaats: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + woonplaatsNaam: + type: string + description: + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + toegekende benaming. + title: woonplaats naam + maxLength: 80 + required: + - identificatie + - woonplaatsNaam + ObjectWozDeelobject: + type: object + properties: + nummerWozDeelObject: + type: string + description: Uniek identificatienummer voor het deelobject binnen een WOZ-object. + title: nummer woz deel object + maxLength: 6 + isOnderdeelVan: + allOf: + - $ref: '#/components/schemas/ObjectWozObject' + title: isOnderdeelVan + required: + - nummerWozDeelObject + ObjectWozObject: + type: object + properties: + wozObjectNummer: + type: string + description: De unieke identificatie van het OBJECT + title: woz object nummer + maxLength: 100 + aanduidingWozObject: + allOf: + - $ref: '#/components/schemas/WozObjectAdres' + nullable: true + title: aanduidingWozObject + required: + - wozObjectNummer + ObjectWozWaarde: + type: object + properties: + waardepeildatum: + type: string + description: De datum waarnaar de waarde van het WOZ-object wordt bepaald. + title: waardepeildatum + maxLength: 9 + isVoor: + allOf: + - $ref: '#/components/schemas/ObjectWozObject' + title: isVoor + required: + - waardepeildatum + ObjectZakelijkRecht: + type: object + properties: + identificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + avgAard: + type: string + description: aanduiding voor de aard van het recht + title: avg aard + maxLength: 1000 + heeftBetrekkingOp: + allOf: + - $ref: '#/components/schemas/ObjectKadastraleOnroerendeZaak' + title: heeftBetrekkingOp + heeftAlsGerechtigde: + allOf: + - $ref: '#/components/schemas/ZakelijkRechtHeeftAlsGerechtigde' + title: heeftAlsGerechtigde + required: + - avgAard + - identificatie + Opschorting: + type: object + description: + Gegevens omtrent het tijdelijk opschorten van de behandeling van + de ZAAK + properties: + indicatie: + type: boolean + description: Aanduiding of de behandeling van de ZAAK tijdelijk is opgeschort. + title: indicatie opschorting + reden: + type: string + description: + Omschrijving van de reden voor het opschorten van de behandeling + van de zaak. + title: reden opschorting + maxLength: 200 + required: + - indicatie + - reden + nullable: true + PaginatedKlantContactList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/KlantContact' + PaginatedResultaatList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Resultaat' + PaginatedRolList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Rol' + PaginatedStatusList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Status' + PaginatedZaakList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ZaakExpanded' + PaginatedZaakObjectList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ZaakObject' + PatchedResultaat: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + resultaattype: + type: string + format: uri + description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API). + title: resultaattype + maxLength: 1000 + toelichting: + type: string + description: Een toelichting op wat het resultaat van de zaak inhoudt. + title: toelichting + maxLength: 1000 + PatchedZaak: + type: object + description: 'Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + identificatie: + type: string + description: + De unieke identificatie van de ZAAK binnen de organisatie die + verantwoordelijk is voor de behandeling van de ZAAK. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + description: + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers + en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + title: bronorganisatie + maxLength: 9 + omschrijving: + type: string + description: Een korte omschrijving van de zaak. + title: omschrijving + maxLength: 80 + toelichting: + type: string + description: Een toelichting op de zaak. + title: toelichting + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de + CATALOGUS waar deze voorkomt + title: zaaktype + maxLength: 1000 + registratiedatum: + type: string + format: date + description: + De datum waarop de zaakbehandelende organisatie de ZAAK heeft + geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag + gebruikt. + title: registratiedatum + verantwoordelijkeOrganisatie: + type: string + description: + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die eindverantwoordelijk is voor de behandeling van de zaak. Dit moet + een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + title: verantwoordelijke organisatie + maxLength: 9 + startdatum: + type: string + format: date + description: De datum waarop met de uitvoering van de zaak is gestart + title: startdatum + einddatum: + type: string + format: date + readOnly: true + nullable: true + description: De datum waarop de uitvoering van de zaak afgerond is. + title: einddatum + einddatumGepland: + type: string + format: date + nullable: true + description: + De datum waarop volgens de planning verwacht wordt dat de zaak + afgerond wordt. + title: einddatum gepland + uiterlijkeEinddatumAfdoening: + type: string + format: date + nullable: true + description: + De laatste datum waarop volgens wet- en regelgeving de zaak + afgerond dient te zijn. + title: uiterlijke einddatum afdoening + publicatiedatum: + type: string + format: date + nullable: true + description: Datum waarop (het starten van) de zaak gepubliceerd is of wordt. + title: publicatiedatum + communicatiekanaal: + type: string + format: uri + description: + Het medium waarlangs de aanleiding om een zaak te starten is + ontvangen. URL naar een communicatiekanaal in de VNG-Referentielijst van + communicatiekanalen. + title: communicatiekanaal + maxLength: 1000 + productenOfDiensten: + type: array + items: + type: string + format: uri + title: URL naar product/dienst + maxLength: 1000 + description: + De producten en/of diensten die door de zaak worden voortgebracht. + Dit zijn URLs naar de resources zoals die door de producten- en dienstencatalogus-API + wordt ontsloten. De producten/diensten moeten bij het zaaktype vermeld + zijn. + title: producten of diensten + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + title: Vertrouwlijkheidaanduiding + description: + Aanduiding van de mate waarin het zaakdossier van de ZAAK voor + de openbaarheid bestemd is. Optioneel - indien geen waarde gekozen wordt, + dan wordt de waarde van het ZAAKTYPE overgenomen. Dit betekent dat de + API _altijd_ een waarde teruggeeft. + betalingsindicatie: + description: + 'Indicatie of de, met behandeling van de zaak gemoeide, kosten + betaald zijn door de desbetreffende betrokkene. + + + Uitleg bij mogelijke waarden: + + + * `nvt` - Er is geen sprake van te betalen, met de zaak gemoeide, kosten. + + * `nog_niet` - De met de zaak gemoeide kosten zijn (nog) niet betaald. + + * `gedeeltelijk` - De met de zaak gemoeide kosten zijn gedeeltelijk betaald. + + * `geheel` - De met de zaak gemoeide kosten zijn geheel betaald.' + title: betalingsindicatie + oneOf: + - $ref: '#/components/schemas/BetalingsindicatieEnum' + - $ref: '#/components/schemas/BlankEnum' + betalingsindicatieWeergave: + type: string + readOnly: true + description: Uitleg bij `betalingsindicatie`. + title: betalingsindicatieWeergave + laatsteBetaaldatum: + type: string + format: date-time + nullable: true + description: + De datum waarop de meest recente betaling is verwerkt van kosten + die gemoeid zijn met behandeling van de zaak. + title: laatste betaaldatum + zaakgeometrie: + allOf: + - $ref: '#/components/schemas/GeoJSONGeometry' + nullable: true + description: Punt, lijn of (multi-)vlak geometrie-informatie, in GeoJSON. + title: zaakgeometrie + verlenging: + allOf: + - $ref: '#/components/schemas/Verlenging' + nullable: true + description: + Gegevens omtrent het verlengen van de doorlooptijd van de behandeling + van de ZAAK + title: verlenging + opschorting: + allOf: + - $ref: '#/components/schemas/Opschorting' + nullable: true + description: + Gegevens omtrent het tijdelijk opschorten van de behandeling + van de ZAAK + title: opschorting + selectielijstklasse: + type: string + format: uri + description: + URL-referentie naar de categorie in de gehanteerde 'Selectielijst + Archiefbescheiden' die, gezien het zaaktype en het resultaattype van de + zaak, bepalend is voor het archiefregime van de zaak. + title: selectielijstklasse + maxLength: 1000 + hoofdzaak: + type: string + format: uri + nullable: true + title: Is deelzaak van + description: + "URL-referentie naar de ZAAK, waarom verzocht is door de initiator\ + \ daarvan, die behandeld wordt in twee of meer separate ZAAKen waarvan\ + \ de onderhavige ZAAK er \xE9\xE9n is." + minLength: 1 + maxLength: 1000 + deelzaken: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar deel ZAAKen. + title: is deelzaak van + uniqueItems: true + relevanteAndereZaken: + type: array + items: + $ref: '#/components/schemas/RelevanteZaak' + description: Een lijst van relevante andere zaken. + title: zaak + eigenschappen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + rollen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + status: + type: string + format: uri + readOnly: true + nullable: true + description: Indien geen status bekend is, dan is de waarde 'null' + title: status + zaakinformatieobjecten: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + zaakobjecten: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + kenmerken: + type: array + items: + $ref: '#/components/schemas/ZaakKenmerk' + description: + Lijst van kenmerken. Merk op dat refereren naar gerelateerde + objecten beter kan via `ZaakObject`. + title: zaak + archiefnominatie: + nullable: true + description: + 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + + + Uitleg bij mogelijke waarden: + + + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum + overgedragen worden naar een archiefbewaarplaats. + + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' + title: archiefnominatie + oneOf: + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/NullEnum' + archiefstatus: + allOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + description: + 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + + + Uitleg bij mogelijke waarden: + + + * `nog_te_archiveren` - De zaak cq. het zaakdossier is nog niet als geheel + gearchiveerd. + + * `gearchiveerd` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar + bewaarbaar gemaakt. + + * `gearchiveerd_procestermijn_onbekend` - De zaak cq. het zaakdossier + is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum + kan nog niet bepaald worden. + + * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een + archiefbewaarplaats.' + title: archiefstatus + archiefactiedatum: + type: string + format: date + nullable: true + description: + De datum waarop het gearchiveerde zaakdossier vernietigd moet + worden dan wel overgebracht moet worden naar een archiefbewaarplaats. + Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT + aan deze ZAAK indien nog leeg. + title: archiefactiedatum + resultaat: + type: string + format: uri + readOnly: true + nullable: true + description: + URL-referentie naar het RESULTAAT. Indien geen resultaat bekend + is, dan is de waarde 'null' + title: resultaat + opdrachtgevendeOrganisatie: + type: string + description: + De krachtens publiekrecht ingestelde rechtspersoon dan wel + ander niet-natuurlijk persoon waarbinnen het (bestuurs)orgaan zetelt dat + opdracht heeft gegeven om taken uit te voeren waaraan de zaak invulling + geeft. + title: opdrachtgevende organisatie + maxLength: 9 + processobjectaard: + type: string + nullable: true + title: Procesobjectaard + description: + Omschrijving van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, de zaak betrekking heeft. + maxLength: 200 + startdatumBewaartermijn: + type: string + format: date + nullable: true + description: + De datum die de start markeert van de termijn waarop het zaakdossier + vernietigd moet worden. + title: startdatum bewaartermijn + processobject: + allOf: + - $ref: '#/components/schemas/Processobject' + nullable: true + description: + Specificatie van de attribuutsoort van het object, subject + of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking + heeft en dat bepalend is voor de start van de archiefactietermijn. + title: processobject + PatchedZaakEigenschap: + type: object + description: + "A type of `ModelSerializer` that uses hyperlinked relationships + with compound keys instead + + of primary key relationships. Specifically: + + + * A 'url' field is included instead of the 'id' field. + + * Relationships to other instances are hyperlinks, instead of primary keys. + + + NOTE: this only works with DRF 3.1.0 and above." + properties: + url: + type: string + format: uri + readOnly: true + title: url + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + title: zaak + eigenschap: + type: string + format: uri + description: URL-referentie naar de EIGENSCHAP (in de Catalogi API). + title: eigenschap + maxLength: 1000 + naam: + type: string + readOnly: true + description: De naam van de EIGENSCHAP (overgenomen uit de Catalogi API). + title: ' naam' + waarde: + type: string + title: waarde + PatchedZaakInformatieObject: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + informatieobject: + type: string + format: uri + description: + URL-referentie naar het INFORMATIEOBJECT (in de Documenten + API), waar ook de relatieinformatie opgevraagd kan worden. + title: informatieobject + maxLength: 1000 + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + aardRelatieWeergave: + allOf: + - $ref: '#/components/schemas/AardRelatieWeergaveEnum' + readOnly: true + title: aardRelatieWeergave + titel: + type: string + description: + De naam waaronder het INFORMATIEOBJECT binnen het OBJECT bekend + is. + title: titel + maxLength: 200 + beschrijving: + type: string + description: + Een op het object gerichte beschrijving van de inhoud vanhet + INFORMATIEOBJECT. + title: beschrijving + registratiedatum: + type: string + format: date-time + readOnly: true + description: + De datum waarop de behandelende organisatie het INFORMATIEOBJECT + heeft geregistreerd bij het OBJECT. Geldige waardes zijn datumtijden gelegen + op of voor de huidige datum en tijd. + title: registratiedatum + vernietigingsdatum: + type: string + format: date-time + nullable: true + description: + De datum waarop het informatieobject uit het zaakdossier verwijderd + moet worden. + title: vernietigingsdatum + status: + type: string + format: uri + nullable: true + description: + De bij de desbetreffende ZAAK behorende STATUS waarvoor het + ZAAK-INFORMATIEOBJECT relevant is (geweest) met het oog op het bereiken + van die STATUS en/of de communicatie daarover. + title: status + minLength: 1 + maxLength: 1000 + PatchedZaakObject: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + object: + type: string + format: uri + description: URL-referentie naar de resource die het OBJECT beschrijft. + title: object + maxLength: 1000 + zaakobjecttype: + type: string + format: uri + description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API). + title: zaakobjecttype + maxLength: 1000 + objectType: + allOf: + - $ref: '#/components/schemas/ObjectTypeEnum' + description: + 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er + geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. + + + Uitleg bij mogelijke waarden: + + + * `adres` - Adres + + * `besluit` - Besluit + + * `buurt` - Buurt + + * `enkelvoudig_document` - Enkelvoudig document + + * `gemeente` - Gemeente + + * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte + + * `huishouden` - Huishouden + + * `inrichtingselement` - Inrichtingselement + + * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak + + * `kunstwerkdeel` - Kunstwerkdeel + + * `maatschappelijke_activiteit` - Maatschappelijke activiteit + + * `medewerker` - Medewerker + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `openbare_ruimte` - Openbare ruimte + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `pand` - Pand + + * `spoorbaandeel` - Spoorbaandeel + + * `status` - Status + + * `terreindeel` - Terreindeel + + * `terrein_gebouwd_object` - Terrein gebouwd object + + * `vestiging` - Vestiging + + * `waterdeel` - Waterdeel + + * `wegdeel` - Wegdeel + + * `wijk` - Wijk + + * `woonplaats` - Woonplaats + + * `woz_deelobject` - Woz deel object + + * `woz_object` - Woz object + + * `woz_waarde` - Woz waarde + + * `zakelijk_recht` - Zakelijk recht + + * `overige` - Overige' + title: object type + objectTypeOverige: + type: string + description: + Beschrijft het type OBJECT als `objectType` de waarde "overige" + heeft. + title: object type overige + pattern: '[a-z\_]+' + maxLength: 100 + objectTypeOverigeDefinitie: + allOf: + - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie' + nullable: true + title: definitie object type overige + description: + 'Verwijzing naar het schema van het type OBJECT als `objectType` + de waarde "overige" heeft. + + + * De URL referentie moet naar een JSON endpoint wijzen waarin het objecttype + gedefinieerd is, inclusief het [JSON-schema](https://json-schema.org/). + + * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen de + objecttype resource (deze gebruikt het [jq](http://stedolan.github.io/jq/) + formaat. + + * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens binnen + het OBJECT. Deze gebruikt ook het [jq](http://stedolan.github.io/jq/) + formaat. + + + Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven + en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven + OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.' + relatieomschrijving: + type: string + description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. + title: relatieomschrijving + maxLength: 80 + discriminator: + propertyName: objectType + mapping: + adres: '#/components/schemas/adres_PatchedZaakObject' + besluit: '#/components/schemas/besluit_PatchedZaakObject' + buurt: '#/components/schemas/buurt_PatchedZaakObject' + enkelvoudig_document: '#/components/schemas/enkelvoudig_document_PatchedZaakObject' + gemeente: '#/components/schemas/gemeente_PatchedZaakObject' + gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_PatchedZaakObject' + huishouden: '#/components/schemas/huishouden_PatchedZaakObject' + inrichtingselement: '#/components/schemas/inrichtingselement_PatchedZaakObject' + kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_PatchedZaakObject' + kunstwerkdeel: '#/components/schemas/kunstwerkdeel_PatchedZaakObject' + maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_PatchedZaakObject' + medewerker: '#/components/schemas/medewerker_PatchedZaakObject' + natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_PatchedZaakObject' + niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_PatchedZaakObject' + openbare_ruimte: '#/components/schemas/openbare_ruimte_PatchedZaakObject' + organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_PatchedZaakObject' + pand: '#/components/schemas/pand_PatchedZaakObject' + spoorbaandeel: '#/components/schemas/spoorbaandeel_PatchedZaakObject' + status: '#/components/schemas/status_PatchedZaakObject' + terreindeel: '#/components/schemas/terreindeel_PatchedZaakObject' + terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_PatchedZaakObject' + vestiging: '#/components/schemas/vestiging_PatchedZaakObject' + waterdeel: '#/components/schemas/waterdeel_PatchedZaakObject' + wegdeel: '#/components/schemas/wegdeel_PatchedZaakObject' + wijk: '#/components/schemas/wijk_PatchedZaakObject' + woonplaats: '#/components/schemas/woonplaats_PatchedZaakObject' + woz_deelobject: '#/components/schemas/woz_deelobject_PatchedZaakObject' + woz_object: '#/components/schemas/woz_object_PatchedZaakObject' + woz_waarde: '#/components/schemas/woz_waarde_PatchedZaakObject' + zakelijk_recht: '#/components/schemas/zakelijk_recht_PatchedZaakObject' + overige: '#/components/schemas/overige_PatchedZaakObject' + Point: + title: Point + description: GeoJSON point geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.2 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + $ref: '#/components/schemas/Point2D' + Point2D: + title: Point2D + type: array + items: + type: number + maxItems: 2 + minItems: 2 + Polygon: + title: Polygon + description: GeoJSON polygon geometry + type: object + externalDocs: + url: https://tools.ietf.org/html/rfc7946#section-3.1.6 + allOf: + - $ref: '#/components/schemas/Geometry' + - type: object + required: + - coordinates + properties: + coordinates: + type: array + items: + type: array + items: + $ref: '#/components/schemas/Point2D' + Processobject: + type: object + description: + Specificatie van de attribuutsoort van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, de zaak betrekking heeft en dat bepalend is voor + de start van de archiefactietermijn. + properties: + datumkenmerk: + type: string + description: + De naam van de attribuutsoort van het procesobject dat bepalend + is voor het einde van de procestermijn. + title: datumkenmerk + maxLength: 250 + identificatie: + type: string + description: De unieke aanduiding van het procesobject. + title: identificatie + maxLength: 250 + objecttype: + type: string + description: Het soort object dat het procesobject representeert. + title: objecttype + maxLength: 250 + registratie: + type: string + description: + De naam van de registratie waarvan het procesobject deel uit + maakt. + title: registratie + maxLength: 250 + required: + - datumkenmerk + - identificatie + - objecttype + - registratie + nullable: true + RelevanteZaak: + type: object + properties: + url: + type: string + format: uri + title: URL-referentie naar de ZAAK. + maxLength: 1000 + aardRelatie: + allOf: + - $ref: '#/components/schemas/AardRelatieEnum' + description: + 'Benamingen van de aard van de relaties van andere zaken tot + (onderhanden) zaken. + + + Uitleg bij mogelijke waarden: + + + * `vervolg` - De andere zaak gaf aanleiding tot het starten van de onderhanden + zaak. + + * `onderwerp` - De andere zaak is relevant voor cq. is onderwerp van de + onderhanden zaak. + + * `bijdrage` - Aan het bereiken van de uitkomst van de andere zaak levert + de onderhanden zaak een bijdrage.' + title: aard relatie + required: + - aardRelatie + - url + Resultaat: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + resultaattype: + type: string + format: uri + description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API). + title: resultaattype + maxLength: 1000 + toelichting: + type: string + description: Een toelichting op wat het resultaat van de zaak inhoudt. + title: toelichting + maxLength: 1000 + required: + - resultaattype + - url + - uuid + - zaak + ResultaatExpanded: + allOf: + - $ref: '#/components/schemas/Resultaat' + - properties: + _expand: + $ref: '#/components/schemas/ResultaatEmbedded' + ResultaatEmbedded: + type: object + properties: + zaak: + $ref: '#/components/schemas/ZaakExpanded' + resultaattype: + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/ResultaatTypeExpanded' + Rol: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + betrokkene: + type: string + format: uri + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + title: betrokkene + maxLength: 1000 + betrokkeneType: + allOf: + - $ref: '#/components/schemas/BetrokkeneTypeEnum' + description: 'Type van de `betrokkene`. + + + Uitleg bij mogelijke waarden: + + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `vestiging` - Vestiging + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `medewerker` - Medewerker' + title: betrokkene type + afwijkendeNaamBetrokkene: + type: string + description: + De naam van de betrokkene waaronder deze in relatie tot de + zaak aangesproken wil worden. + title: afwijkende naam betrokkene + maxLength: 625 + roltype: + type: string + format: uri + description: + URL-referentie naar een roltype binnen het ZAAKTYPE van de + ZAAK. + title: roltype + maxLength: 1000 + omschrijving: + type: string + readOnly: true + description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. + title: omschrijving + omschrijvingGeneriek: + type: string + readOnly: true + description: + "Algemeen gehanteerde benaming van de aard van de ROL, afgeleid\ + \ uit het ROLTYPE.\n\nUitleg bij mogelijke waarden:\n\n* `adviseur` -\ + \ (Adviseur) Kennis in dienst stellen van de behandeling van (een deel\ + \ van) een zaak.\n* `behandelaar` - (Behandelaar) De vakinhoudelijke behandeling\ + \ doen van (een deel van) een zaak.\n* `belanghebbende` - (Belanghebbende)\ + \ Vanuit eigen en objectief belang rechtstreeks betrokken zijn bij de\ + \ behandeling en/of de uitkomst van een zaak.\n* `beslisser` - (Beslisser)\ + \ Nemen van besluiten die voor de uitkomst van een zaak noodzakelijk zijn.\n\ + * `initiator` - (Initiator) Aanleiding geven tot de start van een zaak\ + \ ..\n* `klantcontacter` - (Klantcontacter) Het eerste aanspreekpunt zijn\ + \ voor vragen van burgers en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6\ + rdinator) Er voor zorg dragen dat de behandeling van de zaak in samenhang\ + \ uitgevoerd wordt conform de daarover gemaakte afspraken.\n* `mede_initiator`\ + \ - Mede-initiator" + title: omschrijving generiek + roltoelichting: + type: string + title: roltoelichting + maxLength: 1000 + registratiedatum: + type: string + format: date-time + readOnly: true + description: De datum waarop dit object is geregistreerd. + title: registratiedatum + indicatieMachtiging: + description: 'Indicatie machtiging + + + Uitleg bij mogelijke waarden: + + + * `gemachtigde` - De betrokkene in de rol bij de zaak is door een andere + betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen + + * `machtiginggever` - De betrokkene in de rol bij de zaak heeft een andere + betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen' + title: indicatie machtiging + oneOf: + - $ref: '#/components/schemas/IndicatieMachtigingEnum' + - $ref: '#/components/schemas/BlankEnum' + contactpersoonRol: + allOf: + - $ref: '#/components/schemas/ContactPersoonRol' + nullable: true + description: + De gegevens van de persoon die anderen desgevraagd in contact + brengt met medewerkers van de BETROKKENE, een NIET-NATUURLIJK PERSOON + of VESTIGING zijnde, of met BETROKKENE zelf, een NATUURLIJK PERSOON zijnde + , vanuit het belang van BETROKKENE in haar ROL bij een ZAAK. + title: contactpersoonRol + statussen: + type: array + items: + type: string + format: uri + title: '' + minLength: 1 + maxLength: 1000 + readOnly: true + description: + De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd + dat STATUSsen in die ZAAK bereikt zijn. + title: statussen + uniqueItems: true + required: + - betrokkeneType + - omschrijving + - omschrijvingGeneriek + - registratiedatum + - roltoelichting + - roltype + - statussen + - url + - uuid + - zaak + discriminator: + propertyName: betrokkeneType + mapping: + medewerker: '#/components/schemas/medewerker_Rol' + natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_Rol' + niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_Rol' + organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_Rol' + vestiging: '#/components/schemas/vestiging_Rol' + RolExpanded: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + betrokkene: + type: string + format: uri + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + title: betrokkene + maxLength: 1000 + betrokkeneType: + allOf: + - $ref: '#/components/schemas/BetrokkeneTypeEnum' + description: 'Type van de `betrokkene`. + + + Uitleg bij mogelijke waarden: + + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `vestiging` - Vestiging + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `medewerker` - Medewerker' + title: betrokkene type + afwijkendeNaamBetrokkene: + type: string + description: + De naam van de betrokkene waaronder deze in relatie tot de + zaak aangesproken wil worden. + title: afwijkende naam betrokkene + maxLength: 625 + roltype: + type: string + format: uri + description: + URL-referentie naar een roltype binnen het ZAAKTYPE van de + ZAAK. + title: roltype + maxLength: 1000 + omschrijving: + type: string + readOnly: true + description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. + title: omschrijving + omschrijvingGeneriek: + type: string + readOnly: true + description: + "Algemeen gehanteerde benaming van de aard van de ROL, afgeleid\ + \ uit het ROLTYPE.\n\nUitleg bij mogelijke waarden:\n\n* `adviseur` -\ + \ (Adviseur) Kennis in dienst stellen van de behandeling van (een deel\ + \ van) een zaak.\n* `behandelaar` - (Behandelaar) De vakinhoudelijke behandeling\ + \ doen van (een deel van) een zaak.\n* `belanghebbende` - (Belanghebbende)\ + \ Vanuit eigen en objectief belang rechtstreeks betrokken zijn bij de\ + \ behandeling en/of de uitkomst van een zaak.\n* `beslisser` - (Beslisser)\ + \ Nemen van besluiten die voor de uitkomst van een zaak noodzakelijk zijn.\n\ + * `initiator` - (Initiator) Aanleiding geven tot de start van een zaak\ + \ ..\n* `klantcontacter` - (Klantcontacter) Het eerste aanspreekpunt zijn\ + \ voor vragen van burgers en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6\ + rdinator) Er voor zorg dragen dat de behandeling van de zaak in samenhang\ + \ uitgevoerd wordt conform de daarover gemaakte afspraken.\n* `mede_initiator`\ + \ - Mede-initiator" + title: omschrijving generiek + roltoelichting: + type: string + title: roltoelichting + maxLength: 1000 + registratiedatum: + type: string + format: date-time + readOnly: true + description: De datum waarop dit object is geregistreerd. + title: registratiedatum + indicatieMachtiging: + description: 'Indicatie machtiging + + + Uitleg bij mogelijke waarden: + + + * `gemachtigde` - De betrokkene in de rol bij de zaak is door een andere + betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen + + * `machtiginggever` - De betrokkene in de rol bij de zaak heeft een andere + betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen' + title: indicatie machtiging + oneOf: + - $ref: '#/components/schemas/IndicatieMachtigingEnum' + - $ref: '#/components/schemas/BlankEnum' + contactpersoonRol: + allOf: + - $ref: '#/components/schemas/ContactPersoonRol' + nullable: true + description: + De gegevens van de persoon die anderen desgevraagd in contact + brengt met medewerkers van de BETROKKENE, een NIET-NATUURLIJK PERSOON + of VESTIGING zijnde, of met BETROKKENE zelf, een NATUURLIJK PERSOON zijnde + , vanuit het belang van BETROKKENE in haar ROL bij een ZAAK. + title: contactpersoonRol + statussen: + type: array + items: + type: string + format: uri + title: '' + minLength: 1 + maxLength: 1000 + readOnly: true + description: + De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd + dat STATUSsen in die ZAAK bereikt zijn. + title: statussen + uniqueItems: true + _expand: + $ref: '#/components/schemas/RolEmbedded' + required: + - betrokkeneType + - omschrijving + - omschrijvingGeneriek + - registratiedatum + - roltoelichting + - roltype + - statussen + - url + - uuid + - zaak + discriminator: + propertyName: betrokkeneType + mapping: + medewerker: '#/components/schemas/medewerker_RolExpanded' + natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_RolExpanded' + niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_RolExpanded' + organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_RolExpanded' + vestiging: '#/components/schemas/vestiging_RolExpanded' + + RolEmbedded: + type: object + properties: + zaak: + $ref: '#/components/schemas/ZaakExpanded' + example: {} + roltype: + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/RolTypeExpanded' + statussen: + type: array + items: + $ref: '#/components/schemas/StatusExpanded' + RolMedewerker: + type: object + properties: + identificatie: + type: string + description: Een korte unieke aanduiding van de MEDEWERKER. + title: identificatie + maxLength: 24 + achternaam: + type: string + description: + De achternaam zoals de MEDEWERKER die in het dagelijkse verkeer + gebruikt. + title: achternaam + maxLength: 200 + voorletters: + type: string + description: + De verzameling letters die gevormd wordt door de eerste letter + van alle in volgorde voorkomende voornamen. + title: voorletters + maxLength: 20 + voorvoegselAchternaam: + type: string + description: + Dat deel van de geslachtsnaam dat voorkomt in Tabel 36 (GBA), + voorvoegseltabel, en door een spatie van de geslachtsnaam is + title: voorvoegsel achternaam + maxLength: 10 + RolNatuurlijkPersoon: + type: object + properties: + inpBsn: + type: string + description: + Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet + algemene bepalingen burgerservicenummer. + title: inp bsn + maxLength: 9 + anpIdentificatie: + type: string + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NATUURLIJK PERSOON + title: anp identificatie + maxLength: 17 + inpA_nummer: + type: string + description: Het administratienummer van de persoon, bedoeld in de Wet BRP + title: inp a nummer + pattern: ^[1-9][0-9]{9}$ + maxLength: 10 + geslachtsnaam: + type: string + description: De stam van de geslachtsnaam. + title: geslachtsnaam + maxLength: 200 + voorvoegselGeslachtsnaam: + type: string + title: voorvoegsel geslachtsnaam + maxLength: 80 + voorletters: + type: string + description: + De verzameling letters die gevormd wordt door de eerste letter + van alle in volgorde voorkomende voornamen. + title: voorletters + maxLength: 20 + voornamen: + type: string + description: Voornamen bij de naam die de persoon wenst te voeren. + title: voornamen + maxLength: 200 + geslachtsaanduiding: + description: + 'Een aanduiding die aangeeft of de persoon een man of een vrouw + is, of dat het geslacht nog onbekend is. + + + Uitleg bij mogelijke waarden: + + + * `m` - Man + + * `v` - Vrouw + + * `o` - Onbekend' + title: geslachtsaanduiding + oneOf: + - $ref: '#/components/schemas/GeslachtsaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + geboortedatum: + type: string + title: geboortedatum + maxLength: 18 + verblijfsadres: + allOf: + - $ref: '#/components/schemas/VerblijfsAdres' + nullable: true + title: verblijfsadres + subVerblijfBuitenland: + allOf: + - $ref: '#/components/schemas/SubVerblijfBuitenland' + nullable: true + title: subVerblijfBuitenland + RolNietNatuurlijkPersoon: + type: object + properties: + innNnpId: + type: string + description: + Het door een kamer toegekend uniek nummer voor de INGESCHREVEN + NIET-NATUURLIJK PERSOON + title: inn nnp id + maxLength: 9 + annIdentificatie: + type: string + description: + Het door de gemeente uitgegeven unieke nummer voor een ANDER + NIET-NATUURLIJK PERSOON + title: ann identificatie + maxLength: 17 + statutaireNaam: + type: string + description: + Naam van de niet-natuurlijke persoon zoals deze is vastgelegd + in de statuten (rechtspersoon) of in de vennootschapsovereenkomst is overeengekomen + (Vennootschap onder firma of Commanditaire vennootschap). + title: statutaire naam + maxLength: 500 + innRechtsvorm: + description: De juridische vorm van de NIET-NATUURLIJK PERSOON. + title: inn rechtsvorm + oneOf: + - $ref: '#/components/schemas/InnRechtsvormEnum' + - $ref: '#/components/schemas/BlankEnum' + bezoekadres: + type: string + description: De gegevens over het adres van de NIET-NATUURLIJK PERSOON + title: bezoekadres + maxLength: 1000 + subVerblijfBuitenland: + allOf: + - $ref: '#/components/schemas/SubVerblijfBuitenland' + nullable: true + title: subVerblijfBuitenland + RolOrganisatorischeEenheid: + type: object + properties: + identificatie: + type: string + description: Een korte identificatie van de organisatorische eenheid. + title: identificatie + maxLength: 24 + naam: + type: string + description: De feitelijke naam van de organisatorische eenheid. + title: naam + maxLength: 50 + isGehuisvestIn: + type: string + title: is gehuisvest in + maxLength: 24 + RolVestiging: + type: object + properties: + vestigingsNummer: + type: string + description: Een korte unieke aanduiding van de Vestiging. + title: vestigings nummer + maxLength: 24 + handelsnaam: + type: array + items: + type: string + maxLength: 625 + description: De naam van de vestiging waaronder gehandeld wordt. + title: handelsnaam + verblijfsadres: + allOf: + - $ref: '#/components/schemas/VerblijfsAdres' + nullable: true + title: verblijfsadres + subVerblijfBuitenland: + allOf: + - $ref: '#/components/schemas/SubVerblijfBuitenland' + nullable: true + title: subVerblijfBuitenland + kvkNummer: + type: string + description: Een uniek nummer gekoppeld aan de onderneming. + title: kvk nummer + maxLength: 8 + Status: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + statustype: + type: string + format: uri + description: URL-referentie naar het STATUSTYPE (in de Catalogi API). + title: statustype + maxLength: 1000 + datumStatusGezet: + type: string + format: date-time + description: De datum waarop de ZAAK de status heeft verkregen. + title: datum status gezet + statustoelichting: + type: string + description: + Een, voor de initiator van de zaak relevante, toelichting op + de status van een zaak. + title: statustoelichting + maxLength: 1000 + indicatieLaatstGezetteStatus: + type: boolean + readOnly: true + description: + Het gegeven is afleidbaar uit de historie van de attribuutsoort + Datum status gezet van van alle statussen bij de desbetreffende zaak. + title: indicatieLaatstGezetteStatus + gezetdoor: + type: string + format: uri + title: Gezet door + description: + De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd + dat STATUSsen in die ZAAK bereikt zijn. + maxLength: 200 + zaakinformatieobjecten: + type: array + items: + type: string + format: uri + title: '' + minLength: 1 + maxLength: 1000 + readOnly: true + title: zaakInformatieobjecten + uniqueItems: true + required: + - datumStatusGezet + - indicatieLaatstGezetteStatus + - statustype + - url + - uuid + - zaak + - zaakinformatieobjecten + StatusExpanded: + allOf: + - $ref: '#/components/schemas/Status' + - properties: + _expand: + $ref: '#/components/schemas/StatusEmbedded' + StatusEmbedded: + type: object + properties: + statustype: + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/StatusTypeExpanded' + gezetdoor: + $ref: '#/components/schemas/Rol' + zaakinformatieobjecten: + type: array + items: + $ref: '#/components/schemas/ZaakInformatieObject' + StatusRequestbody: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + statustype: + type: string + format: uri + description: URL-referentie naar het STATUSTYPE (in de Catalogi API). + title: statustype + maxLength: 1000 + datumStatusGezet: + type: string + format: date-time + description: De datum waarop de ZAAK de status heeft verkregen. + title: datum status gezet + statustoelichting: + type: string + description: + Een, voor de initiator van de zaak relevante, toelichting op + de status van een zaak. + title: statustoelichting + maxLength: 1000 + indicatieLaatstGezetteStatus: + type: boolean + readOnly: true + description: + Het gegeven is afleidbaar uit de historie van de attribuutsoort + Datum status gezet van van alle statussen bij de desbetreffende zaak. + title: indicatieLaatstGezetteStatus + gezetdoor: + type: string + format: uri + title: Gezet door + description: + De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd + dat STATUSsen in die ZAAK bereikt zijn. + maxLength: 200 + required: + - datumStatusGezet + - indicatieLaatstGezetteStatus + - statustype + - url + - uuid + - zaak + - zaakinformatieobjecten + SubVerblijfBuitenland: + type: object + properties: + lndLandcode: + type: string + description: + De code, behorende bij de landnaam, zoals opgenomen in de Land/Gebied-tabel + van de BRP. + title: lnd landcode + maxLength: 4 + lndLandnaam: + type: string + description: + De naam van het land, zoals opgenomen in de Land/Gebied-tabel + van de BRP. + title: lnd landnaam + maxLength: 40 + subAdresBuitenland_1: + type: string + title: sub adres buitenland 1 + maxLength: 35 + subAdresBuitenland_2: + type: string + title: sub adres buitenland 2 + maxLength: 35 + subAdresBuitenland_3: + type: string + title: sub adres buitenland 3 + maxLength: 35 + required: + - lndLandcode + - lndLandnaam + TerreinGebouwdObjectAdres: + type: object + properties: + numIdentificatie: + type: string + title: num identificatie + maxLength: 100 + oaoIdentificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + wplWoonplaatsNaam: + type: string + title: wpl woonplaats naam + maxLength: 80 + gorOpenbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: gor openbare ruimte naam + maxLength: 80 + aoaPostcode: + type: string + title: postcode + maxLength: 7 + aoaHuisnummer: + type: integer + maximum: 99999 + minimum: 0 + title: huisnummer + aoaHuisletter: + type: string + title: huisletter + maxLength: 1 + aoaHuisnummertoevoeging: + type: string + title: huisnummertoevoeging + maxLength: 4 + ogoLocatieAanduiding: + type: string + title: locatie aanduiding + maxLength: 100 + required: + - aoaHuisnummer + - gorOpenbareRuimteNaam + - oaoIdentificatie + - wplWoonplaatsNaam + TypeWaterdeelEnum: + enum: + - zee + - waterloop + - watervlakte + - greppel_droge_sloot + type: string + ValidatieFout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: + URI met referentie naar dit specifiek voorkomen van de fout. + Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + invalidParams: + type: array + items: + $ref: '#/components/schemas/FieldValidationError' + title: invalidParams + required: + - code + - detail + - instance + - invalidParams + - status + - title + VerblijfsAdres: + type: object + properties: + aoaIdentificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + wplWoonplaatsNaam: + type: string + title: wpl woonplaats naam + maxLength: 80 + gorOpenbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: gor openbare ruimte naam + maxLength: 80 + aoaPostcode: + type: string + title: postcode + maxLength: 7 + aoaHuisnummer: + type: integer + maximum: 99999 + minimum: 0 + title: huisnummer + aoaHuisletter: + type: string + title: huisletter + maxLength: 1 + aoaHuisnummertoevoeging: + type: string + title: huisnummertoevoeging + maxLength: 4 + inpLocatiebeschrijving: + type: string + title: locatie omschrijving + maxLength: 1000 + required: + - aoaHuisnummer + - aoaIdentificatie + - gorOpenbareRuimteNaam + - wplWoonplaatsNaam + Verlenging: + type: object + description: + Gegevens omtrent het verlengen van de doorlooptijd van de behandeling + van de ZAAK + properties: + reden: + type: string + description: + Omschrijving van de reden voor het verlengen van de behandeling + van de zaak. + title: reden verlenging + maxLength: 200 + duur: + type: string + description: + Het aantal werkbare dagen waarmee de doorlooptijd van de behandeling + van de ZAAK is verlengd (of verkort) ten opzichte van de eerder gecommuniceerde + doorlooptijd. + title: duur verlenging + format: duration + required: + - duur + - reden + nullable: true + VertrouwelijkheidaanduidingEnum: + enum: + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim + type: string + Wijzigingen: + type: object + properties: + oud: + type: object + additionalProperties: {} + description: + Volledige JSON body van het object zoals dat bestond voordat + de actie heeft plaatsgevonden. + title: oud + nieuw: + type: object + additionalProperties: {} + description: Volledige JSON body van het object na de actie. + title: nieuw + WozObjectAdres: + type: object + properties: + aoaIdentificatie: + type: string + description: De unieke identificatie van het OBJECT + title: identificatie + maxLength: 100 + wplWoonplaatsNaam: + type: string + title: wpl woonplaats naam + maxLength: 80 + gorOpenbareRuimteNaam: + type: string + description: + Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming + title: gor openbare ruimte naam + maxLength: 80 + aoaPostcode: + type: string + title: postcode + maxLength: 7 + aoaHuisnummer: + type: integer + maximum: 99999 + minimum: 0 + title: huisnummer + aoaHuisletter: + type: string + title: huisletter + maxLength: 1 + aoaHuisnummertoevoeging: + type: string + title: huisnummertoevoeging + maxLength: 4 + locatieOmschrijving: + type: string + title: locatie omschrijving + maxLength: 1000 + required: + - aoaHuisnummer + - aoaIdentificatie + - gorOpenbareRuimteNaam + - wplWoonplaatsNaam + Zaak: + type: object + description: 'Set gegevensgroepdata from validated nested data. + + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + identificatie: + type: string + description: + De unieke identificatie van de ZAAK binnen de organisatie die + verantwoordelijk is voor de behandeling van de ZAAK. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + description: + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers + en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + title: bronorganisatie + maxLength: 9 + omschrijving: + type: string + description: Een korte omschrijving van de zaak. + title: omschrijving + maxLength: 80 + toelichting: + type: string + description: Een toelichting op de zaak. + title: toelichting + maxLength: 1000 + zaaktype: + type: string + format: uri + description: + URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de + CATALOGUS waar deze voorkomt + title: zaaktype + maxLength: 1000 + registratiedatum: + type: string + format: date + description: + De datum waarop de zaakbehandelende organisatie de ZAAK heeft + geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag + gebruikt. + title: registratiedatum + verantwoordelijkeOrganisatie: + type: string + description: + Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die eindverantwoordelijk is voor de behandeling van de zaak. Dit moet + een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + title: verantwoordelijke organisatie + maxLength: 9 + startdatum: + type: string + format: date + description: De datum waarop met de uitvoering van de zaak is gestart + title: startdatum + einddatum: + type: string + format: date + readOnly: true + nullable: true + description: De datum waarop de uitvoering van de zaak afgerond is. + title: einddatum + einddatumGepland: + type: string + format: date + nullable: true + description: + De datum waarop volgens de planning verwacht wordt dat de zaak + afgerond wordt. + title: einddatum gepland + uiterlijkeEinddatumAfdoening: + type: string + format: date + nullable: true + description: + De laatste datum waarop volgens wet- en regelgeving de zaak + afgerond dient te zijn. + title: uiterlijke einddatum afdoening + publicatiedatum: + type: string + format: date + nullable: true + description: Datum waarop (het starten van) de zaak gepubliceerd is of wordt. + title: publicatiedatum + communicatiekanaal: + type: string + format: uri + description: + Het medium waarlangs de aanleiding om een zaak te starten is + ontvangen. URL naar een communicatiekanaal in de VNG-Referentielijst van + communicatiekanalen. + title: communicatiekanaal + maxLength: 1000 + productenOfDiensten: + type: array + items: + type: string + format: uri + title: URL naar product/dienst + maxLength: 1000 + description: + De producten en/of diensten die door de zaak worden voortgebracht. + Dit zijn URLs naar de resources zoals die door de producten- en dienstencatalogus-API + wordt ontsloten. De producten/diensten moeten bij het zaaktype vermeld + zijn. + title: producten of diensten + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + title: Vertrouwlijkheidaanduiding + description: + Aanduiding van de mate waarin het zaakdossier van de ZAAK voor + de openbaarheid bestemd is. Optioneel - indien geen waarde gekozen wordt, + dan wordt de waarde van het ZAAKTYPE overgenomen. Dit betekent dat de + API _altijd_ een waarde teruggeeft. + betalingsindicatie: + description: + 'Indicatie of de, met behandeling van de zaak gemoeide, kosten + betaald zijn door de desbetreffende betrokkene. + + + Uitleg bij mogelijke waarden: + + + * `nvt` - Er is geen sprake van te betalen, met de zaak gemoeide, kosten. + + * `nog_niet` - De met de zaak gemoeide kosten zijn (nog) niet betaald. + + * `gedeeltelijk` - De met de zaak gemoeide kosten zijn gedeeltelijk betaald. + + * `geheel` - De met de zaak gemoeide kosten zijn geheel betaald.' + title: betalingsindicatie + oneOf: + - $ref: '#/components/schemas/BetalingsindicatieEnum' + - $ref: '#/components/schemas/BlankEnum' + betalingsindicatieWeergave: + type: string + readOnly: true + description: Uitleg bij `betalingsindicatie`. + title: betalingsindicatieWeergave + laatsteBetaaldatum: + type: string + format: date-time + nullable: true + description: + De datum waarop de meest recente betaling is verwerkt van kosten + die gemoeid zijn met behandeling van de zaak. + title: laatste betaaldatum + zaakgeometrie: + allOf: + - $ref: '#/components/schemas/GeoJSONGeometry' + nullable: true + description: Punt, lijn of (multi-)vlak geometrie-informatie, in GeoJSON. + title: zaakgeometrie + verlenging: + allOf: + - $ref: '#/components/schemas/Verlenging' + nullable: true + description: + Gegevens omtrent het verlengen van de doorlooptijd van de behandeling + van de ZAAK + title: verlenging + opschorting: + allOf: + - $ref: '#/components/schemas/Opschorting' + nullable: true + description: + Gegevens omtrent het tijdelijk opschorten van de behandeling + van de ZAAK + title: opschorting + selectielijstklasse: + type: string + format: uri + description: + URL-referentie naar de categorie in de gehanteerde 'Selectielijst + Archiefbescheiden' die, gezien het zaaktype en het resultaattype van de + zaak, bepalend is voor het archiefregime van de zaak. + title: selectielijstklasse + maxLength: 1000 + hoofdzaak: + type: string + format: uri + nullable: true + title: Is deelzaak van + description: + "URL-referentie naar de ZAAK, waarom verzocht is door de initiator\ + \ daarvan, die behandeld wordt in twee of meer separate ZAAKen waarvan\ + \ de onderhavige ZAAK er \xE9\xE9n is." + minLength: 1 + maxLength: 1000 + deelzaken: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar deel ZAAKen. + title: is deelzaak van + uniqueItems: true + relevanteAndereZaken: + type: array + items: + $ref: '#/components/schemas/RelevanteZaak' + description: Een lijst van relevante andere zaken. + title: zaak + eigenschappen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + rollen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + status: + type: string + format: uri + readOnly: true + nullable: true + description: Indien geen status bekend is, dan is de waarde 'null' + title: status + zaakinformatieobjecten: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + zaakobjecten: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: zaak + uniqueItems: true + kenmerken: + type: array + items: + $ref: '#/components/schemas/ZaakKenmerk' + description: + Lijst van kenmerken. Merk op dat refereren naar gerelateerde + objecten beter kan via `ZaakObject`. + title: zaak + archiefnominatie: + nullable: true + description: + 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + + + Uitleg bij mogelijke waarden: + + + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum + overgedragen worden naar een archiefbewaarplaats. + + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' + title: archiefnominatie + oneOf: + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/NullEnum' + archiefstatus: + allOf: + - $ref: '#/components/schemas/ArchiefstatusEnum' + description: + 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + + + Uitleg bij mogelijke waarden: + + + * `nog_te_archiveren` - De zaak cq. het zaakdossier is nog niet als geheel + gearchiveerd. + + * `gearchiveerd` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar + bewaarbaar gemaakt. + + * `gearchiveerd_procestermijn_onbekend` - De zaak cq. het zaakdossier + is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum + kan nog niet bepaald worden. + + * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een + archiefbewaarplaats.' + title: archiefstatus + archiefactiedatum: + type: string + format: date + nullable: true + description: + De datum waarop het gearchiveerde zaakdossier vernietigd moet + worden dan wel overgebracht moet worden naar een archiefbewaarplaats. + Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT + aan deze ZAAK indien nog leeg. + title: archiefactiedatum + resultaat: + type: string + format: uri + readOnly: true + nullable: true + description: + URL-referentie naar het RESULTAAT. Indien geen resultaat bekend + is, dan is de waarde 'null' + title: resultaat + opdrachtgevendeOrganisatie: + type: string + description: + De krachtens publiekrecht ingestelde rechtspersoon dan wel + ander niet-natuurlijk persoon waarbinnen het (bestuurs)orgaan zetelt dat + opdracht heeft gegeven om taken uit te voeren waaraan de zaak invulling + geeft. + title: opdrachtgevende organisatie + maxLength: 9 + processobjectaard: + type: string + nullable: true + title: Procesobjectaard + description: + Omschrijving van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, de zaak betrekking heeft. + maxLength: 200 + startdatumBewaartermijn: + type: string + format: date + nullable: true + description: + De datum die de start markeert van de termijn waarop het zaakdossier + vernietigd moet worden. + title: startdatum bewaartermijn + processobject: + allOf: + - $ref: '#/components/schemas/Processobject' + nullable: true + description: + Specificatie van de attribuutsoort van het object, subject + of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking + heeft en dat bepalend is voor de start van de archiefactietermijn. + title: processobject + required: + - betalingsindicatieWeergave + - bronorganisatie + - deelzaken + - eigenschappen + - einddatum + - resultaat + - rollen + - startdatum + - status + - url + - uuid + - verantwoordelijkeOrganisatie + - zaakinformatieobjecten + - zaakobjecten + - zaaktype + ZaakExpanded: + allOf: + - $ref: '#/components/schemas/Zaak' + - properties: + _expand: + $ref: '#/components/schemas/ZaakEmbedded' + ZaakEmbedded: + type: object + properties: + zaaktype: + + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' + hoofdzaak: + oneOf: + - $ref: '#/components/schemas/ZaakExpanded' + - $ref: '#/components/schemas/EmptyObject' + example: {} + deelzaken: + type: array + items: + $ref: '#/components/schemas/ZaakExpanded' + example: [{}] + relevanteAndereZaken: + type: array + items: + $ref: '#/components/schemas/ZaakExpanded' + example: [{}] + eigenschappen: + type: array + items: + $ref: '#/components/schemas/ZaakEigenschapExpanded' + rollen: + type: array + items: + $ref: '#/components/schemas/RolExpanded' + status: + oneOf: + - $ref: '#/components/schemas/StatusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaakobjecten: + type: array + items: + $ref: '#/components/schemas/ZaakObjectExpanded' + resultaat: + oneOf: + - $ref: '#/components/schemas/ResultaatExpanded' + - $ref: '#/components/schemas/EmptyObject' + EmptyObject: + type: object + description: Leeg object. Dit wordt teruggeven indien het te expanderen veld een null waarde heeft. + example: {} + ExpandCatalogusObject: + type: object + properties: + _expand: + type: object + description: Zie de Catalogus API hoe dit object verder geëxpandeerd kan worden. + ZaakBesluit: + type: object + description: + "A type of `ModelSerializer` that uses hyperlinked relationships + with compound keys instead + + of primary key relationships. Specifically: + + + * A 'url' field is included instead of the 'id' field. + + * Relationships to other instances are hyperlinks, instead of primary keys. + + + NOTE: this only works with DRF 3.1.0 and above." + properties: + url: + type: string + format: uri + readOnly: true + title: url + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + besluit: + type: string + format: uri + description: + URL-referentie naar het BESLUIT (in de Besluiten API), waar + ook de relatieinformatie opgevraagd kan worden. + title: besluit + maxLength: 1000 + required: + - besluit + - url + - uuid + ZaakContactMoment: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + contactmoment: + type: string + format: uri + description: + URL-referentie naar het CONTACTMOMENT (in de Klantinteractie + API) + title: contactmoment + maxLength: 1000 + required: + - contactmoment + - url + - uuid + - zaak + ZaakEigenschap: + type: object + description: + "A type of `ModelSerializer` that uses hyperlinked relationships + with compound keys instead + + of primary key relationships. Specifically: + + + * A 'url' field is included instead of the 'id' field. + + * Relationships to other instances are hyperlinks, instead of primary keys. + + + NOTE: this only works with DRF 3.1.0 and above." + properties: + url: + type: string + format: uri + readOnly: true + title: url + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + title: zaak + eigenschap: + type: string + format: uri + description: URL-referentie naar de EIGENSCHAP (in de Catalogi API). + title: eigenschap + maxLength: 1000 + naam: + type: string + readOnly: true + description: De naam van de EIGENSCHAP (overgenomen uit de Catalogi API). + title: ' naam' + waarde: + type: string + title: waarde + required: + - eigenschap + - naam + - url + - uuid + - waarde + - zaak + ZaakEigenschapExpanded: + allOf: + - $ref: '#/components/schemas/ZaakEigenschap' + - properties: + _expand: + $ref: '#/components/schemas/ZaakEigenschapEmbedded' + ZaakEigenschapEmbedded: + type: object + properties: + zaak: + oneOf: + - $ref: '#/components/schemas/ZaakExpanded' + - $ref: '#/components/schemas/EmptyObject' + eigenschap: + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/EigenschapExpanded' + ZaakInformatieObject: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + informatieobject: + type: string + format: uri + description: + URL-referentie naar het INFORMATIEOBJECT (in de Documenten + API), waar ook de relatieinformatie opgevraagd kan worden. + title: informatieobject + maxLength: 1000 + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + aardRelatieWeergave: + allOf: + - $ref: '#/components/schemas/AardRelatieWeergaveEnum' + readOnly: true + title: aardRelatieWeergave + titel: + type: string + description: + De naam waaronder het INFORMATIEOBJECT binnen het OBJECT bekend + is. + title: titel + maxLength: 200 + beschrijving: + type: string + description: + Een op het object gerichte beschrijving van de inhoud vanhet + INFORMATIEOBJECT. + title: beschrijving + registratiedatum: + type: string + format: date-time + readOnly: true + description: + De datum waarop de behandelende organisatie het INFORMATIEOBJECT + heeft geregistreerd bij het OBJECT. Geldige waardes zijn datumtijden gelegen + op of voor de huidige datum en tijd. + title: registratiedatum + vernietigingsdatum: + type: string + format: date-time + nullable: true + description: + De datum waarop het informatieobject uit het zaakdossier verwijderd + moet worden. + title: vernietigingsdatum + status: + type: string + format: uri + nullable: true + description: + De bij de desbetreffende ZAAK behorende STATUS waarvoor het + ZAAK-INFORMATIEOBJECT relevant is (geweest) met het oog op het bereiken + van die STATUS en/of de communicatie daarover. + title: status + minLength: 1 + maxLength: 1000 + required: + - aardRelatieWeergave + - informatieobject + - registratiedatum + - url + - uuid + - zaak + ZaakInformatieObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakInformatieObject' + - properties: + _expand: + $ref: '#/components/schemas/ZaakInformatieObjectEmbedded' + ZaakInformatieObjectEmbedded: + type: object + properties: + status: + $ref: '#/components/schemas/StatusExpanded' + ZaakKenmerk: + type: object + properties: + kenmerk: + type: string + description: Identificeert uniek de zaak in een andere administratie. + title: kenmerk + maxLength: 40 + bron: + type: string + description: De aanduiding van de administratie waar het kenmerk op slaat. + title: bron + maxLength: 40 + required: + - bron + - kenmerk + ZaakObject: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + object: + type: string + format: uri + description: URL-referentie naar de resource die het OBJECT beschrijft. + title: object + maxLength: 1000 + zaakobjecttype: + type: string + format: uri + description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API). + title: zaakobjecttype + maxLength: 1000 + objectType: + allOf: + - $ref: '#/components/schemas/ObjectTypeEnum' + description: + 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er + geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. + + + Uitleg bij mogelijke waarden: + + + * `adres` - Adres + + * `besluit` - Besluit + + * `buurt` - Buurt + + * `enkelvoudig_document` - Enkelvoudig document + + * `gemeente` - Gemeente + + * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte + + * `huishouden` - Huishouden + + * `inrichtingselement` - Inrichtingselement + + * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak + + * `kunstwerkdeel` - Kunstwerkdeel + + * `maatschappelijke_activiteit` - Maatschappelijke activiteit + + * `medewerker` - Medewerker + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `openbare_ruimte` - Openbare ruimte + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `pand` - Pand + + * `spoorbaandeel` - Spoorbaandeel + + * `status` - Status + + * `terreindeel` - Terreindeel + + * `terrein_gebouwd_object` - Terrein gebouwd object + + * `vestiging` - Vestiging + + * `waterdeel` - Waterdeel + + * `wegdeel` - Wegdeel + + * `wijk` - Wijk + + * `woonplaats` - Woonplaats + + * `woz_deelobject` - Woz deel object + + * `woz_object` - Woz object + + * `woz_waarde` - Woz waarde + + * `zakelijk_recht` - Zakelijk recht + + * `overige` - Overige' + title: object type + objectTypeOverige: + type: string + description: + Beschrijft het type OBJECT als `objectType` de waarde "overige" + heeft. + title: object type overige + pattern: '[a-z\_]+' + maxLength: 100 + objectTypeOverigeDefinitie: + allOf: + - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie' + nullable: true + title: definitie object type overige + description: + 'Verwijzing naar het schema van het type OBJECT als `objectType` + de waarde "overige" heeft. + + + * De URL referentie moet naar een JSON endpoint wijzen waarin het objecttype + gedefinieerd is, inclusief het [JSON-schema](https://json-schema.org/). + + * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen de + objecttype resource (deze gebruikt het [jq](http://stedolan.github.io/jq/) + formaat. + + * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens binnen + het OBJECT. Deze gebruikt ook het [jq](http://stedolan.github.io/jq/) + formaat. + + + Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven + en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven + OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.' + relatieomschrijving: + type: string + description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. + title: relatieomschrijving + maxLength: 80 + required: + - objectType + - url + - uuid + - zaak + discriminator: + propertyName: objectType + mapping: + adres: '#/components/schemas/adres_ZaakObject' + besluit: '#/components/schemas/besluit_ZaakObject' + buurt: '#/components/schemas/buurt_ZaakObject' + enkelvoudig_document: '#/components/schemas/enkelvoudig_document_ZaakObject' + gemeente: '#/components/schemas/gemeente_ZaakObject' + gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_ZaakObject' + huishouden: '#/components/schemas/huishouden_ZaakObject' + inrichtingselement: '#/components/schemas/inrichtingselement_ZaakObject' + kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_ZaakObject' + kunstwerkdeel: '#/components/schemas/kunstwerkdeel_ZaakObject' + maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_ZaakObject' + medewerker: '#/components/schemas/medewerker_ZaakObject' + natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_ZaakObject' + niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_ZaakObject' + openbare_ruimte: '#/components/schemas/openbare_ruimte_ZaakObject' + organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_ZaakObject' + pand: '#/components/schemas/pand_ZaakObject' + spoorbaandeel: '#/components/schemas/spoorbaandeel_ZaakObject' + status: '#/components/schemas/status_ZaakObject' + terreindeel: '#/components/schemas/terreindeel_ZaakObject' + terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_ZaakObject' + vestiging: '#/components/schemas/vestiging_ZaakObject' + waterdeel: '#/components/schemas/waterdeel_ZaakObject' + wegdeel: '#/components/schemas/wegdeel_ZaakObject' + wijk: '#/components/schemas/wijk_ZaakObject' + woonplaats: '#/components/schemas/woonplaats_ZaakObject' + woz_deelobject: '#/components/schemas/woz_deelobject_ZaakObject' + woz_object: '#/components/schemas/woz_object_ZaakObject' + woz_waarde: '#/components/schemas/woz_waarde_ZaakObject' + zakelijk_recht: '#/components/schemas/zakelijk_recht_ZaakObject' + overige: '#/components/schemas/overige_ZaakObject' + ZaakObjectExpanded: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + object: + type: string + format: uri + description: URL-referentie naar de resource die het OBJECT beschrijft. + title: object + maxLength: 1000 + zaakobjecttype: + type: string + format: uri + description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API). + title: zaakobjecttype + maxLength: 1000 + objectType: + allOf: + - $ref: '#/components/schemas/ObjectTypeEnum' + description: + 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er + geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. + + + Uitleg bij mogelijke waarden: + + + * `adres` - Adres + + * `besluit` - Besluit + + * `buurt` - Buurt + + * `enkelvoudig_document` - Enkelvoudig document + + * `gemeente` - Gemeente + + * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte + + * `huishouden` - Huishouden + + * `inrichtingselement` - Inrichtingselement + + * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak + + * `kunstwerkdeel` - Kunstwerkdeel + + * `maatschappelijke_activiteit` - Maatschappelijke activiteit + + * `medewerker` - Medewerker + + * `natuurlijk_persoon` - Natuurlijk persoon + + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + + * `openbare_ruimte` - Openbare ruimte + + * `organisatorische_eenheid` - Organisatorische eenheid + + * `pand` - Pand + + * `spoorbaandeel` - Spoorbaandeel + + * `status` - Status + + * `terreindeel` - Terreindeel + + * `terrein_gebouwd_object` - Terrein gebouwd object + + * `vestiging` - Vestiging + + * `waterdeel` - Waterdeel + + * `wegdeel` - Wegdeel + + * `wijk` - Wijk + + * `woonplaats` - Woonplaats + + * `woz_deelobject` - Woz deel object + + * `woz_object` - Woz object + + * `woz_waarde` - Woz waarde + + * `zakelijk_recht` - Zakelijk recht + + * `overige` - Overige' + title: object type + objectTypeOverige: + type: string + description: + Beschrijft het type OBJECT als `objectType` de waarde "overige" + heeft. + title: object type overige + pattern: '[a-z\_]+' + maxLength: 100 + objectTypeOverigeDefinitie: + allOf: + - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie' + nullable: true + title: definitie object type overige + description: + 'Verwijzing naar het schema van het type OBJECT als `objectType` + de waarde "overige" heeft. + + + * De URL referentie moet naar een JSON endpoint wijzen waarin het objecttype + gedefinieerd is, inclusief het [JSON-schema](https://json-schema.org/). + + * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen de + objecttype resource (deze gebruikt het [jq](http://stedolan.github.io/jq/) + formaat. + + * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens binnen + het OBJECT. Deze gebruikt ook het [jq](http://stedolan.github.io/jq/) + formaat. + + + Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven + en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven + OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.' + relatieomschrijving: + type: string + description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. + title: relatieomschrijving + maxLength: 80 + _expand: + $ref: '#/components/schemas/ZaakObjectEmbedded' + required: + - objectType + - url + - uuid + - zaak + discriminator: + propertyName: objectType + mapping: + adres: '#/components/schemas/adres_ZaakObjectExpanded' + besluit: '#/components/schemas/besluit_ZaakObjectExpanded' + buurt: '#/components/schemas/buurt_ZaakObjectExpanded' + enkelvoudig_document: '#/components/schemas/enkelvoudig_document_ZaakObjectExpanded' + gemeente: '#/components/schemas/gemeente_ZaakObjectExpanded' + gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_ZaakObjectExpanded' + huishouden: '#/components/schemas/huishouden_ZaakObjectExpanded' + inrichtingselement: '#/components/schemas/inrichtingselement_ZaakObjectExpanded' + kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_ZaakObjectExpanded' + kunstwerkdeel: '#/components/schemas/kunstwerkdeel_ZaakObjectExpanded' + maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_ZaakObjectExpanded' + medewerker: '#/components/schemas/medewerker_ZaakObjectExpanded' + natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_ZaakObjectExpanded' + niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_ZaakObjectExpanded' + openbare_ruimte: '#/components/schemas/openbare_ruimte_ZaakObjectExpanded' + organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_ZaakObjectExpanded' + pand: '#/components/schemas/pand_ZaakObjectExpanded' + spoorbaandeel: '#/components/schemas/spoorbaandeel_ZaakObjectExpanded' + status: '#/components/schemas/status_ZaakObjectExpanded' + terreindeel: '#/components/schemas/terreindeel_ZaakObjectExpanded' + terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_ZaakObjectExpanded' + vestiging: '#/components/schemas/vestiging_ZaakObjectExpanded' + waterdeel: '#/components/schemas/waterdeel_ZaakObjectExpanded' + wegdeel: '#/components/schemas/wegdeel_ZaakObjectExpanded' + wijk: '#/components/schemas/wijk_ZaakObjectExpanded' + woonplaats: '#/components/schemas/woonplaats_ZaakObjectExpanded' + woz_deelobject: '#/components/schemas/woz_deelobject_ZaakObjectExpanded' + woz_object: '#/components/schemas/woz_object_ZaakObjectExpanded' + woz_waarde: '#/components/schemas/woz_waarde_ZaakObjectExpanded' + zakelijk_recht: '#/components/schemas/zakelijk_recht_ZaakObjectExpanded' + overige: '#/components/schemas/overige_ZaakObjectExpanded' + ZaakObjectEmbedded: + type: object + properties: + zaakobjecttype: + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakObjectType' + ZaakVerzoek: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + uuid: + type: string + format: uuid + readOnly: true + description: Unieke resource identifier (UUID4) + title: uuid + zaak: + type: string + format: uri + description: URL-referentie naar de ZAAK. + title: zaak + minLength: 1 + maxLength: 1000 + verzoek: + type: string + format: uri + description: URL-referentie naar het VERZOEK (in de Klantinteractie API) + title: verzoek + maxLength: 1000 + required: + - url + - uuid + - verzoek + - zaak + ZaakZoek: + type: object + properties: + zaakgeometrie: + $ref: '#/components/schemas/GeoWithin' + uuid__in: + description: Array of unieke resource identifiers (UUID4) + type: array + items: + type: string + format: uuid + example: ["e80b7507-199a-484c-ad49-c41a1e43a6e7", "78e12133-c467-4202-91ba-4417baa52801"] + identificatie: + title: Identificatie + description: De unieke identificatie van de ZAAK binnen de organisatie die + verantwoordelijk is voor de behandeling van de ZAAK. + type: string + example: "zaak123" + bronorganisatie: + title: Bronorganisatie + description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers + en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef + type: string + example: "000000000" + bronorganisatie__in: + description: Array van bronorganisaties. + type: array + items: + type: string + format: string + example: ["000000000","479559740","875883461"] + zaaktype: + title: Zaaktype + description: URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de + CATALOGUS waar deze voorkomt + type: string + example: "https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/e80b7507-199a-484c-ad49-c41a1e43a6e7" + zaaktype__in: + description: Array van zaaktypen. + type: array + items: + type: string + format: uri + example: ["https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/e80b7507-199a-484c-ad49-c41a1e43a6e7","https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/78e12133-c467-4202-91ba-4417baa52801"] + archiefnominatie: + title: Archiefnominatie + description: 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + Uitleg bij mogelijke waarden: + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum + overgedragen worden naar een archiefbewaarplaats. + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' + type: string + enum: + - blijvend_bewaren + - vernietigen + example: "blijvend_bewaren" + archiefnominatie__in: + title: Archiefnominatie in + description: Multiple values may be separated by commas. + type: array + items: + type: string + example: [ "blijvend_bewaren", "vernietigen" ] + archiefactiedatum: + title: Archiefactiedatum + description: De datum waarop het gearchiveerde zaakdossier vernietigd moet + worden dan wel overgebracht moet worden naar een archiefbewaarplaats. + Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT + aan deze ZAAK indien nog leeg. + type: string + example: "2019-01-02" + archiefactiedatum__isnull: + title: Archiefactiedatum is leeg + type: boolean + example: false + archiefactiedatum__lt: + title: Archiefactiedatum kleiner dan + type: string + example: "2020-01-02" + archiefactiedatum__gt: + title: Archiefactiedatum groter dan + type: string + example: "2018-01-02" + archiefstatus: + title: Archiefstatus + description: 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + Uitleg bij mogelijke waarden: + * `nog_te_archiveren` - De zaak cq. het zaakdossier is nog niet als geheel + gearchiveerd. + * `gearchiveerd` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar + bewaarbaar gemaakt. + * `gearchiveerd_procestermijn_onbekend` - De zaak cq. het zaakdossier + is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum + kan nog niet bepaald worden. + * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een + archiefbewaarplaats.' + type: string + enum: + - nog_te_archiveren + - gearchiveerd + - gearchiveerd_procestermijn_onbekend + - overgedragen + example: "nog_te_archiveren" + archiefstatus__in: + title: Archiefstatus in + description: Multiple values may be separated by commas. + type: array + items: + type: string + example: [ "nog_te_archiveren","gearchiveerd","gearchiveerd_procestermijn_onbekend","overgedragen" ] + startdatum: + title: Startdatum + description: De datum waarop met de uitvoering van de zaak is gestart + type: string + example: "2017-01-02" + startdatum__gt: + title: Startdatum groter dan + type: string + example: "2018-01-02" + startdatum__gte: + title: Startdatum groter dan of gelijk + type: string + example: "2016-01-02" + startdatum__lt: + title: Startdatum kleiner dan + type: string + example: "2018-01-02" + startdatum__lte: + title: Startdatum kleiner dan of gelijk + type: string + example: "2018-01-02" + registratiedatum: + title: Registratiedatum + description: De datum waarop de zaakbehandelende organisatie de ZAAK heeft geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag gebruikt. + type: string + example: "2015-01-02" + registratiedatum__gt: + title: Registratiedatum groter dan + type: string + example: "2014-01-02" + registratiedatum__lt: + title: Registratiedatum kleiner dan + type: string + example: "2016-01-02" + einddatum: + title: Einddatum + description: De datum waarop de uitvoering van de zaak afgerond is. + type: string + example: "2022-01-02" + einddatum__isnull: + title: Einddatum is leeg + type: boolean + example: false + einddatum__gt: + title: Einddatum groter dan + type: string + example: "2021-01-02" + einddatum__lt: + title: Einddatum kleiner dan + type: string + minLength: 1 + example: "2023-01-02" + einddatumGepland: + title: Einddatum gepland + description: De datum waarop volgens de planning verwacht wordt dat de zaak afgerond wordt. + type: string + example: "2022-01-02" + einddatumGepland__gt: + title: Einddatum gepland groter dan + type: string + example: "2021-01-02" + einddatumGepland__lt: + title: Einddatum gepland kleiner dan + type: string + example: "2024-01-02" + uiterlijkeEinddatumAfdoening: + title: Uiterlijke einddatumAfdoening + description: De laatste datum waarop volgens wet- en regelgeving de zaak afgerond dient te zijn. + type: string + example: "2024-01-02" + uiterlijkeEinddatumAfdoening__gt: + title: Uiterlijke einddatumAfdoening groter dan + type: string + example: "2023-01-02" + uiterlijkeEinddatumAfdoening__lt: + title: Uiterlijke einddatumAfdoening kleiner dan + type: string + example: "2025-01-02" + rol__betrokkeneType: + title: Rol betrokkenetype + description: 'Type van de `betrokkene`. + Uitleg bij mogelijke waarden: + * `natuurlijk_persoon` - Natuurlijk persoon + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + * `vestiging` - Vestiging + * `organisatorische_eenheid` - Organisatorische eenheid + * `medewerker` - Medewerker' + type: string + enum: + - natuurlijk_persoon + - niet_natuurlijk_persoon + - vestiging + - organisatorische_eenheid + - medewerker + example: "natuurlijk_persoon" + rol__betrokkene: + title: Rol betrokkene + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + type: string + example: "https://example.com" + rol__omschrijvingGeneriek: + title: Rol omschrijvinggeneriek + description: + Algemeen gehanteerde benaming van de aard van de ROL, afgeleid uit het ROLTYPE. + type: string + enum: + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator + example: "initiator" + maximaleVertrouwelijkheidaanduiding: + title: Maximalevertrouwelijkheidaanduiding + description: + Zaken met een vertrouwelijkheidaanduiding die beperkter is + dan de aangegeven aanduiding worden uit de resultaten gefiltered. + type: string + enum: + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim + example: "zaakvertrouwelijk" + rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn: + title: Rol betrokkeneidentificatie natuurlijkpersoon inpbsn + description: Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet + algemene bepalingen burgerservicenummer. + type: string + example: "123456789" + rol__betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie: + title: Rol betrokkeneidentificatie natuurlijkpersoon anpidentificatie + description: Het door de gemeente uitgegeven unieke nummer voor een ANDER + NATUURLIJK PERSOON + type: string + example: "123456789" + rol__betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer: + title: Rol betrokkeneidentificatie natuurlijkpersoon inpa nummer + description: Het administratienummer van de persoon, bedoeld in de Wet BRP + type: string + example: "123456789" + rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId: + title: Rol betrokkeneidentificatie nietnatuurlijkpersoon innnnpid + description: Het door een kamer toegekend uniek nummer voor de INGESCHREVEN + NIET-NATUURLIJK PERSOON + type: string + example: "123456789" + rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie: + title: Rol betrokkeneidentificatie nietnatuurlijkpersoon annidentificatie + description: Het door de gemeente uitgegeven unieke nummer voor een ANDER + NIET-NATUURLIJK PERSOON + type: string + example: "123456789" + rol__betrokkeneIdentificatie__vestiging__vestigingsNummer: + title: Rol betrokkeneidentificatie vestiging vestigingsnummer + description: Een korte unieke aanduiding van de Vestiging. + type: string + example: "123456789" + rol__betrokkeneIdentificatie__medewerker__identificatie: + title: Rol betrokkeneidentificatie medewerker identificatie + description: Een korte unieke aanduiding van de MEDEWERKER. + type: string + example: "123456789" + rol__betrokkeneIdentificatie__organisatorischeEenheid__identificatie: + title: Rol betrokkeneidentificatie organisatorischeeenheid identificatie + description: Een korte identificatie van de organisatorische eenheid. + type: string + example: "123456789" + expand: + description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,` \ + \ hoofdzaak.deelzaken.status.statustype`Haal details van gelinkte resources direct op. + Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. + Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt." + title: expand + type: string + example: zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype + ordering: + title: Ordering + description: Het veld waarop de resultaten geordend worden. Het minnetje betekent omgekeerde volgorde. + type: string + enum: + - startdatum + - -startdatum + - einddatum + - -einddatum + - publicatiedatum + - -publicatiedatum + - archiefactiedatum + - -archiefactiedatum + - registratiedatum + - -registratiedatum + - identificatie + - -identificatie + example: "-startdatum" + ZakelijkRechtHeeftAlsGerechtigde: + type: object + properties: + natuurlijkPersoon: + allOf: + - $ref: '#/components/schemas/RolNatuurlijkPersoon' + title: natuurlijkPersoon + nietNatuurlijkPersoon: + allOf: + - $ref: '#/components/schemas/RolNietNatuurlijkPersoon' + title: nietNatuurlijkPersoon + adres_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectAdres' + adres_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectAdres' + adres_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectAdres' + besluit_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + besluit_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + besluit_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + betrokkene_identificatie_RolMedewerker: + type: object + properties: + betrokkeneIdentificatie: + allOf: + - $ref: '#/components/schemas/RolMedewerker' + title: betrokkeneIdentificatie + betrokkene_identificatie_RolNatuurlijkPersoon: + type: object + properties: + betrokkeneIdentificatie: + allOf: + - $ref: '#/components/schemas/RolNatuurlijkPersoon' + title: betrokkeneIdentificatie + betrokkene_identificatie_RolNietNatuurlijkPersoon: + type: object + properties: + betrokkeneIdentificatie: + allOf: + - $ref: '#/components/schemas/RolNietNatuurlijkPersoon' + title: betrokkeneIdentificatie + betrokkene_identificatie_RolOrganisatorischeEenheid: + type: object + properties: + betrokkeneIdentificatie: + allOf: + - $ref: '#/components/schemas/RolOrganisatorischeEenheid' + title: betrokkeneIdentificatie + betrokkene_identificatie_RolVestiging: + type: object + properties: + betrokkeneIdentificatie: + allOf: + - $ref: '#/components/schemas/RolVestiging' + title: betrokkeneIdentificatie + buurt_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' + buurt_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' + buurt_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' + enkelvoudig_document_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + enkelvoudig_document_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + enkelvoudig_document_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + gemeente_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' + gemeente_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' + gemeente_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' + gemeentelijke_openbare_ruimte_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' + gemeentelijke_openbare_ruimte_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' + gemeentelijke_openbare_ruimte_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' + huishouden_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' + huishouden_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' + huishouden_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' + inrichtingselement_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' + inrichtingselement_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' + inrichtingselement_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' + kadastrale_onroerende_zaak_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' + kadastrale_onroerende_zaak_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' + kadastrale_onroerende_zaak_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' + kunstwerkdeel_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' + kunstwerkdeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' + kunstwerkdeel_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' + maatschappelijke_activiteit_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' + maatschappelijke_activiteit_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' + maatschappelijke_activiteit_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' + medewerker_Rol: + allOf: + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' + medewerker_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' + medewerker_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' + medewerker_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' + medewerker_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' + natuurlijk_persoon_Rol: + allOf: + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' + natuurlijk_persoon_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' + natuurlijk_persoon_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' + natuurlijk_persoon_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' + natuurlijk_persoon_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' + niet_natuurlijk_persoon_Rol: + allOf: + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' + niet_natuurlijk_persoon_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' + niet_natuurlijk_persoon_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' + niet_natuurlijk_persoon_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' + niet_natuurlijk_persoon_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' + object_identificatie_ObjectAdres: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectAdres' + title: objectIdentificatie + object_identificatie_ObjectBuurt: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectBuurt' + title: objectIdentificatie + object_identificatie_ObjectGemeente: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectGemeente' + title: objectIdentificatie + object_identificatie_ObjectGemeentelijkeOpenbareRuimte: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectGemeentelijkeOpenbareRuimte' + title: objectIdentificatie + object_identificatie_ObjectHuishouden: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectHuishouden' + title: objectIdentificatie + object_identificatie_ObjectInrichtingselement: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectInrichtingselement' + title: objectIdentificatie + object_identificatie_ObjectKadastraleOnroerendeZaak: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectKadastraleOnroerendeZaak' + title: objectIdentificatie + object_identificatie_ObjectKunstwerkdeel: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectKunstwerkdeel' + title: objectIdentificatie + object_identificatie_ObjectMaatschappelijkeActiviteit: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectMaatschappelijkeActiviteit' + title: objectIdentificatie + object_identificatie_ObjectOpenbareRuimte: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectOpenbareRuimte' + title: objectIdentificatie + object_identificatie_ObjectOverige: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectOverige' + title: objectIdentificatie + object_identificatie_ObjectPand: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectPand' + title: objectIdentificatie + object_identificatie_ObjectSpoorbaandeel: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectSpoorbaandeel' + title: objectIdentificatie + object_identificatie_ObjectTerreinGebouwdObject: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectTerreinGebouwdObject' + title: objectIdentificatie + object_identificatie_ObjectTerreindeel: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectTerreindeel' + title: objectIdentificatie + object_identificatie_ObjectWaterdeel: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWaterdeel' + title: objectIdentificatie + object_identificatie_ObjectWegdeel: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWegdeel' + title: objectIdentificatie + object_identificatie_ObjectWijk: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWijk' + title: objectIdentificatie + object_identificatie_ObjectWoonplaats: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWoonplaats' + title: objectIdentificatie + object_identificatie_ObjectWozDeelobject: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWozDeelobject' + title: objectIdentificatie + object_identificatie_ObjectWozObject: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWozObject' + title: objectIdentificatie + object_identificatie_ObjectWozWaarde: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectWozWaarde' + title: objectIdentificatie + object_identificatie_ObjectZakelijkRecht: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/ObjectZakelijkRecht' + title: objectIdentificatie + object_identificatie_RolMedewerker: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/RolMedewerker' + title: objectIdentificatie + object_identificatie_RolNatuurlijkPersoon: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/RolNatuurlijkPersoon' + title: objectIdentificatie + object_identificatie_RolNietNatuurlijkPersoon: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/RolNietNatuurlijkPersoon' + title: objectIdentificatie + object_identificatie_RolOrganisatorischeEenheid: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/RolOrganisatorischeEenheid' + title: objectIdentificatie + object_identificatie_RolVestiging: + type: object + properties: + objectIdentificatie: + allOf: + - $ref: '#/components/schemas/RolVestiging' + title: objectIdentificatie + openbare_ruimte_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' + openbare_ruimte_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' + openbare_ruimte_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' + organisatorische_eenheid_Rol: + allOf: + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' + organisatorische_eenheid_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' + organisatorische_eenheid_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' + organisatorische_eenheid_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' + organisatorische_eenheid_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' + overige_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectOverige' + overige_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectOverige' + overige_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectOverige' + pand_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectPand' + pand_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectPand' + pand_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectPand' + spoorbaandeel_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' + spoorbaandeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' + spoorbaandeel_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' + status_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + status_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + status_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + terrein_gebouwd_object_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' + terrein_gebouwd_object_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' + terrein_gebouwd_object_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' + terreindeel_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' + terreindeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' + terreindeel_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' + vestiging_Rol: + allOf: + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' + vestiging_RolExpanded: + allOf: + - $ref: '#/components/schemas/RolExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' + vestiging_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' + vestiging_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' + vestiging_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' + waterdeel_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' + waterdeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' + waterdeel_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' + wegdeel_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' + wegdeel_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' + wegdeel_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' + wijk_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWijk' + wijk_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWijk' + wijk_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWijk' + woonplaats_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' + woonplaats_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' + woonplaats_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' + woz_deelobject_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' + woz_deelobject_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' + woz_deelobject_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' + woz_object_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' + woz_object_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' + woz_object_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' + woz_waarde_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' + woz_waarde_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' + woz_waarde_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' + zakelijk_recht_ZaakObject: + allOf: + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' + zakelijk_recht_ZaakObjectExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectExpanded' + - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' + zakelijk_recht_PatchedZaakObject: + allOf: + - $ref: '#/components/schemas/PatchedZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' + securitySchemes: + JWT-Claims: + type: http + bearerFormat: JWT + scheme: bearer +servers: + - url: https://zaken-api.test.vng.cloud/api/v1 + - url: https://zaken-api.vng.cloud/api/v1 +tags: + - name: klantcontacten + description: '' + - name: resultaten + description: '' + - name: rollen + description: '' + - name: statussen + description: '' + - name: zaakcontactmomenten + description: '' + - name: zaakinformatieobjecten + description: '' + - name: zaakobjecten + description: '' + - name: zaakverzoeken + description: '' + - name: zaken + description: + Een zaak mag (in principe) niet meer gewijzigd worden als de `archiefstatus` + een andere status heeft dan "nog_te_archiveren". Voor praktische redenen is er + geen harde validatie regel aan de provider kant. diff --git a/api-specificatie/ztc/current_version/openapi.yaml b/api-specificatie/ztc/current_version/openapi.yaml index e87ca8e76..699a51ac0 100644 --- a/api-specificatie/ztc/current_version/openapi.yaml +++ b/api-specificatie/ztc/current_version/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Catalogi API - version: 1.3.1 + version: 1.3.2 description: "Een API om een zaaktypecatalogus (ZTC) te benaderen.\n\nDe zaaktypecatalogus\ \ helpt gemeenten om het proces vanuit de 'vraag van een\nklant' (productaanvraag,\ @@ -10933,6 +10933,35 @@ components: - url - vastgelegdIn - zaaktypen + BesluitTypeExpanded: + allOf: + - $ref: '#/components/schemas/BesluitType' + - properties: + _expand: + $ref: '#/components/schemas/BesluitTypeEmbedded' + BesluitTypeEmbedded: + type: object + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypeExpanded' + informatieobjecttypen: + type: array + items: + $ref: '#/components/schemas/InformatieObjectTypeExpanded' + resultaattypen: + type: array + items: + $ref: '#/components/schemas/ResultaatTypeExpanded' + EmptyObject: + type: object + description: Leeg object. Dit wordt teruggeven indien het te expanderen veld een null waarde heeft. + example: {} BesluitTypeCreate: type: object properties: @@ -11567,6 +11596,27 @@ components: - rsin - url - zaaktypen + CatalogusExpanded: + allOf: + - $ref: '#/components/schemas/Catalogus' + - properties: + _expand: + $ref: '#/components/schemas/CatalogusEmbedded' + CatalogusEmbedded: + type: object + properties: + zaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypeExpanded' + besluittypen: + type: array + items: + $ref: '#/components/schemas/BesluitTypeExpanded' + informatieobjecttypen: + type: array + items: + $ref: '#/components/schemas/InformatieObjectTypeExpanded' CheckListItem: type: object properties: @@ -11692,6 +11742,27 @@ components: - url - zaaktype - zaaktypeIdentificatie + EigenschapExpanded: + allOf: + - $ref: '#/components/schemas/Eigenschap' + - properties: + _expand: + $ref: '#/components/schemas/EigenschapEmbedded' + EigenschapEmbedded: + type: object + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + statustype: + oneOf: + - $ref: '#/components/schemas/StatusTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' EigenschapSpecificatie: type: object properties: @@ -11943,6 +12014,27 @@ components: - url - vertrouwelijkheidaanduiding - zaaktypen + InformatieObjectTypeExpanded: + allOf: + - $ref: '#/components/schemas/InformatieObjectType' + - properties: + _expand: + $ref: '#/components/schemas/InformatieObjectTypeEmbedded' + InformatieObjectTypeEmbedded: + type: object + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypeExpanded' + besluittypen: + type: array + items: + $ref: '#/components/schemas/BesluitTypeExpanded' InformatieObjectTypeOmschrijvingGeneriek: type: object properties: @@ -12914,8 +13006,6 @@ components: ResultaatType: type: object description: 'Set gegevensgroepdata from validated nested data. - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' properties: url: @@ -13125,11 +13215,34 @@ components: - url - zaaktype - zaaktypeIdentificatie + ResultaatTypeExpanded: + allOf: + - $ref: '#/components/schemas/ResultaatType' + - properties: + _expand: + $ref: '#/components/schemas/ResultaatTypeEmbedded' + ResultaatTypeEmbedded: + type: object + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + besluittypen: + type: array + items: + $ref: '#/components/schemas/BesluitTypeExpanded' + informatieobjecttypen: + type: array + items: + $ref: '#/components/schemas/InformatieObjectTypeExpanded' ResultaatTypeCreate: type: object description: 'Set gegevensgroepdata from validated nested data. - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' properties: url: @@ -13642,6 +13755,23 @@ components: - url - zaaktype - zaaktypeIdentificatie + RolTypeExpanded: + allOf: + - $ref: '#/components/schemas/RolType' + - properties: + _expand: + $ref: '#/components/schemas/RolTypeEmbedded' + RolTypeEmbedded: + type: object + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' StatusType: type: object properties: @@ -13781,6 +13911,27 @@ components: - volgnummer - zaaktype - zaaktypeIdentificatie + StatusTypeExpanded: + allOf: + - $ref: '#/components/schemas/StatusType' + - properties: + _expand: + $ref: '#/components/schemas/StatusTypeEmbedded' + StatusTypeEmbedded: + type: object + properties: + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + eigenschappen: + type: array + items: + $ref: '#/components/schemas/EigenschapExpanded' ValidatieFout: type: object description: Formaat van HTTP 4xx en 5xx fouten. @@ -13943,6 +14094,31 @@ components: - url - zaaktype - zaaktypeIdentificatie + ZaakObjectTypeExpanded: + allOf: + - $ref: '#/components/schemas/ZaakObjectType' + - properties: + _expand: + $ref: '#/components/schemas/ZaakObjectTypeEmbedded' + ZaakObjectTypeEmbedded: + type: object + properties: + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + resultaattypen: + type: array + items: + $ref: '#/components/schemas/ResultaatTypeExpanded' + statustypen: + type: array + items: + $ref: '#/components/schemas/StatusTypeExpanded' + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' ZaakType: type: object description: 'Set gegevensgroepdata from validated nested data. @@ -14332,6 +14508,55 @@ components: - versiedatum - vertrouwelijkheidaanduiding - zaakobjecttypen + ZaakTypeExpanded: + allOf: + - $ref: '#/components/schemas/ZaakType' + - properties: + _expand: + $ref: '#/components/schemas/ZaakTypeEmbedded' + ZaakTypeEmbedded: + type: object + properties: + zaakobjecttypen: + type: array + items: + $ref: '#/components/schemas/ZaakObjectTypeExpanded' + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + statustypen: + type: array + items: + $ref: '#/components/schemas/StatusTypeExpanded' + resultaattypen: + type: array + items: + $ref: '#/components/schemas/ResultaatTypeExpanded' + eigenschappen: + type: array + items: + $ref: '#/components/schemas/EigenschapExpanded' + informatieobjecttypen: + type: array + items: + $ref: '#/components/schemas/InformatieObjectTypeExpanded' + roltypen: + type: array + items: + $ref: '#/components/schemas/RolTypeExpanded' + besluittypen: + type: array + items: + $ref: '#/components/schemas/BesluitTypeExpanded' + deelzaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypeExpanded' + gerelateerdeZaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypeExpanded' ZaakTypeCreate: type: object description: 'Set gegevensgroepdata from validated nested data. @@ -14796,6 +15021,31 @@ components: - volgnummer - zaaktype - zaaktypeIdentificatie + ZaakTypeInformatieObjectTypeExpanded: + allOf: + - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + - properties: + _expand: + $ref: '#/components/schemas/ZaakTypeInformatieObjectTypeEmbedded' + ZaakTypeInformatieObjectTypeEmbedded: + type: object + properties: + zaaktype: + oneOf: + - $ref: '#/components/schemas/ZaakTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + catalogus: + oneOf: + - $ref: '#/components/schemas/CatalogusExpanded' + - $ref: '#/components/schemas/EmptyObject' + informatieobjecttype: + oneOf: + - $ref: '#/components/schemas/InformatieObjectTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' + statustype: + oneOf: + - $ref: '#/components/schemas/StatusTypeExpanded' + - $ref: '#/components/schemas/EmptyObject' ZaakTypeUpdate: type: object description: 'Set gegevensgroepdata from validated nested data. From 01f8c8c6f8e397cdc251dd953a58021a3897c18c Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Wed, 12 Feb 2025 20:48:19 +0100 Subject: [PATCH 23/36] Update relative references in openapi_abs_paths.yaml to absolute references hoping this will speed up loading time in redoc viewer --- .../zrc/1.5.x/1.5.2/openapi _abs_paths.yaml | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi _abs_paths.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi _abs_paths.yaml index 113f3d4db..ff8d55554 100644 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi _abs_paths.yaml +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi _abs_paths.yaml @@ -12904,7 +12904,7 @@ components: zaak: $ref: '#/components/schemas/ZaakExpanded' resultaattype: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/ResultaatTypeExpanded' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/ResultaatTypeExpanded' Rol: type: object properties: @@ -13233,7 +13233,7 @@ components: $ref: '#/components/schemas/ZaakExpanded' example: {} roltype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/RolTypeExpanded' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/RolTypeExpanded' statussen: type: array items: @@ -13519,7 +13519,7 @@ components: type: object properties: statustype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/StatusTypeExpanded' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/StatusTypeExpanded' gezetdoor: $ref: '#/components/schemas/Rol' zaakinformatieobjecten: @@ -14267,7 +14267,7 @@ components: properties: zaaktype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' hoofdzaak: oneOf: - $ref: '#/components/schemas/ZaakExpanded' @@ -14457,7 +14457,8 @@ components: - $ref: '#/components/schemas/ZaakExpanded' - $ref: '#/components/schemas/EmptyObject' eigenschap: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/EigenschapExpanded' + # $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/EigenschapExpanded' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/EigenschapExpanded' ZaakInformatieObject: type: object properties: @@ -14954,7 +14955,8 @@ components: type: object properties: zaakobjecttype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakObjectType' + # $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakObjectType' + $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/ZaakObjectType' ZaakVerzoek: type: object properties: From bb0b469542350dc71c89b2e0b00ff0c129582767 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Wed, 12 Feb 2025 20:53:46 +0100 Subject: [PATCH 24/36] Removed space from file name --- .../1.5.2/{openapi _abs_paths.yaml => openapi_abs_paths.yaml} | 0 1 file changed, 0 insertions(+), 0 deletions(-) rename api-specificatie/zrc/1.5.x/1.5.2/{openapi _abs_paths.yaml => openapi_abs_paths.yaml} (100%) diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi _abs_paths.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi_abs_paths.yaml similarity index 100% rename from api-specificatie/zrc/1.5.x/1.5.2/openapi _abs_paths.yaml rename to api-specificatie/zrc/1.5.x/1.5.2/openapi_abs_paths.yaml From 49c5cc1f7013a90087e79427a9918b3c263c3c59 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Thu, 13 Feb 2025 11:35:02 +0100 Subject: [PATCH 25/36] Expand in versie ztc 1.3.2 uitgebreid met recursie (nesting). Ook de referenties relatief gemaakt. --- api-specificatie/drc/1.6.x/1.6.0/openapi.yaml | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/api-specificatie/drc/1.6.x/1.6.0/openapi.yaml b/api-specificatie/drc/1.6.x/1.6.0/openapi.yaml index f6d45c2e2..a8034e7ed 100644 --- a/api-specificatie/drc/1.6.x/1.6.0/openapi.yaml +++ b/api-specificatie/drc/1.6.x/1.6.0/openapi.yaml @@ -7270,8 +7270,7 @@ components: type: object properties: informatieobjecttype: - $ref: >- - https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/InformatieObjectType + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/InformatieObjectTypeExpanded' FieldValidationError: type: object description: Formaat van validatiefouten. @@ -7571,7 +7570,7 @@ components: type: object properties: informatieobject: - $ref: '#/components/schemas/EnkelvoudigInformatieObject' + $ref: '#/components/schemas/EnkelvoudigInformatieObjectExpanded' ObjectInformatieObjectRequest: type: object properties: @@ -8357,7 +8356,7 @@ components: type: object properties: informatieobject: - $ref: '#/components/schemas/EnkelvoudigInformatieObject' + $ref: '#/components/schemas/EnkelvoudigInformatieObjectExpanded' VerzendingRequest: type: object description: >- From 49dc926f74293bd3fdc6cbc7ba5124642b70c9ec Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Mon, 17 Feb 2025 17:10:00 +0100 Subject: [PATCH 26/36] Update references in openapi.yaml to use non-expanded schema types form the Catalogi API --- api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml | 11 +- .../zrc/1.5.x/1.5.2/openapi_abs_paths.yaml | 15986 ---------------- ..._fast.yaml => openapi_geneste_expand.yaml} | 11 +- 3 files changed, 11 insertions(+), 15997 deletions(-) delete mode 100644 api-specificatie/zrc/1.5.x/1.5.2/openapi_abs_paths.yaml rename api-specificatie/zrc/1.5.x/1.5.2/{openapi_fast.yaml => openapi_geneste_expand.yaml} (99%) diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml index 3b0e550a9..c1bb33995 100644 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml @@ -12904,7 +12904,7 @@ components: zaak: $ref: '#/components/schemas/ZaakExpanded' resultaattype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ResultaatTypeExpanded' + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ResultaatType' Rol: type: object properties: @@ -13233,7 +13233,7 @@ components: $ref: '#/components/schemas/ZaakExpanded' example: {} roltype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/RolTypeExpanded' + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/RolType' statussen: type: array items: @@ -13519,7 +13519,7 @@ components: type: object properties: statustype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/StatusTypeExpanded' + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/StatusType' gezetdoor: $ref: '#/components/schemas/Rol' zaakinformatieobjecten: @@ -14266,8 +14266,7 @@ components: type: object properties: zaaktype: - - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakType' hoofdzaak: oneOf: - $ref: '#/components/schemas/ZaakExpanded' @@ -14457,7 +14456,7 @@ components: - $ref: '#/components/schemas/ZaakExpanded' - $ref: '#/components/schemas/EmptyObject' eigenschap: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/EigenschapExpanded' + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/Eigenschap' ZaakInformatieObject: type: object properties: diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi_abs_paths.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi_abs_paths.yaml deleted file mode 100644 index ff8d55554..000000000 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi_abs_paths.yaml +++ /dev/null @@ -1,15986 +0,0 @@ -openapi: 3.0.3 -info: - title: Zaken API - version: 1.5.2 - description: " Met expand mechanisme in plain json - - - Een API om een zaakregistratiecomponent (ZRC) te benaderen. - - - De ZAAK is het kernobject in deze API, waaraan verschillende andere - - resources gerelateerd zijn. De Zaken API werkt samen met andere API's voor - - Zaakgericht werken om tot volledige functionaliteit te komen. - - - **Wat is nieuw?** - - * Query parameters en zoekvelden voor archivering. - - - **Afhankelijkheden** - - - Deze API is afhankelijk van: - - - * Catalogi API - - * Notificaties API - - * Documenten API *(optioneel)* - - * Besluiten API *(optioneel)* - - * Autorisaties API *(optioneel)* - - - **Autorisatie** - - - Deze API vereist autorisatie. Je kan de - - [token-tool](https://zaken-auth.vng.cloud/) gebruiken om JWT-tokens te - - genereren. - - - ### Notificaties - - - Deze API publiceert notificaties op het kanaal `zaken`. - - - **Main resource** - - - `zaak` - - - - - **Kenmerken** - - - * `bronorganisatie`: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers en voldoen - aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef - - * `zaaktype`: URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS - waar deze voorkomt - - * `vertrouwelijkheidaanduiding`: Aanduiding van de mate waarin het zaakdossier - van de ZAAK voor de openbaarheid bestemd is. - - - **Resources en acties** - - - `zaak`: create, update, destroy - - - `status`: create - - - `zaakobject`: create, update, destroy - - - `zaakinformatieobject`: create - - - `zaakeigenschap`: create, update, destroy - - - `klantcontact`: create - - - `rol`: create, destroy - - - `resultaat`: create, update, destroy - - - `zaakbesluit`: create - - - `zaakcontactmoment`: create - - - `zaakverzoek`: create - - - - **Handige links** - - - * [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard) - - * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken) - - " - contact: - email: standaarden.ondersteuning@vng.nl - url: https://vng-realisatie.github.io/gemma-zaken - license: - name: EUPL 1.2 - url: https://opensource.org/licenses/EUPL-1.2 -paths: - /klantcontacten: - get: - operationId: klantcontact_list - description: 'Alle KLANTCONTACTen opvragen. - - - **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' - summary: 'Alle KLANTCONTACTen opvragen. ' - parameters: - - name: zaak - required: false - in: query - description: URL-referentie naar de ZAAK. - schema: - type: string - format: uri - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - klantcontacten - security: - - JWT-Claims: - - zaken.lezen - deprecated: true - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedKlantContactList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: klantcontact_create - description: - 'Indien geen identificatie gegeven is, dan wordt deze automatisch - gegenereerd. - - - **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' - summary: Maak een KLANTCONTACT bij een ZAAK aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - klantcontacten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/KlantContact' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - deprecated: true - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/KlantContact' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /klantcontacten/{uuid}: - get: - operationId: klantcontact_retrieve - description: 'Een specifieke KLANTCONTACT opvragen. - - - **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' - summary: Een specifieke KLANTCONTACT opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - klantcontacten - security: - - JWT-Claims: - - zaken.lezen - deprecated: true - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/KlantContact' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /resultaten: - get: - operationId: resultaat_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle RESULTAATen van ZAAKen opvragen. - parameters: - - name: zaak - required: false - in: query - description: URL-referentie naar de ZAAK. - schema: - type: string - format: uri - - name: resultaattype - required: false - in: query - description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API). - schema: - type: string - format: uri - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - resultaten - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedResultaatList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: resultaat_create - description: '**Er wordt gevalideerd op:** - - - geldigheid URL naar de ZAAK - - - geldigheid URL naar het RESULTAATTYPE' - summary: Maak een RESULTAAT bij een ZAAK aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - resultaten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Resultaat' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Resultaat' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /resultaten/{uuid}: - get: - operationId: resultaat_retrieve - description: Een specifieke RESULTAAT opvragen. - summary: Een specifieke RESULTAAT opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - resultaten - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Resultaat' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: resultaat_update - description: - "**Er wordt gevalideerd op** \n- geldigheid URL naar de ZAAK\n\ - - het RESULTAATTYPE mag niet gewijzigd worden" - summary: Werk een RESULTAAT in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - resultaten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Resultaat' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Resultaat' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: resultaat_partial_update - description: - "**Er wordt gevalideerd op** \n- geldigheid URL naar de ZAAK\n\ - - het RESULTAATTYPE mag niet gewijzigd worden" - summary: Werk een RESULTAAT deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - resultaten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedResultaat' - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Resultaat' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: resultaat_destroy - description: Verwijder een RESULTAAT van een ZAAK. - summary: Verwijder een RESULTAAT van een ZAAK. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - resultaten - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: resultaat_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) RESULTAAT opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - resultaten - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /rollen: - get: - operationId: rol_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle ROLlen bij ZAAKen opvragen. - parameters: - - name: zaak - required: false - in: query - description: URL-referentie naar de ZAAK. - schema: - type: string - format: uri - - name: betrokkene - required: false - in: query - description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. - schema: - type: string - format: uri - - name: betrokkeneType - required: false - in: query - description: Type van de `betrokkene`. - schema: - type: string - enum: - - natuurlijk_persoon - - niet_natuurlijk_persoon - - vestiging - - organisatorische_eenheid - - medewerker - - name: betrokkeneIdentificatie__natuurlijkPersoon__inpBsn - required: false - in: query - description: - Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene - bepalingen burgerservicenummer. - schema: - type: string - - name: betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie - required: false - in: query - description: - Het door de gemeente uitgegeven unieke nummer voor een ANDER - NATUURLIJK PERSOON - schema: - type: string - - name: betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer - required: false - in: query - description: Het administratienummer van de persoon, bedoeld in de Wet BRP - schema: - type: string - - name: betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId - required: false - in: query - description: - Het door een kamer toegekend uniek nummer voor de INGESCHREVEN - NIET-NATUURLIJK PERSOON - schema: - type: string - - name: betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie - required: false - in: query - description: - Het door de gemeente uitgegeven unieke nummer voor een ANDER - NIET-NATUURLIJK PERSOON - schema: - type: string - - name: betrokkeneIdentificatie__vestiging__vestigingsNummer - required: false - in: query - description: Een korte unieke aanduiding van de Vestiging. - schema: - type: string - - name: betrokkeneIdentificatie__organisatorischeEenheid__identificatie - required: false - in: query - description: Een korte identificatie van de organisatorische eenheid. - schema: - type: string - - name: betrokkeneIdentificatie__medewerker__identificatie - required: false - in: query - description: Een korte unieke aanduiding van de MEDEWERKER. - schema: - type: string - - name: roltype - required: false - in: query - description: URL-referentie naar een roltype binnen het ZAAKTYPE van de ZAAK. - schema: - type: string - format: uri - - name: omschrijving - required: false - in: query - description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. - schema: - type: string - - name: omschrijvingGeneriek - required: false - in: query - description: - Algemeen gehanteerde benaming van de aard van de ROL, afgeleid - uit het ROLTYPE. - schema: - type: string - enum: - - adviseur - - behandelaar - - belanghebbende - - beslisser - - initiator - - klantcontacter - - zaakcoordinator - - mede_initiator - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - rollen - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedRolList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: rol_create - description: Maak een ROL aan bij een ZAAK. - summary: Maak een ROL aan bij een ZAAK. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - rollen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Rol' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Rol' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /rollen/{uuid}: - get: - operationId: rol_retrieve - description: Een specifieke ROL bij een ZAAK opvragen. - summary: Een specifieke ROL bij een ZAAK opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - rollen - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Rol' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: rol_destroy - description: Verwijder een ROL van een ZAAK. - summary: Verwijder een ROL van een ZAAK. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - rollen - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: rol_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ROL opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - rollen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /statussen: - get: - operationId: status_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle STATUSsen bij ZAAKen opvragen. - parameters: - - name: zaak - required: false - in: query - description: URL-referentie naar de ZAAK. - schema: - type: string - format: uri - - name: statustype - required: false - in: query - description: URL-referentie naar het STATUSTYPE (in de Catalogi API). - schema: - type: string - format: uri - - name: indicatieLaatstGezetteStatus - required: false - in: query - description: - Het gegeven is afleidbaar uit de historie van de attribuutsoort - Datum status gezet van van alle statussen bij de desbetreffende zaak. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - statussen - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedStatusList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: status_create - description: '**Er wordt gevalideerd op** - - - geldigheid URL naar de ZAAK - - - geldigheid URL naar het STATUSTYPE - - - indien het de eindstatus betreft, dan moet het attribuut `indicatieGebruiksrecht` - gezet zijn op alle informatieobjecten dieaan de zaak gerelateerd zijn - - - **Opmerkingen** - - - Indien het statustype de eindstatus is (volgens het ZTC), dan wordt de zaak - afgesloten door de einddatum te zetten.' - summary: Maak een STATUS aan voor een ZAAK. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - statussen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Status' - required: true - security: - - JWT-Claims: - - (zaken.aanmaken | zaken.statussen.toevoegen | zaken.heropenen) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/StatusRequestbody' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /statussen/{uuid}: - get: - operationId: status_retrieve - description: Een specifieke STATUS van een ZAAK opvragen. - summary: Een specifieke STATUS van een ZAAK opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - statussen - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Status' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: status_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) STATUS opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - statussen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaakcontactmomenten: - get: - operationId: zaakcontactmoment_list - description: Alle ZAAKCONTACTMOMENTen opvragen. - summary: Alle ZAAKCONTACTMOMENTen opvragen. - parameters: - - name: zaak - required: false - in: query - description: URL-referentie naar de ZAAK. - schema: - type: string - format: uri - - name: contactmoment - required: false - in: query - description: - URL-referentie naar het CONTACTMOMENT (in de Klantinteractie - API) - schema: - type: string - format: uri - tags: - - zaakcontactmomenten - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/ZaakContactMoment' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaakcontactmoment_create - description: '**Er wordt gevalideerd op:** - - - geldigheid URL naar het CONTACTMOMENT' - summary: Maak een ZAAKCONTACTMOMENT aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakcontactmomenten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakContactMoment' - required: true - security: - - JWT-Claims: - - zaken.bijwerken - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakContactMoment' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaakcontactmomenten/{uuid}: - get: - operationId: zaakcontactmoment_retrieve - description: Een specifiek ZAAKCONTACTMOMENT opvragen. - summary: 'Een specifiek ZAAKCONTACTMOMENT opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - zaakcontactmomenten - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakContactMoment' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaakcontactmoment_destroy - description: Verwijder een ZAAKCONTACTMOMENT. - summary: Verwijder een ZAAKCONTACTMOMENT. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakcontactmomenten - security: - - JWT-Claims: - - zaken.bijwerken - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaakinformatieobjecten: - get: - operationId: zaakinformatieobject_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: 'Alle ZAAK-INFORMATIEOBJECT relaties opvragen ' - parameters: - - name: zaak - required: false - in: query - description: URL-referentie naar de ZAAK. - schema: - type: string - format: uri - - name: informatieobject - required: false - in: query - description: - URL-referentie naar het INFORMATIEOBJECT (in de Documenten API), - waar ook de relatieinformatie opgevraagd kan worden. - schema: - type: string - format: uri - tags: - - zaakinformatieobjecten - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/ZaakInformatieObject' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaakinformatieobject_create - description: - "Maak een ZAAK-INFORMATIEOBJECT relatie aan.\n\n**Er wordt gevalideerd\ - \ op**\n- geldigheid zaak URL\n- geldigheid informatieobject URL\n- `zaak.archiefstatus`\ - \ moet gelijk zijn aan 'nog_te_archiveren' \n- de combinatie informatieobject\ - \ en zaak moet uniek zijn\n\n**Opmerkingen**\n- De registratiedatum wordt\ - \ door het systeem op 'NU' gezet. De `aardRelatie` wordt ook door het systeem\ - \ gezet.\n- Bij het aanmaken wordt ook in de Documenten API de gespiegelde\ - \ relatie aangemaakt, echter zonder de relatie-informatie.\n" - summary: Maak een ZAAK-INFORMATIEOBJECT relatie aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakinformatieobjecten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakInformatieObject' - required: true - security: - - JWT-Claims: - - (zaken.aanmaken | zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakInformatieObject' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaakinformatieobjecten/{uuid}: - get: - operationId: zaakinformatieobject_retrieve - description: Een specifieke ZAAK-INFORMATIEOBJECT relatie opvragen. - summary: Een specifieke ZAAK-INFORMATIEOBJECT relatie opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaakinformatieobjecten - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakInformatieObject' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: zaakinformatieobject_update - description: - "Je mag enkel de gegevens van de relatie bewerken, en niet de relatie\ - \ zelf aanpassen.\n\n**Er wordt gevalideerd op** \n- informatieobject URL\ - \ en zaak URL mogen niet veranderen" - summary: Werk een ZAAK-INFORMATIEOBJECT relatie in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakinformatieobjecten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakInformatieObject' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakInformatieObject' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: zaakinformatieobject_partial_update - description: - "Je mag enkel de gegevens van de relatie bewerken, en niet de relatie\ - \ zelf aanpassen.\n\n**Er wordt gevalideerd op** \n- informatieobject URL\ - \ en zaak URL mogen niet veranderen" - summary: Werk een ZAAK-INFORMATIEOBJECT relatie deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakinformatieobjecten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedZaakInformatieObject' - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakInformatieObject' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaakinformatieobject_destroy - description: - De gespiegelde relatie in de Documenten API wordt door de Zaken - API verwijderd. Consumers kunnen dit niet handmatig doen. - summary: Verwijder een ZAAK-INFORMATIEOBJECT relatie. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakinformatieobjecten - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken | zaken.verwijderen) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: zaakinformatieobject_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ZAAKINFORMATIEOBJECT opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaakinformatieobjecten - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaakobjecten: - get: - operationId: zaakobject_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle ZAAKOBJECTen opvragen. - parameters: - - name: zaak - required: false - in: query - description: URL-referentie naar de ZAAK. - schema: - type: string - format: uri - - name: object - required: false - in: query - description: URL-referentie naar de resource die het OBJECT beschrijft. - schema: - type: string - format: uri - - name: objectType - required: false - in: query - description: - Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er geen - passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. - schema: - type: string - enum: - - adres - - besluit - - buurt - - enkelvoudig_document - - gemeente - - gemeentelijke_openbare_ruimte - - huishouden - - inrichtingselement - - kadastrale_onroerende_zaak - - kunstwerkdeel - - maatschappelijke_activiteit - - medewerker - - natuurlijk_persoon - - niet_natuurlijk_persoon - - openbare_ruimte - - organisatorische_eenheid - - pand - - spoorbaandeel - - status - - terreindeel - - terrein_gebouwd_object - - vestiging - - waterdeel - - wegdeel - - wijk - - woonplaats - - woz_deelobject - - woz_object - - woz_waarde - - zakelijk_recht - - overige - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - zaakobjecten - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedZaakObjectList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaakobject_create - description: 'Maak een ZAAKOBJECT aan. - - - **Er wordt gevalideerd op** - - - Indien de `object` URL opgegeveven is, dan moet deze een geldige response - (HTTP 200) geven. - - - Indien opgegeven, dan wordt `objectIdentificatie` gevalideerd tegen de `objectType` - discriminator.' - summary: Maak een ZAAKOBJECT aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakobjecten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObject' - required: true - security: - - JWT-Claims: - - (zaken.aanmaken | zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObject' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaakobjecten/{uuid}: - get: - operationId: zaakobject_retrieve - description: Een specifieke ZAAKOBJECT opvragen. - summary: Een specifieke ZAAKOBJECT opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaakobjecten - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObject' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: zaakobject_update - description: - "**Er wordt gevalideerd op** \n- De attributen `zaak`, `object`\ - \ en `objectType` mogen niet gewijzigd worden.\n- Indien opgegeven, dan wordt\ - \ `objectIdentificatie` gevalideerd tegen de objectType discriminator." - summary: Werk een ZAAKOBJECT zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaakobjecten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObject' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObject' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: zaakobject_partial_update - description: - "**Er wordt gevalideerd op** \n- De attributen `zaak`, `object`\ - \ en `objectType` mogen niet gewijzigd worden.\n- Indien opgegeven, dan wordt\ - \ `objectIdentificatie` gevalideerd tegen de objectType discriminator." - summary: Werk een ZAAKOBJECT deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaakobjecten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedZaakObject' - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObject' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaakobject_destroy - description: - Verbreek de relatie tussen een ZAAK en een OBJECT door de ZAAKOBJECT - resource te verwijderen. - summary: Verwijder een ZAAKOBJECT. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - zaakobjecten - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken | zaken.verwijderen) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: zaakobject_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ZAAKOBJECT opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaakobjecten - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaakverzoeken: - get: - operationId: zaakverzoek_list - description: Alle ZAAK-VERZOEKen opvragen. - summary: Alle ZAAK-VERZOEKen opvragen. - parameters: - - name: zaak - required: false - in: query - description: URL-referentie naar de ZAAK. - schema: - type: string - format: uri - - name: verzoek - required: false - in: query - description: URL-referentie naar het VERZOEK (in de Klantinteractie API) - schema: - type: string - format: uri - tags: - - zaakverzoeken - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/ZaakVerzoek' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaakverzoek_create - description: '**Er wordt gevalideerd op** - - - geldigheid URL naar de VERZOEK' - summary: Maak een ZAAK-VERZOEK aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakverzoeken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakVerzoek' - required: true - security: - - JWT-Claims: - - zaken.bijwerken - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakVerzoek' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaakverzoeken/{uuid}: - get: - operationId: zaakverzoek_retrieve - description: Een specifieke ZAAK-VERZOEK opvragen. - summary: Een specifieke ZAAK-VERZOEK opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - zaakverzoeken - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakVerzoek' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaakverzoek_destroy - description: Verwijder een ZAAK-VERZOEK. - summary: Verwijder een ZAAK-VERZOEK. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakverzoeken - security: - - JWT-Claims: - - zaken.bijwerken - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaken: - get: - operationId: zaak_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle ZAAKen opvragen. - parameters: - - name: identificatie - required: false - in: query - description: - De unieke identificatie van de ZAAK binnen de organisatie die - verantwoordelijk is voor de behandeling van de ZAAK. - schema: - type: string - example: "zaak123" - - name: bronorganisatie - required: false - in: query - description: - Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers - en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef - schema: - type: string - example: "000000000" - - name: bronorganisatie__in - required: false - in: query - description: Multiple values may be separated by commas. - schema: - type: array - items: - type: string - example: ["000000000","479559740","875883461"] - style: form - explode: false - - name: zaaktype - required: false - in: query - description: - URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS - waar deze voorkomt - schema: - type: string - format: uri - example: "https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/e80b7507-199a-484c-ad49-c41a1e43a6e7" - - name: archiefnominatie - required: false - in: query - description: - Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - schema: - type: string - enum: - - blijvend_bewaren - - vernietigen - example: "blijvend_bewaren" - - name: archiefnominatie__in - required: false - in: query - description: Multiple values may be separated by commas. - schema: - type: array - items: - type: string - example: ["blijvend_bewaren", "vernietigen"] - style: form - explode: false - - name: archiefactiedatum - required: false - in: query - description: - De datum waarop het gearchiveerde zaakdossier vernietigd moet - worden dan wel overgebracht moet worden naar een archiefbewaarplaats. Wordt - automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT aan - deze ZAAK indien nog leeg. - schema: - type: string - example: "2019-01-02" - - name: archiefactiedatum__isnull - required: false - in: query - description: De archiefactiedatum is leeg. - schema: - type: boolean - example: false - - name: archiefactiedatum__lt - required: false - in: query - description: De archiefactiedatum is kleiner dan de opgegeven datum. - schema: - type: string - example: "2020-01-02" - - name: archiefactiedatum__gt - required: false - in: query - description: De archiefactiedatum is groter dan de opgegeven datum. - schema: - type: string - example: "2018-01-02" - - name: archiefstatus - required: false - in: query - description: - Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - schema: - type: string - enum: - - nog_te_archiveren - - gearchiveerd - - gearchiveerd_procestermijn_onbekend - - overgedragen - example: "nog_te_archiveren" - - name: archiefstatus__in - required: false - in: query - description: Multiple values may be separated by commas. - schema: - type: array - items: - type: string - example: ["nog_te_archiveren","gearchiveerd","gearchiveerd_procestermijn_onbekend","overgedragen"] - style: form - explode: false - - name: startdatum - required: false - in: query - description: De datum waarop met de uitvoering van de zaak is gestart - schema: - type: string - example: "2017-01-02" - - name: startdatum__gt - required: false - in: query - description: De startdatum is groter dan de opgegeven datum. - schema: - type: string - example: "2018-01-02" - - name: startdatum__gte - required: false - in: query - description: De startdatum is groter dan of gelijk dan de opgegeven datum. - schema: - type: string - example: "2016-01-02" - - name: startdatum__lt - required: false - in: query - description: De startdatum is kleiner dan de opgegeven datum. - schema: - type: string - example: "2018-01-02" - - name: startdatum__lte - required: false - in: query - description: De startdatum is kleiner of gelijk dan de opgegeven datum. - schema: - type: string - example: "2018-01-02" - - name: registratiedatum - required: false - in: query - description: - De datum waarop de zaakbehandelende organisatie de ZAAK heeft - geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag - gebruikt. - schema: - type: string - example: "2015-01-02" - - name: registratiedatum__gt - required: false - in: query - description: - De registratiedatum is groter dan de opgegeven datum. - schema: - type: string - example: "2014-01-02" - - name: registratiedatum__lt - required: false - in: query - description: - De registratiedatum is kleiner dan de opgegeven datum. - schema: - type: string - example: "2016-01-02" - - name: einddatum - required: false - in: query - description: De datum waarop de uitvoering van de zaak afgerond is. - schema: - type: string - example: "2022-01-02" - - name: einddatum__isnull - required: false - in: query - description: De einddatum is leeg. - schema: - type: boolean - example: false - - name: einddatum__gt - required: false - in: query - description: De einddatum is groter dan de opgegeven datum. - schema: - type: string - example: "2021-01-02" - - name: einddatum__lt - required: false - in: query - description: De einddatum is kleiner dan de opgegeven datum. - schema: - type: string - example: "2023-01-02" - - name: einddatumGepland - required: false - in: query - description: - De datum waarop volgens de planning verwacht wordt dat de zaak - afgerond wordt. - schema: - type: string - example: "2022-01-02" - - name: einddatumGepland__gt - required: false - in: query - description: - De geplande einddatum is groter dan de opgegeven datum. - schema: - type: string - example: "2021-01-02" - - name: einddatumGepland__lt - required: false - in: query - description: - De geplande einddatum is kleiner dan de opgegeven datum. - schema: - type: string - example: "2024-01-02" - - name: uiterlijkeEinddatumAfdoening - required: false - in: query - description: - De laatste datum waarop volgens wet- en regelgeving de zaak afgerond - dient te zijn. - schema: - type: string - example: "2024-01-02" - - name: uiterlijkeEinddatumAfdoening__gt - required: false - in: query - description: - De uiterlijke einddatumafdoening is groter dan de opgegeven datum. - schema: - type: string - example: "2023-01-02" - - name: uiterlijkeEinddatumAfdoening__lt - required: false - in: query - description: - De uiterlijke einddatumafdoening is kleiner dan de opgegeven datum. - schema: - type: string - example: "2025-01-02" - - name: rol__betrokkeneType - required: false - in: query - description: Type van de `betrokkene`. - schema: - type: string - enum: - - natuurlijk_persoon - - niet_natuurlijk_persoon - - vestiging - - organisatorische_eenheid - - medewerker - example: "natuurlijk_persoon" - - name: rol__betrokkene - required: false - in: query - description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. - schema: - type: string - format: uri - example: "https://example.com" - - name: rol__omschrijvingGeneriek - required: false - in: query - description: - Algemeen gehanteerde benaming van de aard van de ROL, afgeleid - uit het ROLTYPE. - schema: - type: string - enum: - - adviseur - - behandelaar - - belanghebbende - - beslisser - - initiator - - klantcontacter - - zaakcoordinator - - mede_initiator - example: "initiator" - - name: maximaleVertrouwelijkheidaanduiding - required: false - in: query - description: - Zaken met een vertrouwelijkheidaanduiding die beperkter is dan - de aangegeven aanduiding worden uit de resultaten gefiltered. - schema: - type: string - enum: - - openbaar - - beperkt_openbaar - - intern - - zaakvertrouwelijk - - vertrouwelijk - - confidentieel - - geheim - - zeer_geheim - example: "zaakvertrouwelijk" - - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn - required: false - in: query - description: - Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene - bepalingen burgerservicenummer. - schema: - type: string - maxLength: 9 - example: "123456789" - - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie - required: false - in: query - description: - Het door de gemeente uitgegeven unieke nummer voor een ANDER - NATUURLIJK PERSOON - schema: - type: string - maxLength: 17 - example: "123456789" - - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer - required: false - in: query - description: Het administratienummer van de persoon, bedoeld in de Wet BRP - schema: - type: string - maxLength: 10 - example: "123456789" - - name: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId - required: false - in: query - description: - Het door een kamer toegekend uniek nummer voor de INGESCHREVEN - NIET-NATUURLIJK PERSOON - schema: - type: string - example: "123456789" - - name: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie - required: false - in: query - description: - Het door de gemeente uitgegeven unieke nummer voor een ANDER - NIET-NATUURLIJK PERSOON - schema: - type: string - maxLength: 17 - example: "123456789" - - name: rol__betrokkeneIdentificatie__vestiging__vestigingsNummer - required: false - in: query - description: Een korte unieke aanduiding van de Vestiging. - schema: - type: string - maxLength: 24 - example: "123456789" - - name: rol__betrokkeneIdentificatie__medewerker__identificatie - required: false - in: query - description: Een korte unieke aanduiding van de MEDEWERKER. - schema: - type: string - maxLength: 24 - example: "123456789" - - name: rol__betrokkeneIdentificatie__organisatorischeEenheid__identificatie - required: false - in: query - description: Een korte identificatie van de organisatorische eenheid. - schema: - type: string - example: "123456789" - - name: expand - in: query - description: Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt. - schema: - type: string - example: zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype - - name: ordering - required: false - in: query - description: Het veld waarop de resultaten geordend worden. Het minnetje betekent omgekeerde volgorde. - schema: - type: array - items: - type: string - enum: - - startdatum - - -startdatum - - einddatum - - -einddatum - - publicatiedatum - - -publicatiedatum - - archiefactiedatum - - -archiefactiedatum - - registratiedatum - - -registratiedatum - - identificatie - - -identificatie - example: "-startdatum" - style: form - explode: false - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - example: 1 - - in: header - name: Accept-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het gewenste 'Coordinate Reference System' (CRS) van de geometrie - in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - required: true - - in: header - name: Content-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie in de - vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 - is hetzelfde als WGS84). - required: true - tags: - - zaken - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - Content-Crs: - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie - in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedZaakList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '412': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Precondition failed - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaak_create - description: - 'Indien geen identificatie gegeven is, dan wordt deze automatisch - gegenereerd. De identificatie moet uniek zijn binnen de bronorganisatie. - - - **Er wordt gevalideerd op:** - - - geldigheid `zaaktype` URL - de resource moet opgevraagd kunnen worden uit - de Catalogi API en de vorm van een ZAAKTYPE hebben. - - - `zaaktype` is geen concept (`zaaktype.concept = False`) - - - `laatsteBetaaldatum` mag niet in de toekomst liggen. - - - `laatsteBetaaldatum` mag niet gezet worden als de betalingsindicatie "nvt" - is. - - - `barchiefnominatie` moet een waarde hebben indien archiefstatus niet de - waarde "nog_te_archiveren" heeft. - - - `archiefactiedatum` moet een waarde hebben indien archiefstatus niet de - waarde "nog_te_archiveren" heeft. - - - `archiefstatus` kan alleen een waarde anders dan "nog_te_archiveren" hebben - indien van alle gerelateeerde INFORMATIEOBJECTen het attribuut `status` de - waarde "gearchiveerd" heeft.' - summary: Maak een ZAAK aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - - in: header - name: Accept-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het gewenste 'Coordinate Reference System' (CRS) van de geometrie - in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - required: true - - in: header - name: Content-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie in de - vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 - is hetzelfde als WGS84). - required: true - tags: - - zaken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Zaak' - required: true - security: - - JWT-Claims: - - zaken.aanmaken - responses: - '201': - headers: - Content-Crs: - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie - in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Zaak' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '412': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Precondition failed - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaken/{uuid}: - get: - operationId: zaak_retrieve - description: Een specifieke ZAAK opvragen. - summary: Een specifieke ZAAK opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: header - name: Accept-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het gewenste 'Coordinate Reference System' (CRS) van de geometrie - in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - required: true - - in: header - name: Content-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie in de - vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 - is hetzelfde als WGS84). - required: true - - name: expand - in: query - description: Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt. - schema: - type: string - example: zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype - tags: - - zaken - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - Content-Crs: - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie - in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakExpanded' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '412': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Precondition failed - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: zaak_update - description: - "**Er wordt gevalideerd op** \n- `identificatie` mag niet gewijzigd worden.\n- `laatsteBetaaldatum`\ - \ mag niet in de toekomst liggen.\n- `laatsteBetaaldatum` mag niet gezet worden\ - \ als de betalingsindicatie\n\"nvt\" is.\n- `archiefnominatie` moet een waarde\ - \ hebben indien `archiefstatus` niet de\nwaarde \"nog_te_archiveren\" heeft.\n\ - - `archiefactiedatum` moet een waarde hebben indien `archiefstatus` niet de\n\ - \ waarde \"nog_te_archiveren\" heeft.\n- `archiefstatus` kan alleen een waarde\ - \ anders dan \"nog_te_archiveren\"\n hebben indien van alle gerelateeerde\ - \ INFORMATIEOBJECTen het attribuut\n `status` de waarde \"gearchiveerd\"\ - \ heeft.\n**Opmerkingen**\n- er worden enkel zaken getoond van de zaaktypes\ - \ waar u toe geautoriseerd\n bent.\n- indien een zaak heropend moet worden,\ - \ doe dit dan door een nieuwe status\n toe te voegen die NIET de eindstatus\ - \ is. Zie de `Status` resource." - summary: Werk een ZAAK in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - - in: header - name: Accept-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het gewenste 'Coordinate Reference System' (CRS) van de geometrie - in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - required: true - - in: header - name: Content-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie in de - vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 - is hetzelfde als WGS84). - required: true - tags: - - zaken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Zaak' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - Content-Crs: - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie - in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Zaak' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '412': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Precondition failed - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: zaak_partial_update - description: - "**Er wordt gevalideerd op** \n- `identificatie` mag niet gewijzigd worden.\n- `laatsteBetaaldatum`\ - \ mag niet in de toekomst liggen.\n- `laatsteBetaaldatum` mag niet gezet worden\ - \ als de betalingsindicatie\n\"nvt\" is.\n- `archiefnominatie` moet een waarde\ - \ hebben indien `archiefstatus` niet de\nwaarde \"nog_te_archiveren\" heeft.\n\ - - `archiefactiedatum` moet een waarde hebben indien `archiefstatus` niet de\n\ - \ waarde \"nog_te_archiveren\" heeft.\n- `archiefstatus` kan alleen een waarde\ - \ anders dan \"nog_te_archiveren\"\n hebben indien van alle gerelateeerde\ - \ INFORMATIEOBJECTen het attribuut\n `status` de waarde \"gearchiveerd\"\ - \ heeft.\n**Opmerkingen**\n- er worden enkel zaken getoond van de zaaktypes\ - \ waar u toe geautoriseerd\n bent.\n- indien een zaak heropend moet worden,\ - \ doe dit dan door een nieuwe status\n toe te voegen die NIET de eindstatus\ - \ is. Zie de `Status` resource." - summary: Werk een ZAAK deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - - in: header - name: Accept-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het gewenste 'Coordinate Reference System' (CRS) van de geometrie - in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - required: true - - in: header - name: Content-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie in de - vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 - is hetzelfde als WGS84). - required: true - tags: - - zaken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedZaak' - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - Content-Crs: - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie - in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Zaak' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '412': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Precondition failed - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaak_destroy - description: '***De gerelateerde resources zijn hierbij*** - - - `zaak` - de deelzaken van de verwijderde hoofzaak - - - `status` - alle statussen van de verwijderde zaak - - - `resultaat` - het resultaat van de verwijderde zaak - - - `rol` - alle rollen bij de zaak - - - `zaakobject` - alle zaakobjecten bij de zaak - - - `zaakeigenschap` - alle eigenschappen van de zaak - - - `zaakkenmerk` - alle kenmerken van de zaak - - - `zaakinformatieobject` - dit moet door-cascaden naar de Documenten API, - zie ook: https://github.com/VNG-Realisatie/gemma-zaken/issues/791 (TODO) - - - `klantcontact` - alle klantcontacten bij een zaak' - summary: Verwijder een ZAAK. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - - in: header - name: Accept-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het gewenste 'Coordinate Reference System' (CRS) van de geometrie - in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - required: true - - in: header - name: Content-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie in de - vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 - is hetzelfde als WGS84). - required: true - tags: - - zaken - security: - - JWT-Claims: - - zaken.verwijderen - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '412': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Precondition failed - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: zaak_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ZAAK opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: header - name: Accept-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het gewenste 'Coordinate Reference System' (CRS) van de geometrie - in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - required: true - - in: header - name: Content-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie in de - vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 - is hetzelfde als WGS84). - required: true - tags: - - zaken - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - Content-Crs: - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie - in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaken/{zaak_uuid}/audittrail: - get: - operationId: audittrail_list - description: Alle audit trail regels behorend bij de ZAAK. - summary: Alle audit trail regels behorend bij de ZAAK. - parameters: - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - security: - - JWT-Claims: - - audittrails.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/AuditTrail' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaken/{zaak_uuid}/audittrail/{uuid}: - get: - operationId: audittrail_retrieve - description: Een specifieke audit trail regel opvragen. - summary: 'Een specifieke audit trail regel opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke identificatie van de audit regel. - title: uuid - required: true - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - security: - - JWT-Claims: - - audittrails.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/AuditTrail' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaken/{zaak_uuid}/besluiten: - get: - operationId: zaakbesluit_list - description: Alle ZAAKBESLUITen opvragen. - summary: Alle ZAAKBESLUITen opvragen. - parameters: - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/ZaakBesluit' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaakbesluit_create - description: - '**LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** - - - De Besluiten API gebruikt dit endpoint om relaties te synchroniseren, daarom - is dit endpoint in de Zaken API geimplementeerd. - - - **Er wordt gevalideerd op:** - - - geldigheid URL naar de ZAAK' - summary: Maak een ZAAKBESLUIT aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakBesluit' - required: true - security: - - JWT-Claims: - - zaken.bijwerken - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakBesluit' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaken/{zaak_uuid}/besluiten/{uuid}: - get: - operationId: zaakbesluit_retrieve - description: Een specifiek ZAAKBESLUIT opvragen. - summary: 'Een specifiek ZAAKBESLUIT opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakBesluit' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaakbesluit_destroy - description: - '***LET OP: Dit endpoint hoor je als consumer niet zelf aan te - spreken.*** - - - De Besluiten API gebruikt dit endpoint om relaties te synchroniseren, daarom - is dit endpoint in de Zaken API geimplementeerd. - - ' - summary: Verwijder een ZAAKBESLUIT. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - security: - - JWT-Claims: - - zaken.bijwerken - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaken/{zaak_uuid}/zaakeigenschappen: - get: - operationId: zaakeigenschap_list - description: Alle ZAAKEIGENSCHAPpen opvragen. - summary: 'Alle ZAAKEIGENSCHAPpen opvragen. ' - parameters: - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/ZaakEigenschap' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaakeigenschap_create - description: 'Maak een ZAAKEIGENSCHAP aan. - - - **Er wordt gevalideerd op:** - - - geldigheid `eigenschap` URL - de resource moet opgevraagd kunnen worden - uit de Catalogi API en de vorm van een EIGENSCHAP hebben. - - - de `eigenschap` moet bij het `ZAAK.zaaktype` horen' - summary: Maak een ZAAKEIGENSCHAP aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakEigenschap' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakEigenschap' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaken/{zaak_uuid}/zaakeigenschappen/{uuid}: - get: - operationId: zaakeigenschap_retrieve - description: Een specifieke ZAAKEIGENSCHAP opvragen. - summary: Een specifieke ZAAKEIGENSCHAP opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakEigenschap' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: zaakeigenschap_update - description: - "**Er wordt gevalideerd op** \n- Alleen de `waarde` mag gewijzigd\ - \ worden" - summary: Werk een ZAAKEIGENSCHAP in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakEigenschap' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakEigenschap' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: zaakeigenschap_partial_update - description: - "**Er wordt gevalideerd op** \n- Alleen de `waarde` mag gewijzigd\ - \ worden" - summary: Werk een ZAAKEIGENSCHAP deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedZaakEigenschap' - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakEigenschap' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaakeigenschap_destroy - description: Verwijder een ZAAKEIGENSCHAP - summary: Verwijder een ZAAKEIGENSCHAP. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: zaakeigenschap_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ZAAKEIGENSCHAP opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaken/_zoek: - post: - operationId: zaak__zoek - description: - Zoeken/filteren gaat normaal via de `list` operatie, deze is echter - niet geschikt voor geo-zoekopdrachten. - summary: Voer een (geo)-zoekopdracht uit op ZAAKen. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: query - name: page - schema: - type: integer - description: Een pagina binnen de gepagineerde set resultaten. - - in: header - name: Accept-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het gewenste 'Coordinate Reference System' (CRS) van de geometrie - in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - required: true - - in: header - name: Content-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie in de - vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 - is hetzelfde als WGS84). - required: true - tags: - - zaken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakZoek' - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - Content-Crs: - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie - in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedZaakList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '412': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Precondition failed - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error -components: - responses: - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '412': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Precondition failed - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - schemas: - AardRelatieEnum: - enum: - - vervolg - - onderwerp - - bijdrage - type: string - AardRelatieWeergaveEnum: - enum: - - 'Hoort bij, omgekeerd: kent' - - 'Legt vast, omgekeerd: kan vastgelegd zijn als' - type: string - ArchiefnominatieEnum: - enum: - - blijvend_bewaren - - vernietigen - type: string - ArchiefstatusEnum: - enum: - - nog_te_archiveren - - gearchiveerd - - gearchiveerd_procestermijn_onbekend - - overgedragen - type: string - AuditTrail: - type: object - properties: - uuid: - type: string - format: uuid - description: Unieke identificatie van de audit regel. - title: uuid - bron: - allOf: - - $ref: '#/components/schemas/BronEnum' - description: - 'De naam van het component waar de wijziging in is gedaan. - - - Uitleg bij mogelijke waarden: - - - * `ac` - Autorisaties API - - * `nrc` - Notificaties API - - * `zrc` - Zaken API - - * `ztc` - Catalogi API - - * `drc` - Documenten API - - * `brc` - Besluiten API - - * `cmc` - Contactmomenten API - - * `kc` - Klanten API - - * `vrc` - Verzoeken API' - title: bron - applicatieId: - type: string - description: Unieke identificatie van de applicatie, binnen de organisatie. - title: applicatie id - maxLength: 100 - applicatieWeergave: - type: string - description: Vriendelijke naam van de applicatie. - title: applicatie weergave - maxLength: 200 - gebruikersId: - type: string - description: - Unieke identificatie van de gebruiker die binnen de organisatie - herleid kan worden naar een persoon. - title: gebruikers id - maxLength: 255 - gebruikersWeergave: - type: string - description: Vriendelijke naam van de gebruiker. - title: gebruikers weergave - maxLength: 255 - actie: - type: string - description: 'De uitgevoerde handeling. - - - De bekende waardes voor dit veld zijn hieronder aangegeven, maar - andere waardes zijn ook toegestaan - - - Uitleg bij mogelijke waarden: - - - * `create` - Object aangemaakt - - * `list` - Lijst van objecten opgehaald - - * `retrieve` - Object opgehaald - - * `destroy` - Object verwijderd - - * `update` - Object bijgewerkt - - * `partial_update` - Object deels bijgewerkt' - title: actie - maxLength: 50 - actieWeergave: - type: string - description: Vriendelijke naam van de actie. - title: actie weergave - maxLength: 200 - resultaat: - type: integer - maximum: 599 - minimum: 100 - description: HTTP status code van de API response van de uitgevoerde handeling. - title: resultaat - hoofdObject: - type: string - format: uri - description: De URL naar het hoofdobject van een component. - title: hoofd object - maxLength: 1000 - resource: - type: string - description: Het type resource waarop de actie gebeurde. - title: resource - maxLength: 50 - resourceUrl: - type: string - format: uri - description: De URL naar het object. - title: resource url - maxLength: 1000 - toelichting: - type: string - description: Toelichting waarom de handeling is uitgevoerd. - title: toelichting - resourceWeergave: - type: string - description: Vriendelijke identificatie van het object. - title: resource weergave - maxLength: 200 - aanmaakdatum: - type: string - format: date-time - readOnly: true - description: De datum waarop de handeling is gedaan. - title: aanmaakdatum - wijzigingen: - allOf: - - $ref: '#/components/schemas/Wijzigingen' - title: wijzigingen - required: - - aanmaakdatum - - actie - - bron - - hoofdObject - - resource - - resourceUrl - - resourceWeergave - - resultaat - - wijzigingen - BetalingsindicatieEnum: - enum: - - nvt - - nog_niet - - gedeeltelijk - - geheel - type: string - BetrokkeneTypeEnum: - enum: - - natuurlijk_persoon - - niet_natuurlijk_persoon - - vestiging - - organisatorische_eenheid - - medewerker - type: string - BlankEnum: - enum: - - '' - BronEnum: - enum: - - ac - - nrc - - zrc - - ztc - - drc - - brc - - cmc - - kc - - vrc - type: string - ContactPersoonRol: - type: object - description: - De gegevens van de persoon die anderen desgevraagd in contact brengt - met medewerkers van de BETROKKENE, een NIET-NATUURLIJK PERSOON of VESTIGING - zijnde, of met BETROKKENE zelf, een NATUURLIJK PERSOON zijnde , vanuit het - belang van BETROKKENE in haar ROL bij een ZAAK. - properties: - emailadres: - type: string - format: email - title: Email - description: - Elektronich postadres waaronder de contactpersoon in de regel - bereikbaar is. - maxLength: 254 - functie: - type: string - description: - 'De aanduiding van de taken, rechten en plichten die de contactpersoon - heeft binnen de organisatie van BETROKKENE. ' - title: functie - maxLength: 50 - telefoonnummer: - type: string - description: - Telefoonnummer waaronder de contactpersoon in de regel bereikbaar - is. - title: telefoonnummer - maxLength: 20 - naam: - type: string - description: De opgemaakte naam van de contactpersoon namens de BETROKKENE. - title: naam - maxLength: 40 - required: - - naam - nullable: true - FieldValidationError: - type: object - description: Formaat van validatiefouten. - properties: - name: - type: string - description: Naam van het veld met ongeldige gegevens - title: name - code: - type: string - description: Systeemcode die het type fout aangeeft - title: code - reason: - type: string - description: Uitleg wat er precies fout is met de gegevens - title: reason - required: - - code - - name - - reason - Fout: - type: object - description: Formaat van HTTP 4xx en 5xx fouten. - properties: - type: - type: string - description: URI referentie naar het type fout, bedoeld voor developers - title: type - code: - type: string - description: Systeemcode die het type fout aangeeft - title: code - title: - type: string - description: Generieke titel voor het type fout - title: title - status: - type: integer - description: De HTTP status code - title: status - detail: - type: string - description: Extra informatie bij de fout, indien beschikbaar - title: detail - instance: - type: string - description: - URI met referentie naar dit specifiek voorkomen van de fout. - Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. - title: instance - required: - - code - - detail - - instance - - status - - title - GeoJSONGeometry: - title: GeoJSONGeometry - type: object - oneOf: - - $ref: '#/components/schemas/Point' - - $ref: '#/components/schemas/MultiPoint' - - $ref: '#/components/schemas/LineString' - - $ref: '#/components/schemas/MultiLineString' - - $ref: '#/components/schemas/Polygon' - - $ref: '#/components/schemas/MultiPolygon' - - $ref: '#/components/schemas/GeometryCollection' - discriminator: - propertyName: type - GeoWithin: - type: object - properties: - within: - allOf: - - $ref: '#/components/schemas/GeoJSONGeometry' - title: within - Geometry: - title: Geometry - description: GeoJSON geometry - type: object - required: - - type - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1 - properties: - type: - allOf: - - $ref: '#/components/schemas/GeometryTypeEnum' - description: The geometry type - GeometryCollection: - title: Geometry collection - description: GeoJSON multi-polygon geometry - type: object - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.8 - allOf: - - $ref: '#/components/schemas/Geometry' - - type: object - required: - - geometries - properties: - geometries: - type: array - items: - $ref: '#/components/schemas/Geometry' - GeometryTypeEnum: - type: string - enum: - - Point - - MultiPoint - - LineString - - MultiLineString - - Polygon - - MultiPolygon - - Feature - - FeatureCollection - - GeometryCollection - GeslachtsaanduidingEnum: - enum: - - m - - v - - o - type: string - IndicatieMachtigingEnum: - enum: - - gemachtigde - - machtiginggever - type: string - InnRechtsvormEnum: - enum: - - besloten_vennootschap - - cooperatie_europees_economische_samenwerking - - europese_cooperatieve_venootschap - - europese_naamloze_vennootschap - - kerkelijke_organisatie - - naamloze_vennootschap - - onderlinge_waarborg_maatschappij - - overig_privaatrechtelijke_rechtspersoon - - stichting - - vereniging - - vereniging_van_eigenaars - - publiekrechtelijke_rechtspersoon - - vennootschap_onder_firma - - maatschap - - rederij - - commanditaire_vennootschap - - kapitaalvennootschap_binnen_eer - - overige_buitenlandse_rechtspersoon_vennootschap - - kapitaalvennootschap_buiten_eer - type: string - KlantContact: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - identificatie: - type: string - description: De unieke aanduiding van een KLANTCONTACT - title: identificatie - maxLength: 14 - datumtijd: - type: string - format: date-time - description: De datum en het tijdstip waarop het KLANTCONTACT begint - title: datumtijd - kanaal: - type: string - description: Het communicatiekanaal waarlangs het KLANTCONTACT gevoerd wordt - title: kanaal - maxLength: 20 - onderwerp: - type: string - description: Het onderwerp waarover contact is geweest met de klant. - title: onderwerp - maxLength: 200 - toelichting: - type: string - description: Een toelichting die inhoudelijk het contact met de klant beschrijft. - title: toelichting - maxLength: 1000 - required: - - datumtijd - - url - - uuid - - zaak - LineString: - title: Line-string - description: GeoJSON line-string geometry - type: object - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.4 - allOf: - - $ref: '#/components/schemas/Geometry' - - type: object - required: - - coordinates - properties: - coordinates: - type: array - items: - $ref: '#/components/schemas/Point2D' - minItems: 2 - MultiLineString: - title: Multi-line string - description: GeoJSON multi-line-string geometry - type: object - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.5 - allOf: - - $ref: '#/components/schemas/Geometry' - - type: object - required: - - coordinates - properties: - coordinates: - type: array - items: - type: array - items: - $ref: '#/components/schemas/Point2D' - MultiPoint: - title: MultiPoint - description: GeoJSON multi-point geometry - type: object - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.3 - allOf: - - $ref: '#/components/schemas/Geometry' - - type: object - required: - - coordinates - properties: - coordinates: - type: array - items: - $ref: '#/components/schemas/Point2D' - MultiPolygon: - title: Multi-polygon - description: GeoJSON multi-polygon geometry - type: object - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.7 - allOf: - - $ref: '#/components/schemas/Geometry' - - type: object - required: - - coordinates - properties: - coordinates: - type: array - items: - type: array - items: - type: array - items: - $ref: '#/components/schemas/Point2D' - NullEnum: - enum: - - null - ObjectAdres: - type: object - properties: - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - wplWoonplaatsNaam: - type: string - title: wpl woonplaats naam - maxLength: 80 - gorOpenbareRuimteNaam: - type: string - description: - Een door het bevoegde gemeentelijke orgaan aan een OPENBARE - RUIMTE toegekende benaming - title: gor openbare ruimte naam - maxLength: 80 - huisnummer: - type: integer - maximum: 99999 - minimum: 0 - title: huisnummer - huisletter: - type: string - title: huisletter - maxLength: 1 - huisnummertoevoeging: - type: string - title: huisnummertoevoeging - maxLength: 4 - postcode: - type: string - title: postcode - maxLength: 7 - required: - - gorOpenbareRuimteNaam - - huisnummer - - identificatie - - wplWoonplaatsNaam - ObjectBuurt: - type: object - properties: - buurtCode: - type: string - description: De code behorende bij de naam van de buurt - title: buurt code - maxLength: 2 - buurtNaam: - type: string - description: De naam van de buurt, zoals die door het CBS wordt gebruikt. - title: buurt naam - maxLength: 40 - gemGemeenteCode: - type: string - description: - Een numerieke aanduiding waarmee een Nederlandse gemeente uniek - wordt aangeduid - title: gem gemeente code - maxLength: 4 - wykWijkCode: - type: string - description: De code behorende bij de naam van de wijk - title: wyk wijk code - maxLength: 2 - required: - - buurtCode - - buurtNaam - - gemGemeenteCode - - wykWijkCode - ObjectGemeente: - type: object - properties: - gemeenteNaam: - type: string - description: "De offici\xEBle door de gemeente vastgestelde gemeentenaam." - title: gemeente naam - maxLength: 80 - gemeenteCode: - type: string - description: - Een numerieke aanduiding waarmee een Nederlandse gemeente uniek - wordt aangeduid - title: gemeente code - maxLength: 4 - required: - - gemeenteCode - - gemeenteNaam - ObjectGemeentelijkeOpenbareRuimte: - type: object - properties: - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - openbareRuimteNaam: - type: string - description: - Een door het bevoegde gemeentelijke orgaan aan een OPENBARE - RUIMTE toegekende benaming - title: openbare ruimte naam - maxLength: 80 - required: - - identificatie - - openbareRuimteNaam - ObjectHuishouden: - type: object - properties: - nummer: - type: string - description: - Uniek identificerend administratienummer van een huishouden - zoals toegekend door de gemeente waarin het huishouden woonachtig is. - title: nummer - maxLength: 12 - isGehuisvestIn: - allOf: - - $ref: '#/components/schemas/ObjectTerreinGebouwdObject' - nullable: true - title: isGehuisvestIn - required: - - nummer - ObjectInrichtingselement: - type: object - properties: - type: - allOf: - - $ref: '#/components/schemas/ObjectInrichtingselementTypeEnum' - description: 'Specificatie van de aard van het inrichtingselement. - - - Uitleg bij mogelijke waarden: - - - * `bak` - Bak - - * `bord` - Bord - - * `installatie` - Installatie - - * `kast` - Kast - - * `mast` - Mast - - * `paal` - Paal - - * `sensor` - Sensor - - * `straatmeubilair` - Straatmeubilair - - * `waterinrichtingselement` - Waterinrichtingselement - - * `weginrichtingselement` - Weginrichtingselement' - title: type - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - naam: - type: string - description: De benaming van het OBJECT - title: naam - maxLength: 500 - required: - - identificatie - - type - ObjectInrichtingselementTypeEnum: - enum: - - bak - - bord - - installatie - - kast - - mast - - paal - - sensor - - straatmeubilair - - waterinrichtingselement - - weginrichtingselement - type: string - ObjectKadastraleOnroerendeZaak: - type: object - properties: - kadastraleIdentificatie: - type: string - description: De unieke identificatie van het OBJECT - title: kadastrale identificatie - maxLength: 100 - kadastraleAanduiding: - type: string - description: - De typering van de kadastrale aanduiding van een onroerende - zaak conform Kadaster - title: kadastrale aanduiding - maxLength: 1000 - required: - - kadastraleAanduiding - - kadastraleIdentificatie - ObjectKunstwerkdeel: - type: object - properties: - type: - allOf: - - $ref: '#/components/schemas/ObjectKunstwerkdeelTypeEnum' - description: - 'Specificatie van het soort Kunstwerk waartoe het kunstwerkdeel - behoort. - - - Uitleg bij mogelijke waarden: - - - * `keermuur` - Keermuur - - * `overkluizing` - Overkluizing - - * `duiker` - Duiker - - * `faunavoorziening` - Faunavoorziening - - * `vispassage` - Vispassage - - * `bodemval` - Bodemval - - * `coupure` - Coupure - - * `ponton` - Ponton - - * `voorde` - Voorde - - * `hoogspanningsmast` - Hoogspanningsmast - - * `gemaal` - Gemaal - - * `perron` - Perron - - * `sluis` - Sluis - - * `strekdam` - Strekdam - - * `steiger` - Steiger - - * `stuw` - Stuw' - title: type - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - naam: - type: string - title: naam - maxLength: 80 - required: - - identificatie - - naam - - type - ObjectKunstwerkdeelTypeEnum: - enum: - - keermuur - - overkluizing - - duiker - - faunavoorziening - - vispassage - - bodemval - - coupure - - ponton - - voorde - - hoogspanningsmast - - gemaal - - perron - - sluis - - strekdam - - steiger - - stuw - type: string - ObjectMaatschappelijkeActiviteit: - type: object - properties: - kvkNummer: - type: string - description: - Landelijk uniek identificerend administratienummer van een - MAATSCHAPPELIJKE ACTIVITEIT zoals toegewezen door de Kamer van Koophandel - (KvK). - title: kvk nummer - maxLength: 8 - handelsnaam: - type: string - description: De naam waaronder de onderneming handelt. - title: handelsnaam - maxLength: 200 - required: - - handelsnaam - - kvkNummer - ObjectOpenbareRuimte: - type: object - properties: - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - wplWoonplaatsNaam: - type: string - title: wpl woonplaats naam - maxLength: 80 - gorOpenbareRuimteNaam: - type: string - description: - Een door het bevoegde gemeentelijke orgaan aan een OPENBARE - RUIMTE toegekende benaming - title: gor openbare ruimte naam - maxLength: 80 - required: - - gorOpenbareRuimteNaam - - identificatie - - wplWoonplaatsNaam - ObjectOverige: - type: object - properties: - overigeData: - type: object - additionalProperties: {} - title: overige data - required: - - overigeData - ObjectPand: - type: object - properties: - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - required: - - identificatie - ObjectSpoorbaandeel: - type: object - properties: - type: - allOf: - - $ref: '#/components/schemas/ObjectSpoorbaandeelTypeEnum' - description: 'Specificatie van het soort Spoorbaan - - - Uitleg bij mogelijke waarden: - - - * `breedspoor` - breedspoor - - * `normaalspoor` - normaalspoor - - * `smalspoor` - smalspoor - - * `spoorbaan` - spoorbaan' - title: type - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - naam: - type: string - description: De benaming van het OBJECT - title: naam - maxLength: 500 - required: - - identificatie - - type - ObjectSpoorbaandeelTypeEnum: - enum: - - breedspoor - - normaalspoor - - smalspoor - - spoorbaan - type: string - ObjectTerreinGebouwdObject: - type: object - properties: - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - adresAanduidingGrp: - allOf: - - $ref: '#/components/schemas/TerreinGebouwdObjectAdres' - nullable: true - title: adresAanduidingGrp - required: - - identificatie - ObjectTerreindeel: - type: object - properties: - type: - type: string - title: type - maxLength: 40 - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - naam: - type: string - description: De benaming van het OBJECT - title: naam - maxLength: 500 - required: - - identificatie - - type - ObjectTypeEnum: - enum: - - adres - - besluit - - buurt - - enkelvoudig_document - - gemeente - - gemeentelijke_openbare_ruimte - - huishouden - - inrichtingselement - - kadastrale_onroerende_zaak - - kunstwerkdeel - - maatschappelijke_activiteit - - medewerker - - natuurlijk_persoon - - niet_natuurlijk_persoon - - openbare_ruimte - - organisatorische_eenheid - - pand - - spoorbaandeel - - status - - terreindeel - - terrein_gebouwd_object - - vestiging - - waterdeel - - wegdeel - - wijk - - woonplaats - - woz_deelobject - - woz_object - - woz_waarde - - zakelijk_recht - - overige - type: string - ObjectTypeOverigeDefinitie: - type: object - properties: - url: - type: string - format: uri - title: Objecttype-URL - description: - URL-referentie naar de objecttype resource in een API. Deze - resource moet de [JSON-schema](https://json-schema.org/)-definitie van - het objecttype bevatten. - maxLength: 1000 - schema: - type: string - title: schema-pad - description: - 'Een geldige [jq](http://stedolan.github.io/jq/) expressie. - Dit wordt gecombineerd met de resource uit het `url`-attribuut om het - schema van het objecttype uit te lezen. Bijvoorbeeld: `.jsonSchema`.' - maxLength: 100 - objectData: - type: string - title: objectgegevens-pad - description: - 'Een geldige [jq](http://stedolan.github.io/jq/) expressie. - Dit wordt gecombineerd met de JSON data uit de OBJECT url om de objectgegevens - uit te lezen en de vorm van de gegevens tegen het schema te valideren. - Bijvoorbeeld: `.record.data`.' - maxLength: 100 - required: - - objectData - - schema - - url - ObjectWaterdeel: - type: object - properties: - typeWaterdeel: - allOf: - - $ref: '#/components/schemas/TypeWaterdeelEnum' - description: 'Specificatie van het soort water - - - Uitleg bij mogelijke waarden: - - - * `zee` - Zee - - * `waterloop` - Waterloop - - * `watervlakte` - Watervlakte - - * `greppel_droge_sloot` - Greppel, droge sloot' - title: type waterdeel - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - naam: - type: string - description: De benaming van het OBJECT - title: naam - maxLength: 500 - required: - - identificatie - - typeWaterdeel - ObjectWegdeel: - type: object - properties: - type: - type: string - title: type - maxLength: 100 - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - naam: - type: string - description: De benaming van het OBJECT - title: naam - maxLength: 500 - required: - - identificatie - - type - ObjectWijk: - type: object - properties: - wijkCode: - type: string - description: De code behorende bij de naam van de wijk. - title: wijk code - maxLength: 2 - wijkNaam: - type: string - description: De naam van de wijk, zoals die door het CBS wordt gebruikt. - title: wijk naam - maxLength: 40 - gemGemeenteCode: - type: string - description: - Een numerieke aanduiding waarmee een Nederlandse gemeente uniek - wordt aangeduid - title: gem gemeente code - maxLength: 4 - required: - - gemGemeenteCode - - wijkCode - - wijkNaam - ObjectWoonplaats: - type: object - properties: - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - woonplaatsNaam: - type: string - description: - De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS - toegekende benaming. - title: woonplaats naam - maxLength: 80 - required: - - identificatie - - woonplaatsNaam - ObjectWozDeelobject: - type: object - properties: - nummerWozDeelObject: - type: string - description: Uniek identificatienummer voor het deelobject binnen een WOZ-object. - title: nummer woz deel object - maxLength: 6 - isOnderdeelVan: - allOf: - - $ref: '#/components/schemas/ObjectWozObject' - title: isOnderdeelVan - required: - - nummerWozDeelObject - ObjectWozObject: - type: object - properties: - wozObjectNummer: - type: string - description: De unieke identificatie van het OBJECT - title: woz object nummer - maxLength: 100 - aanduidingWozObject: - allOf: - - $ref: '#/components/schemas/WozObjectAdres' - nullable: true - title: aanduidingWozObject - required: - - wozObjectNummer - ObjectWozWaarde: - type: object - properties: - waardepeildatum: - type: string - description: De datum waarnaar de waarde van het WOZ-object wordt bepaald. - title: waardepeildatum - maxLength: 9 - isVoor: - allOf: - - $ref: '#/components/schemas/ObjectWozObject' - title: isVoor - required: - - waardepeildatum - ObjectZakelijkRecht: - type: object - properties: - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - avgAard: - type: string - description: aanduiding voor de aard van het recht - title: avg aard - maxLength: 1000 - heeftBetrekkingOp: - allOf: - - $ref: '#/components/schemas/ObjectKadastraleOnroerendeZaak' - title: heeftBetrekkingOp - heeftAlsGerechtigde: - allOf: - - $ref: '#/components/schemas/ZakelijkRechtHeeftAlsGerechtigde' - title: heeftAlsGerechtigde - required: - - avgAard - - identificatie - Opschorting: - type: object - description: - Gegevens omtrent het tijdelijk opschorten van de behandeling van - de ZAAK - properties: - indicatie: - type: boolean - description: Aanduiding of de behandeling van de ZAAK tijdelijk is opgeschort. - title: indicatie opschorting - reden: - type: string - description: - Omschrijving van de reden voor het opschorten van de behandeling - van de zaak. - title: reden opschorting - maxLength: 200 - required: - - indicatie - - reden - nullable: true - PaginatedKlantContactList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/KlantContact' - PaginatedResultaatList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Resultaat' - PaginatedRolList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Rol' - PaginatedStatusList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Status' - PaginatedZaakList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/ZaakExpanded' - PaginatedZaakObjectList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/ZaakObject' - PatchedResultaat: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - resultaattype: - type: string - format: uri - description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API). - title: resultaattype - maxLength: 1000 - toelichting: - type: string - description: Een toelichting op wat het resultaat van de zaak inhoudt. - title: toelichting - maxLength: 1000 - PatchedZaak: - type: object - description: 'Set gegevensgroepdata from validated nested data. - - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - identificatie: - type: string - description: - De unieke identificatie van de ZAAK binnen de organisatie die - verantwoordelijk is voor de behandeling van de ZAAK. - title: identificatie - maxLength: 40 - bronorganisatie: - type: string - description: - Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers - en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef - title: bronorganisatie - maxLength: 9 - omschrijving: - type: string - description: Een korte omschrijving van de zaak. - title: omschrijving - maxLength: 80 - toelichting: - type: string - description: Een toelichting op de zaak. - title: toelichting - maxLength: 1000 - zaaktype: - type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de - CATALOGUS waar deze voorkomt - title: zaaktype - maxLength: 1000 - registratiedatum: - type: string - format: date - description: - De datum waarop de zaakbehandelende organisatie de ZAAK heeft - geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag - gebruikt. - title: registratiedatum - verantwoordelijkeOrganisatie: - type: string - description: - Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die eindverantwoordelijk is voor de behandeling van de zaak. Dit moet - een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef - title: verantwoordelijke organisatie - maxLength: 9 - startdatum: - type: string - format: date - description: De datum waarop met de uitvoering van de zaak is gestart - title: startdatum - einddatum: - type: string - format: date - readOnly: true - nullable: true - description: De datum waarop de uitvoering van de zaak afgerond is. - title: einddatum - einddatumGepland: - type: string - format: date - nullable: true - description: - De datum waarop volgens de planning verwacht wordt dat de zaak - afgerond wordt. - title: einddatum gepland - uiterlijkeEinddatumAfdoening: - type: string - format: date - nullable: true - description: - De laatste datum waarop volgens wet- en regelgeving de zaak - afgerond dient te zijn. - title: uiterlijke einddatum afdoening - publicatiedatum: - type: string - format: date - nullable: true - description: Datum waarop (het starten van) de zaak gepubliceerd is of wordt. - title: publicatiedatum - communicatiekanaal: - type: string - format: uri - description: - Het medium waarlangs de aanleiding om een zaak te starten is - ontvangen. URL naar een communicatiekanaal in de VNG-Referentielijst van - communicatiekanalen. - title: communicatiekanaal - maxLength: 1000 - productenOfDiensten: - type: array - items: - type: string - format: uri - title: URL naar product/dienst - maxLength: 1000 - description: - De producten en/of diensten die door de zaak worden voortgebracht. - Dit zijn URLs naar de resources zoals die door de producten- en dienstencatalogus-API - wordt ontsloten. De producten/diensten moeten bij het zaaktype vermeld - zijn. - title: producten of diensten - vertrouwelijkheidaanduiding: - allOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - title: Vertrouwlijkheidaanduiding - description: - Aanduiding van de mate waarin het zaakdossier van de ZAAK voor - de openbaarheid bestemd is. Optioneel - indien geen waarde gekozen wordt, - dan wordt de waarde van het ZAAKTYPE overgenomen. Dit betekent dat de - API _altijd_ een waarde teruggeeft. - betalingsindicatie: - description: - 'Indicatie of de, met behandeling van de zaak gemoeide, kosten - betaald zijn door de desbetreffende betrokkene. - - - Uitleg bij mogelijke waarden: - - - * `nvt` - Er is geen sprake van te betalen, met de zaak gemoeide, kosten. - - * `nog_niet` - De met de zaak gemoeide kosten zijn (nog) niet betaald. - - * `gedeeltelijk` - De met de zaak gemoeide kosten zijn gedeeltelijk betaald. - - * `geheel` - De met de zaak gemoeide kosten zijn geheel betaald.' - title: betalingsindicatie - oneOf: - - $ref: '#/components/schemas/BetalingsindicatieEnum' - - $ref: '#/components/schemas/BlankEnum' - betalingsindicatieWeergave: - type: string - readOnly: true - description: Uitleg bij `betalingsindicatie`. - title: betalingsindicatieWeergave - laatsteBetaaldatum: - type: string - format: date-time - nullable: true - description: - De datum waarop de meest recente betaling is verwerkt van kosten - die gemoeid zijn met behandeling van de zaak. - title: laatste betaaldatum - zaakgeometrie: - allOf: - - $ref: '#/components/schemas/GeoJSONGeometry' - nullable: true - description: Punt, lijn of (multi-)vlak geometrie-informatie, in GeoJSON. - title: zaakgeometrie - verlenging: - allOf: - - $ref: '#/components/schemas/Verlenging' - nullable: true - description: - Gegevens omtrent het verlengen van de doorlooptijd van de behandeling - van de ZAAK - title: verlenging - opschorting: - allOf: - - $ref: '#/components/schemas/Opschorting' - nullable: true - description: - Gegevens omtrent het tijdelijk opschorten van de behandeling - van de ZAAK - title: opschorting - selectielijstklasse: - type: string - format: uri - description: - URL-referentie naar de categorie in de gehanteerde 'Selectielijst - Archiefbescheiden' die, gezien het zaaktype en het resultaattype van de - zaak, bepalend is voor het archiefregime van de zaak. - title: selectielijstklasse - maxLength: 1000 - hoofdzaak: - type: string - format: uri - nullable: true - title: Is deelzaak van - description: - "URL-referentie naar de ZAAK, waarom verzocht is door de initiator\ - \ daarvan, die behandeld wordt in twee of meer separate ZAAKen waarvan\ - \ de onderhavige ZAAK er \xE9\xE9n is." - minLength: 1 - maxLength: 1000 - deelzaken: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: URL-referenties naar deel ZAAKen. - title: is deelzaak van - uniqueItems: true - relevanteAndereZaken: - type: array - items: - $ref: '#/components/schemas/RelevanteZaak' - description: Een lijst van relevante andere zaken. - title: zaak - eigenschappen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: zaak - uniqueItems: true - rollen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: zaak - uniqueItems: true - status: - type: string - format: uri - readOnly: true - nullable: true - description: Indien geen status bekend is, dan is de waarde 'null' - title: status - zaakinformatieobjecten: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: zaak - uniqueItems: true - zaakobjecten: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: zaak - uniqueItems: true - kenmerken: - type: array - items: - $ref: '#/components/schemas/ZaakKenmerk' - description: - Lijst van kenmerken. Merk op dat refereren naar gerelateerde - objecten beter kan via `ZaakObject`. - title: zaak - archiefnominatie: - nullable: true - description: - 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - - - Uitleg bij mogelijke waarden: - - - * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum - overgedragen worden naar een archiefbewaarplaats. - - * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd - worden.' - title: archiefnominatie - oneOf: - - $ref: '#/components/schemas/ArchiefnominatieEnum' - - $ref: '#/components/schemas/BlankEnum' - - $ref: '#/components/schemas/NullEnum' - archiefstatus: - allOf: - - $ref: '#/components/schemas/ArchiefstatusEnum' - description: - 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - - - Uitleg bij mogelijke waarden: - - - * `nog_te_archiveren` - De zaak cq. het zaakdossier is nog niet als geheel - gearchiveerd. - - * `gearchiveerd` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar - bewaarbaar gemaakt. - - * `gearchiveerd_procestermijn_onbekend` - De zaak cq. het zaakdossier - is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum - kan nog niet bepaald worden. - - * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een - archiefbewaarplaats.' - title: archiefstatus - archiefactiedatum: - type: string - format: date - nullable: true - description: - De datum waarop het gearchiveerde zaakdossier vernietigd moet - worden dan wel overgebracht moet worden naar een archiefbewaarplaats. - Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT - aan deze ZAAK indien nog leeg. - title: archiefactiedatum - resultaat: - type: string - format: uri - readOnly: true - nullable: true - description: - URL-referentie naar het RESULTAAT. Indien geen resultaat bekend - is, dan is de waarde 'null' - title: resultaat - opdrachtgevendeOrganisatie: - type: string - description: - De krachtens publiekrecht ingestelde rechtspersoon dan wel - ander niet-natuurlijk persoon waarbinnen het (bestuurs)orgaan zetelt dat - opdracht heeft gegeven om taken uit te voeren waaraan de zaak invulling - geeft. - title: opdrachtgevende organisatie - maxLength: 9 - processobjectaard: - type: string - nullable: true - title: Procesobjectaard - description: - Omschrijving van het object, subject of gebeurtenis waarop, - vanuit archiveringsoptiek, de zaak betrekking heeft. - maxLength: 200 - startdatumBewaartermijn: - type: string - format: date - nullable: true - description: - De datum die de start markeert van de termijn waarop het zaakdossier - vernietigd moet worden. - title: startdatum bewaartermijn - processobject: - allOf: - - $ref: '#/components/schemas/Processobject' - nullable: true - description: - Specificatie van de attribuutsoort van het object, subject - of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking - heeft en dat bepalend is voor de start van de archiefactietermijn. - title: processobject - PatchedZaakEigenschap: - type: object - description: - "A type of `ModelSerializer` that uses hyperlinked relationships - with compound keys instead - - of primary key relationships. Specifically: - - - * A 'url' field is included instead of the 'id' field. - - * Relationships to other instances are hyperlinks, instead of primary keys. - - - NOTE: this only works with DRF 3.1.0 and above." - properties: - url: - type: string - format: uri - readOnly: true - title: url - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - title: zaak - eigenschap: - type: string - format: uri - description: URL-referentie naar de EIGENSCHAP (in de Catalogi API). - title: eigenschap - maxLength: 1000 - naam: - type: string - readOnly: true - description: De naam van de EIGENSCHAP (overgenomen uit de Catalogi API). - title: ' naam' - waarde: - type: string - title: waarde - PatchedZaakInformatieObject: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - informatieobject: - type: string - format: uri - description: - URL-referentie naar het INFORMATIEOBJECT (in de Documenten - API), waar ook de relatieinformatie opgevraagd kan worden. - title: informatieobject - maxLength: 1000 - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - aardRelatieWeergave: - allOf: - - $ref: '#/components/schemas/AardRelatieWeergaveEnum' - readOnly: true - title: aardRelatieWeergave - titel: - type: string - description: - De naam waaronder het INFORMATIEOBJECT binnen het OBJECT bekend - is. - title: titel - maxLength: 200 - beschrijving: - type: string - description: - Een op het object gerichte beschrijving van de inhoud vanhet - INFORMATIEOBJECT. - title: beschrijving - registratiedatum: - type: string - format: date-time - readOnly: true - description: - De datum waarop de behandelende organisatie het INFORMATIEOBJECT - heeft geregistreerd bij het OBJECT. Geldige waardes zijn datumtijden gelegen - op of voor de huidige datum en tijd. - title: registratiedatum - vernietigingsdatum: - type: string - format: date-time - nullable: true - description: - De datum waarop het informatieobject uit het zaakdossier verwijderd - moet worden. - title: vernietigingsdatum - status: - type: string - format: uri - nullable: true - description: - De bij de desbetreffende ZAAK behorende STATUS waarvoor het - ZAAK-INFORMATIEOBJECT relevant is (geweest) met het oog op het bereiken - van die STATUS en/of de communicatie daarover. - title: status - minLength: 1 - maxLength: 1000 - PatchedZaakObject: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - object: - type: string - format: uri - description: URL-referentie naar de resource die het OBJECT beschrijft. - title: object - maxLength: 1000 - zaakobjecttype: - type: string - format: uri - description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API). - title: zaakobjecttype - maxLength: 1000 - objectType: - allOf: - - $ref: '#/components/schemas/ObjectTypeEnum' - description: - 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er - geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. - - - Uitleg bij mogelijke waarden: - - - * `adres` - Adres - - * `besluit` - Besluit - - * `buurt` - Buurt - - * `enkelvoudig_document` - Enkelvoudig document - - * `gemeente` - Gemeente - - * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte - - * `huishouden` - Huishouden - - * `inrichtingselement` - Inrichtingselement - - * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak - - * `kunstwerkdeel` - Kunstwerkdeel - - * `maatschappelijke_activiteit` - Maatschappelijke activiteit - - * `medewerker` - Medewerker - - * `natuurlijk_persoon` - Natuurlijk persoon - - * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon - - * `openbare_ruimte` - Openbare ruimte - - * `organisatorische_eenheid` - Organisatorische eenheid - - * `pand` - Pand - - * `spoorbaandeel` - Spoorbaandeel - - * `status` - Status - - * `terreindeel` - Terreindeel - - * `terrein_gebouwd_object` - Terrein gebouwd object - - * `vestiging` - Vestiging - - * `waterdeel` - Waterdeel - - * `wegdeel` - Wegdeel - - * `wijk` - Wijk - - * `woonplaats` - Woonplaats - - * `woz_deelobject` - Woz deel object - - * `woz_object` - Woz object - - * `woz_waarde` - Woz waarde - - * `zakelijk_recht` - Zakelijk recht - - * `overige` - Overige' - title: object type - objectTypeOverige: - type: string - description: - Beschrijft het type OBJECT als `objectType` de waarde "overige" - heeft. - title: object type overige - pattern: '[a-z\_]+' - maxLength: 100 - objectTypeOverigeDefinitie: - allOf: - - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie' - nullable: true - title: definitie object type overige - description: - 'Verwijzing naar het schema van het type OBJECT als `objectType` - de waarde "overige" heeft. - - - * De URL referentie moet naar een JSON endpoint wijzen waarin het objecttype - gedefinieerd is, inclusief het [JSON-schema](https://json-schema.org/). - - * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen de - objecttype resource (deze gebruikt het [jq](http://stedolan.github.io/jq/) - formaat. - - * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens binnen - het OBJECT. Deze gebruikt ook het [jq](http://stedolan.github.io/jq/) - formaat. - - - Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven - en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven - OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.' - relatieomschrijving: - type: string - description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. - title: relatieomschrijving - maxLength: 80 - discriminator: - propertyName: objectType - mapping: - adres: '#/components/schemas/adres_PatchedZaakObject' - besluit: '#/components/schemas/besluit_PatchedZaakObject' - buurt: '#/components/schemas/buurt_PatchedZaakObject' - enkelvoudig_document: '#/components/schemas/enkelvoudig_document_PatchedZaakObject' - gemeente: '#/components/schemas/gemeente_PatchedZaakObject' - gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_PatchedZaakObject' - huishouden: '#/components/schemas/huishouden_PatchedZaakObject' - inrichtingselement: '#/components/schemas/inrichtingselement_PatchedZaakObject' - kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_PatchedZaakObject' - kunstwerkdeel: '#/components/schemas/kunstwerkdeel_PatchedZaakObject' - maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_PatchedZaakObject' - medewerker: '#/components/schemas/medewerker_PatchedZaakObject' - natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_PatchedZaakObject' - niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_PatchedZaakObject' - openbare_ruimte: '#/components/schemas/openbare_ruimte_PatchedZaakObject' - organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_PatchedZaakObject' - pand: '#/components/schemas/pand_PatchedZaakObject' - spoorbaandeel: '#/components/schemas/spoorbaandeel_PatchedZaakObject' - status: '#/components/schemas/status_PatchedZaakObject' - terreindeel: '#/components/schemas/terreindeel_PatchedZaakObject' - terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_PatchedZaakObject' - vestiging: '#/components/schemas/vestiging_PatchedZaakObject' - waterdeel: '#/components/schemas/waterdeel_PatchedZaakObject' - wegdeel: '#/components/schemas/wegdeel_PatchedZaakObject' - wijk: '#/components/schemas/wijk_PatchedZaakObject' - woonplaats: '#/components/schemas/woonplaats_PatchedZaakObject' - woz_deelobject: '#/components/schemas/woz_deelobject_PatchedZaakObject' - woz_object: '#/components/schemas/woz_object_PatchedZaakObject' - woz_waarde: '#/components/schemas/woz_waarde_PatchedZaakObject' - zakelijk_recht: '#/components/schemas/zakelijk_recht_PatchedZaakObject' - overige: '#/components/schemas/overige_PatchedZaakObject' - Point: - title: Point - description: GeoJSON point geometry - type: object - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.2 - allOf: - - $ref: '#/components/schemas/Geometry' - - type: object - required: - - coordinates - properties: - coordinates: - $ref: '#/components/schemas/Point2D' - Point2D: - title: Point2D - type: array - items: - type: number - maxItems: 2 - minItems: 2 - Polygon: - title: Polygon - description: GeoJSON polygon geometry - type: object - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.6 - allOf: - - $ref: '#/components/schemas/Geometry' - - type: object - required: - - coordinates - properties: - coordinates: - type: array - items: - type: array - items: - $ref: '#/components/schemas/Point2D' - Processobject: - type: object - description: - Specificatie van de attribuutsoort van het object, subject of gebeurtenis waarop, - vanuit archiveringsoptiek, de zaak betrekking heeft en dat bepalend is voor - de start van de archiefactietermijn. - properties: - datumkenmerk: - type: string - description: - De naam van de attribuutsoort van het procesobject dat bepalend - is voor het einde van de procestermijn. - title: datumkenmerk - maxLength: 250 - identificatie: - type: string - description: De unieke aanduiding van het procesobject. - title: identificatie - maxLength: 250 - objecttype: - type: string - description: Het soort object dat het procesobject representeert. - title: objecttype - maxLength: 250 - registratie: - type: string - description: - De naam van de registratie waarvan het procesobject deel uit - maakt. - title: registratie - maxLength: 250 - required: - - datumkenmerk - - identificatie - - objecttype - - registratie - nullable: true - RelevanteZaak: - type: object - properties: - url: - type: string - format: uri - title: URL-referentie naar de ZAAK. - maxLength: 1000 - aardRelatie: - allOf: - - $ref: '#/components/schemas/AardRelatieEnum' - description: - 'Benamingen van de aard van de relaties van andere zaken tot - (onderhanden) zaken. - - - Uitleg bij mogelijke waarden: - - - * `vervolg` - De andere zaak gaf aanleiding tot het starten van de onderhanden - zaak. - - * `onderwerp` - De andere zaak is relevant voor cq. is onderwerp van de - onderhanden zaak. - - * `bijdrage` - Aan het bereiken van de uitkomst van de andere zaak levert - de onderhanden zaak een bijdrage.' - title: aard relatie - required: - - aardRelatie - - url - Resultaat: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - resultaattype: - type: string - format: uri - description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API). - title: resultaattype - maxLength: 1000 - toelichting: - type: string - description: Een toelichting op wat het resultaat van de zaak inhoudt. - title: toelichting - maxLength: 1000 - required: - - resultaattype - - url - - uuid - - zaak - ResultaatExpanded: - allOf: - - $ref: '#/components/schemas/Resultaat' - - properties: - _expand: - $ref: '#/components/schemas/ResultaatEmbedded' - ResultaatEmbedded: - type: object - properties: - zaak: - $ref: '#/components/schemas/ZaakExpanded' - resultaattype: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/ResultaatTypeExpanded' - Rol: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - betrokkene: - type: string - format: uri - description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. - title: betrokkene - maxLength: 1000 - betrokkeneType: - allOf: - - $ref: '#/components/schemas/BetrokkeneTypeEnum' - description: 'Type van de `betrokkene`. - - - Uitleg bij mogelijke waarden: - - - * `natuurlijk_persoon` - Natuurlijk persoon - - * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon - - * `vestiging` - Vestiging - - * `organisatorische_eenheid` - Organisatorische eenheid - - * `medewerker` - Medewerker' - title: betrokkene type - afwijkendeNaamBetrokkene: - type: string - description: - De naam van de betrokkene waaronder deze in relatie tot de - zaak aangesproken wil worden. - title: afwijkende naam betrokkene - maxLength: 625 - roltype: - type: string - format: uri - description: - URL-referentie naar een roltype binnen het ZAAKTYPE van de - ZAAK. - title: roltype - maxLength: 1000 - omschrijving: - type: string - readOnly: true - description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. - title: omschrijving - omschrijvingGeneriek: - type: string - readOnly: true - description: - "Algemeen gehanteerde benaming van de aard van de ROL, afgeleid\ - \ uit het ROLTYPE.\n\nUitleg bij mogelijke waarden:\n\n* `adviseur` -\ - \ (Adviseur) Kennis in dienst stellen van de behandeling van (een deel\ - \ van) een zaak.\n* `behandelaar` - (Behandelaar) De vakinhoudelijke behandeling\ - \ doen van (een deel van) een zaak.\n* `belanghebbende` - (Belanghebbende)\ - \ Vanuit eigen en objectief belang rechtstreeks betrokken zijn bij de\ - \ behandeling en/of de uitkomst van een zaak.\n* `beslisser` - (Beslisser)\ - \ Nemen van besluiten die voor de uitkomst van een zaak noodzakelijk zijn.\n\ - * `initiator` - (Initiator) Aanleiding geven tot de start van een zaak\ - \ ..\n* `klantcontacter` - (Klantcontacter) Het eerste aanspreekpunt zijn\ - \ voor vragen van burgers en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6\ - rdinator) Er voor zorg dragen dat de behandeling van de zaak in samenhang\ - \ uitgevoerd wordt conform de daarover gemaakte afspraken.\n* `mede_initiator`\ - \ - Mede-initiator" - title: omschrijving generiek - roltoelichting: - type: string - title: roltoelichting - maxLength: 1000 - registratiedatum: - type: string - format: date-time - readOnly: true - description: De datum waarop dit object is geregistreerd. - title: registratiedatum - indicatieMachtiging: - description: 'Indicatie machtiging - - - Uitleg bij mogelijke waarden: - - - * `gemachtigde` - De betrokkene in de rol bij de zaak is door een andere - betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen - - * `machtiginggever` - De betrokkene in de rol bij de zaak heeft een andere - betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen' - title: indicatie machtiging - oneOf: - - $ref: '#/components/schemas/IndicatieMachtigingEnum' - - $ref: '#/components/schemas/BlankEnum' - contactpersoonRol: - allOf: - - $ref: '#/components/schemas/ContactPersoonRol' - nullable: true - description: - De gegevens van de persoon die anderen desgevraagd in contact - brengt met medewerkers van de BETROKKENE, een NIET-NATUURLIJK PERSOON - of VESTIGING zijnde, of met BETROKKENE zelf, een NATUURLIJK PERSOON zijnde - , vanuit het belang van BETROKKENE in haar ROL bij een ZAAK. - title: contactpersoonRol - statussen: - type: array - items: - type: string - format: uri - title: '' - minLength: 1 - maxLength: 1000 - readOnly: true - description: - De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd - dat STATUSsen in die ZAAK bereikt zijn. - title: statussen - uniqueItems: true - required: - - betrokkeneType - - omschrijving - - omschrijvingGeneriek - - registratiedatum - - roltoelichting - - roltype - - statussen - - url - - uuid - - zaak - discriminator: - propertyName: betrokkeneType - mapping: - medewerker: '#/components/schemas/medewerker_Rol' - natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_Rol' - niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_Rol' - organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_Rol' - vestiging: '#/components/schemas/vestiging_Rol' - RolExpanded: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - betrokkene: - type: string - format: uri - description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. - title: betrokkene - maxLength: 1000 - betrokkeneType: - allOf: - - $ref: '#/components/schemas/BetrokkeneTypeEnum' - description: 'Type van de `betrokkene`. - - - Uitleg bij mogelijke waarden: - - - * `natuurlijk_persoon` - Natuurlijk persoon - - * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon - - * `vestiging` - Vestiging - - * `organisatorische_eenheid` - Organisatorische eenheid - - * `medewerker` - Medewerker' - title: betrokkene type - afwijkendeNaamBetrokkene: - type: string - description: - De naam van de betrokkene waaronder deze in relatie tot de - zaak aangesproken wil worden. - title: afwijkende naam betrokkene - maxLength: 625 - roltype: - type: string - format: uri - description: - URL-referentie naar een roltype binnen het ZAAKTYPE van de - ZAAK. - title: roltype - maxLength: 1000 - omschrijving: - type: string - readOnly: true - description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. - title: omschrijving - omschrijvingGeneriek: - type: string - readOnly: true - description: - "Algemeen gehanteerde benaming van de aard van de ROL, afgeleid\ - \ uit het ROLTYPE.\n\nUitleg bij mogelijke waarden:\n\n* `adviseur` -\ - \ (Adviseur) Kennis in dienst stellen van de behandeling van (een deel\ - \ van) een zaak.\n* `behandelaar` - (Behandelaar) De vakinhoudelijke behandeling\ - \ doen van (een deel van) een zaak.\n* `belanghebbende` - (Belanghebbende)\ - \ Vanuit eigen en objectief belang rechtstreeks betrokken zijn bij de\ - \ behandeling en/of de uitkomst van een zaak.\n* `beslisser` - (Beslisser)\ - \ Nemen van besluiten die voor de uitkomst van een zaak noodzakelijk zijn.\n\ - * `initiator` - (Initiator) Aanleiding geven tot de start van een zaak\ - \ ..\n* `klantcontacter` - (Klantcontacter) Het eerste aanspreekpunt zijn\ - \ voor vragen van burgers en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6\ - rdinator) Er voor zorg dragen dat de behandeling van de zaak in samenhang\ - \ uitgevoerd wordt conform de daarover gemaakte afspraken.\n* `mede_initiator`\ - \ - Mede-initiator" - title: omschrijving generiek - roltoelichting: - type: string - title: roltoelichting - maxLength: 1000 - registratiedatum: - type: string - format: date-time - readOnly: true - description: De datum waarop dit object is geregistreerd. - title: registratiedatum - indicatieMachtiging: - description: 'Indicatie machtiging - - - Uitleg bij mogelijke waarden: - - - * `gemachtigde` - De betrokkene in de rol bij de zaak is door een andere - betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen - - * `machtiginggever` - De betrokkene in de rol bij de zaak heeft een andere - betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen' - title: indicatie machtiging - oneOf: - - $ref: '#/components/schemas/IndicatieMachtigingEnum' - - $ref: '#/components/schemas/BlankEnum' - contactpersoonRol: - allOf: - - $ref: '#/components/schemas/ContactPersoonRol' - nullable: true - description: - De gegevens van de persoon die anderen desgevraagd in contact - brengt met medewerkers van de BETROKKENE, een NIET-NATUURLIJK PERSOON - of VESTIGING zijnde, of met BETROKKENE zelf, een NATUURLIJK PERSOON zijnde - , vanuit het belang van BETROKKENE in haar ROL bij een ZAAK. - title: contactpersoonRol - statussen: - type: array - items: - type: string - format: uri - title: '' - minLength: 1 - maxLength: 1000 - readOnly: true - description: - De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd - dat STATUSsen in die ZAAK bereikt zijn. - title: statussen - uniqueItems: true - _expand: - $ref: '#/components/schemas/RolEmbedded' - required: - - betrokkeneType - - omschrijving - - omschrijvingGeneriek - - registratiedatum - - roltoelichting - - roltype - - statussen - - url - - uuid - - zaak - discriminator: - propertyName: betrokkeneType - mapping: - medewerker: '#/components/schemas/medewerker_RolExpanded' - natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_RolExpanded' - niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_RolExpanded' - organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_RolExpanded' - vestiging: '#/components/schemas/vestiging_RolExpanded' - - RolEmbedded: - type: object - properties: - zaak: - $ref: '#/components/schemas/ZaakExpanded' - example: {} - roltype: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/RolTypeExpanded' - statussen: - type: array - items: - $ref: '#/components/schemas/StatusExpanded' - RolMedewerker: - type: object - properties: - identificatie: - type: string - description: Een korte unieke aanduiding van de MEDEWERKER. - title: identificatie - maxLength: 24 - achternaam: - type: string - description: - De achternaam zoals de MEDEWERKER die in het dagelijkse verkeer - gebruikt. - title: achternaam - maxLength: 200 - voorletters: - type: string - description: - De verzameling letters die gevormd wordt door de eerste letter - van alle in volgorde voorkomende voornamen. - title: voorletters - maxLength: 20 - voorvoegselAchternaam: - type: string - description: - Dat deel van de geslachtsnaam dat voorkomt in Tabel 36 (GBA), - voorvoegseltabel, en door een spatie van de geslachtsnaam is - title: voorvoegsel achternaam - maxLength: 10 - RolNatuurlijkPersoon: - type: object - properties: - inpBsn: - type: string - description: - Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet - algemene bepalingen burgerservicenummer. - title: inp bsn - maxLength: 9 - anpIdentificatie: - type: string - description: - Het door de gemeente uitgegeven unieke nummer voor een ANDER - NATUURLIJK PERSOON - title: anp identificatie - maxLength: 17 - inpA_nummer: - type: string - description: Het administratienummer van de persoon, bedoeld in de Wet BRP - title: inp a nummer - pattern: ^[1-9][0-9]{9}$ - maxLength: 10 - geslachtsnaam: - type: string - description: De stam van de geslachtsnaam. - title: geslachtsnaam - maxLength: 200 - voorvoegselGeslachtsnaam: - type: string - title: voorvoegsel geslachtsnaam - maxLength: 80 - voorletters: - type: string - description: - De verzameling letters die gevormd wordt door de eerste letter - van alle in volgorde voorkomende voornamen. - title: voorletters - maxLength: 20 - voornamen: - type: string - description: Voornamen bij de naam die de persoon wenst te voeren. - title: voornamen - maxLength: 200 - geslachtsaanduiding: - description: - 'Een aanduiding die aangeeft of de persoon een man of een vrouw - is, of dat het geslacht nog onbekend is. - - - Uitleg bij mogelijke waarden: - - - * `m` - Man - - * `v` - Vrouw - - * `o` - Onbekend' - title: geslachtsaanduiding - oneOf: - - $ref: '#/components/schemas/GeslachtsaanduidingEnum' - - $ref: '#/components/schemas/BlankEnum' - geboortedatum: - type: string - title: geboortedatum - maxLength: 18 - verblijfsadres: - allOf: - - $ref: '#/components/schemas/VerblijfsAdres' - nullable: true - title: verblijfsadres - subVerblijfBuitenland: - allOf: - - $ref: '#/components/schemas/SubVerblijfBuitenland' - nullable: true - title: subVerblijfBuitenland - RolNietNatuurlijkPersoon: - type: object - properties: - innNnpId: - type: string - description: - Het door een kamer toegekend uniek nummer voor de INGESCHREVEN - NIET-NATUURLIJK PERSOON - title: inn nnp id - maxLength: 9 - annIdentificatie: - type: string - description: - Het door de gemeente uitgegeven unieke nummer voor een ANDER - NIET-NATUURLIJK PERSOON - title: ann identificatie - maxLength: 17 - statutaireNaam: - type: string - description: - Naam van de niet-natuurlijke persoon zoals deze is vastgelegd - in de statuten (rechtspersoon) of in de vennootschapsovereenkomst is overeengekomen - (Vennootschap onder firma of Commanditaire vennootschap). - title: statutaire naam - maxLength: 500 - innRechtsvorm: - description: De juridische vorm van de NIET-NATUURLIJK PERSOON. - title: inn rechtsvorm - oneOf: - - $ref: '#/components/schemas/InnRechtsvormEnum' - - $ref: '#/components/schemas/BlankEnum' - bezoekadres: - type: string - description: De gegevens over het adres van de NIET-NATUURLIJK PERSOON - title: bezoekadres - maxLength: 1000 - subVerblijfBuitenland: - allOf: - - $ref: '#/components/schemas/SubVerblijfBuitenland' - nullable: true - title: subVerblijfBuitenland - RolOrganisatorischeEenheid: - type: object - properties: - identificatie: - type: string - description: Een korte identificatie van de organisatorische eenheid. - title: identificatie - maxLength: 24 - naam: - type: string - description: De feitelijke naam van de organisatorische eenheid. - title: naam - maxLength: 50 - isGehuisvestIn: - type: string - title: is gehuisvest in - maxLength: 24 - RolVestiging: - type: object - properties: - vestigingsNummer: - type: string - description: Een korte unieke aanduiding van de Vestiging. - title: vestigings nummer - maxLength: 24 - handelsnaam: - type: array - items: - type: string - maxLength: 625 - description: De naam van de vestiging waaronder gehandeld wordt. - title: handelsnaam - verblijfsadres: - allOf: - - $ref: '#/components/schemas/VerblijfsAdres' - nullable: true - title: verblijfsadres - subVerblijfBuitenland: - allOf: - - $ref: '#/components/schemas/SubVerblijfBuitenland' - nullable: true - title: subVerblijfBuitenland - kvkNummer: - type: string - description: Een uniek nummer gekoppeld aan de onderneming. - title: kvk nummer - maxLength: 8 - Status: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - statustype: - type: string - format: uri - description: URL-referentie naar het STATUSTYPE (in de Catalogi API). - title: statustype - maxLength: 1000 - datumStatusGezet: - type: string - format: date-time - description: De datum waarop de ZAAK de status heeft verkregen. - title: datum status gezet - statustoelichting: - type: string - description: - Een, voor de initiator van de zaak relevante, toelichting op - de status van een zaak. - title: statustoelichting - maxLength: 1000 - indicatieLaatstGezetteStatus: - type: boolean - readOnly: true - description: - Het gegeven is afleidbaar uit de historie van de attribuutsoort - Datum status gezet van van alle statussen bij de desbetreffende zaak. - title: indicatieLaatstGezetteStatus - gezetdoor: - type: string - format: uri - title: Gezet door - description: - De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd - dat STATUSsen in die ZAAK bereikt zijn. - maxLength: 200 - zaakinformatieobjecten: - type: array - items: - type: string - format: uri - title: '' - minLength: 1 - maxLength: 1000 - readOnly: true - title: zaakInformatieobjecten - uniqueItems: true - required: - - datumStatusGezet - - indicatieLaatstGezetteStatus - - statustype - - url - - uuid - - zaak - - zaakinformatieobjecten - StatusExpanded: - allOf: - - $ref: '#/components/schemas/Status' - - properties: - _expand: - $ref: '#/components/schemas/StatusEmbedded' - StatusEmbedded: - type: object - properties: - statustype: - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/StatusTypeExpanded' - gezetdoor: - $ref: '#/components/schemas/Rol' - zaakinformatieobjecten: - type: array - items: - $ref: '#/components/schemas/ZaakInformatieObject' - StatusRequestbody: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - statustype: - type: string - format: uri - description: URL-referentie naar het STATUSTYPE (in de Catalogi API). - title: statustype - maxLength: 1000 - datumStatusGezet: - type: string - format: date-time - description: De datum waarop de ZAAK de status heeft verkregen. - title: datum status gezet - statustoelichting: - type: string - description: - Een, voor de initiator van de zaak relevante, toelichting op - de status van een zaak. - title: statustoelichting - maxLength: 1000 - indicatieLaatstGezetteStatus: - type: boolean - readOnly: true - description: - Het gegeven is afleidbaar uit de historie van de attribuutsoort - Datum status gezet van van alle statussen bij de desbetreffende zaak. - title: indicatieLaatstGezetteStatus - gezetdoor: - type: string - format: uri - title: Gezet door - description: - De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd - dat STATUSsen in die ZAAK bereikt zijn. - maxLength: 200 - required: - - datumStatusGezet - - indicatieLaatstGezetteStatus - - statustype - - url - - uuid - - zaak - - zaakinformatieobjecten - SubVerblijfBuitenland: - type: object - properties: - lndLandcode: - type: string - description: - De code, behorende bij de landnaam, zoals opgenomen in de Land/Gebied-tabel - van de BRP. - title: lnd landcode - maxLength: 4 - lndLandnaam: - type: string - description: - De naam van het land, zoals opgenomen in de Land/Gebied-tabel - van de BRP. - title: lnd landnaam - maxLength: 40 - subAdresBuitenland_1: - type: string - title: sub adres buitenland 1 - maxLength: 35 - subAdresBuitenland_2: - type: string - title: sub adres buitenland 2 - maxLength: 35 - subAdresBuitenland_3: - type: string - title: sub adres buitenland 3 - maxLength: 35 - required: - - lndLandcode - - lndLandnaam - TerreinGebouwdObjectAdres: - type: object - properties: - numIdentificatie: - type: string - title: num identificatie - maxLength: 100 - oaoIdentificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - wplWoonplaatsNaam: - type: string - title: wpl woonplaats naam - maxLength: 80 - gorOpenbareRuimteNaam: - type: string - description: - Een door het bevoegde gemeentelijke orgaan aan een OPENBARE - RUIMTE toegekende benaming - title: gor openbare ruimte naam - maxLength: 80 - aoaPostcode: - type: string - title: postcode - maxLength: 7 - aoaHuisnummer: - type: integer - maximum: 99999 - minimum: 0 - title: huisnummer - aoaHuisletter: - type: string - title: huisletter - maxLength: 1 - aoaHuisnummertoevoeging: - type: string - title: huisnummertoevoeging - maxLength: 4 - ogoLocatieAanduiding: - type: string - title: locatie aanduiding - maxLength: 100 - required: - - aoaHuisnummer - - gorOpenbareRuimteNaam - - oaoIdentificatie - - wplWoonplaatsNaam - TypeWaterdeelEnum: - enum: - - zee - - waterloop - - watervlakte - - greppel_droge_sloot - type: string - ValidatieFout: - type: object - description: Formaat van HTTP 4xx en 5xx fouten. - properties: - type: - type: string - description: URI referentie naar het type fout, bedoeld voor developers - title: type - code: - type: string - description: Systeemcode die het type fout aangeeft - title: code - title: - type: string - description: Generieke titel voor het type fout - title: title - status: - type: integer - description: De HTTP status code - title: status - detail: - type: string - description: Extra informatie bij de fout, indien beschikbaar - title: detail - instance: - type: string - description: - URI met referentie naar dit specifiek voorkomen van de fout. - Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. - title: instance - invalidParams: - type: array - items: - $ref: '#/components/schemas/FieldValidationError' - title: invalidParams - required: - - code - - detail - - instance - - invalidParams - - status - - title - VerblijfsAdres: - type: object - properties: - aoaIdentificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - wplWoonplaatsNaam: - type: string - title: wpl woonplaats naam - maxLength: 80 - gorOpenbareRuimteNaam: - type: string - description: - Een door het bevoegde gemeentelijke orgaan aan een OPENBARE - RUIMTE toegekende benaming - title: gor openbare ruimte naam - maxLength: 80 - aoaPostcode: - type: string - title: postcode - maxLength: 7 - aoaHuisnummer: - type: integer - maximum: 99999 - minimum: 0 - title: huisnummer - aoaHuisletter: - type: string - title: huisletter - maxLength: 1 - aoaHuisnummertoevoeging: - type: string - title: huisnummertoevoeging - maxLength: 4 - inpLocatiebeschrijving: - type: string - title: locatie omschrijving - maxLength: 1000 - required: - - aoaHuisnummer - - aoaIdentificatie - - gorOpenbareRuimteNaam - - wplWoonplaatsNaam - Verlenging: - type: object - description: - Gegevens omtrent het verlengen van de doorlooptijd van de behandeling - van de ZAAK - properties: - reden: - type: string - description: - Omschrijving van de reden voor het verlengen van de behandeling - van de zaak. - title: reden verlenging - maxLength: 200 - duur: - type: string - description: - Het aantal werkbare dagen waarmee de doorlooptijd van de behandeling - van de ZAAK is verlengd (of verkort) ten opzichte van de eerder gecommuniceerde - doorlooptijd. - title: duur verlenging - format: duration - required: - - duur - - reden - nullable: true - VertrouwelijkheidaanduidingEnum: - enum: - - openbaar - - beperkt_openbaar - - intern - - zaakvertrouwelijk - - vertrouwelijk - - confidentieel - - geheim - - zeer_geheim - type: string - Wijzigingen: - type: object - properties: - oud: - type: object - additionalProperties: {} - description: - Volledige JSON body van het object zoals dat bestond voordat - de actie heeft plaatsgevonden. - title: oud - nieuw: - type: object - additionalProperties: {} - description: Volledige JSON body van het object na de actie. - title: nieuw - WozObjectAdres: - type: object - properties: - aoaIdentificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - wplWoonplaatsNaam: - type: string - title: wpl woonplaats naam - maxLength: 80 - gorOpenbareRuimteNaam: - type: string - description: - Een door het bevoegde gemeentelijke orgaan aan een OPENBARE - RUIMTE toegekende benaming - title: gor openbare ruimte naam - maxLength: 80 - aoaPostcode: - type: string - title: postcode - maxLength: 7 - aoaHuisnummer: - type: integer - maximum: 99999 - minimum: 0 - title: huisnummer - aoaHuisletter: - type: string - title: huisletter - maxLength: 1 - aoaHuisnummertoevoeging: - type: string - title: huisnummertoevoeging - maxLength: 4 - locatieOmschrijving: - type: string - title: locatie omschrijving - maxLength: 1000 - required: - - aoaHuisnummer - - aoaIdentificatie - - gorOpenbareRuimteNaam - - wplWoonplaatsNaam - Zaak: - type: object - description: 'Set gegevensgroepdata from validated nested data. - - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - identificatie: - type: string - description: - De unieke identificatie van de ZAAK binnen de organisatie die - verantwoordelijk is voor de behandeling van de ZAAK. - title: identificatie - maxLength: 40 - bronorganisatie: - type: string - description: - Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers - en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef - title: bronorganisatie - maxLength: 9 - omschrijving: - type: string - description: Een korte omschrijving van de zaak. - title: omschrijving - maxLength: 80 - toelichting: - type: string - description: Een toelichting op de zaak. - title: toelichting - maxLength: 1000 - zaaktype: - type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de - CATALOGUS waar deze voorkomt - title: zaaktype - maxLength: 1000 - registratiedatum: - type: string - format: date - description: - De datum waarop de zaakbehandelende organisatie de ZAAK heeft - geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag - gebruikt. - title: registratiedatum - verantwoordelijkeOrganisatie: - type: string - description: - Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die eindverantwoordelijk is voor de behandeling van de zaak. Dit moet - een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef - title: verantwoordelijke organisatie - maxLength: 9 - startdatum: - type: string - format: date - description: De datum waarop met de uitvoering van de zaak is gestart - title: startdatum - einddatum: - type: string - format: date - readOnly: true - nullable: true - description: De datum waarop de uitvoering van de zaak afgerond is. - title: einddatum - einddatumGepland: - type: string - format: date - nullable: true - description: - De datum waarop volgens de planning verwacht wordt dat de zaak - afgerond wordt. - title: einddatum gepland - uiterlijkeEinddatumAfdoening: - type: string - format: date - nullable: true - description: - De laatste datum waarop volgens wet- en regelgeving de zaak - afgerond dient te zijn. - title: uiterlijke einddatum afdoening - publicatiedatum: - type: string - format: date - nullable: true - description: Datum waarop (het starten van) de zaak gepubliceerd is of wordt. - title: publicatiedatum - communicatiekanaal: - type: string - format: uri - description: - Het medium waarlangs de aanleiding om een zaak te starten is - ontvangen. URL naar een communicatiekanaal in de VNG-Referentielijst van - communicatiekanalen. - title: communicatiekanaal - maxLength: 1000 - productenOfDiensten: - type: array - items: - type: string - format: uri - title: URL naar product/dienst - maxLength: 1000 - description: - De producten en/of diensten die door de zaak worden voortgebracht. - Dit zijn URLs naar de resources zoals die door de producten- en dienstencatalogus-API - wordt ontsloten. De producten/diensten moeten bij het zaaktype vermeld - zijn. - title: producten of diensten - vertrouwelijkheidaanduiding: - allOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - title: Vertrouwlijkheidaanduiding - description: - Aanduiding van de mate waarin het zaakdossier van de ZAAK voor - de openbaarheid bestemd is. Optioneel - indien geen waarde gekozen wordt, - dan wordt de waarde van het ZAAKTYPE overgenomen. Dit betekent dat de - API _altijd_ een waarde teruggeeft. - betalingsindicatie: - description: - 'Indicatie of de, met behandeling van de zaak gemoeide, kosten - betaald zijn door de desbetreffende betrokkene. - - - Uitleg bij mogelijke waarden: - - - * `nvt` - Er is geen sprake van te betalen, met de zaak gemoeide, kosten. - - * `nog_niet` - De met de zaak gemoeide kosten zijn (nog) niet betaald. - - * `gedeeltelijk` - De met de zaak gemoeide kosten zijn gedeeltelijk betaald. - - * `geheel` - De met de zaak gemoeide kosten zijn geheel betaald.' - title: betalingsindicatie - oneOf: - - $ref: '#/components/schemas/BetalingsindicatieEnum' - - $ref: '#/components/schemas/BlankEnum' - betalingsindicatieWeergave: - type: string - readOnly: true - description: Uitleg bij `betalingsindicatie`. - title: betalingsindicatieWeergave - laatsteBetaaldatum: - type: string - format: date-time - nullable: true - description: - De datum waarop de meest recente betaling is verwerkt van kosten - die gemoeid zijn met behandeling van de zaak. - title: laatste betaaldatum - zaakgeometrie: - allOf: - - $ref: '#/components/schemas/GeoJSONGeometry' - nullable: true - description: Punt, lijn of (multi-)vlak geometrie-informatie, in GeoJSON. - title: zaakgeometrie - verlenging: - allOf: - - $ref: '#/components/schemas/Verlenging' - nullable: true - description: - Gegevens omtrent het verlengen van de doorlooptijd van de behandeling - van de ZAAK - title: verlenging - opschorting: - allOf: - - $ref: '#/components/schemas/Opschorting' - nullable: true - description: - Gegevens omtrent het tijdelijk opschorten van de behandeling - van de ZAAK - title: opschorting - selectielijstklasse: - type: string - format: uri - description: - URL-referentie naar de categorie in de gehanteerde 'Selectielijst - Archiefbescheiden' die, gezien het zaaktype en het resultaattype van de - zaak, bepalend is voor het archiefregime van de zaak. - title: selectielijstklasse - maxLength: 1000 - hoofdzaak: - type: string - format: uri - nullable: true - title: Is deelzaak van - description: - "URL-referentie naar de ZAAK, waarom verzocht is door de initiator\ - \ daarvan, die behandeld wordt in twee of meer separate ZAAKen waarvan\ - \ de onderhavige ZAAK er \xE9\xE9n is." - minLength: 1 - maxLength: 1000 - deelzaken: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: URL-referenties naar deel ZAAKen. - title: is deelzaak van - uniqueItems: true - relevanteAndereZaken: - type: array - items: - $ref: '#/components/schemas/RelevanteZaak' - description: Een lijst van relevante andere zaken. - title: zaak - eigenschappen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: zaak - uniqueItems: true - rollen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: zaak - uniqueItems: true - status: - type: string - format: uri - readOnly: true - nullable: true - description: Indien geen status bekend is, dan is de waarde 'null' - title: status - zaakinformatieobjecten: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: zaak - uniqueItems: true - zaakobjecten: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: zaak - uniqueItems: true - kenmerken: - type: array - items: - $ref: '#/components/schemas/ZaakKenmerk' - description: - Lijst van kenmerken. Merk op dat refereren naar gerelateerde - objecten beter kan via `ZaakObject`. - title: zaak - archiefnominatie: - nullable: true - description: - 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - - - Uitleg bij mogelijke waarden: - - - * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum - overgedragen worden naar een archiefbewaarplaats. - - * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd - worden.' - title: archiefnominatie - oneOf: - - $ref: '#/components/schemas/ArchiefnominatieEnum' - - $ref: '#/components/schemas/BlankEnum' - - $ref: '#/components/schemas/NullEnum' - archiefstatus: - allOf: - - $ref: '#/components/schemas/ArchiefstatusEnum' - description: - 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - - - Uitleg bij mogelijke waarden: - - - * `nog_te_archiveren` - De zaak cq. het zaakdossier is nog niet als geheel - gearchiveerd. - - * `gearchiveerd` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar - bewaarbaar gemaakt. - - * `gearchiveerd_procestermijn_onbekend` - De zaak cq. het zaakdossier - is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum - kan nog niet bepaald worden. - - * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een - archiefbewaarplaats.' - title: archiefstatus - archiefactiedatum: - type: string - format: date - nullable: true - description: - De datum waarop het gearchiveerde zaakdossier vernietigd moet - worden dan wel overgebracht moet worden naar een archiefbewaarplaats. - Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT - aan deze ZAAK indien nog leeg. - title: archiefactiedatum - resultaat: - type: string - format: uri - readOnly: true - nullable: true - description: - URL-referentie naar het RESULTAAT. Indien geen resultaat bekend - is, dan is de waarde 'null' - title: resultaat - opdrachtgevendeOrganisatie: - type: string - description: - De krachtens publiekrecht ingestelde rechtspersoon dan wel - ander niet-natuurlijk persoon waarbinnen het (bestuurs)orgaan zetelt dat - opdracht heeft gegeven om taken uit te voeren waaraan de zaak invulling - geeft. - title: opdrachtgevende organisatie - maxLength: 9 - processobjectaard: - type: string - nullable: true - title: Procesobjectaard - description: - Omschrijving van het object, subject of gebeurtenis waarop, - vanuit archiveringsoptiek, de zaak betrekking heeft. - maxLength: 200 - startdatumBewaartermijn: - type: string - format: date - nullable: true - description: - De datum die de start markeert van de termijn waarop het zaakdossier - vernietigd moet worden. - title: startdatum bewaartermijn - processobject: - allOf: - - $ref: '#/components/schemas/Processobject' - nullable: true - description: - Specificatie van de attribuutsoort van het object, subject - of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking - heeft en dat bepalend is voor de start van de archiefactietermijn. - title: processobject - required: - - betalingsindicatieWeergave - - bronorganisatie - - deelzaken - - eigenschappen - - einddatum - - resultaat - - rollen - - startdatum - - status - - url - - uuid - - verantwoordelijkeOrganisatie - - zaakinformatieobjecten - - zaakobjecten - - zaaktype - ZaakExpanded: - allOf: - - $ref: '#/components/schemas/Zaak' - - properties: - _expand: - $ref: '#/components/schemas/ZaakEmbedded' - ZaakEmbedded: - type: object - properties: - zaaktype: - - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' - hoofdzaak: - oneOf: - - $ref: '#/components/schemas/ZaakExpanded' - - $ref: '#/components/schemas/EmptyObject' - example: {} - deelzaken: - type: array - items: - $ref: '#/components/schemas/ZaakExpanded' - example: [{}] - relevanteAndereZaken: - type: array - items: - $ref: '#/components/schemas/ZaakExpanded' - example: [{}] - eigenschappen: - type: array - items: - $ref: '#/components/schemas/ZaakEigenschapExpanded' - rollen: - type: array - items: - $ref: '#/components/schemas/RolExpanded' - status: - oneOf: - - $ref: '#/components/schemas/StatusExpanded' - - $ref: '#/components/schemas/EmptyObject' - zaakobjecten: - type: array - items: - $ref: '#/components/schemas/ZaakObjectExpanded' - resultaat: - oneOf: - - $ref: '#/components/schemas/ResultaatExpanded' - - $ref: '#/components/schemas/EmptyObject' - EmptyObject: - type: object - description: Leeg object. Dit wordt teruggeven indien het te expanderen veld een null waarde heeft. - example: {} - ExpandCatalogusObject: - type: object - properties: - _expand: - type: object - description: Zie de Catalogus API hoe dit object verder geëxpandeerd kan worden. - ZaakBesluit: - type: object - description: - "A type of `ModelSerializer` that uses hyperlinked relationships - with compound keys instead - - of primary key relationships. Specifically: - - - * A 'url' field is included instead of the 'id' field. - - * Relationships to other instances are hyperlinks, instead of primary keys. - - - NOTE: this only works with DRF 3.1.0 and above." - properties: - url: - type: string - format: uri - readOnly: true - title: url - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - besluit: - type: string - format: uri - description: - URL-referentie naar het BESLUIT (in de Besluiten API), waar - ook de relatieinformatie opgevraagd kan worden. - title: besluit - maxLength: 1000 - required: - - besluit - - url - - uuid - ZaakContactMoment: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - contactmoment: - type: string - format: uri - description: - URL-referentie naar het CONTACTMOMENT (in de Klantinteractie - API) - title: contactmoment - maxLength: 1000 - required: - - contactmoment - - url - - uuid - - zaak - ZaakEigenschap: - type: object - description: - "A type of `ModelSerializer` that uses hyperlinked relationships - with compound keys instead - - of primary key relationships. Specifically: - - - * A 'url' field is included instead of the 'id' field. - - * Relationships to other instances are hyperlinks, instead of primary keys. - - - NOTE: this only works with DRF 3.1.0 and above." - properties: - url: - type: string - format: uri - readOnly: true - title: url - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - title: zaak - eigenschap: - type: string - format: uri - description: URL-referentie naar de EIGENSCHAP (in de Catalogi API). - title: eigenschap - maxLength: 1000 - naam: - type: string - readOnly: true - description: De naam van de EIGENSCHAP (overgenomen uit de Catalogi API). - title: ' naam' - waarde: - type: string - title: waarde - required: - - eigenschap - - naam - - url - - uuid - - waarde - - zaak - ZaakEigenschapExpanded: - allOf: - - $ref: '#/components/schemas/ZaakEigenschap' - - properties: - _expand: - $ref: '#/components/schemas/ZaakEigenschapEmbedded' - ZaakEigenschapEmbedded: - type: object - properties: - zaak: - oneOf: - - $ref: '#/components/schemas/ZaakExpanded' - - $ref: '#/components/schemas/EmptyObject' - eigenschap: - # $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/EigenschapExpanded' - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/EigenschapExpanded' - ZaakInformatieObject: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - informatieobject: - type: string - format: uri - description: - URL-referentie naar het INFORMATIEOBJECT (in de Documenten - API), waar ook de relatieinformatie opgevraagd kan worden. - title: informatieobject - maxLength: 1000 - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - aardRelatieWeergave: - allOf: - - $ref: '#/components/schemas/AardRelatieWeergaveEnum' - readOnly: true - title: aardRelatieWeergave - titel: - type: string - description: - De naam waaronder het INFORMATIEOBJECT binnen het OBJECT bekend - is. - title: titel - maxLength: 200 - beschrijving: - type: string - description: - Een op het object gerichte beschrijving van de inhoud vanhet - INFORMATIEOBJECT. - title: beschrijving - registratiedatum: - type: string - format: date-time - readOnly: true - description: - De datum waarop de behandelende organisatie het INFORMATIEOBJECT - heeft geregistreerd bij het OBJECT. Geldige waardes zijn datumtijden gelegen - op of voor de huidige datum en tijd. - title: registratiedatum - vernietigingsdatum: - type: string - format: date-time - nullable: true - description: - De datum waarop het informatieobject uit het zaakdossier verwijderd - moet worden. - title: vernietigingsdatum - status: - type: string - format: uri - nullable: true - description: - De bij de desbetreffende ZAAK behorende STATUS waarvoor het - ZAAK-INFORMATIEOBJECT relevant is (geweest) met het oog op het bereiken - van die STATUS en/of de communicatie daarover. - title: status - minLength: 1 - maxLength: 1000 - required: - - aardRelatieWeergave - - informatieobject - - registratiedatum - - url - - uuid - - zaak - ZaakInformatieObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakInformatieObject' - - properties: - _expand: - $ref: '#/components/schemas/ZaakInformatieObjectEmbedded' - ZaakInformatieObjectEmbedded: - type: object - properties: - status: - $ref: '#/components/schemas/StatusExpanded' - ZaakKenmerk: - type: object - properties: - kenmerk: - type: string - description: Identificeert uniek de zaak in een andere administratie. - title: kenmerk - maxLength: 40 - bron: - type: string - description: De aanduiding van de administratie waar het kenmerk op slaat. - title: bron - maxLength: 40 - required: - - bron - - kenmerk - ZaakObject: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - object: - type: string - format: uri - description: URL-referentie naar de resource die het OBJECT beschrijft. - title: object - maxLength: 1000 - zaakobjecttype: - type: string - format: uri - description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API). - title: zaakobjecttype - maxLength: 1000 - objectType: - allOf: - - $ref: '#/components/schemas/ObjectTypeEnum' - description: - 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er - geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. - - - Uitleg bij mogelijke waarden: - - - * `adres` - Adres - - * `besluit` - Besluit - - * `buurt` - Buurt - - * `enkelvoudig_document` - Enkelvoudig document - - * `gemeente` - Gemeente - - * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte - - * `huishouden` - Huishouden - - * `inrichtingselement` - Inrichtingselement - - * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak - - * `kunstwerkdeel` - Kunstwerkdeel - - * `maatschappelijke_activiteit` - Maatschappelijke activiteit - - * `medewerker` - Medewerker - - * `natuurlijk_persoon` - Natuurlijk persoon - - * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon - - * `openbare_ruimte` - Openbare ruimte - - * `organisatorische_eenheid` - Organisatorische eenheid - - * `pand` - Pand - - * `spoorbaandeel` - Spoorbaandeel - - * `status` - Status - - * `terreindeel` - Terreindeel - - * `terrein_gebouwd_object` - Terrein gebouwd object - - * `vestiging` - Vestiging - - * `waterdeel` - Waterdeel - - * `wegdeel` - Wegdeel - - * `wijk` - Wijk - - * `woonplaats` - Woonplaats - - * `woz_deelobject` - Woz deel object - - * `woz_object` - Woz object - - * `woz_waarde` - Woz waarde - - * `zakelijk_recht` - Zakelijk recht - - * `overige` - Overige' - title: object type - objectTypeOverige: - type: string - description: - Beschrijft het type OBJECT als `objectType` de waarde "overige" - heeft. - title: object type overige - pattern: '[a-z\_]+' - maxLength: 100 - objectTypeOverigeDefinitie: - allOf: - - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie' - nullable: true - title: definitie object type overige - description: - 'Verwijzing naar het schema van het type OBJECT als `objectType` - de waarde "overige" heeft. - - - * De URL referentie moet naar een JSON endpoint wijzen waarin het objecttype - gedefinieerd is, inclusief het [JSON-schema](https://json-schema.org/). - - * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen de - objecttype resource (deze gebruikt het [jq](http://stedolan.github.io/jq/) - formaat. - - * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens binnen - het OBJECT. Deze gebruikt ook het [jq](http://stedolan.github.io/jq/) - formaat. - - - Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven - en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven - OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.' - relatieomschrijving: - type: string - description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. - title: relatieomschrijving - maxLength: 80 - required: - - objectType - - url - - uuid - - zaak - discriminator: - propertyName: objectType - mapping: - adres: '#/components/schemas/adres_ZaakObject' - besluit: '#/components/schemas/besluit_ZaakObject' - buurt: '#/components/schemas/buurt_ZaakObject' - enkelvoudig_document: '#/components/schemas/enkelvoudig_document_ZaakObject' - gemeente: '#/components/schemas/gemeente_ZaakObject' - gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_ZaakObject' - huishouden: '#/components/schemas/huishouden_ZaakObject' - inrichtingselement: '#/components/schemas/inrichtingselement_ZaakObject' - kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_ZaakObject' - kunstwerkdeel: '#/components/schemas/kunstwerkdeel_ZaakObject' - maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_ZaakObject' - medewerker: '#/components/schemas/medewerker_ZaakObject' - natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_ZaakObject' - niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_ZaakObject' - openbare_ruimte: '#/components/schemas/openbare_ruimte_ZaakObject' - organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_ZaakObject' - pand: '#/components/schemas/pand_ZaakObject' - spoorbaandeel: '#/components/schemas/spoorbaandeel_ZaakObject' - status: '#/components/schemas/status_ZaakObject' - terreindeel: '#/components/schemas/terreindeel_ZaakObject' - terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_ZaakObject' - vestiging: '#/components/schemas/vestiging_ZaakObject' - waterdeel: '#/components/schemas/waterdeel_ZaakObject' - wegdeel: '#/components/schemas/wegdeel_ZaakObject' - wijk: '#/components/schemas/wijk_ZaakObject' - woonplaats: '#/components/schemas/woonplaats_ZaakObject' - woz_deelobject: '#/components/schemas/woz_deelobject_ZaakObject' - woz_object: '#/components/schemas/woz_object_ZaakObject' - woz_waarde: '#/components/schemas/woz_waarde_ZaakObject' - zakelijk_recht: '#/components/schemas/zakelijk_recht_ZaakObject' - overige: '#/components/schemas/overige_ZaakObject' - ZaakObjectExpanded: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - object: - type: string - format: uri - description: URL-referentie naar de resource die het OBJECT beschrijft. - title: object - maxLength: 1000 - zaakobjecttype: - type: string - format: uri - description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API). - title: zaakobjecttype - maxLength: 1000 - objectType: - allOf: - - $ref: '#/components/schemas/ObjectTypeEnum' - description: - 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er - geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. - - - Uitleg bij mogelijke waarden: - - - * `adres` - Adres - - * `besluit` - Besluit - - * `buurt` - Buurt - - * `enkelvoudig_document` - Enkelvoudig document - - * `gemeente` - Gemeente - - * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte - - * `huishouden` - Huishouden - - * `inrichtingselement` - Inrichtingselement - - * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak - - * `kunstwerkdeel` - Kunstwerkdeel - - * `maatschappelijke_activiteit` - Maatschappelijke activiteit - - * `medewerker` - Medewerker - - * `natuurlijk_persoon` - Natuurlijk persoon - - * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon - - * `openbare_ruimte` - Openbare ruimte - - * `organisatorische_eenheid` - Organisatorische eenheid - - * `pand` - Pand - - * `spoorbaandeel` - Spoorbaandeel - - * `status` - Status - - * `terreindeel` - Terreindeel - - * `terrein_gebouwd_object` - Terrein gebouwd object - - * `vestiging` - Vestiging - - * `waterdeel` - Waterdeel - - * `wegdeel` - Wegdeel - - * `wijk` - Wijk - - * `woonplaats` - Woonplaats - - * `woz_deelobject` - Woz deel object - - * `woz_object` - Woz object - - * `woz_waarde` - Woz waarde - - * `zakelijk_recht` - Zakelijk recht - - * `overige` - Overige' - title: object type - objectTypeOverige: - type: string - description: - Beschrijft het type OBJECT als `objectType` de waarde "overige" - heeft. - title: object type overige - pattern: '[a-z\_]+' - maxLength: 100 - objectTypeOverigeDefinitie: - allOf: - - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie' - nullable: true - title: definitie object type overige - description: - 'Verwijzing naar het schema van het type OBJECT als `objectType` - de waarde "overige" heeft. - - - * De URL referentie moet naar een JSON endpoint wijzen waarin het objecttype - gedefinieerd is, inclusief het [JSON-schema](https://json-schema.org/). - - * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen de - objecttype resource (deze gebruikt het [jq](http://stedolan.github.io/jq/) - formaat. - - * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens binnen - het OBJECT. Deze gebruikt ook het [jq](http://stedolan.github.io/jq/) - formaat. - - - Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven - en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven - OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.' - relatieomschrijving: - type: string - description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. - title: relatieomschrijving - maxLength: 80 - _expand: - $ref: '#/components/schemas/ZaakObjectEmbedded' - required: - - objectType - - url - - uuid - - zaak - discriminator: - propertyName: objectType - mapping: - adres: '#/components/schemas/adres_ZaakObjectExpanded' - besluit: '#/components/schemas/besluit_ZaakObjectExpanded' - buurt: '#/components/schemas/buurt_ZaakObjectExpanded' - enkelvoudig_document: '#/components/schemas/enkelvoudig_document_ZaakObjectExpanded' - gemeente: '#/components/schemas/gemeente_ZaakObjectExpanded' - gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_ZaakObjectExpanded' - huishouden: '#/components/schemas/huishouden_ZaakObjectExpanded' - inrichtingselement: '#/components/schemas/inrichtingselement_ZaakObjectExpanded' - kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_ZaakObjectExpanded' - kunstwerkdeel: '#/components/schemas/kunstwerkdeel_ZaakObjectExpanded' - maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_ZaakObjectExpanded' - medewerker: '#/components/schemas/medewerker_ZaakObjectExpanded' - natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_ZaakObjectExpanded' - niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_ZaakObjectExpanded' - openbare_ruimte: '#/components/schemas/openbare_ruimte_ZaakObjectExpanded' - organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_ZaakObjectExpanded' - pand: '#/components/schemas/pand_ZaakObjectExpanded' - spoorbaandeel: '#/components/schemas/spoorbaandeel_ZaakObjectExpanded' - status: '#/components/schemas/status_ZaakObjectExpanded' - terreindeel: '#/components/schemas/terreindeel_ZaakObjectExpanded' - terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_ZaakObjectExpanded' - vestiging: '#/components/schemas/vestiging_ZaakObjectExpanded' - waterdeel: '#/components/schemas/waterdeel_ZaakObjectExpanded' - wegdeel: '#/components/schemas/wegdeel_ZaakObjectExpanded' - wijk: '#/components/schemas/wijk_ZaakObjectExpanded' - woonplaats: '#/components/schemas/woonplaats_ZaakObjectExpanded' - woz_deelobject: '#/components/schemas/woz_deelobject_ZaakObjectExpanded' - woz_object: '#/components/schemas/woz_object_ZaakObjectExpanded' - woz_waarde: '#/components/schemas/woz_waarde_ZaakObjectExpanded' - zakelijk_recht: '#/components/schemas/zakelijk_recht_ZaakObjectExpanded' - overige: '#/components/schemas/overige_ZaakObjectExpanded' - ZaakObjectEmbedded: - type: object - properties: - zaakobjecttype: - # $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakObjectType' - $ref: 'https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/korver_develop/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/ZaakObjectType' - ZaakVerzoek: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - verzoek: - type: string - format: uri - description: URL-referentie naar het VERZOEK (in de Klantinteractie API) - title: verzoek - maxLength: 1000 - required: - - url - - uuid - - verzoek - - zaak - ZaakZoek: - type: object - properties: - zaakgeometrie: - $ref: '#/components/schemas/GeoWithin' - uuid__in: - description: Array of unieke resource identifiers (UUID4) - type: array - items: - type: string - format: uuid - example: ["e80b7507-199a-484c-ad49-c41a1e43a6e7", "78e12133-c467-4202-91ba-4417baa52801"] - identificatie: - title: Identificatie - description: De unieke identificatie van de ZAAK binnen de organisatie die - verantwoordelijk is voor de behandeling van de ZAAK. - type: string - example: "zaak123" - bronorganisatie: - title: Bronorganisatie - description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers - en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef - type: string - example: "000000000" - bronorganisatie__in: - description: Array van bronorganisaties. - type: array - items: - type: string - format: string - example: ["000000000","479559740","875883461"] - zaaktype: - title: Zaaktype - description: URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de - CATALOGUS waar deze voorkomt - type: string - example: "https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/e80b7507-199a-484c-ad49-c41a1e43a6e7" - zaaktype__in: - description: Array van zaaktypen. - type: array - items: - type: string - format: uri - example: ["https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/e80b7507-199a-484c-ad49-c41a1e43a6e7","https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/78e12133-c467-4202-91ba-4417baa52801"] - archiefnominatie: - title: Archiefnominatie - description: 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - Uitleg bij mogelijke waarden: - * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum - overgedragen worden naar een archiefbewaarplaats. - * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd - worden.' - type: string - enum: - - blijvend_bewaren - - vernietigen - example: "blijvend_bewaren" - archiefnominatie__in: - title: Archiefnominatie in - description: Multiple values may be separated by commas. - type: array - items: - type: string - example: [ "blijvend_bewaren", "vernietigen" ] - archiefactiedatum: - title: Archiefactiedatum - description: De datum waarop het gearchiveerde zaakdossier vernietigd moet - worden dan wel overgebracht moet worden naar een archiefbewaarplaats. - Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT - aan deze ZAAK indien nog leeg. - type: string - example: "2019-01-02" - archiefactiedatum__isnull: - title: Archiefactiedatum is leeg - type: boolean - example: false - archiefactiedatum__lt: - title: Archiefactiedatum kleiner dan - type: string - example: "2020-01-02" - archiefactiedatum__gt: - title: Archiefactiedatum groter dan - type: string - example: "2018-01-02" - archiefstatus: - title: Archiefstatus - description: 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - Uitleg bij mogelijke waarden: - * `nog_te_archiveren` - De zaak cq. het zaakdossier is nog niet als geheel - gearchiveerd. - * `gearchiveerd` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar - bewaarbaar gemaakt. - * `gearchiveerd_procestermijn_onbekend` - De zaak cq. het zaakdossier - is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum - kan nog niet bepaald worden. - * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een - archiefbewaarplaats.' - type: string - enum: - - nog_te_archiveren - - gearchiveerd - - gearchiveerd_procestermijn_onbekend - - overgedragen - example: "nog_te_archiveren" - archiefstatus__in: - title: Archiefstatus in - description: Multiple values may be separated by commas. - type: array - items: - type: string - example: [ "nog_te_archiveren","gearchiveerd","gearchiveerd_procestermijn_onbekend","overgedragen" ] - startdatum: - title: Startdatum - description: De datum waarop met de uitvoering van de zaak is gestart - type: string - example: "2017-01-02" - startdatum__gt: - title: Startdatum groter dan - type: string - example: "2018-01-02" - startdatum__gte: - title: Startdatum groter dan of gelijk - type: string - example: "2016-01-02" - startdatum__lt: - title: Startdatum kleiner dan - type: string - example: "2018-01-02" - startdatum__lte: - title: Startdatum kleiner dan of gelijk - type: string - example: "2018-01-02" - registratiedatum: - title: Registratiedatum - description: De datum waarop de zaakbehandelende organisatie de ZAAK heeft geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag gebruikt. - type: string - example: "2015-01-02" - registratiedatum__gt: - title: Registratiedatum groter dan - type: string - example: "2014-01-02" - registratiedatum__lt: - title: Registratiedatum kleiner dan - type: string - example: "2016-01-02" - einddatum: - title: Einddatum - description: De datum waarop de uitvoering van de zaak afgerond is. - type: string - example: "2022-01-02" - einddatum__isnull: - title: Einddatum is leeg - type: boolean - example: false - einddatum__gt: - title: Einddatum groter dan - type: string - example: "2021-01-02" - einddatum__lt: - title: Einddatum kleiner dan - type: string - minLength: 1 - example: "2023-01-02" - einddatumGepland: - title: Einddatum gepland - description: De datum waarop volgens de planning verwacht wordt dat de zaak afgerond wordt. - type: string - example: "2022-01-02" - einddatumGepland__gt: - title: Einddatum gepland groter dan - type: string - example: "2021-01-02" - einddatumGepland__lt: - title: Einddatum gepland kleiner dan - type: string - example: "2024-01-02" - uiterlijkeEinddatumAfdoening: - title: Uiterlijke einddatumAfdoening - description: De laatste datum waarop volgens wet- en regelgeving de zaak afgerond dient te zijn. - type: string - example: "2024-01-02" - uiterlijkeEinddatumAfdoening__gt: - title: Uiterlijke einddatumAfdoening groter dan - type: string - example: "2023-01-02" - uiterlijkeEinddatumAfdoening__lt: - title: Uiterlijke einddatumAfdoening kleiner dan - type: string - example: "2025-01-02" - rol__betrokkeneType: - title: Rol betrokkenetype - description: 'Type van de `betrokkene`. - Uitleg bij mogelijke waarden: - * `natuurlijk_persoon` - Natuurlijk persoon - * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon - * `vestiging` - Vestiging - * `organisatorische_eenheid` - Organisatorische eenheid - * `medewerker` - Medewerker' - type: string - enum: - - natuurlijk_persoon - - niet_natuurlijk_persoon - - vestiging - - organisatorische_eenheid - - medewerker - example: "natuurlijk_persoon" - rol__betrokkene: - title: Rol betrokkene - description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. - type: string - example: "https://example.com" - rol__omschrijvingGeneriek: - title: Rol omschrijvinggeneriek - description: - Algemeen gehanteerde benaming van de aard van de ROL, afgeleid uit het ROLTYPE. - type: string - enum: - - adviseur - - behandelaar - - belanghebbende - - beslisser - - initiator - - klantcontacter - - zaakcoordinator - - mede_initiator - example: "initiator" - maximaleVertrouwelijkheidaanduiding: - title: Maximalevertrouwelijkheidaanduiding - description: - Zaken met een vertrouwelijkheidaanduiding die beperkter is - dan de aangegeven aanduiding worden uit de resultaten gefiltered. - type: string - enum: - - openbaar - - beperkt_openbaar - - intern - - zaakvertrouwelijk - - vertrouwelijk - - confidentieel - - geheim - - zeer_geheim - example: "zaakvertrouwelijk" - rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn: - title: Rol betrokkeneidentificatie natuurlijkpersoon inpbsn - description: Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet - algemene bepalingen burgerservicenummer. - type: string - example: "123456789" - rol__betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie: - title: Rol betrokkeneidentificatie natuurlijkpersoon anpidentificatie - description: Het door de gemeente uitgegeven unieke nummer voor een ANDER - NATUURLIJK PERSOON - type: string - example: "123456789" - rol__betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer: - title: Rol betrokkeneidentificatie natuurlijkpersoon inpa nummer - description: Het administratienummer van de persoon, bedoeld in de Wet BRP - type: string - example: "123456789" - rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId: - title: Rol betrokkeneidentificatie nietnatuurlijkpersoon innnnpid - description: Het door een kamer toegekend uniek nummer voor de INGESCHREVEN - NIET-NATUURLIJK PERSOON - type: string - example: "123456789" - rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie: - title: Rol betrokkeneidentificatie nietnatuurlijkpersoon annidentificatie - description: Het door de gemeente uitgegeven unieke nummer voor een ANDER - NIET-NATUURLIJK PERSOON - type: string - example: "123456789" - rol__betrokkeneIdentificatie__vestiging__vestigingsNummer: - title: Rol betrokkeneidentificatie vestiging vestigingsnummer - description: Een korte unieke aanduiding van de Vestiging. - type: string - example: "123456789" - rol__betrokkeneIdentificatie__medewerker__identificatie: - title: Rol betrokkeneidentificatie medewerker identificatie - description: Een korte unieke aanduiding van de MEDEWERKER. - type: string - example: "123456789" - rol__betrokkeneIdentificatie__organisatorischeEenheid__identificatie: - title: Rol betrokkeneidentificatie organisatorischeeenheid identificatie - description: Een korte identificatie van de organisatorische eenheid. - type: string - example: "123456789" - expand: - description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,` \ - \ hoofdzaak.deelzaken.status.statustype`Haal details van gelinkte resources direct op. - Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. - Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt." - title: expand - type: string - example: zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype - ordering: - title: Ordering - description: Het veld waarop de resultaten geordend worden. Het minnetje betekent omgekeerde volgorde. - type: string - enum: - - startdatum - - -startdatum - - einddatum - - -einddatum - - publicatiedatum - - -publicatiedatum - - archiefactiedatum - - -archiefactiedatum - - registratiedatum - - -registratiedatum - - identificatie - - -identificatie - example: "-startdatum" - ZakelijkRechtHeeftAlsGerechtigde: - type: object - properties: - natuurlijkPersoon: - allOf: - - $ref: '#/components/schemas/RolNatuurlijkPersoon' - title: natuurlijkPersoon - nietNatuurlijkPersoon: - allOf: - - $ref: '#/components/schemas/RolNietNatuurlijkPersoon' - title: nietNatuurlijkPersoon - adres_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectAdres' - adres_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectAdres' - adres_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectAdres' - besluit_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - besluit_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - besluit_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - betrokkene_identificatie_RolMedewerker: - type: object - properties: - betrokkeneIdentificatie: - allOf: - - $ref: '#/components/schemas/RolMedewerker' - title: betrokkeneIdentificatie - betrokkene_identificatie_RolNatuurlijkPersoon: - type: object - properties: - betrokkeneIdentificatie: - allOf: - - $ref: '#/components/schemas/RolNatuurlijkPersoon' - title: betrokkeneIdentificatie - betrokkene_identificatie_RolNietNatuurlijkPersoon: - type: object - properties: - betrokkeneIdentificatie: - allOf: - - $ref: '#/components/schemas/RolNietNatuurlijkPersoon' - title: betrokkeneIdentificatie - betrokkene_identificatie_RolOrganisatorischeEenheid: - type: object - properties: - betrokkeneIdentificatie: - allOf: - - $ref: '#/components/schemas/RolOrganisatorischeEenheid' - title: betrokkeneIdentificatie - betrokkene_identificatie_RolVestiging: - type: object - properties: - betrokkeneIdentificatie: - allOf: - - $ref: '#/components/schemas/RolVestiging' - title: betrokkeneIdentificatie - buurt_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' - buurt_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' - buurt_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' - enkelvoudig_document_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - enkelvoudig_document_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - enkelvoudig_document_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - gemeente_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' - gemeente_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' - gemeente_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' - gemeentelijke_openbare_ruimte_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' - gemeentelijke_openbare_ruimte_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' - gemeentelijke_openbare_ruimte_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' - huishouden_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' - huishouden_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' - huishouden_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' - inrichtingselement_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' - inrichtingselement_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' - inrichtingselement_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' - kadastrale_onroerende_zaak_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' - kadastrale_onroerende_zaak_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' - kadastrale_onroerende_zaak_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' - kunstwerkdeel_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' - kunstwerkdeel_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' - kunstwerkdeel_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' - maatschappelijke_activiteit_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' - maatschappelijke_activiteit_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' - maatschappelijke_activiteit_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' - medewerker_Rol: - allOf: - - $ref: '#/components/schemas/Rol' - - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' - medewerker_RolExpanded: - allOf: - - $ref: '#/components/schemas/RolExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' - medewerker_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' - medewerker_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' - medewerker_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' - natuurlijk_persoon_Rol: - allOf: - - $ref: '#/components/schemas/Rol' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' - natuurlijk_persoon_RolExpanded: - allOf: - - $ref: '#/components/schemas/RolExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' - natuurlijk_persoon_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' - natuurlijk_persoon_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' - natuurlijk_persoon_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' - niet_natuurlijk_persoon_Rol: - allOf: - - $ref: '#/components/schemas/Rol' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' - niet_natuurlijk_persoon_RolExpanded: - allOf: - - $ref: '#/components/schemas/RolExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' - niet_natuurlijk_persoon_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' - niet_natuurlijk_persoon_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' - niet_natuurlijk_persoon_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' - object_identificatie_ObjectAdres: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectAdres' - title: objectIdentificatie - object_identificatie_ObjectBuurt: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectBuurt' - title: objectIdentificatie - object_identificatie_ObjectGemeente: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectGemeente' - title: objectIdentificatie - object_identificatie_ObjectGemeentelijkeOpenbareRuimte: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectGemeentelijkeOpenbareRuimte' - title: objectIdentificatie - object_identificatie_ObjectHuishouden: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectHuishouden' - title: objectIdentificatie - object_identificatie_ObjectInrichtingselement: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectInrichtingselement' - title: objectIdentificatie - object_identificatie_ObjectKadastraleOnroerendeZaak: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectKadastraleOnroerendeZaak' - title: objectIdentificatie - object_identificatie_ObjectKunstwerkdeel: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectKunstwerkdeel' - title: objectIdentificatie - object_identificatie_ObjectMaatschappelijkeActiviteit: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectMaatschappelijkeActiviteit' - title: objectIdentificatie - object_identificatie_ObjectOpenbareRuimte: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectOpenbareRuimte' - title: objectIdentificatie - object_identificatie_ObjectOverige: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectOverige' - title: objectIdentificatie - object_identificatie_ObjectPand: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectPand' - title: objectIdentificatie - object_identificatie_ObjectSpoorbaandeel: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectSpoorbaandeel' - title: objectIdentificatie - object_identificatie_ObjectTerreinGebouwdObject: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectTerreinGebouwdObject' - title: objectIdentificatie - object_identificatie_ObjectTerreindeel: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectTerreindeel' - title: objectIdentificatie - object_identificatie_ObjectWaterdeel: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectWaterdeel' - title: objectIdentificatie - object_identificatie_ObjectWegdeel: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectWegdeel' - title: objectIdentificatie - object_identificatie_ObjectWijk: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectWijk' - title: objectIdentificatie - object_identificatie_ObjectWoonplaats: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectWoonplaats' - title: objectIdentificatie - object_identificatie_ObjectWozDeelobject: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectWozDeelobject' - title: objectIdentificatie - object_identificatie_ObjectWozObject: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectWozObject' - title: objectIdentificatie - object_identificatie_ObjectWozWaarde: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectWozWaarde' - title: objectIdentificatie - object_identificatie_ObjectZakelijkRecht: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectZakelijkRecht' - title: objectIdentificatie - object_identificatie_RolMedewerker: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/RolMedewerker' - title: objectIdentificatie - object_identificatie_RolNatuurlijkPersoon: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/RolNatuurlijkPersoon' - title: objectIdentificatie - object_identificatie_RolNietNatuurlijkPersoon: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/RolNietNatuurlijkPersoon' - title: objectIdentificatie - object_identificatie_RolOrganisatorischeEenheid: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/RolOrganisatorischeEenheid' - title: objectIdentificatie - object_identificatie_RolVestiging: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/RolVestiging' - title: objectIdentificatie - openbare_ruimte_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' - openbare_ruimte_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' - openbare_ruimte_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' - organisatorische_eenheid_Rol: - allOf: - - $ref: '#/components/schemas/Rol' - - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' - organisatorische_eenheid_RolExpanded: - allOf: - - $ref: '#/components/schemas/RolExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' - organisatorische_eenheid_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' - organisatorische_eenheid_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' - organisatorische_eenheid_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' - overige_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectOverige' - overige_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectOverige' - overige_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectOverige' - pand_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectPand' - pand_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectPand' - pand_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectPand' - spoorbaandeel_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' - spoorbaandeel_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' - spoorbaandeel_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' - status_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - status_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - status_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - terrein_gebouwd_object_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' - terrein_gebouwd_object_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' - terrein_gebouwd_object_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' - terreindeel_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' - terreindeel_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' - terreindeel_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' - vestiging_Rol: - allOf: - - $ref: '#/components/schemas/Rol' - - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' - vestiging_RolExpanded: - allOf: - - $ref: '#/components/schemas/RolExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' - vestiging_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' - vestiging_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' - vestiging_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' - waterdeel_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' - waterdeel_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' - waterdeel_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' - wegdeel_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' - wegdeel_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' - wegdeel_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' - wijk_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWijk' - wijk_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectWijk' - wijk_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWijk' - woonplaats_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' - woonplaats_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' - woonplaats_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' - woz_deelobject_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' - woz_deelobject_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' - woz_deelobject_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' - woz_object_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' - woz_object_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' - woz_object_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' - woz_waarde_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' - woz_waarde_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' - woz_waarde_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' - zakelijk_recht_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' - zakelijk_recht_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' - zakelijk_recht_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' - securitySchemes: - JWT-Claims: - type: http - bearerFormat: JWT - scheme: bearer -servers: - - url: https://zaken-api.test.vng.cloud/api/v1 - - url: https://zaken-api.vng.cloud/api/v1 -tags: - - name: klantcontacten - description: '' - - name: resultaten - description: '' - - name: rollen - description: '' - - name: statussen - description: '' - - name: zaakcontactmomenten - description: '' - - name: zaakinformatieobjecten - description: '' - - name: zaakobjecten - description: '' - - name: zaakverzoeken - description: '' - - name: zaken - description: - Een zaak mag (in principe) niet meer gewijzigd worden als de `archiefstatus` - een andere status heeft dan "nog_te_archiveren". Voor praktische redenen is er - geen harde validatie regel aan de provider kant. diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi_fast.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi_geneste_expand.yaml similarity index 99% rename from api-specificatie/zrc/1.5.x/1.5.2/openapi_fast.yaml rename to api-specificatie/zrc/1.5.x/1.5.2/openapi_geneste_expand.yaml index c1bb33995..3b0e550a9 100644 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi_fast.yaml +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi_geneste_expand.yaml @@ -12904,7 +12904,7 @@ components: zaak: $ref: '#/components/schemas/ZaakExpanded' resultaattype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ResultaatType' + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ResultaatTypeExpanded' Rol: type: object properties: @@ -13233,7 +13233,7 @@ components: $ref: '#/components/schemas/ZaakExpanded' example: {} roltype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/RolType' + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/RolTypeExpanded' statussen: type: array items: @@ -13519,7 +13519,7 @@ components: type: object properties: statustype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/StatusType' + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/StatusTypeExpanded' gezetdoor: $ref: '#/components/schemas/Rol' zaakinformatieobjecten: @@ -14266,7 +14266,8 @@ components: type: object properties: zaaktype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakType' + + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' hoofdzaak: oneOf: - $ref: '#/components/schemas/ZaakExpanded' @@ -14456,7 +14457,7 @@ components: - $ref: '#/components/schemas/ZaakExpanded' - $ref: '#/components/schemas/EmptyObject' eigenschap: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/Eigenschap' + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/EigenschapExpanded' ZaakInformatieObject: type: object properties: From a3a424fb197f8a89020283200809270303b09a33 Mon Sep 17 00:00:00 2001 From: Henri Korver <37145898+HenriKorver@users.noreply.github.com> Date: Mon, 17 Feb 2025 17:24:21 +0100 Subject: [PATCH 27/36] Update reference for InformatieObjectType in openapi.yaml to use non-expanded schema type --- api-specificatie/drc/1.6.x/1.6.0/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-specificatie/drc/1.6.x/1.6.0/openapi.yaml b/api-specificatie/drc/1.6.x/1.6.0/openapi.yaml index a8034e7ed..47b7a4819 100644 --- a/api-specificatie/drc/1.6.x/1.6.0/openapi.yaml +++ b/api-specificatie/drc/1.6.x/1.6.0/openapi.yaml @@ -7270,7 +7270,7 @@ components: type: object properties: informatieobjecttype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/InformatieObjectTypeExpanded' + $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/InformatieObjectType' FieldValidationError: type: object description: Formaat van validatiefouten. From 6ce65e2e7692599c5a410c1c65bd47333392f335 Mon Sep 17 00:00:00 2001 From: HenriKorver Date: Thu, 20 Feb 2025 16:56:24 +0100 Subject: [PATCH 28/36] Fouten in ztc 1.3.2 rechtgezet en release_notes aangepast --- api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml | 9 +++------ docs/standaard/release_notes.md | 7 ++++--- 2 files changed, 7 insertions(+), 9 deletions(-) diff --git a/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml b/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml index 699a51ac0..c97e7a61e 100644 --- a/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml +++ b/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml @@ -3063,9 +3063,8 @@ paths: content: application/json: schema: - type: object - additionalProperties: {} - description: Unspecified request body + $ref: '#/components/schemas/InformatieObjectType' + required: true security: - JWT-Claims: - catalogi.schrijven @@ -3081,9 +3080,7 @@ paths: content: application/json: schema: - type: object - additionalProperties: {} - description: Unspecified response body + $ref: '#/components/schemas/InformatieObjectType' description: OK '400': headers: diff --git a/docs/standaard/release_notes.md b/docs/standaard/release_notes.md index e6fc80c5d..6a65c7db7 100644 --- a/docs/standaard/release_notes.md +++ b/docs/standaard/release_notes.md @@ -12,15 +12,16 @@ In de resources rollen en zaakobjecten komt het attribuut _expand (onterecht) voor. Dit is verwarrend want dit attribuut kan alleen indirect gebruikt worden via de zaken resource. Dit attribuut is verwijderd daar waar het niet van toepassing is. Deze correctie heeft geen functionele gevolgen. -- **Geneste expansion naar ztc expliciet zichtbaar gemaakt in de OAS** +- **Referenties naar ztc vervangen door relatieve paden** - Hiervoor was het geneste expansie-mechanisme textueel beschreven maar niet formeel gemodelleerd in de OAS. + Hiervoor waren de referenties absolute paden wat niet handig is voor het uitrollen van een nieuwe release want dan moeten de paden handmatig worden aangepast. ## Catalogi API (`ztc 1.3.2`) - **Geneste expansion toegevoegd aan Catalogi API** - Zie ook Zaken API. + Geneste expansie objecten toegevoegd aan het schema van de OAS. Deze objecten worden niet gebruikt in de operaties van de OAS omdat de nesting niet dieper mag zijn dan 3 niveaus. Echter deze schema-objecten kunnen wel gebruikt worden om door het hele datamodel van de Catalagi API heen te kunnen browsen door middel van drill down expansie. + - **Aanscherping specificatie eigenschappen met datumvelden** From 109c9ffbd09ffba5922c58ecbefcfbd5c6d80cbb Mon Sep 17 00:00:00 2001 From: HenriKorver Date: Thu, 20 Feb 2025 17:11:23 +0100 Subject: [PATCH 29/36] Versie ztc 1.3.2. verwijderd omdat geneste expansie binnen ztc objecten nu nog niet gewenst is (mag alleen tot niveau 3 diep) --- api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml | 15558 ---------------- 1 file changed, 15558 deletions(-) delete mode 100644 api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml diff --git a/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml b/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml deleted file mode 100644 index c97e7a61e..000000000 --- a/api-specificatie/ztc/1.3.x/1.3.2/openapi.yaml +++ /dev/null @@ -1,15558 +0,0 @@ -openapi: 3.0.3 -info: - title: Catalogi API - version: 1.3.2 - description: - "Een API om een zaaktypecatalogus (ZTC) te benaderen.\n\nDe zaaktypecatalogus\ - \ helpt gemeenten om het proces vanuit de 'vraag van een\nklant' (productaanvraag,\ - \ melding, aangifte, informatieverzoek e.d.) tot en met\nhet leveren van een passend\ - \ antwoord daarop in te richten, inclusief de\nbijbehorende informatievoorziening.\n\ - \nEen CATALOGUS bestaat uit ZAAKTYPEn, INFORMATIEOBJECTTYPEn en BESLUITTYPEn en\n\ - wordt typisch gebruikt om een ZAAK (in de Zaken API), INFORMATIEOBJECT (in de\n\ - Documenten API) en BESLUIT (in de Besluiten API) te voorzien van type,\nstandaardwaarden\ - \ en processtructuur.\n\n**Afhankelijkheden**\n\nDeze API is afhankelijk van:\n\ - \n* Gemeentelijke Selectielijst API\n* Autorisaties API *(optioneel)*\n\n\n**Autorisatie**\n\ - \nDeze API vereist autorisatie. Je kan de\n[token-tool](https://zaken-auth.vng.cloud/)\ - \ gebruiken om een token te\ngenereren.\n\n_Zelf een token genereren_\n\nDe tokens\ - \ die gebruikt worden voor autorisatie zijn [jwt.io][JWT's] (JSON web\ntoken).\ - \ In de API calls moeten deze gebruikt worden in de `Authorization`\nheader:\n\ - \n```\nAuthorization: Bearer \n```\n\nOm een JWT te genereren heb je een\ - \ `client ID` en een `secret` nodig. Het JWT\nmoet gebouwd worden volgens het\ - \ `HS256` algoritme. De vereiste payload is:\n\n```json\n{\n \"iss\": \"\",\n \"iat\": 1572863906,\n \"client_id\": \"\",\n \"\ - user_id\": \"\",\n \"user_representation\": \"\"\ - \n}\n```\n\nAls `issuer` gebruik je dus je eigen client ID. De `iat` timestamp\ - \ is een\nUNIX-timestamp die aangeeft op welk moment het token gegenereerd is.\n\ - \n`user_id` en `user_representation` zijn nodig voor de audit trails. Het zijn\n\ - vrije velden met als enige beperking dat de lengte maximaal de lengte van\nde\ - \ overeenkomstige velden in de audit trail resources is (zie rest API spec).\n\ - \n\n### Notificaties\n\nDeze API publiceert notificaties op het kanaal `zaaktypen`.\n\ - \n**Main resource**\n\n`zaaktype`\n\n\n\n**Kenmerken**\n\n* `catalogus`: URL-referentie\ - \ naar de CATALOGUS waartoe dit ZAAKTYPE behoort.\n\n**Resources en acties**\n\ - \n\nDeze API publiceert notificaties op het kanaal `besluittypen`.\n\n**Main resource**\n\ - \n`besluittype`\n\n\n\n**Kenmerken**\n\n* `catalogus`: URL-referentie naar de\ - \ CATALOGUS waartoe dit BESLUITTYPE behoort.\n\n**Resources en acties**\n\n\n\ - Deze API publiceert notificaties op het kanaal `informatieobjecttypen`.\n\n**Main\ - \ resource**\n\n`informatieobjecttype`\n\n\n\n**Kenmerken**\n\n* `catalogus`:\ - \ URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE behoort.\n\ - \n**Resources en acties**\n\n\n**Handige links**\n\n* [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard)\n\ - * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken)\n" - contact: - email: standaarden.ondersteuning@vng.nl - url: https://vng-realisatie.github.io/gemma-zaken - license: - name: EUPL 1.2 - url: https://opensource.org/licenses/EUPL-1.2 -paths: - /besluittypen: - get: - operationId: besluittype_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle BESLUITTYPEn opvragen. - parameters: - - name: catalogus - required: false - in: query - description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. - schema: - type: string - format: uri - - name: zaaktypen - required: false - in: query - description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE - schema: - type: string - - name: informatieobjecttypen - required: false - in: query - description: - Het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten - van dit BESLUITTYPE worden vastgelegd. - schema: - type: string - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: omschrijving - required: false - in: query - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - besluittypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedBesluitTypeList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: besluittype_create - description: Maak een BESLUITTYPE aan. - summary: Maak een BESLUITTYPE aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - besluittypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BesluitTypeCreate' - required: true - security: - - JWT-Claims: - - catalogi.schrijven - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/BesluitType' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /besluittypen/{uuid}: - get: - operationId: besluittype_retrieve - description: Een specifieke BESLUITTYPE opvragen. - summary: Een specifieke BESLUITTYPE opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - besluittypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/BesluitType' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: besluittype_update - description: - Werk een BESLUITTYPE in zijn geheel bij. Dit kan alleen als het - een concept betreft. - summary: Werk een BESLUITTYPE in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - besluittypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/BesluitTypeUpdate' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/BesluitType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: besluittype_partial_update - description: - Werk een BESLUITTYPE deels bij. Dit kan alleen als het een concept - betreft. - summary: Werk een BESLUITTYPE deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - besluittypen - requestBody: - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified request body - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified response body - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: besluittype_destroy - description: Verwijder een BESLUITTYPE. Dit kan alleen als het een concept betreft. - summary: Verwijder een BESLUITTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - besluittypen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified response body - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: besluittype_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) BESLUITTYPE opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - besluittypen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /besluittypen/{uuid}/publish: - post: - operationId: besluittype_publish - description: - Publiceren van het besluittype zorgt ervoor dat dit in een Besluiten - API kan gebruikt worden. Na het publiceren van een besluittype zijn geen inhoudelijke - wijzigingen meer mogelijk. Indien er na het publiceren nog wat gewijzigd moet - worden, dan moet je een nieuwe versie aanmaken. - summary: Publiceer het concept BESLUITTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - besluittypen - security: - - JWT-Claims: - - catalogi.schrijven - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/BesluitType' - description: OK - '400': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '404': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '401': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /catalogussen: - get: - operationId: catalogus_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle CATALOGUSsen opvragen. - parameters: - - name: domein - required: false - in: query - description: domein - schema: - type: string - - name: domein__in - required: false - in: query - description: domein__in - schema: - type: string - - name: rsin - required: false - in: query - description: rsin - schema: - type: string - - name: rsin__in - required: false - in: query - description: rsin__in - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - catalogussen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedCatalogusList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: catalogus_create - description: Maak een CATALOGUS aan. - summary: Maak een CATALOGUS aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - catalogussen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Catalogus' - required: true - security: - - JWT-Claims: - - catalogi.schrijven - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Catalogus' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /catalogussen/{uuid}: - get: - operationId: catalogus_retrieve - description: Een specifieke CATALOGUS opvragen. - summary: Een specifieke CATALOGUS opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - catalogussen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Catalogus' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: catalogus_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) CATALOGUS opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - catalogussen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /eigenschappen: - get: - operationId: eigenschap_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle EIGENSCHAPpen opvragen. - parameters: - - name: zaaktype - required: false - in: query - description: - URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze - EIGENSCHAP van belang is. - schema: - type: string - format: uri - - name: zaaktypeIdentificatie - required: false - in: query - description: zaaktype_identificatie - schema: - type: string - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - eigenschappen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedEigenschapList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: eigenschap_create - description: - Maak een EIGENSCHAP aan. Dit kan alleen als het bijbehorende ZAAKTYPE - een concept betreft. - summary: Maak een EIGENSCHAP aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - eigenschappen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Eigenschap' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Eigenschap' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /eigenschappen/{uuid}: - get: - operationId: eigenschap_retrieve - description: Een specifieke EIGENSCHAP opvragen. - summary: Een specifieke EIGENSCHAP opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - eigenschappen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Eigenschap' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: eigenschap_update - description: - Werk een EIGENSCHAP in zijn geheel bij. Dit kan alleen als het - bijbehorende ZAAKTYPE een concept betreft. - summary: Werk een EIGENSCHAP in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - eigenschappen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Eigenschap' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Eigenschap' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: eigenschap_partial_update - description: - Werk een EIGENSCHAP deels bij. Dit kan alleen als het bijbehorende - ZAAKTYPE een concept betreft. - summary: Werk een EIGENSCHAP deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - eigenschappen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedEigenschap' - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Eigenschap' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: eigenschap_destroy - description: - Verwijder een EIGENSCHAP. Dit kan alleen als het bijbehorende ZAAKTYPE - een concept betreft. - summary: Verwijder een EIGENSCHAP. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - eigenschappen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: eigenschap_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) EIGENSCHAP opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - eigenschappen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /informatieobjecttypen: - get: - operationId: informatieobjecttype_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle INFORMATIEOBJECTTYPEn opvragen. - parameters: - - name: catalogus - required: false - in: query - description: - URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE - behoort. - schema: - type: string - format: uri - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: omschrijving - required: false - in: query - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - informatieobjecttypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedInformatieObjectTypeList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: informatieobjecttype_create - description: Maak een INFORMATIEOBJECTTYPE aan. - summary: Maak een INFORMATIEOBJECTTYPE aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - informatieobjecttypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/InformatieObjectType' - required: true - security: - - JWT-Claims: - - catalogi.schrijven - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/InformatieObjectType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /informatieobjecttypen/{uuid}: - get: - operationId: informatieobjecttype_retrieve - description: Een specifieke INFORMATIEOBJECTTYPE opvragen. - summary: Een specifieke INFORMATIEOBJECTTYPE opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - informatieobjecttypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/InformatieObjectType' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: informatieobjecttype_update - description: - Werk een INFORMATIEOBJECTTYPE in zijn geheel bij. Dit kan alleen - als het een concept betreft. - summary: Werk een INFORMATIEOBJECTTYPE in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - informatieobjecttypen - requestBody: - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified request body - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified response body - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: informatieobjecttype_partial_update - description: - Werk een INFORMATIEOBJECTTYPE deels bij. Dit kan alleen als het - een concept betreft. - summary: ' Werk een INFORMATIEOBJECTTYPE deels bij.' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - informatieobjecttypen - requestBody: - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified request body - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified response body - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: informatieobjecttype_destroy - description: - Verwijder een INFORMATIEOBJECTTYPE. Dit kan alleen als het een - concept betreft. - summary: Verwijder een INFORMATIEOBJECTTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - informatieobjecttypen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified response body - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: informatieobjecttype_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) INFORMATIEOBJECTTYPE opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - informatieobjecttypen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /informatieobjecttypen/{uuid}/publish: - post: - operationId: informatieobjecttype_publish - description: - Publiceren van het informatieobjecttype zorgt ervoor dat dit in - een Documenten API kan gebruikt worden. Na het publiceren van een informatieobjecttype - zijn geen inhoudelijke wijzigingen meer mogelijk. Indien er na het publiceren - nog wat gewijzigd moet worden, dan moet je een nieuwe versie aanmaken. - summary: Publiceer het concept INFORMATIEOBJECTTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - informatieobjecttypen - security: - - JWT-Claims: - - catalogi.schrijven - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/InformatieObjectType' - description: OK - '400': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '404': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '401': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /resultaattypen: - get: - operationId: resultaattype_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle RESULTAATTYPEn opvragen. - parameters: - - name: zaaktype - required: false - in: query - description: zaaktype - schema: - type: string - - name: zaaktype_identificatie - required: false - in: query - description: zaaktype_identificatie - schema: - type: string - - name: status - required: false - in: query - description: status - schema: - type: string - - name: datum_geldigheid - required: false - in: query - description: datum_geldigheid - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - resultaattypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedResultaatTypeList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: resultaattype_create - description: - Maak een RESULTAATTYPE aan. Dit kan alleen als het bijbehorende - ZAAKTYPE een concept betreft. - summary: Maak een RESULTAATTYPE aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - resultaattypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ResultaatTypeCreate' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ResultaatType' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /resultaattypen/{uuid}: - get: - operationId: resultaattype_retrieve - description: Een specifieke RESULTAATTYPE opvragen. - summary: Een specifieke RESULTAATTYPE opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - resultaattypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ResultaatType' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: resultaattype_update - description: - Werk een RESULTAATTYPE in zijn geheel bij. Dit kan alleen als het - bijbehorende ZAAKTYPE een concept betreft. - summary: Werk een RESULTAATTYPE in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - resultaattypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ResultaatTypeCreate' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ResultaatTypeUpdate' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: resultaattype_partial_update - description: - Werk een RESULTAATTYPE deels bij. Dit kan alleen als het bijbehorende - ZAAKTYPE een concept betreft. - summary: Werk een RESULTAATTYPE deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - resultaattypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedResultaatType' - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ResultaatType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: resultaattype_destroy - description: - Verwijder een RESULTAATTYPE. Dit kan alleen als het bijbehorende - ZAAKTYPE een concept betreft. - summary: Verwijder een RESULTAATTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - resultaattypen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: resultaattype_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) RESULTAATTYPE opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - resultaattypen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /roltypen: - get: - operationId: roltype_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle ROLTYPEn opvragen. - parameters: - - name: zaaktype - required: false - in: query - description: - URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken - kunnen zijn. - schema: - type: string - format: uri - - name: zaaktypeIdentificatie - required: false - in: query - description: zaaktype_identificatie - schema: - type: string - - name: omschrijvingGeneriek - required: false - in: query - description: Algemeen gehanteerde omschrijving van de aard van de ROL. - schema: - type: string - enum: - - adviseur - - behandelaar - - belanghebbende - - beslisser - - initiator - - klantcontacter - - zaakcoordinator - - mede_initiator - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - roltypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedRolTypeList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: roltype_create - description: - Maak een ROLTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE - een concept betreft. - summary: Maak een ROLTYPE aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - roltypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RolType' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/RolType' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /roltypen/{uuid}: - get: - operationId: roltype_retrieve - description: Een specifieke ROLTYPE opvragen. - summary: Een specifieke ROLTYPE opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - roltypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/RolType' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: roltype_update - description: - Werk een ROLTYPE in zijn geheel bij. Dit kan alleen als het een - concept betreft. - summary: Werk een ROLTYPE in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - roltypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/RolType' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/RolType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: roltype_partial_update - description: - Werk een ROLTYPE deels bij. Dit kan alleen als het een concept - betreft. - summary: Werk een ROLTYPE deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - roltypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedRolType' - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/RolType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: roltype_destroy - description: Verwijder een ROLTYPE. Dit kan alleen als het een concept betreft. - summary: Verwijder een ROLTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - title: uuid - required: true - tags: - - roltypen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: roltype_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ROLTYPE opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - roltypen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /statustypen: - get: - operationId: statustype_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle STATUSTYPEn opvragen. - parameters: - - name: zaaktype - required: false - in: query - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen - van dit STATUSTYPE bereikt kunnen worden. - schema: - type: string - format: uri - - name: zaaktypeIdentificatie - required: false - in: query - description: zaaktype_identificatie - schema: - type: string - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - statustypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedStatusTypeList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: statustype_create - description: - Maak een STATUSTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE - een concept betreft. - summary: Maak een STATUSTYPE aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - statustypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StatusType' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/StatusType' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /statustypen/{uuid}: - get: - operationId: statustype_retrieve - description: Een specifieke STATUSTYPE opvragen. - summary: Een specifieke STATUSTYPE opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - statustypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/StatusType' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: statustype_update - description: - Werk een STATUSTYPE in zijn geheel bij. Dit kan alleen als het - bijbehorende ZAAKTYPE een concept betreft. - summary: Werk een STATUSTYPE in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - statustypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/StatusType' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/StatusType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: statustype_partial_update - description: - Werk een STATUSTYPE deels bij. Dit kan alleen als het bijbehorende - ZAAKTYPE een concept betreft. - summary: Werk een STATUSTYPE deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - statustypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedStatusType' - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/StatusType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: statustype_destroy - description: - Verwijder een STATUSTYPE. Dit kan alleen als het bijbehorende ZAAKTYPE - een concept betreft. - summary: Verwijder een STATUSTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - statustypen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: statustype_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) STATUSTYPE opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - statustypen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaakobjecttypen: - get: - operationId: zaakobjecttype_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle ZAAKOBJECTTYPEn opvragen. - parameters: - - name: anderObjecttype - required: false - in: query - description: - Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een - ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. - schema: - type: string - - name: catalogus - required: false - in: query - description: URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE behoort. - schema: - type: string - format: uri - - name: datumBeginGeldigheid - required: false - in: query - description: De datum waarop het is ontstaan. - schema: - type: string - - name: datumEindeGeldigheid - required: false - in: query - description: De datum waarop het is opgeheven. - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: objecttype - required: false - in: query - description: - URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE - behoort. - schema: - type: string - format: uri - - name: relatieOmschrijving - required: false - in: query - description: - Omschrijving van de betrekking van het Objecttype op zaken van - het gerelateerde ZAAKTYPE. - schema: - type: string - - name: zaaktype - required: false - in: query - description: URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE behoort. - schema: - type: string - format: uri - - name: zaaktypeIdentificatie - required: false - in: query - description: zaaktype_identificatie - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - zaakobjecttypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedZaakObjectTypeList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaakobjecttype_create - description: Maak een ZAAKOBJECTTYPE aan. - summary: Maak een ZAAKOBJECTTYPE aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaakobjecttypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObjectType' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObjectType' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaakobjecttypen/{uuid}: - get: - operationId: zaakobjecttype_retrieve - description: Een specifieke ZAAKOBJECTTYPE opvragen. - summary: Een specifieke ZAAKOBJECTTYPE opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaakobjecttypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObjectType' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: zaakobjecttype_update - description: Werk een ZAAKOBJECTTYPE in zijn geheel bij. - summary: Werk een ZAAKOBJECTTYPE in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaakobjecttypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObjectType' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObjectType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: zaakobjecttype_partial_update - description: Werk een ZAAKOBJECTTYPE deels bij. - summary: Werk een ZAAKOBJECTTYPE deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaakobjecttypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedZaakObjectType' - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObjectType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaakobjecttype_destroy - description: Verwijder een ZAAKOBJECTTYPE. - summary: Verwijder een ZAAKOBJECTTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - zaakobjecttypen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: zaakobjecttype_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ZAAKOBJECTTYPE opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaakobjecttypen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaaktype-informatieobjecttypen: - get: - operationId: zaakinformatieobjecttype_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle ZAAKTYPE-INFORMATIEOBJECTTYPE relaties opvragen. - parameters: - - name: zaaktype - required: false - in: query - description: URL-referentie naar het ZAAKTYPE. - schema: - type: string - format: uri - - name: informatieobjecttype - required: false - in: query - description: informatieobjecttype - schema: - type: string - - name: richting - required: false - in: query - description: - Aanduiding van de richting van informatieobjecten van het gerelateerde - INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. - schema: - type: string - enum: - - inkomend - - intern - - uitgaand - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - zaaktype-informatieobjecttypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedZaakTypeInformatieObjectTypeList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaakinformatieobjecttype_create - description: - 'Maak een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie aan. Dit kan alleen - als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op: - - - `zaaktype` en `informatieobjecttype` behoren tot dezelfde `catalogus`' - summary: Maak een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaaktype-informatieobjecttypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaaktype-informatieobjecttypen/{uuid}: - get: - operationId: zaakinformatieobjecttype_retrieve - description: Een specifieke ZAAKTYPE-INFORMATIEOBJECTTYPE relatie opvragen. - summary: Een specifieke ZAAKTYPE-INFORMATIEOBJECTTYPE relatie opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaaktype-informatieobjecttypen - security: - - JWT-Claims: - - catalogi.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: zaakinformatieobjecttype_update - description: - "Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel\ - \ bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er\ - \ wordt gevalideerd op:\n - `zaaktype` en `informatieobjecttype` behoren tot\ - \ dezelfde `catalogus`" - summary: Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaaktype-informatieobjecttypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: zaakinformatieobjecttype_partial_update - description: - "Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij. Dit\ - \ kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt\ - \ gevalideerd op:\n - `zaaktype` en `informatieobjecttype` behoren tot dezelfde\ - \ `catalogus`" - summary: Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaaktype-informatieobjecttypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedZaakTypeInformatieObjectType' - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaakinformatieobjecttype_destroy - description: - "Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie. Dit kan alleen\ - \ als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd\ - \ op:\n - `zaaktype` of `informatieobjecttype` is nog niet gepubliceerd" - summary: Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - zaaktype-informatieobjecttypen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: zaakinformatieobjecttype_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ZAAK-INFORMATIEOBJECT-TYPE opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaaktype-informatieobjecttypen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaaktypen: - get: - operationId: zaaktype_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle ZAAKTYPEn opvragen. - parameters: - - name: catalogus - required: false - in: query - description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. - schema: - type: string - format: uri - - name: identificatie - required: false - in: query - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - schema: - type: string - - name: trefwoorden - required: false - in: query - description: Multiple values may be separated by commas. - schema: - type: array - items: - type: string - style: form - explode: false - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - zaaktypen - security: - - JWT-Claims: - - (catalogi.lezen | documenten.lezen | zaken.lezen) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedZaakTypeList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaaktype_create - description: - "Er wordt gevalideerd op:\n- geldigheid `catalogus` URL, dit moet\ - \ een catalogus binnen dezelfde API zijn\n - Uniciteit `catalogus` en `zaaktypeidentificatie`.\ - \ Dezelfde zaaktypeidentificatie mag enkel opnieuw gebruikt worden als het zaaktype\ - \ een andere geldigheidsperiode kent dan bestaande zaaktypen.\n - `deelzaaktypen`\ - \ moeten tot dezelfde catalogus behoren als het ZAAKTYPE." - summary: Maak een ZAAKTYPE aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaaktypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakTypeCreate' - required: true - security: - - JWT-Claims: - - catalogi.schrijven - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakType' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaaktypen/{uuid}: - get: - operationId: zaaktype_retrieve - description: Een specifieke ZAAKTYPE opvragen. - summary: Een specifieke ZAAKTYPE opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: query - name: datumGeldigheid - schema: - type: string - description: - filter op datumGeldigheid voor het zelf en alle onderliggende - objecten - tags: - - zaaktypen - security: - - JWT-Claims: - - (catalogi.lezen | documenten.lezen | zaken.lezen) - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakType' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: zaaktype_update - description: - "Werk een ZAAKTYPE in zijn geheel bij. Dit kan alleen als het een\ - \ concept betreft. Er wordt gevalideerd op:\n - `deelzaaktypen` moeten tot\ - \ dezelfde catalogus behoren als het ZAAKTYPE." - summary: Werk een ZAAKTYPE in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaaktypen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakTypeUpdate' - required: true - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakType' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: zaaktype_partial_update - description: - "Werk een ZAAKTYPE deels bij. Dit kan alleen als het een concept\ - \ betreft. Er wordt gevalideerd op:\n - `deelzaaktypen` moeten tot dezelfde\ - \ catalogus behoren als het ZAAKTYPE." - summary: Werk een ZAAKTYPE deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaaktypen - requestBody: - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified request body - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified response body - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaaktype_destroy - description: Verwijder een ZAAKTYPE. Dit kan alleen als het een concept betreft. - summary: Verwijder een ZAAKTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - zaaktypen - security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified response body - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: zaaktype_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ZAAKTYPE opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaaktypen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaaktypen/{uuid}/publish: - post: - operationId: zaaktype_publish - description: - Publiceren van het zaaktype zorgt ervoor dat dit in een Zaken API - kan gebruiktworden. Na het publiceren van een zaaktype zijn geen inhoudelijke - wijzigingenmeer mogelijk - ook niet de statustypen, eigenschappen... etc. - Indien er na hetpubliceren nog wat gewijzigd moet worden, dan moet je een - nieuwe versieaanmaken. - summary: Publiceer het concept ZAAKTYPE. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaaktypen - requestBody: - content: - application/json: - schema: - type: object - additionalProperties: {} - description: Unspecified request body - security: - - JWT-Claims: - - catalogi.schrijven - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakType' - description: OK - '400': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '404': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '401': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error -components: - responses: - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - schemas: - AardRelatieEnum: - enum: - - vervolg - - bijdrage - - onderwerp - type: string - AfleidingswijzeEnum: - enum: - - afgehandeld - - ander_datumkenmerk - - eigenschap - - gerelateerde_zaak - - hoofdzaak - - ingangsdatum_besluit - - termijn - - vervaldatum_besluit - - zaakobject - type: string - ArchiefnominatieEnum: - enum: - - blijvend_bewaren - - vernietigen - type: string - BesluitType: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - catalogus: - type: string - format: uri - description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. - title: catalogus - zaaktypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE - title: zaaktypen - uniqueItems: true - omschrijving: - type: string - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - title: omschrijving - maxLength: 80 - omschrijvingGeneriek: - type: string - description: - Algemeen gehanteerde omschrijving van de aard van BESLUITen - van het BESLUITTYPE - title: omschrijving generiek - maxLength: 80 - besluitcategorie: - type: string - description: Typering van de aard van BESLUITen van het BESLUITTYPE. - title: besluitcategorie - maxLength: 40 - reactietermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- - of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype - mogelijk is. - title: reactietermijn - format: duration - publicatieIndicatie: - type: boolean - description: - Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten - worden. - title: publicatie indicatie - publicatietekst: - type: string - description: - De generieke tekst van de publicatie van BESLUITen van dit - BESLUITTYPE - title: publicatietekst - publicatietermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- - of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten - blijven. - title: publicatietermijn - format: duration - toelichting: - type: string - description: Een eventuele toelichting op dit BESLUITTYPE. - title: toelichting - informatieobjecttypen: - type: array - items: - type: string - format: uri - title: '' - description: - URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten - waarin besluiten van dit BESLUITTYPE worden vastgelegd. - title: informatieobjecttypen - uniqueItems: true - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - concept: - type: boolean - readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn - niet-definitieve versies en zouden niet gebruikt moeten worden buiten - deze API. - title: concept - resultaattypen: - type: array - items: - type: string - format: uri - title: Is resultaat van - readOnly: true - title: Is resultaat van - description: - Het BESLUITTYPE van besluiten die gepaard gaan met resultaten - van het RESULTAATTYPE. - uniqueItems: true - resultaattypenOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. - title: is resultaat van - uniqueItems: true - vastgelegdIn: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: informatieobjecttypen - uniqueItems: true - required: - - beginGeldigheid - - catalogus - - concept - - informatieobjecttypen - - publicatieIndicatie - - resultaattypen - - resultaattypenOmschrijving - - url - - vastgelegdIn - - zaaktypen - BesluitTypeExpanded: - allOf: - - $ref: '#/components/schemas/BesluitType' - - properties: - _expand: - $ref: '#/components/schemas/BesluitTypeEmbedded' - BesluitTypeEmbedded: - type: object - properties: - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - zaaktypen: - type: array - items: - $ref: '#/components/schemas/ZaakTypeExpanded' - informatieobjecttypen: - type: array - items: - $ref: '#/components/schemas/InformatieObjectTypeExpanded' - resultaattypen: - type: array - items: - $ref: '#/components/schemas/ResultaatTypeExpanded' - EmptyObject: - type: object - description: Leeg object. Dit wordt teruggeven indien het te expanderen veld een null waarde heeft. - example: {} - BesluitTypeCreate: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - catalogus: - type: string - format: uri - description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. - title: catalogus - zaaktypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE - title: zaaktypen - uniqueItems: true - omschrijving: - type: string - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - title: omschrijving - maxLength: 80 - omschrijvingGeneriek: - type: string - description: - Algemeen gehanteerde omschrijving van de aard van BESLUITen - van het BESLUITTYPE - title: omschrijving generiek - maxLength: 80 - besluitcategorie: - type: string - description: Typering van de aard van BESLUITen van het BESLUITTYPE. - title: besluitcategorie - maxLength: 40 - reactietermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- - of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype - mogelijk is. - title: reactietermijn - format: duration - publicatieIndicatie: - type: boolean - description: - Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten - worden. - title: publicatie indicatie - publicatietekst: - type: string - description: - De generieke tekst van de publicatie van BESLUITen van dit - BESLUITTYPE - title: publicatietekst - publicatietermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- - of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten - blijven. - title: publicatietermijn - format: duration - toelichting: - type: string - description: Een eventuele toelichting op dit BESLUITTYPE. - title: toelichting - informatieobjecttypen: - type: array - items: - type: string - title: '' - description: - '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten - waarin besluiten van dit BESLUITTYPE worden vastgelegd.' - title: informatieobjecttypen - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - concept: - type: boolean - readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn - niet-definitieve versies en zouden niet gebruikt moeten worden buiten - deze API. - title: concept - resultaattypen: - type: array - items: - type: string - format: uri - title: Is resultaat van - readOnly: true - title: Is resultaat van - description: - Het BESLUITTYPE van besluiten die gepaard gaan met resultaten - van het RESULTAATTYPE. - uniqueItems: true - resultaattypenOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. - title: is resultaat van - uniqueItems: true - vastgelegdIn: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: informatieobjecttypen - uniqueItems: true - required: - - beginGeldigheid - - catalogus - - concept - - informatieobjecttypen - - publicatieIndicatie - - resultaattypen - - resultaattypenOmschrijving - - url - - vastgelegdIn - - zaaktypen - BesluitTypeUpdate: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - catalogus: - type: string - format: uri - description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. - title: catalogus - zaaktypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE - title: zaaktypen - uniqueItems: true - omschrijving: - type: string - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - title: omschrijving - maxLength: 80 - omschrijvingGeneriek: - type: string - description: - Algemeen gehanteerde omschrijving van de aard van BESLUITen - van het BESLUITTYPE - title: omschrijving generiek - maxLength: 80 - besluitcategorie: - type: string - description: Typering van de aard van BESLUITen van het BESLUITTYPE. - title: besluitcategorie - maxLength: 40 - reactietermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- - of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype - mogelijk is. - title: reactietermijn - format: duration - publicatieIndicatie: - type: boolean - description: - Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten - worden. - title: publicatie indicatie - publicatietekst: - type: string - description: - De generieke tekst van de publicatie van BESLUITen van dit - BESLUITTYPE - title: publicatietekst - publicatietermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- - of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten - blijven. - title: publicatietermijn - format: duration - toelichting: - type: string - description: Een eventuele toelichting op dit BESLUITTYPE. - title: toelichting - informatieobjecttypen: - type: array - items: - type: string - title: '' - description: - '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten - waarin besluiten van dit BESLUITTYPE worden vastgelegd.' - title: informatieobjecttypen - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - concept: - type: boolean - readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn - niet-definitieve versies en zouden niet gebruikt moeten worden buiten - deze API. - title: concept - resultaattypen: - type: array - items: - type: string - format: uri - title: Is resultaat van - readOnly: true - title: Is resultaat van - description: - Het BESLUITTYPE van besluiten die gepaard gaan met resultaten - van het RESULTAATTYPE. - uniqueItems: true - resultaattypenOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. - title: is resultaat van - uniqueItems: true - vastgelegdIn: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: informatieobjecttypen - uniqueItems: true - required: - - beginGeldigheid - - catalogus - - concept - - informatieobjecttypen - - publicatieIndicatie - - resultaattypen - - resultaattypenOmschrijving - - url - - vastgelegdIn - - zaaktypen - BlankEnum: - enum: - - '' - BronCatalogus: - type: object - description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. - properties: - url: - type: string - format: uri - title: URL-referentie broncatalogus - maxLength: 200 - domein: - type: string - description: Het domein van de CATALOGUS waaraan het ZAAKTYPE is ontleend. - title: broncatalogus domein - maxLength: 5 - rsin: - type: string - description: - Het RSIN van de INGESCHREVEN NIET-NATUURLIJK PERSOON die beheerder - is van de CATALOGUS waaraan het ZAAKTYPE is ontleend. - title: broncatalogus rsin - maxLength: 9 - required: - - domein - - rsin - - url - BronZaaktype: - type: object - description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. - properties: - url: - type: string - format: uri - title: URL-referentie bronzaaktype - maxLength: 200 - identificatie: - type: string - description: De Zaaktype-identificatie van het bronzaaktype binnen de CATALOGUS. - title: bronzaaktype identificatie - maxLength: 50 - omschrijving: - type: string - description: - De Zaaktype-omschrijving van het bronzaaktype, zoals gehanteerd - in de Broncatalogus. - title: bronzaaktype omschrijving - maxLength: 80 - required: - - identificatie - - omschrijving - - url - BrondatumArchiefprocedure: - type: object - description: - Specificatie voor het bepalen van de brondatum voor de start van - de Archiefactietermijn (=brondatum) van het zaakdossier. - properties: - afleidingswijze: - allOf: - - $ref: '#/components/schemas/AfleidingswijzeEnum' - title: Afleidingswijze brondatum - description: - "Wijze van bepalen van de brondatum.\n\nUitleg bij mogelijke\ - \ waarden:\n\n* `afgehandeld` - (Afgehandeld) De termijn start op de datum\ - \ waarop de zaak is afgehandeld (ZAAK.Einddatum in het RGBZ).\n* `ander_datumkenmerk`\ - \ - (Ander datumkenmerk) De termijn start op de datum die is vastgelegd\ - \ in een ander datumveld dan de datumvelden waarop de overige waarden\ - \ (van deze attribuutsoort) betrekking hebben. `Objecttype`, `Registratie`\ - \ en `Datumkenmerk` zijn niet leeg.\n* `eigenschap` - (Eigenschap) De\ - \ termijn start op de datum die vermeld is in een zaaktype-specifieke\ - \ eigenschap (zijnde een `datumveld`). `ResultaatType.ZaakType` heeft\ - \ een `Eigenschap`; `Objecttype`, en `Datumkenmerk` zijn niet leeg.\n\ - * `gerelateerde_zaak` - (Gerelateerde zaak) De termijn start op de datum\ - \ waarop de gerelateerde zaak is afgehandeld (`ZAAK.Einddatum` of `ZAAK.Gerelateerde_zaak.Einddatum`\ - \ in het RGBZ). `ResultaatType.ZaakType` heeft gerelateerd `ZaakType`\n\ - * `hoofdzaak` - (Hoofdzaak) De termijn start op de datum waarop de gerelateerde\ - \ zaak is afgehandeld, waarvan de zaak een deelzaak is (`ZAAK.Einddatum`\ - \ van de hoofdzaak in het RGBZ). ResultaatType.ZaakType is deelzaaktype\ - \ van ZaakType.\n* `ingangsdatum_besluit` - (Ingangsdatum besluit) De\ - \ termijn start op de datum waarop het besluit van kracht wordt (`BESLUIT.Ingangsdatum`\ - \ in het RGBZ).\tResultaatType.ZaakType heeft relevant BesluitType\n*\ - \ `termijn` - (Termijn) De termijn start een vast aantal jaren na de datum\ - \ waarop de zaak is afgehandeld (`ZAAK.Einddatum` in het RGBZ).\n* `vervaldatum_besluit`\ - \ - (Vervaldatum besluit) De termijn start op de dag na de datum waarop\ - \ het besluit vervalt (`BESLUIT.Vervaldatum` in het RGBZ). ResultaatType.ZaakType\ - \ heeft relevant BesluitType\n* `zaakobject` - (Zaakobject) De termijn\ - \ start op de einddatum geldigheid van het zaakobject waarop de zaak betrekking\ - \ heeft (bijvoorbeeld de overlijdendatum van een Persoon). M.b.v. de attribuutsoort\ - \ `Objecttype` wordt vastgelegd om welke zaakobjecttype het gaat; m.b.v.\ - \ de attribuutsoort `Datumkenmerk` wordt vastgelegd welke datum-attribuutsoort\ - \ van het zaakobjecttype het betreft." - datumkenmerk: - type: string - description: - Naam van de attribuutsoort van het procesobject dat bepalend - is voor het einde van de procestermijn. - title: datumkenmerk - maxLength: 80 - einddatumBekend: - type: boolean - description: - Indicatie dat de einddatum van het procesobject gedurende de - uitvoering van de zaak bekend moet worden. Indien deze nog niet bekend - is en deze waarde staat op `true`, dan kan de zaak (nog) niet afgesloten - worden. - title: einddatum bekend - objecttype: - description: - 'Het soort object in de registratie dat het procesobject representeert. - - - Uitleg bij mogelijke waarden: - - - * `adres` - Adres - - * `besluit` - Besluit - - * `buurt` - Buurt - - * `enkelvoudig_document` - Enkelvoudig document - - * `gemeente` - Gemeente - - * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte - - * `huishouden` - Huishouden - - * `inrichtingselement` - Inrichtingselement - - * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak - - * `kunstwerkdeel` - Kunstwerkdeel - - * `maatschappelijke_activiteit` - Maatschappelijke activiteit - - * `medewerker` - Medewerker - - * `natuurlijk_persoon` - Natuurlijk persoon - - * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon - - * `openbare_ruimte` - Openbare ruimte - - * `organisatorische_eenheid` - Organisatorische eenheid - - * `pand` - Pand - - * `spoorbaandeel` - Spoorbaandeel - - * `status` - Status - - * `terreindeel` - Terreindeel - - * `terrein_gebouwd_object` - Terrein gebouwd object - - * `vestiging` - Vestiging - - * `waterdeel` - Waterdeel - - * `wegdeel` - Wegdeel - - * `wijk` - Wijk - - * `woonplaats` - Woonplaats - - * `woz_deelobject` - Woz deel object - - * `woz_object` - Woz object - - * `woz_waarde` - Woz waarde - - * `zakelijk_recht` - Zakelijk recht - - * `overige` - Overige' - title: objecttype - oneOf: - - $ref: '#/components/schemas/ObjecttypeEnum' - - $ref: '#/components/schemas/BlankEnum' - registratie: - type: string - description: - De naam van de registratie waarvan het procesobject deel uit - maakt. - title: registratie - maxLength: 80 - procestermijn: - type: string - nullable: true - title: Brondatum procestermijn - description: - De periode dat het zaakdossier na afronding van de zaak actief - gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening - van de organisatie. Enkel relevant indien de afleidingswijze 'termijn' - is. - format: duration - required: - - afleidingswijze - nullable: true - Catalogus: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - domein: - type: string - description: - Een afkorting waarmee wordt aangegeven voor welk domein in - een CATALOGUS ZAAKTYPEn zijn uitgewerkt. - title: domein - maxLength: 5 - rsin: - type: string - description: - Het door een kamer toegekend uniek nummer voor de INGESCHREVEN - NIET-NATUURLIJK PERSOON die de eigenaar is van een CATALOGUS. - title: rsin - maxLength: 9 - contactpersoonBeheerNaam: - type: string - title: Naam contactpersoon - description: - De naam van de contactpersoon die verantwoordelijk is voor - het beheer van de CATALOGUS. - maxLength: 40 - contactpersoonBeheerTelefoonnummer: - type: string - title: Telefoonnummer - description: - Het telefoonnummer van de contactpersoon die verantwoordelijk - is voor het beheer van de CATALOGUS. - maxLength: 20 - contactpersoonBeheerEmailadres: - type: string - format: email - title: Emailadres - description: - Het emailadres van de contactpersoon die verantwoordelijk is - voor het beheer van de CATALOGUS. - maxLength: 254 - zaaktypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar ZAAKTYPEn die in deze CATALOGUS worden - ontsloten. - title: Catalogus - uniqueItems: true - besluittypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar BESLUITTYPEn die in deze CATALOGUS worden - ontsloten. - title: catalogus - uniqueItems: true - informatieobjecttypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar INFORMATIEOBJECTTYPEn die in deze CATALOGUS - worden ontsloten. - title: Catalogus - uniqueItems: true - naam: - type: string - nullable: true - description: De benaming die is gegeven aan de zaaktypecatalogus. - title: naam - maxLength: 200 - versie: - type: string - nullable: true - description: Versie-aanduiding van de van toepassing zijnde zaaktypecatalogus. - title: versie - maxLength: 20 - begindatumVersie: - type: string - format: date - nullable: true - description: - Datum waarop de versie van de zaaktypecatalogus van toepassing - is geworden. - title: begindatum versie - required: - - besluittypen - - contactpersoonBeheerNaam - - domein - - informatieobjecttypen - - rsin - - url - - zaaktypen - CatalogusExpanded: - allOf: - - $ref: '#/components/schemas/Catalogus' - - properties: - _expand: - $ref: '#/components/schemas/CatalogusEmbedded' - CatalogusEmbedded: - type: object - properties: - zaaktypen: - type: array - items: - $ref: '#/components/schemas/ZaakTypeExpanded' - besluittypen: - type: array - items: - $ref: '#/components/schemas/BesluitTypeExpanded' - informatieobjecttypen: - type: array - items: - $ref: '#/components/schemas/InformatieObjectTypeExpanded' - CheckListItem: - type: object - properties: - itemnaam: - type: string - description: De betekenisvolle benaming van het checklistitem - title: itemnaam - maxLength: 30 - toelichting: - type: string - nullable: true - description: - Beschrijving van de overwegingen bij het controleren van het - aandachtspunt - title: toelichting - maxLength: 1000 - vraagstelling: - type: string - description: - Een betekenisvolle vraag waaruit blijkt waarop het aandachtspunt - gecontroleerd moet worden. - title: vraagstelling - maxLength: 255 - verplicht: - type: boolean - description: - Het al dan niet verplicht zijn van controle van het aandachtspunt - voorafgaand aan het bereiken van de status van het gerelateerde STATUSTYPE. - title: verplicht - required: - - itemnaam - - vraagstelling - Eigenschap: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - naam: - type: string - description: De naam van de EIGENSCHAP - title: eigenschapnaam - maxLength: 20 - catalogus: - type: string - format: uri - readOnly: true - title: catalogus - definitie: - type: string - description: De beschrijving van de betekenis van deze EIGENSCHAP - title: definitie - maxLength: 255 - specificatie: - allOf: - - $ref: '#/components/schemas/EigenschapSpecificatie' - title: specificatie van eigenschap - toelichting: - type: string - description: - Een toelichting op deze EIGENSCHAP en het belang hiervan voor - zaken van dit ZAAKTYPE. - title: toelichting - maxLength: 1000 - zaaktype: - type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze - EIGENSCHAP van belang is. - title: Zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype - statustype: - type: string - format: uri - nullable: true - title: Status type - description: - Status type moet (onder andere) deze EIGENSCHAP hebben, voordat - een STATUS van het STATUSTYPE kan worden gezet. - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de EIGENSCHAP is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de EIGENSCHAP is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - required: - - catalogus - - definitie - - naam - - specificatie - - url - - zaaktype - - zaaktypeIdentificatie - EigenschapExpanded: - allOf: - - $ref: '#/components/schemas/Eigenschap' - - properties: - _expand: - $ref: '#/components/schemas/EigenschapEmbedded' - EigenschapEmbedded: - type: object - properties: - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - zaaktype: - oneOf: - - $ref: '#/components/schemas/ZaakTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - statustype: - oneOf: - - $ref: '#/components/schemas/StatusTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - EigenschapSpecificatie: - type: object - properties: - groep: - type: string - description: - Benaming van het object of groepattribuut waarvan de EIGENSCHAP - een inhoudelijk gegeven specificeert. - title: groep - maxLength: 32 - formaat: - allOf: - - $ref: '#/components/schemas/FormaatEnum' - description: - 'Het soort tekens waarmee waarden van de EIGENSCHAP kunnen - worden vastgelegd. - - - Uitleg bij mogelijke waarden: - - - * `tekst` - Tekst - - * `getal` - Getal - - * `datum` - Datum - - * `datum_tijd` - Datum/tijd' - title: formaat - lengte: - type: string - description: - Het aantal karakters (lengte) waarmee waarden van de EIGENSCHAP - worden vastgelegd. - title: lengte - maxLength: 14 - kardinaliteit: - type: string - description: - Het aantal mogelijke voorkomens van waarden van deze EIGENSCHAP - bij een zaak van het ZAAKTYPE. - title: kardinaliteit - maxLength: 3 - waardenverzameling: - type: array - items: - type: string - maxLength: 100 - description: Waarden die deze EIGENSCHAP kan hebben. - title: waardenverzameling - required: - - formaat - - kardinaliteit - - lengte - FieldValidationError: - type: object - description: Formaat van validatiefouten. - properties: - name: - type: string - description: Naam van het veld met ongeldige gegevens - title: name - code: - type: string - description: Systeemcode die het type fout aangeeft - title: code - reason: - type: string - description: Uitleg wat er precies fout is met de gegevens - title: reason - required: - - code - - name - - reason - FormaatEnum: - enum: - - tekst - - getal - - datum - - datum_tijd - type: string - Fout: - type: object - description: Formaat van HTTP 4xx en 5xx fouten. - properties: - type: - type: string - description: URI referentie naar het type fout, bedoeld voor developers - title: type - code: - type: string - description: Systeemcode die het type fout aangeeft - title: code - title: - type: string - description: Generieke titel voor het type fout - title: title - status: - type: integer - description: De HTTP status code - title: status - detail: - type: string - description: Extra informatie bij de fout, indien beschikbaar - title: detail - instance: - type: string - description: - URI met referentie naar dit specifiek voorkomen van de fout. - Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. - title: instance - required: - - code - - detail - - instance - - status - - title - IndicatieInternOfExternEnum: - enum: - - intern - - extern - type: string - InformatieObjectType: - type: object - description: Serializer based on ``IOT-basis`` specified in XSD ``ztc0310_ent_basis.xsd``. - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - catalogus: - type: string - format: uri - description: - URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE - behoort. - title: Catalogus - omschrijving: - type: string - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: omschrijving - maxLength: 80 - vertrouwelijkheidaanduiding: - allOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - description: - 'Aanduiding van de mate waarin informatieobjecten van dit INFORMATIEOBJECTTYPE - voor de openbaarheid bestemd zijn. - - - Uitleg bij mogelijke waarden: - - - * `openbaar` - Openbaar - - * `beperkt_openbaar` - Beperkt openbaar - - * `intern` - Intern - - * `zaakvertrouwelijk` - Zaakvertrouwelijk - - * `vertrouwelijk` - Vertrouwelijk - - * `confidentieel` - Confidentieel - - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' - title: vertrouwelijkheidaanduiding - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - concept: - type: boolean - readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn - niet-definitieve versies en zouden niet gebruikt moeten worden buiten - deze API. - title: concept - zaaktypen: - type: string - readOnly: true - title: zaaktypen - besluittypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten - waarin besluiten van dit BESLUITTYPE worden vastgelegd. - title: informatieobjecttypen - uniqueItems: true - informatieobjectcategorie: - type: string - title: Categorie - description: Typering van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - maxLength: 80 - trefwoord: - type: array - items: - type: string - maxLength: 30 - description: - Trefwoord(en) waarmee informatieobjecten van het INFORMATIEOBJECTTYPE - kunnen worden gekarakteriseerd. (Gebruik een komma om waarden van elkaar - te onderscheiden.) - title: trefwoord - omschrijvingGeneriek: - allOf: - - $ref: '#/components/schemas/InformatieObjectTypeOmschrijvingGeneriek' - title: omschrijving generiek - required: - - beginGeldigheid - - besluittypen - - catalogus - - concept - - informatieobjectcategorie - - omschrijving - - url - - vertrouwelijkheidaanduiding - - zaaktypen - InformatieObjectTypeExpanded: - allOf: - - $ref: '#/components/schemas/InformatieObjectType' - - properties: - _expand: - $ref: '#/components/schemas/InformatieObjectTypeEmbedded' - InformatieObjectTypeEmbedded: - type: object - properties: - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - zaaktypen: - type: array - items: - $ref: '#/components/schemas/ZaakTypeExpanded' - besluittypen: - type: array - items: - $ref: '#/components/schemas/BesluitTypeExpanded' - InformatieObjectTypeOmschrijvingGeneriek: - type: object - properties: - informatieobjecttypeOmschrijvingGeneriek: - type: string - description: Algemeen gehanteerde omschrijving van het type informatieobject. - title: informatieobjecttype omschrijving generiek - maxLength: 80 - definitieInformatieobjecttypeOmschrijvingGeneriek: - type: string - title: Definitie - description: Nauwkeurige beschrijving van het generieke type informatieobject - maxLength: 255 - herkomstInformatieobjecttypeOmschrijvingGeneriek: - type: string - title: Herkomst - description: - De naam van de waardenverzameling, of van de beherende organisatie - daarvan, waaruit de waarde is overgenomen. - maxLength: 12 - hierarchieInformatieobjecttypeOmschrijvingGeneriek: - type: string - title: Hierarchie - description: De plaats in de rangorde van het informatieobjecttype. - maxLength: 80 - opmerkingInformatieobjecttypeOmschrijvingGeneriek: - type: string - nullable: true - title: Opmerking - description: Zinvolle toelichting bij het informatieobjecttype - maxLength: 255 - required: - - definitieInformatieobjecttypeOmschrijvingGeneriek - - herkomstInformatieobjecttypeOmschrijvingGeneriek - - hierarchieInformatieobjecttypeOmschrijvingGeneriek - - informatieobjecttypeOmschrijvingGeneriek - ObjecttypeEnum: - enum: - - adres - - besluit - - buurt - - enkelvoudig_document - - gemeente - - gemeentelijke_openbare_ruimte - - huishouden - - inrichtingselement - - kadastrale_onroerende_zaak - - kunstwerkdeel - - maatschappelijke_activiteit - - medewerker - - natuurlijk_persoon - - niet_natuurlijk_persoon - - openbare_ruimte - - organisatorische_eenheid - - pand - - spoorbaandeel - - status - - terreindeel - - terrein_gebouwd_object - - vestiging - - waterdeel - - wegdeel - - wijk - - woonplaats - - woz_deelobject - - woz_object - - woz_waarde - - zakelijk_recht - - overige - type: string - OmschrijvingGeneriekEnum: - enum: - - adviseur - - behandelaar - - belanghebbende - - beslisser - - initiator - - klantcontacter - - zaakcoordinator - - mede_initiator - type: string - PaginatedBesluitTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/BesluitType' - PaginatedCatalogusList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Catalogus' - PaginatedEigenschapList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Eigenschap' - PaginatedResultaatTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/ResultaatType' - PaginatedInformatieObjectTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/InformatieObjectType' - PaginatedRolTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/RolType' - PaginatedStatusTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/StatusType' - PaginatedZaakObjectTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/ZaakObjectType' - PaginatedZaakTypeInformatieObjectTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' - PaginatedZaakTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/ZaakType' - PatchedEigenschap: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - naam: - type: string - description: De naam van de EIGENSCHAP - title: eigenschapnaam - maxLength: 20 - catalogus: - type: string - format: uri - readOnly: true - title: catalogus - definitie: - type: string - description: De beschrijving van de betekenis van deze EIGENSCHAP - title: definitie - maxLength: 255 - specificatie: - allOf: - - $ref: '#/components/schemas/EigenschapSpecificatie' - title: specificatie van eigenschap - toelichting: - type: string - description: - Een toelichting op deze EIGENSCHAP en het belang hiervan voor - zaken van dit ZAAKTYPE. - title: toelichting - maxLength: 1000 - zaaktype: - type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze - EIGENSCHAP van belang is. - title: Zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype - statustype: - type: string - format: uri - nullable: true - title: Status type - description: - Status type moet (onder andere) deze EIGENSCHAP hebben, voordat - een STATUS van het STATUSTYPE kan worden gezet. - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de EIGENSCHAP is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de EIGENSCHAP is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - PatchedResultaatType: - type: object - description: 'Set gegevensgroepdata from validated nested data. - - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - title: is van - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten - van dit RESULTAATTYPE bereikt kunnen worden. - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: is relevant voor - omschrijving: - type: string - description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. - title: omschrijving - maxLength: 30 - resultaattypeomschrijving: - type: string - format: uri - description: - Algemeen gehanteerde omschrijving van de aard van resultaten - van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst - van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving - generiek' - title: resultaattypeomschrijving - maxLength: 1000 - omschrijvingGeneriek: - type: string - readOnly: true - description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) - title: omschrijving generiek - selectielijstklasse: - type: string - format: uri - description: - URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE - relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT - in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. - title: selectielijstklasse - maxLength: 1000 - toelichting: - type: string - description: - Een toelichting op dit RESULTAATTYPE en het belang hiervan - voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. - title: toelichting - archiefnominatie: - description: - 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit - RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden - vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de - selectielijst. - - - Uitleg bij mogelijke waarden: - - - * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum - overgedragen worden naar een archiefbewaarplaats. - - * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd - worden.' - title: archiefnominatie - oneOf: - - $ref: '#/components/schemas/ArchiefnominatieEnum' - - $ref: '#/components/schemas/BlankEnum' - archiefactietermijn: - type: string - nullable: true - description: - De termijn, na het vervallen van het bedrjfsvoeringsbelang, - waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) - van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht - (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers - betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend - te bewaren zaakdossiers betreft het de termijn vanaf afronding van de - zaak tot overbrenging (de procestermijn is dan nihil). - title: archiefactietermijn - format: duration - brondatumArchiefprocedure: - allOf: - - $ref: '#/components/schemas/BrondatumArchiefprocedure' - nullable: true - description: - Specificatie voor het bepalen van de brondatum voor de start - van de Archiefactietermijn (=brondatum) van het zaakdossier. - title: brondatumArchiefprocedure - procesobjectaard: - type: string - nullable: true - description: - Omschrijving van het object, subject of gebeurtenis waarop, - vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking - heeft. - title: procesobjectaard - maxLength: 200 - catalogus: - type: string - format: uri - nullable: true - description: - URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE - behoort. - title: catalogus - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - indicatieSpecifiek: - type: boolean - nullable: true - description: - Aanduiding of het, vanuit archiveringsoptiek, een resultaattype - betreft dat specifiek is voor een bepaalde procesobjectaard. - title: indicatie specifiek - procestermijn: - type: string - nullable: true - description: - De periode dat het zaakdossier na afronding van de zaak actief - gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening - van de organisatie. - title: procestermijn - format: duration - besluittypen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - title: is resultaat van - uniqueItems: true - besluittypeOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - title: is resultaat van - uniqueItems: true - informatieobjecttypen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - description: - De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn - in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van - dit RESULTAATTYPE kan worden gezet. - title: informatieobjecttypen - uniqueItems: true - informatieobjecttypeOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: informatieobjecttypen - uniqueItems: true - PatchedRolType: - type: object - description: Adds nested create feature - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken - kunnen zijn. - title: Zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype - omschrijving: - type: string - description: Omschrijving van de aard van de ROL. - title: omschrijving - maxLength: 100 - omschrijvingGeneriek: - allOf: - - $ref: '#/components/schemas/OmschrijvingGeneriekEnum' - description: - "Algemeen gehanteerde omschrijving van de aard van de ROL.\n\ - \nUitleg bij mogelijke waarden:\n\n* `adviseur` - (Adviseur) Kennis in\ - \ dienst stellen van de behandeling van (een deel van) een zaak.\n* `behandelaar`\ - \ - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van)\ - \ een zaak.\n* `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief\ - \ belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst\ - \ van een zaak.\n* `beslisser` - (Beslisser) Nemen van besluiten die voor\ - \ de uitkomst van een zaak noodzakelijk zijn.\n* `initiator` - (Initiator)\ - \ Aanleiding geven tot de start van een zaak ..\n* `klantcontacter` -\ - \ (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers\ - \ en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6rdinator) Er voor\ - \ zorg dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt\ - \ conform de daarover gemaakte afspraken.\n* `mede_initiator` - Mede-initiator" - title: omschrijving generiek - catalogus: - type: string - format: uri - nullable: true - description: URL-referentie naar de CATALOGUS waartoe dit ROLTYPE behoort. - title: catalogus - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - PatchedStatusType: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - omschrijving: - type: string - description: - Een korte, voor de initiator van de zaak relevante, omschrijving - van de aard van de STATUS van zaken van een ZAAKTYPE. - title: omschrijving - maxLength: 80 - omschrijvingGeneriek: - type: string - description: - Algemeen gehanteerde omschrijving van de aard van STATUSsen - van het STATUSTYPE - title: omschrijving generiek - maxLength: 80 - statustekst: - type: string - description: - De tekst die wordt gebruikt om de Initiator te informeren over - het bereiken van een STATUS van dit STATUSTYPE bij het desbetreffende - ZAAKTYPE. - title: statustekst - maxLength: 1000 - zaaktype: - type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen - van dit STATUSTYPE bereikt kunnen worden. - title: Zaaktype - catalogus: - type: string - format: uri - readOnly: true - title: catalogus - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype - volgnummer: - type: integer - maximum: 9999 - minimum: 1 - description: - Een volgnummer voor statussen van het STATUSTYPE binnen een - zaak. - title: statustypevolgnummer - isEindstatus: - type: boolean - readOnly: true - description: - Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven - is afgeleid uit alle STATUSTYPEn van dit ZAAKTYPE met het hoogste volgnummer. - title: isEindstatus - informeren: - type: boolean - description: - "Aanduiding die aangeeft of na het zetten van een STATUS van\ - \ dit STATUSTYPE de Initiator moet worden ge\xEFnformeerd over de statusovergang." - title: informeren - doorlooptijd: - type: string - nullable: true - description: - De door de zaakbehandelende organisatie(s) gestelde norm voor - de doorlooptijd voor het bereiken van STATUSsen van dit STATUSTYPE bij - het desbetreffende ZAAKTYPE. - title: doorlooptijd status - format: duration - toelichting: - type: string - nullable: true - description: Een eventuele toelichting op dit STATUSTYPE. - title: toelichting - maxLength: 1000 - checklistitemStatustype: - type: array - items: - $ref: '#/components/schemas/CheckListItem' - title: checklistitem - eigenschappen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - description: - de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen, - voordat een STATUS van dit STATUSTYPE kan worden gezet. - title: eigenschappen - uniqueItems: true - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - PatchedZaakObjectType: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - anderObjecttype: - type: boolean - description: - Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een - ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. - title: Ander objecttype - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - objecttype: - type: string - format: uri - description: - URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE - behoort. - title: Objecttype - maxLength: 200 - relatieOmschrijving: - type: string - description: - Omschrijving van de betrekking van het Objecttype op zaken - van het gerelateerde ZAAKTYPE. - title: Relatie omschrijving - maxLength: 80 - zaaktype: - type: string - format: uri - description: - URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE - behoort. - title: Zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype - resultaattypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: URL-referenties naar de RESULTAATTYPEN. - title: Zaakobjecttypen - uniqueItems: true - statustypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: URL-referenties naar de STATUSTYPEN. - title: Zaakobjecttypen - uniqueItems: true - catalogus: - type: string - format: uri - description: - URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE - behoort. - title: Catalogus - PatchedZaakTypeInformatieObjectType: - type: object - description: 'Represent a ZaakTypeInformatieObjectType. - - - Relatie met informatieobjecttype dat relevant is voor zaaktype.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - description: URL-referentie naar het ZAAKTYPE. - title: zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: zaaktype - catalogus: - type: string - format: uri - readOnly: true - title: catalogus - informatieobjecttype: - type: string - title: informatieobjecttype - maxLength: 100 - volgnummer: - type: integer - maximum: 999 - minimum: 1 - description: - Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het - ZAAKTYPE. - title: volgnummer - richting: - allOf: - - $ref: '#/components/schemas/RichtingEnum' - description: - 'Aanduiding van de richting van informatieobjecten van het - gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. - - - Uitleg bij mogelijke waarden: - - - * `inkomend` - Inkomend - - * `intern` - Intern - - * `uitgaand` - Uitgaand' - title: richting - statustype: - type: string - format: uri - nullable: true - title: Status type - description: - URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn - verplicht aanwezig moeten zijn. - ReferentieProces: - type: object - description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. - properties: - naam: - type: string - title: Referentieprocesnaam - description: De naam van het Referentieproces. - maxLength: 80 - link: - type: string - format: uri - title: Referentieproceslink - description: De URL naar de beschrijving van het Referentieproces - maxLength: 200 - required: - - naam - ResultaatType: - type: object - description: 'Set gegevensgroepdata from validated nested data. - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - title: is van - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten - van dit RESULTAATTYPE bereikt kunnen worden. - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: is relevant voor - omschrijving: - type: string - description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. - title: omschrijving - maxLength: 30 - resultaattypeomschrijving: - type: string - format: uri - description: - Algemeen gehanteerde omschrijving van de aard van resultaten - van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst - van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving - generiek' - title: resultaattypeomschrijving - maxLength: 1000 - omschrijvingGeneriek: - type: string - readOnly: true - description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) - title: omschrijving generiek - selectielijstklasse: - type: string - format: uri - description: - URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE - relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT - in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. - title: selectielijstklasse - maxLength: 1000 - toelichting: - type: string - description: - Een toelichting op dit RESULTAATTYPE en het belang hiervan - voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. - title: toelichting - archiefnominatie: - description: - 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit - RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden - vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de - selectielijst. - - - Uitleg bij mogelijke waarden: - - - * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum - overgedragen worden naar een archiefbewaarplaats. - - * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd - worden.' - title: archiefnominatie - oneOf: - - $ref: '#/components/schemas/ArchiefnominatieEnum' - - $ref: '#/components/schemas/BlankEnum' - archiefactietermijn: - type: string - nullable: true - description: - De termijn, na het vervallen van het bedrjfsvoeringsbelang, - waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) - van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht - (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers - betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend - te bewaren zaakdossiers betreft het de termijn vanaf afronding van de - zaak tot overbrenging (de procestermijn is dan nihil). - title: archiefactietermijn - format: duration - brondatumArchiefprocedure: - allOf: - - $ref: '#/components/schemas/BrondatumArchiefprocedure' - nullable: true - description: - Specificatie voor het bepalen van de brondatum voor de start - van de Archiefactietermijn (=brondatum) van het zaakdossier. - title: brondatumArchiefprocedure - procesobjectaard: - type: string - nullable: true - description: - Omschrijving van het object, subject of gebeurtenis waarop, - vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking - heeft. - title: procesobjectaard - maxLength: 200 - catalogus: - type: string - format: uri - nullable: true - description: - URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE - behoort. - title: catalogus - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - indicatieSpecifiek: - type: boolean - nullable: true - description: - Aanduiding of het, vanuit archiveringsoptiek, een resultaattype - betreft dat specifiek is voor een bepaalde procesobjectaard. - title: indicatie specifiek - procestermijn: - type: string - nullable: true - description: - De periode dat het zaakdossier na afronding van de zaak actief - gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening - van de organisatie. - title: procestermijn - format: duration - besluittypen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - title: is resultaat van - uniqueItems: true - besluittypeOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - title: is resultaat van - uniqueItems: true - informatieobjecttypen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - description: - De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn - in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van - dit RESULTAATTYPE kan worden gezet. - title: informatieobjecttypen - uniqueItems: true - informatieobjecttypeOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: informatieobjecttypen - uniqueItems: true - required: - - besluittypeOmschrijving - - informatieobjecttypeOmschrijving - - omschrijving - - omschrijvingGeneriek - - resultaattypeomschrijving - - selectielijstklasse - - url - - zaaktype - - zaaktypeIdentificatie - ResultaatTypeExpanded: - allOf: - - $ref: '#/components/schemas/ResultaatType' - - properties: - _expand: - $ref: '#/components/schemas/ResultaatTypeEmbedded' - ResultaatTypeEmbedded: - type: object - properties: - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - zaaktype: - oneOf: - - $ref: '#/components/schemas/ZaakTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - besluittypen: - type: array - items: - $ref: '#/components/schemas/BesluitTypeExpanded' - informatieobjecttypen: - type: array - items: - $ref: '#/components/schemas/InformatieObjectTypeExpanded' - ResultaatTypeCreate: - type: object - description: 'Set gegevensgroepdata from validated nested data. - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - title: is van - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten - van dit RESULTAATTYPE bereikt kunnen worden. - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: is relevant voor - omschrijving: - type: string - description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. - title: omschrijving - maxLength: 30 - resultaattypeomschrijving: - type: string - format: uri - description: - Algemeen gehanteerde omschrijving van de aard van resultaten - van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst - van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving - generiek' - title: resultaattypeomschrijving - maxLength: 1000 - omschrijvingGeneriek: - type: string - readOnly: true - description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) - title: omschrijving generiek - selectielijstklasse: - type: string - format: uri - description: - URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE - relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT - in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. - title: selectielijstklasse - maxLength: 1000 - toelichting: - type: string - description: - Een toelichting op dit RESULTAATTYPE en het belang hiervan - voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. - title: toelichting - archiefnominatie: - description: - 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit - RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden - vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de - selectielijst. - - - Uitleg bij mogelijke waarden: - - - * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum - overgedragen worden naar een archiefbewaarplaats. - - * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd - worden.' - title: archiefnominatie - oneOf: - - $ref: '#/components/schemas/ArchiefnominatieEnum' - - $ref: '#/components/schemas/BlankEnum' - archiefactietermijn: - type: string - nullable: true - description: - De termijn, na het vervallen van het bedrjfsvoeringsbelang, - waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) - van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht - (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers - betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend - te bewaren zaakdossiers betreft het de termijn vanaf afronding van de - zaak tot overbrenging (de procestermijn is dan nihil). - title: archiefactietermijn - format: duration - brondatumArchiefprocedure: - allOf: - - $ref: '#/components/schemas/BrondatumArchiefprocedure' - nullable: true - description: - Specificatie voor het bepalen van de brondatum voor de start - van de Archiefactietermijn (=brondatum) van het zaakdossier. - title: brondatumArchiefprocedure - procesobjectaard: - type: string - nullable: true - description: - Omschrijving van het object, subject of gebeurtenis waarop, - vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking - heeft. - title: procesobjectaard - maxLength: 200 - catalogus: - type: string - format: uri - nullable: true - description: - URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE - behoort. - title: catalogus - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - indicatieSpecifiek: - type: boolean - nullable: true - description: - Aanduiding of het, vanuit archiveringsoptiek, een resultaattype - betreft dat specifiek is voor een bepaalde procesobjectaard. - title: indicatie specifiek - procestermijn: - type: string - nullable: true - description: - De periode dat het zaakdossier na afronding van de zaak actief - gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening - van de organisatie. - title: procestermijn - format: duration - besluittypen: - type: array - items: - type: string - title: '' - title: besluittypen - besluittypeOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - title: is resultaat van - uniqueItems: true - informatieobjecttypen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - description: - De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn - in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van - dit RESULTAATTYPE kan worden gezet. - title: informatieobjecttypen - uniqueItems: true - informatieobjecttypeOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: informatieobjecttypen - uniqueItems: true - required: - - besluittypeOmschrijving - - besluittypen - - informatieobjecttypeOmschrijving - - omschrijving - - omschrijvingGeneriek - - resultaattypeomschrijving - - selectielijstklasse - - url - - zaaktype - - zaaktypeIdentificatie - ResultaatTypeUpdate: - type: object - description: 'Set gegevensgroepdata from validated nested data. - - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - title: is van - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten - van dit RESULTAATTYPE bereikt kunnen worden. - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: is relevant voor - omschrijving: - type: string - description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. - title: omschrijving - maxLength: 30 - resultaattypeomschrijving: - type: string - format: uri - description: - Algemeen gehanteerde omschrijving van de aard van resultaten - van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst - van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving - generiek' - title: resultaattypeomschrijving - maxLength: 1000 - omschrijvingGeneriek: - type: string - readOnly: true - description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) - title: omschrijving generiek - selectielijstklasse: - type: string - format: uri - description: - URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE - relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT - in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. - title: selectielijstklasse - maxLength: 1000 - toelichting: - type: string - description: - Een toelichting op dit RESULTAATTYPE en het belang hiervan - voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. - title: toelichting - archiefnominatie: - description: - 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit - RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden - vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de - selectielijst. - - - Uitleg bij mogelijke waarden: - - - * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum - overgedragen worden naar een archiefbewaarplaats. - - * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd - worden.' - title: archiefnominatie - oneOf: - - $ref: '#/components/schemas/ArchiefnominatieEnum' - - $ref: '#/components/schemas/BlankEnum' - archiefactietermijn: - type: string - nullable: true - description: - De termijn, na het vervallen van het bedrjfsvoeringsbelang, - waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) - van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht - (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers - betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend - te bewaren zaakdossiers betreft het de termijn vanaf afronding van de - zaak tot overbrenging (de procestermijn is dan nihil). - title: archiefactietermijn - format: duration - brondatumArchiefprocedure: - allOf: - - $ref: '#/components/schemas/BrondatumArchiefprocedure' - nullable: true - description: - Specificatie voor het bepalen van de brondatum voor de start - van de Archiefactietermijn (=brondatum) van het zaakdossier. - title: brondatumArchiefprocedure - procesobjectaard: - type: string - nullable: true - description: - Omschrijving van het object, subject of gebeurtenis waarop, - vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking - heeft. - title: procesobjectaard - maxLength: 200 - catalogus: - type: string - format: uri - nullable: true - description: - URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE - behoort. - title: catalogus - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - indicatieSpecifiek: - type: boolean - nullable: true - description: - Aanduiding of het, vanuit archiveringsoptiek, een resultaattype - betreft dat specifiek is voor een bepaalde procesobjectaard. - title: indicatie specifiek - procestermijn: - type: string - nullable: true - description: - De periode dat het zaakdossier na afronding van de zaak actief - gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening - van de organisatie. - title: procestermijn - format: duration - besluittypen: - type: array - items: - type: string - title: '' - title: besluittypen - besluittypeOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - title: is resultaat van - uniqueItems: true - informatieobjecttypen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - description: - De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn - in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van - dit RESULTAATTYPE kan worden gezet. - title: informatieobjecttypen - uniqueItems: true - informatieobjecttypeOmschrijving: - type: array - items: - type: string - title: '' - readOnly: true - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: informatieobjecttypen - uniqueItems: true - required: - - besluittypeOmschrijving - - besluittypen - - informatieobjecttypeOmschrijving - - omschrijving - - omschrijvingGeneriek - - resultaattypeomschrijving - - selectielijstklasse - - url - - zaaktype - - zaaktypeIdentificatie - RichtingEnum: - enum: - - inkomend - - intern - - uitgaand - type: string - RolType: - type: object - description: Adds nested create feature - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken - kunnen zijn. - title: Zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype - omschrijving: - type: string - description: Omschrijving van de aard van de ROL. - title: omschrijving - maxLength: 100 - omschrijvingGeneriek: - allOf: - - $ref: '#/components/schemas/OmschrijvingGeneriekEnum' - description: - "Algemeen gehanteerde omschrijving van de aard van de ROL.\n\ - \nUitleg bij mogelijke waarden:\n\n* `adviseur` - (Adviseur) Kennis in\ - \ dienst stellen van de behandeling van (een deel van) een zaak.\n* `behandelaar`\ - \ - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van)\ - \ een zaak.\n* `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief\ - \ belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst\ - \ van een zaak.\n* `beslisser` - (Beslisser) Nemen van besluiten die voor\ - \ de uitkomst van een zaak noodzakelijk zijn.\n* `initiator` - (Initiator)\ - \ Aanleiding geven tot de start van een zaak ..\n* `klantcontacter` -\ - \ (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers\ - \ en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6rdinator) Er voor\ - \ zorg dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt\ - \ conform de daarover gemaakte afspraken.\n* `mede_initiator` - Mede-initiator" - title: omschrijving generiek - catalogus: - type: string - format: uri - nullable: true - description: URL-referentie naar de CATALOGUS waartoe dit ROLTYPE behoort. - title: catalogus - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - required: - - omschrijving - - omschrijvingGeneriek - - url - - zaaktype - - zaaktypeIdentificatie - RolTypeExpanded: - allOf: - - $ref: '#/components/schemas/RolType' - - properties: - _expand: - $ref: '#/components/schemas/RolTypeEmbedded' - RolTypeEmbedded: - type: object - properties: - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - zaaktype: - oneOf: - - $ref: '#/components/schemas/ZaakTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - StatusType: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - omschrijving: - type: string - description: - Een korte, voor de initiator van de zaak relevante, omschrijving - van de aard van de STATUS van zaken van een ZAAKTYPE. - title: omschrijving - maxLength: 80 - omschrijvingGeneriek: - type: string - description: - Algemeen gehanteerde omschrijving van de aard van STATUSsen - van het STATUSTYPE - title: omschrijving generiek - maxLength: 80 - statustekst: - type: string - description: - De tekst die wordt gebruikt om de Initiator te informeren over - het bereiken van een STATUS van dit STATUSTYPE bij het desbetreffende - ZAAKTYPE. - title: statustekst - maxLength: 1000 - zaaktype: - type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen - van dit STATUSTYPE bereikt kunnen worden. - title: Zaaktype - catalogus: - type: string - format: uri - readOnly: true - title: catalogus - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype - volgnummer: - type: integer - maximum: 9999 - minimum: 1 - description: - Een volgnummer voor statussen van het STATUSTYPE binnen een - zaak. - title: statustypevolgnummer - isEindstatus: - type: boolean - readOnly: true - description: - Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven - is afgeleid uit alle STATUSTYPEn van dit ZAAKTYPE met het hoogste volgnummer. - title: isEindstatus - informeren: - type: boolean - description: - "Aanduiding die aangeeft of na het zetten van een STATUS van\ - \ dit STATUSTYPE de Initiator moet worden ge\xEFnformeerd over de statusovergang." - title: informeren - doorlooptijd: - type: string - nullable: true - description: - De door de zaakbehandelende organisatie(s) gestelde norm voor - de doorlooptijd voor het bereiken van STATUSsen van dit STATUSTYPE bij - het desbetreffende ZAAKTYPE. - title: doorlooptijd status - format: duration - toelichting: - type: string - nullable: true - description: Een eventuele toelichting op dit STATUSTYPE. - title: toelichting - maxLength: 1000 - checklistitemStatustype: - type: array - items: - $ref: '#/components/schemas/CheckListItem' - title: checklistitem - eigenschappen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - description: - de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen, - voordat een STATUS van dit STATUSTYPE kan worden gezet. - title: eigenschappen - uniqueItems: true - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - required: - - catalogus - - isEindstatus - - omschrijving - - url - - volgnummer - - zaaktype - - zaaktypeIdentificatie - StatusTypeExpanded: - allOf: - - $ref: '#/components/schemas/StatusType' - - properties: - _expand: - $ref: '#/components/schemas/StatusTypeEmbedded' - StatusTypeEmbedded: - type: object - properties: - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - zaaktype: - oneOf: - - $ref: '#/components/schemas/ZaakTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - eigenschappen: - type: array - items: - $ref: '#/components/schemas/EigenschapExpanded' - ValidatieFout: - type: object - description: Formaat van HTTP 4xx en 5xx fouten. - properties: - type: - type: string - description: URI referentie naar het type fout, bedoeld voor developers - title: type - code: - type: string - description: Systeemcode die het type fout aangeeft - title: code - title: - type: string - description: Generieke titel voor het type fout - title: title - status: - type: integer - description: De HTTP status code - title: status - detail: - type: string - description: Extra informatie bij de fout, indien beschikbaar - title: detail - instance: - type: string - description: - URI met referentie naar dit specifiek voorkomen van de fout. - Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. - title: instance - invalidParams: - type: array - items: - $ref: '#/components/schemas/FieldValidationError' - title: invalidParams - required: - - code - - detail - - instance - - invalidParams - - status - - title - VertrouwelijkheidaanduidingEnum: - enum: - - openbaar - - beperkt_openbaar - - intern - - zaakvertrouwelijk - - vertrouwelijk - - confidentieel - - geheim - - zeer_geheim - type: string - ZaakObjectType: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - anderObjecttype: - type: boolean - description: - Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een - ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. - title: Ander objecttype - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - objecttype: - type: string - format: uri - description: - URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE - behoort. - title: Objecttype - maxLength: 200 - relatieOmschrijving: - type: string - description: - Omschrijving van de betrekking van het Objecttype op zaken - van het gerelateerde ZAAKTYPE. - title: Relatie omschrijving - maxLength: 80 - zaaktype: - type: string - format: uri - description: - URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE - behoort. - title: Zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype - resultaattypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: URL-referenties naar de RESULTAATTYPEN. - title: Zaakobjecttypen - uniqueItems: true - statustypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: URL-referenties naar de STATUSTYPEN. - title: Zaakobjecttypen - uniqueItems: true - catalogus: - type: string - format: uri - description: - URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE - behoort. - title: Catalogus - required: - - anderObjecttype - - beginGeldigheid - - catalogus - - objecttype - - relatieOmschrijving - - resultaattypen - - statustypen - - url - - zaaktype - - zaaktypeIdentificatie - ZaakObjectTypeExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectType' - - properties: - _expand: - $ref: '#/components/schemas/ZaakObjectTypeEmbedded' - ZaakObjectTypeEmbedded: - type: object - properties: - zaaktype: - oneOf: - - $ref: '#/components/schemas/ZaakTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - resultaattypen: - type: array - items: - $ref: '#/components/schemas/ResultaatTypeExpanded' - statustypen: - type: array - items: - $ref: '#/components/schemas/StatusTypeExpanded' - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - ZaakType: - type: object - description: 'Set gegevensgroepdata from validated nested data. - - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - identificatie: - type: string - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: identificatie - maxLength: 50 - omschrijving: - type: string - description: Omschrijving van de aard van ZAAKen van het ZAAKTYPE. - title: omschrijving - maxLength: 80 - omschrijvingGeneriek: - type: string - description: - Algemeen gehanteerde omschrijving van de aard van ZAAKen van - het ZAAKTYPE - title: omschrijving generiek - maxLength: 80 - vertrouwelijkheidaanduiding: - allOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - description: - 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van - dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het - aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde - gezet. - - - Uitleg bij mogelijke waarden: - - - * `openbaar` - Openbaar - - * `beperkt_openbaar` - Beperkt openbaar - - * `intern` - Intern - - * `zaakvertrouwelijk` - Zaakvertrouwelijk - - * `vertrouwelijk` - Vertrouwelijk - - * `confidentieel` - Confidentieel - - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' - title: vertrouwelijkheidaanduiding - doel: - type: string - description: - Een omschrijving van hetgeen beoogd is te bereiken met een - zaak van dit zaaktype. - title: doel - aanleiding: - type: string - description: - Een omschrijving van de gebeurtenis die leidt tot het starten - van een ZAAK van dit ZAAKTYPE. - title: aanleiding - toelichting: - type: string - description: - Een eventuele toelichting op dit zaaktype, zoals een beschrijving - van het procesverloop op de hoofdlijnen. - title: toelichting - indicatieInternOfExtern: - allOf: - - $ref: '#/components/schemas/IndicatieInternOfExternEnum' - description: - "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\ - \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\ - \ beide sprake kan zijn, dan prevaleert de externe initiatie." - title: indicatie intern of extern - handelingInitiator: - type: string - description: - Werkwoord dat hoort bij de handeling die de initiator verricht - bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook - het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator - title: handeling initiator - maxLength: 20 - onderwerp: - type: string - description: - "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen - nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus - (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'. - Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp" - title: onderwerp - maxLength: 80 - handelingBehandelaar: - type: string - description: - Werkwoord dat hoort bij de handeling die de behandelaar verricht - bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', - 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar - title: handeling behandelaar - maxLength: 20 - doorlooptijd: - type: string - description: - De periode waarbinnen volgens wet- en regelgeving een ZAAK - van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. - title: doorlooptijd behandeling - format: duration - servicenorm: - type: string - nullable: true - description: - De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE - afgerond wordt conform de geldende servicenormen van de zaakbehandelende - organisatie(s). - title: servicenorm behandeling - format: duration - opschortingEnAanhoudingMogelijk: - type: boolean - title: Opschorting/aanhouding mogelijk - description: - Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE - kunnen worden opgeschort en/of aangehouden. - verlengingMogelijk: - type: boolean - description: - Aanduiding die aangeeft of de Doorlooptijd behandeling van - ZAAKen van dit ZAAKTYPE kan worden verlengd. - title: verlenging mogelijk - verlengingstermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling - van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde - bevatten als verlenging mogelijk is. - title: verlengingstermijn - format: duration - trefwoorden: - type: array - items: - type: string - title: Trefwoord - maxLength: 30 - description: - Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden - gekarakteriseerd. - title: trefwoorden - publicatieIndicatie: - type: boolean - description: - Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd - moet worden. - title: publicatie indicatie - publicatietekst: - type: string - description: De generieke tekst van de publicatie van ZAAKen van dit ZAAKTYPE. - title: publicatietekst - verantwoordingsrelatie: - type: array - items: - type: string - maxLength: 40 - description: - "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ - \ en/of financi\xEBle verantwoording." - title: verantwoordingsrelatie - productenOfDiensten: - type: array - items: - type: string - format: uri - title: URL naar product/dienst - maxLength: 1000 - description: - Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt - voortgebracht. - title: producten of diensten - selectielijstProcestype: - type: string - format: uri - description: - URL-referentie naar een vanuit archiveringsoptiek onderkende - groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst - API). - title: selectielijst procestype - maxLength: 200 - referentieproces: - allOf: - - $ref: '#/components/schemas/ReferentieProces' - description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. - title: referentieproces - verantwoordelijke: - type: string - description: - De (soort) organisatorische eenheid of (functie van) medewerker - die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. - title: verantwoordelijke - maxLength: 50 - zaakobjecttypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: Zaaktype - uniqueItems: true - broncatalogus: - allOf: - - $ref: '#/components/schemas/BronCatalogus' - description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. - title: broncatalogus - bronzaaktype: - allOf: - - $ref: '#/components/schemas/BronZaaktype' - description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. - title: bronzaaktype - catalogus: - type: string - format: uri - description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. - title: Catalogus - statustypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen - dit ZAAKTYPE. - title: Zaaktype - uniqueItems: true - resultaattypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen - dit ZAAKTYPE. - title: is relevant voor - uniqueItems: true - eigenschappen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn - in ZAKEN van dit ZAAKTYPE. - title: Zaaktype - uniqueItems: true - informatieobjecttypen: - type: string - readOnly: true - title: informatieobjecttypen - roltypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit - ZAAKTYPE. - title: Zaaktype - uniqueItems: true - besluittypen: - type: array - items: - type: string - format: uri - title: heeft relevante besluittypen - title: heeft relevante besluittypen - description: - URL-referenties naar de BESLUITTYPEN die mogelijk zijn binnen - dit ZAAKTYPE. - uniqueItems: true - deelzaaktypen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - description: - De ZAAKTYPE(n) waaronder ZAAKen als deelzaak kunnen voorkomen - bij ZAAKen van dit ZAAKTYPE. - title: deelzaaktypen - uniqueItems: true - gerelateerdeZaaktypen: - type: array - items: - $ref: '#/components/schemas/ZaakTypenRelatie' - description: - De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit - ZAAKTYPE. - title: zaaktype van - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - versiedatum: - type: string - format: date - description: - De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE - geldig zijn geworden - title: versiedatum - concept: - type: boolean - readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn - niet-definitieve versies en zouden niet gebruikt moeten worden buiten - deze API. - title: concept - required: - - aanleiding - - beginGeldigheid - - besluittypen - - catalogus - - concept - - doel - - doorlooptijd - - eigenschappen - - gerelateerdeZaaktypen - - handelingBehandelaar - - handelingInitiator - - identificatie - - indicatieInternOfExtern - - informatieobjecttypen - - omschrijving - - onderwerp - - opschortingEnAanhoudingMogelijk - - productenOfDiensten - - publicatieIndicatie - - referentieproces - - resultaattypen - - roltypen - - statustypen - - url - - verantwoordelijke - - verlengingMogelijk - - versiedatum - - vertrouwelijkheidaanduiding - - zaakobjecttypen - ZaakTypeExpanded: - allOf: - - $ref: '#/components/schemas/ZaakType' - - properties: - _expand: - $ref: '#/components/schemas/ZaakTypeEmbedded' - ZaakTypeEmbedded: - type: object - properties: - zaakobjecttypen: - type: array - items: - $ref: '#/components/schemas/ZaakObjectTypeExpanded' - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - statustypen: - type: array - items: - $ref: '#/components/schemas/StatusTypeExpanded' - resultaattypen: - type: array - items: - $ref: '#/components/schemas/ResultaatTypeExpanded' - eigenschappen: - type: array - items: - $ref: '#/components/schemas/EigenschapExpanded' - informatieobjecttypen: - type: array - items: - $ref: '#/components/schemas/InformatieObjectTypeExpanded' - roltypen: - type: array - items: - $ref: '#/components/schemas/RolTypeExpanded' - besluittypen: - type: array - items: - $ref: '#/components/schemas/BesluitTypeExpanded' - deelzaaktypen: - type: array - items: - $ref: '#/components/schemas/ZaakTypeExpanded' - gerelateerdeZaaktypen: - type: array - items: - $ref: '#/components/schemas/ZaakTypeExpanded' - ZaakTypeCreate: - type: object - description: 'Set gegevensgroepdata from validated nested data. - - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - identificatie: - type: string - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: identificatie - maxLength: 50 - omschrijving: - type: string - description: Omschrijving van de aard van ZAAKen van het ZAAKTYPE. - title: omschrijving - maxLength: 80 - omschrijvingGeneriek: - type: string - description: - Algemeen gehanteerde omschrijving van de aard van ZAAKen van - het ZAAKTYPE - title: omschrijving generiek - maxLength: 80 - vertrouwelijkheidaanduiding: - allOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - description: - 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van - dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het - aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde - gezet. - - - Uitleg bij mogelijke waarden: - - - * `openbaar` - Openbaar - - * `beperkt_openbaar` - Beperkt openbaar - - * `intern` - Intern - - * `zaakvertrouwelijk` - Zaakvertrouwelijk - - * `vertrouwelijk` - Vertrouwelijk - - * `confidentieel` - Confidentieel - - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' - title: vertrouwelijkheidaanduiding - doel: - type: string - description: - Een omschrijving van hetgeen beoogd is te bereiken met een - zaak van dit zaaktype. - title: doel - aanleiding: - type: string - description: - Een omschrijving van de gebeurtenis die leidt tot het starten - van een ZAAK van dit ZAAKTYPE. - title: aanleiding - toelichting: - type: string - description: - Een eventuele toelichting op dit zaaktype, zoals een beschrijving - van het procesverloop op de hoofdlijnen. - title: toelichting - indicatieInternOfExtern: - allOf: - - $ref: '#/components/schemas/IndicatieInternOfExternEnum' - description: - "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\ - \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\ - \ beide sprake kan zijn, dan prevaleert de externe initiatie." - title: indicatie intern of extern - handelingInitiator: - type: string - description: - Werkwoord dat hoort bij de handeling die de initiator verricht - bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook - het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator - title: handeling initiator - maxLength: 20 - onderwerp: - type: string - description: - "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen - nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus - (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'. - Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp" - title: onderwerp - maxLength: 80 - handelingBehandelaar: - type: string - description: - Werkwoord dat hoort bij de handeling die de behandelaar verricht - bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', - 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar - title: handeling behandelaar - maxLength: 20 - doorlooptijd: - type: string - description: - De periode waarbinnen volgens wet- en regelgeving een ZAAK - van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. - title: doorlooptijd behandeling - format: duration - servicenorm: - type: string - nullable: true - description: - De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE - afgerond wordt conform de geldende servicenormen van de zaakbehandelende - organisatie(s). - title: servicenorm behandeling - format: duration - opschortingEnAanhoudingMogelijk: - type: boolean - title: Opschorting/aanhouding mogelijk - description: - Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE - kunnen worden opgeschort en/of aangehouden. - verlengingMogelijk: - type: boolean - description: - Aanduiding die aangeeft of de Doorlooptijd behandeling van - ZAAKen van dit ZAAKTYPE kan worden verlengd. - title: verlenging mogelijk - verlengingstermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling - van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde - bevatten als verlenging mogelijk is. - title: verlengingstermijn - format: duration - trefwoorden: - type: array - items: - type: string - title: Trefwoord - maxLength: 30 - description: - Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden - gekarakteriseerd. - title: trefwoorden - publicatieIndicatie: - type: boolean - description: - Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd - moet worden. - title: publicatie indicatie - publicatietekst: - type: string - description: De generieke tekst van de publicatie van ZAAKen van dit ZAAKTYPE. - title: publicatietekst - verantwoordingsrelatie: - type: array - items: - type: string - maxLength: 40 - description: - "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ - \ en/of financi\xEBle verantwoording." - title: verantwoordingsrelatie - productenOfDiensten: - type: array - items: - type: string - format: uri - title: URL naar product/dienst - maxLength: 1000 - description: - Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt - voortgebracht. - title: producten of diensten - selectielijstProcestype: - type: string - format: uri - description: - URL-referentie naar een vanuit archiveringsoptiek onderkende - groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst - API). - title: selectielijst procestype - maxLength: 200 - referentieproces: - allOf: - - $ref: '#/components/schemas/ReferentieProces' - description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. - title: referentieproces - verantwoordelijke: - type: string - description: - De (soort) organisatorische eenheid of (functie van) medewerker - die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. - title: verantwoordelijke - maxLength: 50 - zaakobjecttypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: Zaaktype - uniqueItems: true - broncatalogus: - allOf: - - $ref: '#/components/schemas/BronCatalogus' - description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. - title: broncatalogus - bronzaaktype: - allOf: - - $ref: '#/components/schemas/BronZaaktype' - description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. - title: bronzaaktype - catalogus: - type: string - format: uri - description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. - title: Catalogus - statustypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen - dit ZAAKTYPE. - title: Zaaktype - uniqueItems: true - resultaattypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen - dit ZAAKTYPE. - title: is relevant voor - uniqueItems: true - eigenschappen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn - in ZAKEN van dit ZAAKTYPE. - title: Zaaktype - uniqueItems: true - informatieobjecttypen: - type: string - readOnly: true - title: informatieobjecttypen - roltypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit - ZAAKTYPE. - title: Zaaktype - uniqueItems: true - besluittypen: - type: array - items: - type: string - title: '' - description: - '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen - dit ZAAKTYPE.' - title: zaaktypen - deelzaaktypen: - type: array - items: - type: string - title: '' - description: - De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak - kunnen voorkomen bij ZAAKen van dit ZAAKTYPE. - title: deelzaaktypen - gerelateerdeZaaktypen: - type: array - items: - $ref: '#/components/schemas/ZaakTypenRelatieCreate' - description: - De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit - ZAAKTYPE. - title: zaaktype van - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - versiedatum: - type: string - format: date - description: - De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE - geldig zijn geworden - title: versiedatum - concept: - type: boolean - readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn - niet-definitieve versies en zouden niet gebruikt moeten worden buiten - deze API. - title: concept - required: - - aanleiding - - beginGeldigheid - - besluittypen - - catalogus - - concept - - deelzaaktypen - - doel - - doorlooptijd - - eigenschappen - - gerelateerdeZaaktypen - - handelingBehandelaar - - handelingInitiator - - identificatie - - indicatieInternOfExtern - - informatieobjecttypen - - omschrijving - - onderwerp - - opschortingEnAanhoudingMogelijk - - productenOfDiensten - - publicatieIndicatie - - referentieproces - - resultaattypen - - roltypen - - statustypen - - url - - verantwoordelijke - - verlengingMogelijk - - versiedatum - - vertrouwelijkheidaanduiding - - zaakobjecttypen - ZaakTypeInformatieObjectType: - type: object - description: 'Represent a ZaakTypeInformatieObjectType. - - - Relatie met informatieobjecttype dat relevant is voor zaaktype.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - description: URL-referentie naar het ZAAKTYPE. - title: zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: zaaktype - catalogus: - type: string - format: uri - readOnly: true - title: catalogus - informatieobjecttype: - type: string - title: informatieobjecttype - maxLength: 100 - volgnummer: - type: integer - maximum: 999 - minimum: 1 - description: - Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het - ZAAKTYPE. - title: volgnummer - richting: - allOf: - - $ref: '#/components/schemas/RichtingEnum' - description: - 'Aanduiding van de richting van informatieobjecten van het - gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. - - - Uitleg bij mogelijke waarden: - - - * `inkomend` - Inkomend - - * `intern` - Intern - - * `uitgaand` - Uitgaand' - title: richting - statustype: - type: string - format: uri - nullable: true - title: Status type - description: - URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn - verplicht aanwezig moeten zijn. - required: - - catalogus - - informatieobjecttype - - richting - - url - - volgnummer - - zaaktype - - zaaktypeIdentificatie - ZaakTypeInformatieObjectTypeExpanded: - allOf: - - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' - - properties: - _expand: - $ref: '#/components/schemas/ZaakTypeInformatieObjectTypeEmbedded' - ZaakTypeInformatieObjectTypeEmbedded: - type: object - properties: - zaaktype: - oneOf: - - $ref: '#/components/schemas/ZaakTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - catalogus: - oneOf: - - $ref: '#/components/schemas/CatalogusExpanded' - - $ref: '#/components/schemas/EmptyObject' - informatieobjecttype: - oneOf: - - $ref: '#/components/schemas/InformatieObjectTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - statustype: - oneOf: - - $ref: '#/components/schemas/StatusTypeExpanded' - - $ref: '#/components/schemas/EmptyObject' - ZaakTypeUpdate: - type: object - description: 'Set gegevensgroepdata from validated nested data. - - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - identificatie: - type: string - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: identificatie - maxLength: 50 - omschrijving: - type: string - description: Omschrijving van de aard van ZAAKen van het ZAAKTYPE. - title: omschrijving - maxLength: 80 - omschrijvingGeneriek: - type: string - description: - Algemeen gehanteerde omschrijving van de aard van ZAAKen van - het ZAAKTYPE - title: omschrijving generiek - maxLength: 80 - vertrouwelijkheidaanduiding: - allOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - description: - 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van - dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het - aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde - gezet. - - - Uitleg bij mogelijke waarden: - - - * `openbaar` - Openbaar - - * `beperkt_openbaar` - Beperkt openbaar - - * `intern` - Intern - - * `zaakvertrouwelijk` - Zaakvertrouwelijk - - * `vertrouwelijk` - Vertrouwelijk - - * `confidentieel` - Confidentieel - - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' - title: vertrouwelijkheidaanduiding - doel: - type: string - description: - Een omschrijving van hetgeen beoogd is te bereiken met een - zaak van dit zaaktype. - title: doel - aanleiding: - type: string - description: - Een omschrijving van de gebeurtenis die leidt tot het starten - van een ZAAK van dit ZAAKTYPE. - title: aanleiding - toelichting: - type: string - description: - Een eventuele toelichting op dit zaaktype, zoals een beschrijving - van het procesverloop op de hoofdlijnen. - title: toelichting - indicatieInternOfExtern: - allOf: - - $ref: '#/components/schemas/IndicatieInternOfExternEnum' - description: - "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\ - \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\ - \ beide sprake kan zijn, dan prevaleert de externe initiatie." - title: indicatie intern of extern - handelingInitiator: - type: string - description: - Werkwoord dat hoort bij de handeling die de initiator verricht - bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook - het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator - title: handeling initiator - maxLength: 20 - onderwerp: - type: string - description: - "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen - nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus - (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'. - Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp" - title: onderwerp - maxLength: 80 - handelingBehandelaar: - type: string - description: - Werkwoord dat hoort bij de handeling die de behandelaar verricht - bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', - 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar - title: handeling behandelaar - maxLength: 20 - doorlooptijd: - type: string - description: - De periode waarbinnen volgens wet- en regelgeving een ZAAK - van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. - title: doorlooptijd behandeling - format: duration - servicenorm: - type: string - nullable: true - description: - De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE - afgerond wordt conform de geldende servicenormen van de zaakbehandelende - organisatie(s). - title: servicenorm behandeling - format: duration - opschortingEnAanhoudingMogelijk: - type: boolean - title: Opschorting/aanhouding mogelijk - description: - Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE - kunnen worden opgeschort en/of aangehouden. - verlengingMogelijk: - type: boolean - description: - Aanduiding die aangeeft of de Doorlooptijd behandeling van - ZAAKen van dit ZAAKTYPE kan worden verlengd. - title: verlenging mogelijk - verlengingstermijn: - type: string - nullable: true - description: - Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling - van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde - bevatten als verlenging mogelijk is. - title: verlengingstermijn - format: duration - trefwoorden: - type: array - items: - type: string - title: Trefwoord - maxLength: 30 - description: - Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden - gekarakteriseerd. - title: trefwoorden - publicatieIndicatie: - type: boolean - description: - Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd - moet worden. - title: publicatie indicatie - publicatietekst: - type: string - description: De generieke tekst van de publicatie van ZAAKen van dit ZAAKTYPE. - title: publicatietekst - verantwoordingsrelatie: - type: array - items: - type: string - maxLength: 40 - description: - "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ - \ en/of financi\xEBle verantwoording." - title: verantwoordingsrelatie - productenOfDiensten: - type: array - items: - type: string - format: uri - title: URL naar product/dienst - maxLength: 1000 - description: - Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt - voortgebracht. - title: producten of diensten - selectielijstProcestype: - type: string - format: uri - description: - URL-referentie naar een vanuit archiveringsoptiek onderkende - groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst - API). - title: selectielijst procestype - maxLength: 200 - referentieproces: - allOf: - - $ref: '#/components/schemas/ReferentieProces' - description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. - title: referentieproces - verantwoordelijke: - type: string - description: - De (soort) organisatorische eenheid of (functie van) medewerker - die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. - title: verantwoordelijke - maxLength: 50 - zaakobjecttypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: Zaaktype - uniqueItems: true - broncatalogus: - allOf: - - $ref: '#/components/schemas/BronCatalogus' - description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. - title: broncatalogus - bronzaaktype: - allOf: - - $ref: '#/components/schemas/BronZaaktype' - description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. - title: bronzaaktype - catalogus: - type: string - format: uri - description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. - title: Catalogus - statustypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen - dit ZAAKTYPE. - title: Zaaktype - uniqueItems: true - resultaattypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen - dit ZAAKTYPE. - title: is relevant voor - uniqueItems: true - eigenschappen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn - in ZAKEN van dit ZAAKTYPE. - title: Zaaktype - uniqueItems: true - informatieobjecttypen: - type: string - readOnly: true - title: informatieobjecttypen - roltypen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: - URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit - ZAAKTYPE. - title: Zaaktype - uniqueItems: true - besluittypen: - type: array - items: - type: string - title: '' - description: - '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen - dit ZAAKTYPE.' - title: zaaktypen - deelzaaktypen: - type: array - items: - type: string - title: '' - description: - De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak - kunnen voorkomen bij ZAAKen van dit ZAAKTYPE. - title: deelzaaktypen - gerelateerdeZaaktypen: - type: array - items: - $ref: '#/components/schemas/ZaakTypenRelatieCreate' - description: - De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit - ZAAKTYPE. - title: zaaktype van - beginGeldigheid: - type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - versiedatum: - type: string - format: date - description: - De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE - geldig zijn geworden - title: versiedatum - concept: - type: boolean - readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn - niet-definitieve versies en zouden niet gebruikt moeten worden buiten - deze API. - title: concept - required: - - aanleiding - - beginGeldigheid - - besluittypen - - catalogus - - concept - - deelzaaktypen - - doel - - doorlooptijd - - eigenschappen - - gerelateerdeZaaktypen - - handelingBehandelaar - - handelingInitiator - - identificatie - - indicatieInternOfExtern - - informatieobjecttypen - - omschrijving - - onderwerp - - opschortingEnAanhoudingMogelijk - - productenOfDiensten - - publicatieIndicatie - - referentieproces - - resultaattypen - - roltypen - - statustypen - - url - - verantwoordelijke - - verlengingMogelijk - - versiedatum - - vertrouwelijkheidaanduiding - - zaakobjecttypen - - ZaakTypenRelatie: - type: object - properties: - zaaktype: - type: string - format: uri - description: - URL referentie naar het gerelateerde zaaktype, mogelijks in - een extern ZTC. - title: gerelateerd zaaktype - maxLength: 200 - aardRelatie: - allOf: - - $ref: '#/components/schemas/AardRelatieEnum' - description: - 'Omschrijving van de aard van de relatie van zaken van het - ZAAKTYPE tot zaken van het andere ZAAKTYPE - - - Uitleg bij mogelijke waarden: - - - * `vervolg` - Vervolg - - * `bijdrage` - Bijdrage - - * `onderwerp` - Onderwerp' - title: aard relatie - toelichting: - type: string - description: Een toelichting op de aard van de relatie tussen beide ZAAKTYPEN. - title: toelichting - maxLength: 255 - required: - - aardRelatie - - zaaktype - ZaakTypenRelatieCreate: - type: object - properties: - zaaktype: - type: string - description: '`zaaktype.identificatie` naar het ZAAKTYPE.' - title: zaaktype van - aardRelatie: - allOf: - - $ref: '#/components/schemas/AardRelatieEnum' - description: - 'Omschrijving van de aard van de relatie van zaken van het - ZAAKTYPE tot zaken van het andere ZAAKTYPE - - - Uitleg bij mogelijke waarden: - - - * `vervolg` - Vervolg - - * `bijdrage` - Bijdrage - - * `onderwerp` - Onderwerp' - title: aard relatie - toelichting: - type: string - description: Een toelichting op de aard van de relatie tussen beide ZAAKTYPEN. - title: toelichting - maxLength: 255 - required: - - aardRelatie - - zaaktype - securitySchemes: - JWT-Claims: - type: http - bearerFormat: JWT - scheme: bearer -servers: - # Added by API Auto Mocking Plugin - - description: SwaggerHub API Auto Mocking - url: https://virtserver.swaggerhub.com/michielverhoef/Catalogussen_API/1.3.0 - - url: https://catalogi-api.vng.cloud/api/v1 - description: Productie Omgeving -tags: - - name: besluittypen - description: - Opvragen en bewerken van BESLUITTYPEn nodig voor BESLUITEN in de Besluiten - API. Alle BESLUITTYPEn van de besluiten die het resultaat kunnen zijn van het - zaakgericht werken van de behandelende organisatie(s). - - name: catalogussen - description: - "Opvragen en bewerken van CATALOGUSsen. De verzameling van ZAAKTYPEn,\ - \ INFORMATIEOBJECTTYPEn en BESLUITTYPEn voor een domein die als \xE9\xE9n geheel\ - \ beheerd wordt." - - name: eigenschappen - description: - Opvragen en bewerken van EIGENSCHAPpen van een ZAAKTYPE. Een relevant - inhoudelijk gegeven dat bij ZAAKen van dit ZAAKTYPE geregistreerd moet kunnen - worden en geen standaard kenmerk is van een zaak. - - name: informatieobjecttypen - description: - Opvragen en bewerken van INFORMATIEOBJECTTYPEn nodig voor INFORMATIEOBJECTen - in de Documenten API. Een INFORMATIEOBJECTTYPE beschijft de karakteristieken van - een document of ander object dat informatie bevat. - - name: resultaattypen - description: - Opvragen en bewerken van RESULTAATTYPEn van een ZAAKTYPE. Het betreft - de indeling of groepering van resultaten van zaken van hetzelfde ZAAKTYPE naar - hun aard, zoals 'verleend', 'geweigerd', 'verwerkt', etc. - - name: roltypen - description: - Opvragen en bewerken van ROLTYPEn van een ZAAKTYPE. Generieke aanduiding - van de aard van een ROL die een BETROKKENE kan uitoefenen in ZAAKen van een ZAAKTYPE. - - name: statustypen - description: - Opvragen en bewerken van STATUSTYPEn van een ZAAKTYPE. Generieke aanduiding - van de aard van een status. - - name: zaakobjecttypen - description: - "Opvragen en bewerken van ZAAKOBJECTTYPEn. Er wordt gevalideerd op:\n\ - \ - `zaaktype` behoort tot dezelfde `catalogus`" - - name: zaaktype-informatieobjecttypen - description: - Opvragen en bewerken van ZAAKTYPE-INFORMATIEOBJECTTYPE relaties. Geeft - aan welke INFORMATIEOBJECTTYPEn binnen een ZAAKTYPE mogelijk zijn en hoe de richting - is. - - name: zaaktypen - description: - Opvragen en bewerken van ZAAKTYPEn nodig voor ZAKEN in de Zaken API.Een - ZAAKTYPE beschrijft het geheel van karakteristieke eigenschappen van zaken van - eenzelfde soort. From fac2293bd9889b2c5b62e1d326a6e304472a9dea Mon Sep 17 00:00:00 2001 From: HenriKorver Date: Thu, 20 Feb 2025 17:39:25 +0100 Subject: [PATCH 30/36] "Add .gitkeep to empty folder" --- api-specificatie/ztc/1.3.x/1.3.2/.gitkeep | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 api-specificatie/ztc/1.3.x/1.3.2/.gitkeep diff --git a/api-specificatie/ztc/1.3.x/1.3.2/.gitkeep b/api-specificatie/ztc/1.3.x/1.3.2/.gitkeep new file mode 100644 index 000000000..e69de29bb From a6828340525a7badaf4d43ca74057b00f48ce290 Mon Sep 17 00:00:00 2001 From: HenriKorver Date: Thu, 20 Feb 2025 17:40:45 +0100 Subject: [PATCH 31/36] Remove empty folder --- api-specificatie/ztc/1.3.x/1.3.2/.gitkeep | 0 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 api-specificatie/ztc/1.3.x/1.3.2/.gitkeep diff --git a/api-specificatie/ztc/1.3.x/1.3.2/.gitkeep b/api-specificatie/ztc/1.3.x/1.3.2/.gitkeep deleted file mode 100644 index e69de29bb..000000000 From 63a9e67e86f12c8cf540ee72ceda0afaae23476e Mon Sep 17 00:00:00 2001 From: HenriKorver Date: Thu, 20 Feb 2025 17:45:49 +0100 Subject: [PATCH 32/36] Remove nested expansion from Catalogi API release notes --- docs/standaard/release_notes.md | 5 ----- 1 file changed, 5 deletions(-) diff --git a/docs/standaard/release_notes.md b/docs/standaard/release_notes.md index 6a65c7db7..a5de5d979 100644 --- a/docs/standaard/release_notes.md +++ b/docs/standaard/release_notes.md @@ -18,11 +18,6 @@ ## Catalogi API (`ztc 1.3.2`) -- **Geneste expansion toegevoegd aan Catalogi API** - - Geneste expansie objecten toegevoegd aan het schema van de OAS. Deze objecten worden niet gebruikt in de operaties van de OAS omdat de nesting niet dieper mag zijn dan 3 niveaus. Echter deze schema-objecten kunnen wel gebruikt worden om door het hele datamodel van de Catalagi API heen te kunnen browsen door middel van drill down expansie. - - - **Aanscherping specificatie eigenschappen met datumvelden** Regel `zt-015` toegevoegd aan de aanvullende specificatie naar aanleiding van het volgende issue: From 07c2502c1354e547e4f393d487d0b3695ad4d666 Mon Sep 17 00:00:00 2001 From: HenriKorver Date: Fri, 21 Feb 2025 11:55:19 +0100 Subject: [PATCH 33/36] Expand referenties teruggezet naar ztc versie 1.3.1 --- api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml index c1bb33995..2f413d9bb 100644 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml +++ b/api-specificatie/zrc/1.5.x/1.5.2/openapi.yaml @@ -12904,7 +12904,7 @@ components: zaak: $ref: '#/components/schemas/ZaakExpanded' resultaattype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ResultaatType' + $ref: '../../../ztc/1.3.x/1.3.1/openapi.yaml#/components/schemas/ResultaatType' Rol: type: object properties: @@ -13233,7 +13233,7 @@ components: $ref: '#/components/schemas/ZaakExpanded' example: {} roltype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/RolType' + $ref: '../../../ztc/1.3.x/1.3.1/openapi.yaml#/components/schemas/RolType' statussen: type: array items: @@ -13519,7 +13519,7 @@ components: type: object properties: statustype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/StatusType' + $ref: '../../../ztc/1.3.x/1.3.1/openapi.yaml#/components/schemas/StatusType' gezetdoor: $ref: '#/components/schemas/Rol' zaakinformatieobjecten: @@ -14266,7 +14266,7 @@ components: type: object properties: zaaktype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakType' + $ref: '../../../ztc/1.3.x/1.3.1/openapi.yaml#/components/schemas/ZaakType' hoofdzaak: oneOf: - $ref: '#/components/schemas/ZaakExpanded' @@ -14456,7 +14456,7 @@ components: - $ref: '#/components/schemas/ZaakExpanded' - $ref: '#/components/schemas/EmptyObject' eigenschap: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/Eigenschap' + $ref: '../../../ztc/1.3.x/1.3.1/openapi.yaml#/components/schemas/Eigenschap' ZaakInformatieObject: type: object properties: @@ -14953,7 +14953,7 @@ components: type: object properties: zaakobjecttype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakObjectType' + $ref: '../../../ztc/1.3.x/1.3.1/openapi.yaml#/components/schemas/ZaakObjectType' ZaakVerzoek: type: object properties: From b4207e89820b5905f7022d426591213f3151c1bb Mon Sep 17 00:00:00 2001 From: HenriKorver Date: Fri, 21 Feb 2025 12:26:04 +0100 Subject: [PATCH 34/36] Update reference to InformatieObjectType into version 1.3.1 --- api-specificatie/drc/1.6.x/1.6.0/openapi.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api-specificatie/drc/1.6.x/1.6.0/openapi.yaml b/api-specificatie/drc/1.6.x/1.6.0/openapi.yaml index 47b7a4819..6b4d839b5 100644 --- a/api-specificatie/drc/1.6.x/1.6.0/openapi.yaml +++ b/api-specificatie/drc/1.6.x/1.6.0/openapi.yaml @@ -7270,7 +7270,7 @@ components: type: object properties: informatieobjecttype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/InformatieObjectType' + $ref: '../../../ztc/1.3.x/1.3.1/openapi.yaml#/components/schemas/InformatieObjectType' FieldValidationError: type: object description: Formaat van validatiefouten. From 5bc8f29902df215d2fc1f506d3e492fc1831b255 Mon Sep 17 00:00:00 2001 From: HenriKorver Date: Fri, 21 Feb 2025 14:26:54 +0100 Subject: [PATCH 35/36] Geneste expand zit nu in een andere branch als future development --- .../1.5.x/1.5.2/openapi_geneste_expand.yaml | 15984 ---------------- 1 file changed, 15984 deletions(-) delete mode 100644 api-specificatie/zrc/1.5.x/1.5.2/openapi_geneste_expand.yaml diff --git a/api-specificatie/zrc/1.5.x/1.5.2/openapi_geneste_expand.yaml b/api-specificatie/zrc/1.5.x/1.5.2/openapi_geneste_expand.yaml deleted file mode 100644 index 3b0e550a9..000000000 --- a/api-specificatie/zrc/1.5.x/1.5.2/openapi_geneste_expand.yaml +++ /dev/null @@ -1,15984 +0,0 @@ -openapi: 3.0.3 -info: - title: Zaken API - version: 1.5.2 - description: " Met expand mechanisme in plain json - - - Een API om een zaakregistratiecomponent (ZRC) te benaderen. - - - De ZAAK is het kernobject in deze API, waaraan verschillende andere - - resources gerelateerd zijn. De Zaken API werkt samen met andere API's voor - - Zaakgericht werken om tot volledige functionaliteit te komen. - - - **Wat is nieuw?** - - * Query parameters en zoekvelden voor archivering. - - - **Afhankelijkheden** - - - Deze API is afhankelijk van: - - - * Catalogi API - - * Notificaties API - - * Documenten API *(optioneel)* - - * Besluiten API *(optioneel)* - - * Autorisaties API *(optioneel)* - - - **Autorisatie** - - - Deze API vereist autorisatie. Je kan de - - [token-tool](https://zaken-auth.vng.cloud/) gebruiken om JWT-tokens te - - genereren. - - - ### Notificaties - - - Deze API publiceert notificaties op het kanaal `zaken`. - - - **Main resource** - - - `zaak` - - - - - **Kenmerken** - - - * `bronorganisatie`: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers en voldoen - aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef - - * `zaaktype`: URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS - waar deze voorkomt - - * `vertrouwelijkheidaanduiding`: Aanduiding van de mate waarin het zaakdossier - van de ZAAK voor de openbaarheid bestemd is. - - - **Resources en acties** - - - `zaak`: create, update, destroy - - - `status`: create - - - `zaakobject`: create, update, destroy - - - `zaakinformatieobject`: create - - - `zaakeigenschap`: create, update, destroy - - - `klantcontact`: create - - - `rol`: create, destroy - - - `resultaat`: create, update, destroy - - - `zaakbesluit`: create - - - `zaakcontactmoment`: create - - - `zaakverzoek`: create - - - - **Handige links** - - - * [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard) - - * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken) - - " - contact: - email: standaarden.ondersteuning@vng.nl - url: https://vng-realisatie.github.io/gemma-zaken - license: - name: EUPL 1.2 - url: https://opensource.org/licenses/EUPL-1.2 -paths: - /klantcontacten: - get: - operationId: klantcontact_list - description: 'Alle KLANTCONTACTen opvragen. - - - **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' - summary: 'Alle KLANTCONTACTen opvragen. ' - parameters: - - name: zaak - required: false - in: query - description: URL-referentie naar de ZAAK. - schema: - type: string - format: uri - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - klantcontacten - security: - - JWT-Claims: - - zaken.lezen - deprecated: true - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedKlantContactList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: klantcontact_create - description: - 'Indien geen identificatie gegeven is, dan wordt deze automatisch - gegenereerd. - - - **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' - summary: Maak een KLANTCONTACT bij een ZAAK aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - klantcontacten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/KlantContact' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - deprecated: true - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/KlantContact' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /klantcontacten/{uuid}: - get: - operationId: klantcontact_retrieve - description: 'Een specifieke KLANTCONTACT opvragen. - - - **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' - summary: Een specifieke KLANTCONTACT opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - klantcontacten - security: - - JWT-Claims: - - zaken.lezen - deprecated: true - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/KlantContact' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /resultaten: - get: - operationId: resultaat_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle RESULTAATen van ZAAKen opvragen. - parameters: - - name: zaak - required: false - in: query - description: URL-referentie naar de ZAAK. - schema: - type: string - format: uri - - name: resultaattype - required: false - in: query - description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API). - schema: - type: string - format: uri - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - resultaten - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedResultaatList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: resultaat_create - description: '**Er wordt gevalideerd op:** - - - geldigheid URL naar de ZAAK - - - geldigheid URL naar het RESULTAATTYPE' - summary: Maak een RESULTAAT bij een ZAAK aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - resultaten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Resultaat' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Resultaat' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /resultaten/{uuid}: - get: - operationId: resultaat_retrieve - description: Een specifieke RESULTAAT opvragen. - summary: Een specifieke RESULTAAT opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - resultaten - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Resultaat' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: resultaat_update - description: - "**Er wordt gevalideerd op** \n- geldigheid URL naar de ZAAK\n\ - - het RESULTAATTYPE mag niet gewijzigd worden" - summary: Werk een RESULTAAT in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - resultaten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Resultaat' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Resultaat' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: resultaat_partial_update - description: - "**Er wordt gevalideerd op** \n- geldigheid URL naar de ZAAK\n\ - - het RESULTAATTYPE mag niet gewijzigd worden" - summary: Werk een RESULTAAT deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - resultaten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedResultaat' - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Resultaat' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: resultaat_destroy - description: Verwijder een RESULTAAT van een ZAAK. - summary: Verwijder een RESULTAAT van een ZAAK. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - resultaten - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: resultaat_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) RESULTAAT opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - resultaten - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /rollen: - get: - operationId: rol_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle ROLlen bij ZAAKen opvragen. - parameters: - - name: zaak - required: false - in: query - description: URL-referentie naar de ZAAK. - schema: - type: string - format: uri - - name: betrokkene - required: false - in: query - description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. - schema: - type: string - format: uri - - name: betrokkeneType - required: false - in: query - description: Type van de `betrokkene`. - schema: - type: string - enum: - - natuurlijk_persoon - - niet_natuurlijk_persoon - - vestiging - - organisatorische_eenheid - - medewerker - - name: betrokkeneIdentificatie__natuurlijkPersoon__inpBsn - required: false - in: query - description: - Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene - bepalingen burgerservicenummer. - schema: - type: string - - name: betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie - required: false - in: query - description: - Het door de gemeente uitgegeven unieke nummer voor een ANDER - NATUURLIJK PERSOON - schema: - type: string - - name: betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer - required: false - in: query - description: Het administratienummer van de persoon, bedoeld in de Wet BRP - schema: - type: string - - name: betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId - required: false - in: query - description: - Het door een kamer toegekend uniek nummer voor de INGESCHREVEN - NIET-NATUURLIJK PERSOON - schema: - type: string - - name: betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie - required: false - in: query - description: - Het door de gemeente uitgegeven unieke nummer voor een ANDER - NIET-NATUURLIJK PERSOON - schema: - type: string - - name: betrokkeneIdentificatie__vestiging__vestigingsNummer - required: false - in: query - description: Een korte unieke aanduiding van de Vestiging. - schema: - type: string - - name: betrokkeneIdentificatie__organisatorischeEenheid__identificatie - required: false - in: query - description: Een korte identificatie van de organisatorische eenheid. - schema: - type: string - - name: betrokkeneIdentificatie__medewerker__identificatie - required: false - in: query - description: Een korte unieke aanduiding van de MEDEWERKER. - schema: - type: string - - name: roltype - required: false - in: query - description: URL-referentie naar een roltype binnen het ZAAKTYPE van de ZAAK. - schema: - type: string - format: uri - - name: omschrijving - required: false - in: query - description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. - schema: - type: string - - name: omschrijvingGeneriek - required: false - in: query - description: - Algemeen gehanteerde benaming van de aard van de ROL, afgeleid - uit het ROLTYPE. - schema: - type: string - enum: - - adviseur - - behandelaar - - belanghebbende - - beslisser - - initiator - - klantcontacter - - zaakcoordinator - - mede_initiator - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - rollen - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedRolList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: rol_create - description: Maak een ROL aan bij een ZAAK. - summary: Maak een ROL aan bij een ZAAK. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - rollen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Rol' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Rol' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /rollen/{uuid}: - get: - operationId: rol_retrieve - description: Een specifieke ROL bij een ZAAK opvragen. - summary: Een specifieke ROL bij een ZAAK opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - rollen - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Rol' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: rol_destroy - description: Verwijder een ROL van een ZAAK. - summary: Verwijder een ROL van een ZAAK. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - rollen - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: rol_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ROL opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - rollen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /statussen: - get: - operationId: status_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle STATUSsen bij ZAAKen opvragen. - parameters: - - name: zaak - required: false - in: query - description: URL-referentie naar de ZAAK. - schema: - type: string - format: uri - - name: statustype - required: false - in: query - description: URL-referentie naar het STATUSTYPE (in de Catalogi API). - schema: - type: string - format: uri - - name: indicatieLaatstGezetteStatus - required: false - in: query - description: - Het gegeven is afleidbaar uit de historie van de attribuutsoort - Datum status gezet van van alle statussen bij de desbetreffende zaak. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - statussen - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedStatusList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: status_create - description: '**Er wordt gevalideerd op** - - - geldigheid URL naar de ZAAK - - - geldigheid URL naar het STATUSTYPE - - - indien het de eindstatus betreft, dan moet het attribuut `indicatieGebruiksrecht` - gezet zijn op alle informatieobjecten dieaan de zaak gerelateerd zijn - - - **Opmerkingen** - - - Indien het statustype de eindstatus is (volgens het ZTC), dan wordt de zaak - afgesloten door de einddatum te zetten.' - summary: Maak een STATUS aan voor een ZAAK. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - statussen - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Status' - required: true - security: - - JWT-Claims: - - (zaken.aanmaken | zaken.statussen.toevoegen | zaken.heropenen) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/StatusRequestbody' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /statussen/{uuid}: - get: - operationId: status_retrieve - description: Een specifieke STATUS van een ZAAK opvragen. - summary: Een specifieke STATUS van een ZAAK opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - statussen - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Status' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: status_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) STATUS opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - statussen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaakcontactmomenten: - get: - operationId: zaakcontactmoment_list - description: Alle ZAAKCONTACTMOMENTen opvragen. - summary: Alle ZAAKCONTACTMOMENTen opvragen. - parameters: - - name: zaak - required: false - in: query - description: URL-referentie naar de ZAAK. - schema: - type: string - format: uri - - name: contactmoment - required: false - in: query - description: - URL-referentie naar het CONTACTMOMENT (in de Klantinteractie - API) - schema: - type: string - format: uri - tags: - - zaakcontactmomenten - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/ZaakContactMoment' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaakcontactmoment_create - description: '**Er wordt gevalideerd op:** - - - geldigheid URL naar het CONTACTMOMENT' - summary: Maak een ZAAKCONTACTMOMENT aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakcontactmomenten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakContactMoment' - required: true - security: - - JWT-Claims: - - zaken.bijwerken - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakContactMoment' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaakcontactmomenten/{uuid}: - get: - operationId: zaakcontactmoment_retrieve - description: Een specifiek ZAAKCONTACTMOMENT opvragen. - summary: 'Een specifiek ZAAKCONTACTMOMENT opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - zaakcontactmomenten - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakContactMoment' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaakcontactmoment_destroy - description: Verwijder een ZAAKCONTACTMOMENT. - summary: Verwijder een ZAAKCONTACTMOMENT. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakcontactmomenten - security: - - JWT-Claims: - - zaken.bijwerken - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaakinformatieobjecten: - get: - operationId: zaakinformatieobject_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: 'Alle ZAAK-INFORMATIEOBJECT relaties opvragen ' - parameters: - - name: zaak - required: false - in: query - description: URL-referentie naar de ZAAK. - schema: - type: string - format: uri - - name: informatieobject - required: false - in: query - description: - URL-referentie naar het INFORMATIEOBJECT (in de Documenten API), - waar ook de relatieinformatie opgevraagd kan worden. - schema: - type: string - format: uri - tags: - - zaakinformatieobjecten - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/ZaakInformatieObject' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaakinformatieobject_create - description: - "Maak een ZAAK-INFORMATIEOBJECT relatie aan.\n\n**Er wordt gevalideerd\ - \ op**\n- geldigheid zaak URL\n- geldigheid informatieobject URL\n- `zaak.archiefstatus`\ - \ moet gelijk zijn aan 'nog_te_archiveren' \n- de combinatie informatieobject\ - \ en zaak moet uniek zijn\n\n**Opmerkingen**\n- De registratiedatum wordt\ - \ door het systeem op 'NU' gezet. De `aardRelatie` wordt ook door het systeem\ - \ gezet.\n- Bij het aanmaken wordt ook in de Documenten API de gespiegelde\ - \ relatie aangemaakt, echter zonder de relatie-informatie.\n" - summary: Maak een ZAAK-INFORMATIEOBJECT relatie aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakinformatieobjecten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakInformatieObject' - required: true - security: - - JWT-Claims: - - (zaken.aanmaken | zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakInformatieObject' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaakinformatieobjecten/{uuid}: - get: - operationId: zaakinformatieobject_retrieve - description: Een specifieke ZAAK-INFORMATIEOBJECT relatie opvragen. - summary: Een specifieke ZAAK-INFORMATIEOBJECT relatie opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaakinformatieobjecten - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakInformatieObject' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: zaakinformatieobject_update - description: - "Je mag enkel de gegevens van de relatie bewerken, en niet de relatie\ - \ zelf aanpassen.\n\n**Er wordt gevalideerd op** \n- informatieobject URL\ - \ en zaak URL mogen niet veranderen" - summary: Werk een ZAAK-INFORMATIEOBJECT relatie in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakinformatieobjecten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakInformatieObject' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakInformatieObject' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: zaakinformatieobject_partial_update - description: - "Je mag enkel de gegevens van de relatie bewerken, en niet de relatie\ - \ zelf aanpassen.\n\n**Er wordt gevalideerd op** \n- informatieobject URL\ - \ en zaak URL mogen niet veranderen" - summary: Werk een ZAAK-INFORMATIEOBJECT relatie deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakinformatieobjecten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedZaakInformatieObject' - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakInformatieObject' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaakinformatieobject_destroy - description: - De gespiegelde relatie in de Documenten API wordt door de Zaken - API verwijderd. Consumers kunnen dit niet handmatig doen. - summary: Verwijder een ZAAK-INFORMATIEOBJECT relatie. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakinformatieobjecten - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken | zaken.verwijderen) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: zaakinformatieobject_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ZAAKINFORMATIEOBJECT opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaakinformatieobjecten - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaakobjecten: - get: - operationId: zaakobject_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle ZAAKOBJECTen opvragen. - parameters: - - name: zaak - required: false - in: query - description: URL-referentie naar de ZAAK. - schema: - type: string - format: uri - - name: object - required: false - in: query - description: URL-referentie naar de resource die het OBJECT beschrijft. - schema: - type: string - format: uri - - name: objectType - required: false - in: query - description: - Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er geen - passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. - schema: - type: string - enum: - - adres - - besluit - - buurt - - enkelvoudig_document - - gemeente - - gemeentelijke_openbare_ruimte - - huishouden - - inrichtingselement - - kadastrale_onroerende_zaak - - kunstwerkdeel - - maatschappelijke_activiteit - - medewerker - - natuurlijk_persoon - - niet_natuurlijk_persoon - - openbare_ruimte - - organisatorische_eenheid - - pand - - spoorbaandeel - - status - - terreindeel - - terrein_gebouwd_object - - vestiging - - waterdeel - - wegdeel - - wijk - - woonplaats - - woz_deelobject - - woz_object - - woz_waarde - - zakelijk_recht - - overige - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - tags: - - zaakobjecten - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedZaakObjectList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaakobject_create - description: 'Maak een ZAAKOBJECT aan. - - - **Er wordt gevalideerd op** - - - Indien de `object` URL opgegeveven is, dan moet deze een geldige response - (HTTP 200) geven. - - - Indien opgegeven, dan wordt `objectIdentificatie` gevalideerd tegen de `objectType` - discriminator.' - summary: Maak een ZAAKOBJECT aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakobjecten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObject' - required: true - security: - - JWT-Claims: - - (zaken.aanmaken | zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObject' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaakobjecten/{uuid}: - get: - operationId: zaakobject_retrieve - description: Een specifieke ZAAKOBJECT opvragen. - summary: Een specifieke ZAAKOBJECT opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaakobjecten - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObject' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: zaakobject_update - description: - "**Er wordt gevalideerd op** \n- De attributen `zaak`, `object`\ - \ en `objectType` mogen niet gewijzigd worden.\n- Indien opgegeven, dan wordt\ - \ `objectIdentificatie` gevalideerd tegen de objectType discriminator." - summary: Werk een ZAAKOBJECT zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaakobjecten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObject' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObject' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: zaakobject_partial_update - description: - "**Er wordt gevalideerd op** \n- De attributen `zaak`, `object`\ - \ en `objectType` mogen niet gewijzigd worden.\n- Indien opgegeven, dan wordt\ - \ `objectIdentificatie` gevalideerd tegen de objectType discriminator." - summary: Werk een ZAAKOBJECT deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - tags: - - zaakobjecten - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedZaakObject' - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakObject' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaakobject_destroy - description: - Verbreek de relatie tussen een ZAAK en een OBJECT door de ZAAKOBJECT - resource te verwijderen. - summary: Verwijder een ZAAKOBJECT. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - zaakobjecten - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken | zaken.verwijderen) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: zaakobject_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ZAAKOBJECT opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - tags: - - zaakobjecten - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaakverzoeken: - get: - operationId: zaakverzoek_list - description: Alle ZAAK-VERZOEKen opvragen. - summary: Alle ZAAK-VERZOEKen opvragen. - parameters: - - name: zaak - required: false - in: query - description: URL-referentie naar de ZAAK. - schema: - type: string - format: uri - - name: verzoek - required: false - in: query - description: URL-referentie naar het VERZOEK (in de Klantinteractie API) - schema: - type: string - format: uri - tags: - - zaakverzoeken - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/ZaakVerzoek' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaakverzoek_create - description: '**Er wordt gevalideerd op** - - - geldigheid URL naar de VERZOEK' - summary: Maak een ZAAK-VERZOEK aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakverzoeken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakVerzoek' - required: true - security: - - JWT-Claims: - - zaken.bijwerken - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakVerzoek' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaakverzoeken/{uuid}: - get: - operationId: zaakverzoek_retrieve - description: Een specifieke ZAAK-VERZOEK opvragen. - summary: Een specifieke ZAAK-VERZOEK opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - tags: - - zaakverzoeken - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakVerzoek' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaakverzoek_destroy - description: Verwijder een ZAAK-VERZOEK. - summary: Verwijder een ZAAK-VERZOEK. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - tags: - - zaakverzoeken - security: - - JWT-Claims: - - zaken.bijwerken - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaken: - get: - operationId: zaak_list - description: Deze lijst kan gefilterd wordt met query-string parameters. - summary: Alle ZAAKen opvragen. - parameters: - - name: identificatie - required: false - in: query - description: - De unieke identificatie van de ZAAK binnen de organisatie die - verantwoordelijk is voor de behandeling van de ZAAK. - schema: - type: string - example: "zaak123" - - name: bronorganisatie - required: false - in: query - description: - Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers - en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef - schema: - type: string - example: "000000000" - - name: bronorganisatie__in - required: false - in: query - description: Multiple values may be separated by commas. - schema: - type: array - items: - type: string - example: ["000000000","479559740","875883461"] - style: form - explode: false - - name: zaaktype - required: false - in: query - description: - URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS - waar deze voorkomt - schema: - type: string - format: uri - example: "https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/e80b7507-199a-484c-ad49-c41a1e43a6e7" - - name: archiefnominatie - required: false - in: query - description: - Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - schema: - type: string - enum: - - blijvend_bewaren - - vernietigen - example: "blijvend_bewaren" - - name: archiefnominatie__in - required: false - in: query - description: Multiple values may be separated by commas. - schema: - type: array - items: - type: string - example: ["blijvend_bewaren", "vernietigen"] - style: form - explode: false - - name: archiefactiedatum - required: false - in: query - description: - De datum waarop het gearchiveerde zaakdossier vernietigd moet - worden dan wel overgebracht moet worden naar een archiefbewaarplaats. Wordt - automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT aan - deze ZAAK indien nog leeg. - schema: - type: string - example: "2019-01-02" - - name: archiefactiedatum__isnull - required: false - in: query - description: De archiefactiedatum is leeg. - schema: - type: boolean - example: false - - name: archiefactiedatum__lt - required: false - in: query - description: De archiefactiedatum is kleiner dan de opgegeven datum. - schema: - type: string - example: "2020-01-02" - - name: archiefactiedatum__gt - required: false - in: query - description: De archiefactiedatum is groter dan de opgegeven datum. - schema: - type: string - example: "2018-01-02" - - name: archiefstatus - required: false - in: query - description: - Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - schema: - type: string - enum: - - nog_te_archiveren - - gearchiveerd - - gearchiveerd_procestermijn_onbekend - - overgedragen - example: "nog_te_archiveren" - - name: archiefstatus__in - required: false - in: query - description: Multiple values may be separated by commas. - schema: - type: array - items: - type: string - example: ["nog_te_archiveren","gearchiveerd","gearchiveerd_procestermijn_onbekend","overgedragen"] - style: form - explode: false - - name: startdatum - required: false - in: query - description: De datum waarop met de uitvoering van de zaak is gestart - schema: - type: string - example: "2017-01-02" - - name: startdatum__gt - required: false - in: query - description: De startdatum is groter dan de opgegeven datum. - schema: - type: string - example: "2018-01-02" - - name: startdatum__gte - required: false - in: query - description: De startdatum is groter dan of gelijk dan de opgegeven datum. - schema: - type: string - example: "2016-01-02" - - name: startdatum__lt - required: false - in: query - description: De startdatum is kleiner dan de opgegeven datum. - schema: - type: string - example: "2018-01-02" - - name: startdatum__lte - required: false - in: query - description: De startdatum is kleiner of gelijk dan de opgegeven datum. - schema: - type: string - example: "2018-01-02" - - name: registratiedatum - required: false - in: query - description: - De datum waarop de zaakbehandelende organisatie de ZAAK heeft - geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag - gebruikt. - schema: - type: string - example: "2015-01-02" - - name: registratiedatum__gt - required: false - in: query - description: - De registratiedatum is groter dan de opgegeven datum. - schema: - type: string - example: "2014-01-02" - - name: registratiedatum__lt - required: false - in: query - description: - De registratiedatum is kleiner dan de opgegeven datum. - schema: - type: string - example: "2016-01-02" - - name: einddatum - required: false - in: query - description: De datum waarop de uitvoering van de zaak afgerond is. - schema: - type: string - example: "2022-01-02" - - name: einddatum__isnull - required: false - in: query - description: De einddatum is leeg. - schema: - type: boolean - example: false - - name: einddatum__gt - required: false - in: query - description: De einddatum is groter dan de opgegeven datum. - schema: - type: string - example: "2021-01-02" - - name: einddatum__lt - required: false - in: query - description: De einddatum is kleiner dan de opgegeven datum. - schema: - type: string - example: "2023-01-02" - - name: einddatumGepland - required: false - in: query - description: - De datum waarop volgens de planning verwacht wordt dat de zaak - afgerond wordt. - schema: - type: string - example: "2022-01-02" - - name: einddatumGepland__gt - required: false - in: query - description: - De geplande einddatum is groter dan de opgegeven datum. - schema: - type: string - example: "2021-01-02" - - name: einddatumGepland__lt - required: false - in: query - description: - De geplande einddatum is kleiner dan de opgegeven datum. - schema: - type: string - example: "2024-01-02" - - name: uiterlijkeEinddatumAfdoening - required: false - in: query - description: - De laatste datum waarop volgens wet- en regelgeving de zaak afgerond - dient te zijn. - schema: - type: string - example: "2024-01-02" - - name: uiterlijkeEinddatumAfdoening__gt - required: false - in: query - description: - De uiterlijke einddatumafdoening is groter dan de opgegeven datum. - schema: - type: string - example: "2023-01-02" - - name: uiterlijkeEinddatumAfdoening__lt - required: false - in: query - description: - De uiterlijke einddatumafdoening is kleiner dan de opgegeven datum. - schema: - type: string - example: "2025-01-02" - - name: rol__betrokkeneType - required: false - in: query - description: Type van de `betrokkene`. - schema: - type: string - enum: - - natuurlijk_persoon - - niet_natuurlijk_persoon - - vestiging - - organisatorische_eenheid - - medewerker - example: "natuurlijk_persoon" - - name: rol__betrokkene - required: false - in: query - description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. - schema: - type: string - format: uri - example: "https://example.com" - - name: rol__omschrijvingGeneriek - required: false - in: query - description: - Algemeen gehanteerde benaming van de aard van de ROL, afgeleid - uit het ROLTYPE. - schema: - type: string - enum: - - adviseur - - behandelaar - - belanghebbende - - beslisser - - initiator - - klantcontacter - - zaakcoordinator - - mede_initiator - example: "initiator" - - name: maximaleVertrouwelijkheidaanduiding - required: false - in: query - description: - Zaken met een vertrouwelijkheidaanduiding die beperkter is dan - de aangegeven aanduiding worden uit de resultaten gefiltered. - schema: - type: string - enum: - - openbaar - - beperkt_openbaar - - intern - - zaakvertrouwelijk - - vertrouwelijk - - confidentieel - - geheim - - zeer_geheim - example: "zaakvertrouwelijk" - - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn - required: false - in: query - description: - Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene - bepalingen burgerservicenummer. - schema: - type: string - maxLength: 9 - example: "123456789" - - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie - required: false - in: query - description: - Het door de gemeente uitgegeven unieke nummer voor een ANDER - NATUURLIJK PERSOON - schema: - type: string - maxLength: 17 - example: "123456789" - - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer - required: false - in: query - description: Het administratienummer van de persoon, bedoeld in de Wet BRP - schema: - type: string - maxLength: 10 - example: "123456789" - - name: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId - required: false - in: query - description: - Het door een kamer toegekend uniek nummer voor de INGESCHREVEN - NIET-NATUURLIJK PERSOON - schema: - type: string - example: "123456789" - - name: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie - required: false - in: query - description: - Het door de gemeente uitgegeven unieke nummer voor een ANDER - NIET-NATUURLIJK PERSOON - schema: - type: string - maxLength: 17 - example: "123456789" - - name: rol__betrokkeneIdentificatie__vestiging__vestigingsNummer - required: false - in: query - description: Een korte unieke aanduiding van de Vestiging. - schema: - type: string - maxLength: 24 - example: "123456789" - - name: rol__betrokkeneIdentificatie__medewerker__identificatie - required: false - in: query - description: Een korte unieke aanduiding van de MEDEWERKER. - schema: - type: string - maxLength: 24 - example: "123456789" - - name: rol__betrokkeneIdentificatie__organisatorischeEenheid__identificatie - required: false - in: query - description: Een korte identificatie van de organisatorische eenheid. - schema: - type: string - example: "123456789" - - name: expand - in: query - description: Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt. - schema: - type: string - example: zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype - - name: ordering - required: false - in: query - description: Het veld waarop de resultaten geordend worden. Het minnetje betekent omgekeerde volgorde. - schema: - type: array - items: - type: string - enum: - - startdatum - - -startdatum - - einddatum - - -einddatum - - publicatiedatum - - -publicatiedatum - - archiefactiedatum - - -archiefactiedatum - - registratiedatum - - -registratiedatum - - identificatie - - -identificatie - example: "-startdatum" - style: form - explode: false - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer - example: 1 - - in: header - name: Accept-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het gewenste 'Coordinate Reference System' (CRS) van de geometrie - in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - required: true - - in: header - name: Content-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie in de - vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 - is hetzelfde als WGS84). - required: true - tags: - - zaken - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - Content-Crs: - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie - in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedZaakList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '412': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Precondition failed - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaak_create - description: - 'Indien geen identificatie gegeven is, dan wordt deze automatisch - gegenereerd. De identificatie moet uniek zijn binnen de bronorganisatie. - - - **Er wordt gevalideerd op:** - - - geldigheid `zaaktype` URL - de resource moet opgevraagd kunnen worden uit - de Catalogi API en de vorm van een ZAAKTYPE hebben. - - - `zaaktype` is geen concept (`zaaktype.concept = False`) - - - `laatsteBetaaldatum` mag niet in de toekomst liggen. - - - `laatsteBetaaldatum` mag niet gezet worden als de betalingsindicatie "nvt" - is. - - - `barchiefnominatie` moet een waarde hebben indien archiefstatus niet de - waarde "nog_te_archiveren" heeft. - - - `archiefactiedatum` moet een waarde hebben indien archiefstatus niet de - waarde "nog_te_archiveren" heeft. - - - `archiefstatus` kan alleen een waarde anders dan "nog_te_archiveren" hebben - indien van alle gerelateeerde INFORMATIEOBJECTen het attribuut `status` de - waarde "gearchiveerd" heeft.' - summary: Maak een ZAAK aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - - in: header - name: Accept-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het gewenste 'Coordinate Reference System' (CRS) van de geometrie - in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - required: true - - in: header - name: Content-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie in de - vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 - is hetzelfde als WGS84). - required: true - tags: - - zaken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Zaak' - required: true - security: - - JWT-Claims: - - zaken.aanmaken - responses: - '201': - headers: - Content-Crs: - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie - in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Zaak' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '412': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Precondition failed - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaken/{uuid}: - get: - operationId: zaak_retrieve - description: Een specifieke ZAAK opvragen. - summary: Een specifieke ZAAK opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: header - name: Accept-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het gewenste 'Coordinate Reference System' (CRS) van de geometrie - in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - required: true - - in: header - name: Content-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie in de - vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 - is hetzelfde als WGS84). - required: true - - name: expand - in: query - description: Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt. - schema: - type: string - example: zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype - tags: - - zaken - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - Content-Crs: - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie - in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakExpanded' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '412': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Precondition failed - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: zaak_update - description: - "**Er wordt gevalideerd op** \n- `identificatie` mag niet gewijzigd worden.\n- `laatsteBetaaldatum`\ - \ mag niet in de toekomst liggen.\n- `laatsteBetaaldatum` mag niet gezet worden\ - \ als de betalingsindicatie\n\"nvt\" is.\n- `archiefnominatie` moet een waarde\ - \ hebben indien `archiefstatus` niet de\nwaarde \"nog_te_archiveren\" heeft.\n\ - - `archiefactiedatum` moet een waarde hebben indien `archiefstatus` niet de\n\ - \ waarde \"nog_te_archiveren\" heeft.\n- `archiefstatus` kan alleen een waarde\ - \ anders dan \"nog_te_archiveren\"\n hebben indien van alle gerelateeerde\ - \ INFORMATIEOBJECTen het attribuut\n `status` de waarde \"gearchiveerd\"\ - \ heeft.\n**Opmerkingen**\n- er worden enkel zaken getoond van de zaaktypes\ - \ waar u toe geautoriseerd\n bent.\n- indien een zaak heropend moet worden,\ - \ doe dit dan door een nieuwe status\n toe te voegen die NIET de eindstatus\ - \ is. Zie de `Status` resource." - summary: Werk een ZAAK in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - - in: header - name: Accept-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het gewenste 'Coordinate Reference System' (CRS) van de geometrie - in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - required: true - - in: header - name: Content-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie in de - vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 - is hetzelfde als WGS84). - required: true - tags: - - zaken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/Zaak' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - Content-Crs: - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie - in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Zaak' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '412': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Precondition failed - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: zaak_partial_update - description: - "**Er wordt gevalideerd op** \n- `identificatie` mag niet gewijzigd worden.\n- `laatsteBetaaldatum`\ - \ mag niet in de toekomst liggen.\n- `laatsteBetaaldatum` mag niet gezet worden\ - \ als de betalingsindicatie\n\"nvt\" is.\n- `archiefnominatie` moet een waarde\ - \ hebben indien `archiefstatus` niet de\nwaarde \"nog_te_archiveren\" heeft.\n\ - - `archiefactiedatum` moet een waarde hebben indien `archiefstatus` niet de\n\ - \ waarde \"nog_te_archiveren\" heeft.\n- `archiefstatus` kan alleen een waarde\ - \ anders dan \"nog_te_archiveren\"\n hebben indien van alle gerelateeerde\ - \ INFORMATIEOBJECTen het attribuut\n `status` de waarde \"gearchiveerd\"\ - \ heeft.\n**Opmerkingen**\n- er worden enkel zaken getoond van de zaaktypes\ - \ waar u toe geautoriseerd\n bent.\n- indien een zaak heropend moet worden,\ - \ doe dit dan door een nieuwe status\n toe te voegen die NIET de eindstatus\ - \ is. Zie de `Status` resource." - summary: Werk een ZAAK deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - - in: header - name: Accept-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het gewenste 'Coordinate Reference System' (CRS) van de geometrie - in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - required: true - - in: header - name: Content-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie in de - vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 - is hetzelfde als WGS84). - required: true - tags: - - zaken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedZaak' - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - Content-Crs: - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie - in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/Zaak' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '412': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Precondition failed - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaak_destroy - description: '***De gerelateerde resources zijn hierbij*** - - - `zaak` - de deelzaken van de verwijderde hoofzaak - - - `status` - alle statussen van de verwijderde zaak - - - `resultaat` - het resultaat van de verwijderde zaak - - - `rol` - alle rollen bij de zaak - - - `zaakobject` - alle zaakobjecten bij de zaak - - - `zaakeigenschap` - alle eigenschappen van de zaak - - - `zaakkenmerk` - alle kenmerken van de zaak - - - `zaakinformatieobject` - dit moet door-cascaden naar de Documenten API, - zie ook: https://github.com/VNG-Realisatie/gemma-zaken/issues/791 (TODO) - - - `klantcontact` - alle klantcontacten bij een zaak' - summary: Verwijder een ZAAK. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - - in: header - name: Accept-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het gewenste 'Coordinate Reference System' (CRS) van de geometrie - in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - required: true - - in: header - name: Content-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie in de - vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 - is hetzelfde als WGS84). - required: true - tags: - - zaken - security: - - JWT-Claims: - - zaken.verwijderen - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '412': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Precondition failed - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: zaak_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ZAAK opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: header - name: Accept-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het gewenste 'Coordinate Reference System' (CRS) van de geometrie - in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - required: true - - in: header - name: Content-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie in de - vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 - is hetzelfde als WGS84). - required: true - tags: - - zaken - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - Content-Crs: - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie - in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaken/{zaak_uuid}/audittrail: - get: - operationId: audittrail_list - description: Alle audit trail regels behorend bij de ZAAK. - summary: Alle audit trail regels behorend bij de ZAAK. - parameters: - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - security: - - JWT-Claims: - - audittrails.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/AuditTrail' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaken/{zaak_uuid}/audittrail/{uuid}: - get: - operationId: audittrail_retrieve - description: Een specifieke audit trail regel opvragen. - summary: 'Een specifieke audit trail regel opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke identificatie van de audit regel. - title: uuid - required: true - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - security: - - JWT-Claims: - - audittrails.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/AuditTrail' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaken/{zaak_uuid}/besluiten: - get: - operationId: zaakbesluit_list - description: Alle ZAAKBESLUITen opvragen. - summary: Alle ZAAKBESLUITen opvragen. - parameters: - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/ZaakBesluit' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaakbesluit_create - description: - '**LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** - - - De Besluiten API gebruikt dit endpoint om relaties te synchroniseren, daarom - is dit endpoint in de Zaken API geimplementeerd. - - - **Er wordt gevalideerd op:** - - - geldigheid URL naar de ZAAK' - summary: Maak een ZAAKBESLUIT aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakBesluit' - required: true - security: - - JWT-Claims: - - zaken.bijwerken - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakBesluit' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaken/{zaak_uuid}/besluiten/{uuid}: - get: - operationId: zaakbesluit_retrieve - description: Een specifiek ZAAKBESLUIT opvragen. - summary: 'Een specifiek ZAAKBESLUIT opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakBesluit' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaakbesluit_destroy - description: - '***LET OP: Dit endpoint hoor je als consumer niet zelf aan te - spreken.*** - - - De Besluiten API gebruikt dit endpoint om relaties te synchroniseren, daarom - is dit endpoint in de Zaken API geimplementeerd. - - ' - summary: Verwijder een ZAAKBESLUIT. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - security: - - JWT-Claims: - - zaken.bijwerken - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaken/{zaak_uuid}/zaakeigenschappen: - get: - operationId: zaakeigenschap_list - description: Alle ZAAKEIGENSCHAPpen opvragen. - summary: 'Alle ZAAKEIGENSCHAPpen opvragen. ' - parameters: - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - type: array - items: - $ref: '#/components/schemas/ZaakEigenschap' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - post: - operationId: zaakeigenschap_create - description: 'Maak een ZAAKEIGENSCHAP aan. - - - **Er wordt gevalideerd op:** - - - geldigheid `eigenschap` URL - de resource moet opgevraagd kunnen worden - uit de Catalogi API en de vorm van een EIGENSCHAP hebben. - - - de `eigenschap` moet bij het `ZAAK.zaaktype` horen' - summary: Maak een ZAAKEIGENSCHAP aan. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakEigenschap' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '201': - headers: - Location: - schema: - type: string - format: uri - description: URL waar de resource leeft. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakEigenschap' - description: Created - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - /zaken/{zaak_uuid}/zaakeigenschappen/{uuid}: - get: - operationId: zaakeigenschap_retrieve - description: Een specifieke ZAAKEIGENSCHAP opvragen. - summary: Een specifieke ZAAKEIGENSCHAP opvragen. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakEigenschap' - description: OK - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - put: - operationId: zaakeigenschap_update - description: - "**Er wordt gevalideerd op** \n- Alleen de `waarde` mag gewijzigd\ - \ worden" - summary: Werk een ZAAKEIGENSCHAP in zijn geheel bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakEigenschap' - required: true - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakEigenschap' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - patch: - operationId: zaakeigenschap_partial_update - description: - "**Er wordt gevalideerd op** \n- Alleen de `waarde` mag gewijzigd\ - \ worden" - summary: Werk een ZAAKEIGENSCHAP deels bij. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/PatchedZaakEigenschap' - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '200': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakEigenschap' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - delete: - operationId: zaakeigenschap_destroy - description: Verwijder een ZAAKEIGENSCHAP - summary: Verwijder een ZAAKEIGENSCHAP. - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) - responses: - '204': - description: No content - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - head: - operationId: zaakeigenschap_headers - description: Vraag de headers op die je bij een GET request zou krijgen. - summary: 'De headers voor een specifiek(e) ZAAKEIGENSCHAP opvragen ' - parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: path - name: zaak_uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - required: true - tags: - - zaken - responses: - '200': - headers: - ETag: - schema: - type: string - description: - De ETag berekend op de response body JSON. Indien twee - resources exact dezelfde ETag hebben, dan zijn deze resources identiek - aan elkaar. Je kan de ETag gebruiken om caching te implementeren. - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - description: OK - /zaken/_zoek: - post: - operationId: zaak__zoek - description: - Zoeken/filteren gaat normaal via de `list` operatie, deze is echter - niet geschikt voor geo-zoekopdrachten. - summary: Voer een (geo)-zoekopdracht uit op ZAAKen. - parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: query - name: page - schema: - type: integer - description: Een pagina binnen de gepagineerde set resultaten. - - in: header - name: Accept-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het gewenste 'Coordinate Reference System' (CRS) van de geometrie - in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - required: true - - in: header - name: Content-Crs - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie in de - vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 - is hetzelfde als WGS84). - required: true - tags: - - zaken - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/ZaakZoek' - security: - - JWT-Claims: - - zaken.lezen - responses: - '200': - headers: - Content-Crs: - schema: - type: string - enum: - - EPSG:4326 - description: - Het 'Coordinate Reference System' (CRS) van de geometrie - in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default - (EPSG:4326 is hetzelfde als WGS84). - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/json: - schema: - $ref: '#/components/schemas/PaginatedZaakList' - description: OK - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '412': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Precondition failed - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van - een specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error -components: - responses: - '400': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/ValidatieFout' - description: Bad request - '401': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unauthorized - '403': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Forbidden - '404': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not found - '406': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Not acceptable - '409': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Conflict - '410': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Gone - '412': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Precondition failed - '415': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Unsupported media type - '429': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Too many requests - '500': - headers: - API-version: - schema: - type: string - description: - 'Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1.' - content: - application/problem+json: - schema: - $ref: '#/components/schemas/Fout' - description: Internal server error - schemas: - AardRelatieEnum: - enum: - - vervolg - - onderwerp - - bijdrage - type: string - AardRelatieWeergaveEnum: - enum: - - 'Hoort bij, omgekeerd: kent' - - 'Legt vast, omgekeerd: kan vastgelegd zijn als' - type: string - ArchiefnominatieEnum: - enum: - - blijvend_bewaren - - vernietigen - type: string - ArchiefstatusEnum: - enum: - - nog_te_archiveren - - gearchiveerd - - gearchiveerd_procestermijn_onbekend - - overgedragen - type: string - AuditTrail: - type: object - properties: - uuid: - type: string - format: uuid - description: Unieke identificatie van de audit regel. - title: uuid - bron: - allOf: - - $ref: '#/components/schemas/BronEnum' - description: - 'De naam van het component waar de wijziging in is gedaan. - - - Uitleg bij mogelijke waarden: - - - * `ac` - Autorisaties API - - * `nrc` - Notificaties API - - * `zrc` - Zaken API - - * `ztc` - Catalogi API - - * `drc` - Documenten API - - * `brc` - Besluiten API - - * `cmc` - Contactmomenten API - - * `kc` - Klanten API - - * `vrc` - Verzoeken API' - title: bron - applicatieId: - type: string - description: Unieke identificatie van de applicatie, binnen de organisatie. - title: applicatie id - maxLength: 100 - applicatieWeergave: - type: string - description: Vriendelijke naam van de applicatie. - title: applicatie weergave - maxLength: 200 - gebruikersId: - type: string - description: - Unieke identificatie van de gebruiker die binnen de organisatie - herleid kan worden naar een persoon. - title: gebruikers id - maxLength: 255 - gebruikersWeergave: - type: string - description: Vriendelijke naam van de gebruiker. - title: gebruikers weergave - maxLength: 255 - actie: - type: string - description: 'De uitgevoerde handeling. - - - De bekende waardes voor dit veld zijn hieronder aangegeven, maar - andere waardes zijn ook toegestaan - - - Uitleg bij mogelijke waarden: - - - * `create` - Object aangemaakt - - * `list` - Lijst van objecten opgehaald - - * `retrieve` - Object opgehaald - - * `destroy` - Object verwijderd - - * `update` - Object bijgewerkt - - * `partial_update` - Object deels bijgewerkt' - title: actie - maxLength: 50 - actieWeergave: - type: string - description: Vriendelijke naam van de actie. - title: actie weergave - maxLength: 200 - resultaat: - type: integer - maximum: 599 - minimum: 100 - description: HTTP status code van de API response van de uitgevoerde handeling. - title: resultaat - hoofdObject: - type: string - format: uri - description: De URL naar het hoofdobject van een component. - title: hoofd object - maxLength: 1000 - resource: - type: string - description: Het type resource waarop de actie gebeurde. - title: resource - maxLength: 50 - resourceUrl: - type: string - format: uri - description: De URL naar het object. - title: resource url - maxLength: 1000 - toelichting: - type: string - description: Toelichting waarom de handeling is uitgevoerd. - title: toelichting - resourceWeergave: - type: string - description: Vriendelijke identificatie van het object. - title: resource weergave - maxLength: 200 - aanmaakdatum: - type: string - format: date-time - readOnly: true - description: De datum waarop de handeling is gedaan. - title: aanmaakdatum - wijzigingen: - allOf: - - $ref: '#/components/schemas/Wijzigingen' - title: wijzigingen - required: - - aanmaakdatum - - actie - - bron - - hoofdObject - - resource - - resourceUrl - - resourceWeergave - - resultaat - - wijzigingen - BetalingsindicatieEnum: - enum: - - nvt - - nog_niet - - gedeeltelijk - - geheel - type: string - BetrokkeneTypeEnum: - enum: - - natuurlijk_persoon - - niet_natuurlijk_persoon - - vestiging - - organisatorische_eenheid - - medewerker - type: string - BlankEnum: - enum: - - '' - BronEnum: - enum: - - ac - - nrc - - zrc - - ztc - - drc - - brc - - cmc - - kc - - vrc - type: string - ContactPersoonRol: - type: object - description: - De gegevens van de persoon die anderen desgevraagd in contact brengt - met medewerkers van de BETROKKENE, een NIET-NATUURLIJK PERSOON of VESTIGING - zijnde, of met BETROKKENE zelf, een NATUURLIJK PERSOON zijnde , vanuit het - belang van BETROKKENE in haar ROL bij een ZAAK. - properties: - emailadres: - type: string - format: email - title: Email - description: - Elektronich postadres waaronder de contactpersoon in de regel - bereikbaar is. - maxLength: 254 - functie: - type: string - description: - 'De aanduiding van de taken, rechten en plichten die de contactpersoon - heeft binnen de organisatie van BETROKKENE. ' - title: functie - maxLength: 50 - telefoonnummer: - type: string - description: - Telefoonnummer waaronder de contactpersoon in de regel bereikbaar - is. - title: telefoonnummer - maxLength: 20 - naam: - type: string - description: De opgemaakte naam van de contactpersoon namens de BETROKKENE. - title: naam - maxLength: 40 - required: - - naam - nullable: true - FieldValidationError: - type: object - description: Formaat van validatiefouten. - properties: - name: - type: string - description: Naam van het veld met ongeldige gegevens - title: name - code: - type: string - description: Systeemcode die het type fout aangeeft - title: code - reason: - type: string - description: Uitleg wat er precies fout is met de gegevens - title: reason - required: - - code - - name - - reason - Fout: - type: object - description: Formaat van HTTP 4xx en 5xx fouten. - properties: - type: - type: string - description: URI referentie naar het type fout, bedoeld voor developers - title: type - code: - type: string - description: Systeemcode die het type fout aangeeft - title: code - title: - type: string - description: Generieke titel voor het type fout - title: title - status: - type: integer - description: De HTTP status code - title: status - detail: - type: string - description: Extra informatie bij de fout, indien beschikbaar - title: detail - instance: - type: string - description: - URI met referentie naar dit specifiek voorkomen van de fout. - Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. - title: instance - required: - - code - - detail - - instance - - status - - title - GeoJSONGeometry: - title: GeoJSONGeometry - type: object - oneOf: - - $ref: '#/components/schemas/Point' - - $ref: '#/components/schemas/MultiPoint' - - $ref: '#/components/schemas/LineString' - - $ref: '#/components/schemas/MultiLineString' - - $ref: '#/components/schemas/Polygon' - - $ref: '#/components/schemas/MultiPolygon' - - $ref: '#/components/schemas/GeometryCollection' - discriminator: - propertyName: type - GeoWithin: - type: object - properties: - within: - allOf: - - $ref: '#/components/schemas/GeoJSONGeometry' - title: within - Geometry: - title: Geometry - description: GeoJSON geometry - type: object - required: - - type - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1 - properties: - type: - allOf: - - $ref: '#/components/schemas/GeometryTypeEnum' - description: The geometry type - GeometryCollection: - title: Geometry collection - description: GeoJSON multi-polygon geometry - type: object - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.8 - allOf: - - $ref: '#/components/schemas/Geometry' - - type: object - required: - - geometries - properties: - geometries: - type: array - items: - $ref: '#/components/schemas/Geometry' - GeometryTypeEnum: - type: string - enum: - - Point - - MultiPoint - - LineString - - MultiLineString - - Polygon - - MultiPolygon - - Feature - - FeatureCollection - - GeometryCollection - GeslachtsaanduidingEnum: - enum: - - m - - v - - o - type: string - IndicatieMachtigingEnum: - enum: - - gemachtigde - - machtiginggever - type: string - InnRechtsvormEnum: - enum: - - besloten_vennootschap - - cooperatie_europees_economische_samenwerking - - europese_cooperatieve_venootschap - - europese_naamloze_vennootschap - - kerkelijke_organisatie - - naamloze_vennootschap - - onderlinge_waarborg_maatschappij - - overig_privaatrechtelijke_rechtspersoon - - stichting - - vereniging - - vereniging_van_eigenaars - - publiekrechtelijke_rechtspersoon - - vennootschap_onder_firma - - maatschap - - rederij - - commanditaire_vennootschap - - kapitaalvennootschap_binnen_eer - - overige_buitenlandse_rechtspersoon_vennootschap - - kapitaalvennootschap_buiten_eer - type: string - KlantContact: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - identificatie: - type: string - description: De unieke aanduiding van een KLANTCONTACT - title: identificatie - maxLength: 14 - datumtijd: - type: string - format: date-time - description: De datum en het tijdstip waarop het KLANTCONTACT begint - title: datumtijd - kanaal: - type: string - description: Het communicatiekanaal waarlangs het KLANTCONTACT gevoerd wordt - title: kanaal - maxLength: 20 - onderwerp: - type: string - description: Het onderwerp waarover contact is geweest met de klant. - title: onderwerp - maxLength: 200 - toelichting: - type: string - description: Een toelichting die inhoudelijk het contact met de klant beschrijft. - title: toelichting - maxLength: 1000 - required: - - datumtijd - - url - - uuid - - zaak - LineString: - title: Line-string - description: GeoJSON line-string geometry - type: object - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.4 - allOf: - - $ref: '#/components/schemas/Geometry' - - type: object - required: - - coordinates - properties: - coordinates: - type: array - items: - $ref: '#/components/schemas/Point2D' - minItems: 2 - MultiLineString: - title: Multi-line string - description: GeoJSON multi-line-string geometry - type: object - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.5 - allOf: - - $ref: '#/components/schemas/Geometry' - - type: object - required: - - coordinates - properties: - coordinates: - type: array - items: - type: array - items: - $ref: '#/components/schemas/Point2D' - MultiPoint: - title: MultiPoint - description: GeoJSON multi-point geometry - type: object - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.3 - allOf: - - $ref: '#/components/schemas/Geometry' - - type: object - required: - - coordinates - properties: - coordinates: - type: array - items: - $ref: '#/components/schemas/Point2D' - MultiPolygon: - title: Multi-polygon - description: GeoJSON multi-polygon geometry - type: object - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.7 - allOf: - - $ref: '#/components/schemas/Geometry' - - type: object - required: - - coordinates - properties: - coordinates: - type: array - items: - type: array - items: - type: array - items: - $ref: '#/components/schemas/Point2D' - NullEnum: - enum: - - null - ObjectAdres: - type: object - properties: - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - wplWoonplaatsNaam: - type: string - title: wpl woonplaats naam - maxLength: 80 - gorOpenbareRuimteNaam: - type: string - description: - Een door het bevoegde gemeentelijke orgaan aan een OPENBARE - RUIMTE toegekende benaming - title: gor openbare ruimte naam - maxLength: 80 - huisnummer: - type: integer - maximum: 99999 - minimum: 0 - title: huisnummer - huisletter: - type: string - title: huisletter - maxLength: 1 - huisnummertoevoeging: - type: string - title: huisnummertoevoeging - maxLength: 4 - postcode: - type: string - title: postcode - maxLength: 7 - required: - - gorOpenbareRuimteNaam - - huisnummer - - identificatie - - wplWoonplaatsNaam - ObjectBuurt: - type: object - properties: - buurtCode: - type: string - description: De code behorende bij de naam van de buurt - title: buurt code - maxLength: 2 - buurtNaam: - type: string - description: De naam van de buurt, zoals die door het CBS wordt gebruikt. - title: buurt naam - maxLength: 40 - gemGemeenteCode: - type: string - description: - Een numerieke aanduiding waarmee een Nederlandse gemeente uniek - wordt aangeduid - title: gem gemeente code - maxLength: 4 - wykWijkCode: - type: string - description: De code behorende bij de naam van de wijk - title: wyk wijk code - maxLength: 2 - required: - - buurtCode - - buurtNaam - - gemGemeenteCode - - wykWijkCode - ObjectGemeente: - type: object - properties: - gemeenteNaam: - type: string - description: "De offici\xEBle door de gemeente vastgestelde gemeentenaam." - title: gemeente naam - maxLength: 80 - gemeenteCode: - type: string - description: - Een numerieke aanduiding waarmee een Nederlandse gemeente uniek - wordt aangeduid - title: gemeente code - maxLength: 4 - required: - - gemeenteCode - - gemeenteNaam - ObjectGemeentelijkeOpenbareRuimte: - type: object - properties: - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - openbareRuimteNaam: - type: string - description: - Een door het bevoegde gemeentelijke orgaan aan een OPENBARE - RUIMTE toegekende benaming - title: openbare ruimte naam - maxLength: 80 - required: - - identificatie - - openbareRuimteNaam - ObjectHuishouden: - type: object - properties: - nummer: - type: string - description: - Uniek identificerend administratienummer van een huishouden - zoals toegekend door de gemeente waarin het huishouden woonachtig is. - title: nummer - maxLength: 12 - isGehuisvestIn: - allOf: - - $ref: '#/components/schemas/ObjectTerreinGebouwdObject' - nullable: true - title: isGehuisvestIn - required: - - nummer - ObjectInrichtingselement: - type: object - properties: - type: - allOf: - - $ref: '#/components/schemas/ObjectInrichtingselementTypeEnum' - description: 'Specificatie van de aard van het inrichtingselement. - - - Uitleg bij mogelijke waarden: - - - * `bak` - Bak - - * `bord` - Bord - - * `installatie` - Installatie - - * `kast` - Kast - - * `mast` - Mast - - * `paal` - Paal - - * `sensor` - Sensor - - * `straatmeubilair` - Straatmeubilair - - * `waterinrichtingselement` - Waterinrichtingselement - - * `weginrichtingselement` - Weginrichtingselement' - title: type - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - naam: - type: string - description: De benaming van het OBJECT - title: naam - maxLength: 500 - required: - - identificatie - - type - ObjectInrichtingselementTypeEnum: - enum: - - bak - - bord - - installatie - - kast - - mast - - paal - - sensor - - straatmeubilair - - waterinrichtingselement - - weginrichtingselement - type: string - ObjectKadastraleOnroerendeZaak: - type: object - properties: - kadastraleIdentificatie: - type: string - description: De unieke identificatie van het OBJECT - title: kadastrale identificatie - maxLength: 100 - kadastraleAanduiding: - type: string - description: - De typering van de kadastrale aanduiding van een onroerende - zaak conform Kadaster - title: kadastrale aanduiding - maxLength: 1000 - required: - - kadastraleAanduiding - - kadastraleIdentificatie - ObjectKunstwerkdeel: - type: object - properties: - type: - allOf: - - $ref: '#/components/schemas/ObjectKunstwerkdeelTypeEnum' - description: - 'Specificatie van het soort Kunstwerk waartoe het kunstwerkdeel - behoort. - - - Uitleg bij mogelijke waarden: - - - * `keermuur` - Keermuur - - * `overkluizing` - Overkluizing - - * `duiker` - Duiker - - * `faunavoorziening` - Faunavoorziening - - * `vispassage` - Vispassage - - * `bodemval` - Bodemval - - * `coupure` - Coupure - - * `ponton` - Ponton - - * `voorde` - Voorde - - * `hoogspanningsmast` - Hoogspanningsmast - - * `gemaal` - Gemaal - - * `perron` - Perron - - * `sluis` - Sluis - - * `strekdam` - Strekdam - - * `steiger` - Steiger - - * `stuw` - Stuw' - title: type - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - naam: - type: string - title: naam - maxLength: 80 - required: - - identificatie - - naam - - type - ObjectKunstwerkdeelTypeEnum: - enum: - - keermuur - - overkluizing - - duiker - - faunavoorziening - - vispassage - - bodemval - - coupure - - ponton - - voorde - - hoogspanningsmast - - gemaal - - perron - - sluis - - strekdam - - steiger - - stuw - type: string - ObjectMaatschappelijkeActiviteit: - type: object - properties: - kvkNummer: - type: string - description: - Landelijk uniek identificerend administratienummer van een - MAATSCHAPPELIJKE ACTIVITEIT zoals toegewezen door de Kamer van Koophandel - (KvK). - title: kvk nummer - maxLength: 8 - handelsnaam: - type: string - description: De naam waaronder de onderneming handelt. - title: handelsnaam - maxLength: 200 - required: - - handelsnaam - - kvkNummer - ObjectOpenbareRuimte: - type: object - properties: - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - wplWoonplaatsNaam: - type: string - title: wpl woonplaats naam - maxLength: 80 - gorOpenbareRuimteNaam: - type: string - description: - Een door het bevoegde gemeentelijke orgaan aan een OPENBARE - RUIMTE toegekende benaming - title: gor openbare ruimte naam - maxLength: 80 - required: - - gorOpenbareRuimteNaam - - identificatie - - wplWoonplaatsNaam - ObjectOverige: - type: object - properties: - overigeData: - type: object - additionalProperties: {} - title: overige data - required: - - overigeData - ObjectPand: - type: object - properties: - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - required: - - identificatie - ObjectSpoorbaandeel: - type: object - properties: - type: - allOf: - - $ref: '#/components/schemas/ObjectSpoorbaandeelTypeEnum' - description: 'Specificatie van het soort Spoorbaan - - - Uitleg bij mogelijke waarden: - - - * `breedspoor` - breedspoor - - * `normaalspoor` - normaalspoor - - * `smalspoor` - smalspoor - - * `spoorbaan` - spoorbaan' - title: type - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - naam: - type: string - description: De benaming van het OBJECT - title: naam - maxLength: 500 - required: - - identificatie - - type - ObjectSpoorbaandeelTypeEnum: - enum: - - breedspoor - - normaalspoor - - smalspoor - - spoorbaan - type: string - ObjectTerreinGebouwdObject: - type: object - properties: - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - adresAanduidingGrp: - allOf: - - $ref: '#/components/schemas/TerreinGebouwdObjectAdres' - nullable: true - title: adresAanduidingGrp - required: - - identificatie - ObjectTerreindeel: - type: object - properties: - type: - type: string - title: type - maxLength: 40 - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - naam: - type: string - description: De benaming van het OBJECT - title: naam - maxLength: 500 - required: - - identificatie - - type - ObjectTypeEnum: - enum: - - adres - - besluit - - buurt - - enkelvoudig_document - - gemeente - - gemeentelijke_openbare_ruimte - - huishouden - - inrichtingselement - - kadastrale_onroerende_zaak - - kunstwerkdeel - - maatschappelijke_activiteit - - medewerker - - natuurlijk_persoon - - niet_natuurlijk_persoon - - openbare_ruimte - - organisatorische_eenheid - - pand - - spoorbaandeel - - status - - terreindeel - - terrein_gebouwd_object - - vestiging - - waterdeel - - wegdeel - - wijk - - woonplaats - - woz_deelobject - - woz_object - - woz_waarde - - zakelijk_recht - - overige - type: string - ObjectTypeOverigeDefinitie: - type: object - properties: - url: - type: string - format: uri - title: Objecttype-URL - description: - URL-referentie naar de objecttype resource in een API. Deze - resource moet de [JSON-schema](https://json-schema.org/)-definitie van - het objecttype bevatten. - maxLength: 1000 - schema: - type: string - title: schema-pad - description: - 'Een geldige [jq](http://stedolan.github.io/jq/) expressie. - Dit wordt gecombineerd met de resource uit het `url`-attribuut om het - schema van het objecttype uit te lezen. Bijvoorbeeld: `.jsonSchema`.' - maxLength: 100 - objectData: - type: string - title: objectgegevens-pad - description: - 'Een geldige [jq](http://stedolan.github.io/jq/) expressie. - Dit wordt gecombineerd met de JSON data uit de OBJECT url om de objectgegevens - uit te lezen en de vorm van de gegevens tegen het schema te valideren. - Bijvoorbeeld: `.record.data`.' - maxLength: 100 - required: - - objectData - - schema - - url - ObjectWaterdeel: - type: object - properties: - typeWaterdeel: - allOf: - - $ref: '#/components/schemas/TypeWaterdeelEnum' - description: 'Specificatie van het soort water - - - Uitleg bij mogelijke waarden: - - - * `zee` - Zee - - * `waterloop` - Waterloop - - * `watervlakte` - Watervlakte - - * `greppel_droge_sloot` - Greppel, droge sloot' - title: type waterdeel - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - naam: - type: string - description: De benaming van het OBJECT - title: naam - maxLength: 500 - required: - - identificatie - - typeWaterdeel - ObjectWegdeel: - type: object - properties: - type: - type: string - title: type - maxLength: 100 - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - naam: - type: string - description: De benaming van het OBJECT - title: naam - maxLength: 500 - required: - - identificatie - - type - ObjectWijk: - type: object - properties: - wijkCode: - type: string - description: De code behorende bij de naam van de wijk. - title: wijk code - maxLength: 2 - wijkNaam: - type: string - description: De naam van de wijk, zoals die door het CBS wordt gebruikt. - title: wijk naam - maxLength: 40 - gemGemeenteCode: - type: string - description: - Een numerieke aanduiding waarmee een Nederlandse gemeente uniek - wordt aangeduid - title: gem gemeente code - maxLength: 4 - required: - - gemGemeenteCode - - wijkCode - - wijkNaam - ObjectWoonplaats: - type: object - properties: - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - woonplaatsNaam: - type: string - description: - De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS - toegekende benaming. - title: woonplaats naam - maxLength: 80 - required: - - identificatie - - woonplaatsNaam - ObjectWozDeelobject: - type: object - properties: - nummerWozDeelObject: - type: string - description: Uniek identificatienummer voor het deelobject binnen een WOZ-object. - title: nummer woz deel object - maxLength: 6 - isOnderdeelVan: - allOf: - - $ref: '#/components/schemas/ObjectWozObject' - title: isOnderdeelVan - required: - - nummerWozDeelObject - ObjectWozObject: - type: object - properties: - wozObjectNummer: - type: string - description: De unieke identificatie van het OBJECT - title: woz object nummer - maxLength: 100 - aanduidingWozObject: - allOf: - - $ref: '#/components/schemas/WozObjectAdres' - nullable: true - title: aanduidingWozObject - required: - - wozObjectNummer - ObjectWozWaarde: - type: object - properties: - waardepeildatum: - type: string - description: De datum waarnaar de waarde van het WOZ-object wordt bepaald. - title: waardepeildatum - maxLength: 9 - isVoor: - allOf: - - $ref: '#/components/schemas/ObjectWozObject' - title: isVoor - required: - - waardepeildatum - ObjectZakelijkRecht: - type: object - properties: - identificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - avgAard: - type: string - description: aanduiding voor de aard van het recht - title: avg aard - maxLength: 1000 - heeftBetrekkingOp: - allOf: - - $ref: '#/components/schemas/ObjectKadastraleOnroerendeZaak' - title: heeftBetrekkingOp - heeftAlsGerechtigde: - allOf: - - $ref: '#/components/schemas/ZakelijkRechtHeeftAlsGerechtigde' - title: heeftAlsGerechtigde - required: - - avgAard - - identificatie - Opschorting: - type: object - description: - Gegevens omtrent het tijdelijk opschorten van de behandeling van - de ZAAK - properties: - indicatie: - type: boolean - description: Aanduiding of de behandeling van de ZAAK tijdelijk is opgeschort. - title: indicatie opschorting - reden: - type: string - description: - Omschrijving van de reden voor het opschorten van de behandeling - van de zaak. - title: reden opschorting - maxLength: 200 - required: - - indicatie - - reden - nullable: true - PaginatedKlantContactList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/KlantContact' - PaginatedResultaatList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Resultaat' - PaginatedRolList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Rol' - PaginatedStatusList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/Status' - PaginatedZaakList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/ZaakExpanded' - PaginatedZaakObjectList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/ZaakObject' - PatchedResultaat: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - resultaattype: - type: string - format: uri - description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API). - title: resultaattype - maxLength: 1000 - toelichting: - type: string - description: Een toelichting op wat het resultaat van de zaak inhoudt. - title: toelichting - maxLength: 1000 - PatchedZaak: - type: object - description: 'Set gegevensgroepdata from validated nested data. - - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - identificatie: - type: string - description: - De unieke identificatie van de ZAAK binnen de organisatie die - verantwoordelijk is voor de behandeling van de ZAAK. - title: identificatie - maxLength: 40 - bronorganisatie: - type: string - description: - Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers - en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef - title: bronorganisatie - maxLength: 9 - omschrijving: - type: string - description: Een korte omschrijving van de zaak. - title: omschrijving - maxLength: 80 - toelichting: - type: string - description: Een toelichting op de zaak. - title: toelichting - maxLength: 1000 - zaaktype: - type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de - CATALOGUS waar deze voorkomt - title: zaaktype - maxLength: 1000 - registratiedatum: - type: string - format: date - description: - De datum waarop de zaakbehandelende organisatie de ZAAK heeft - geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag - gebruikt. - title: registratiedatum - verantwoordelijkeOrganisatie: - type: string - description: - Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die eindverantwoordelijk is voor de behandeling van de zaak. Dit moet - een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef - title: verantwoordelijke organisatie - maxLength: 9 - startdatum: - type: string - format: date - description: De datum waarop met de uitvoering van de zaak is gestart - title: startdatum - einddatum: - type: string - format: date - readOnly: true - nullable: true - description: De datum waarop de uitvoering van de zaak afgerond is. - title: einddatum - einddatumGepland: - type: string - format: date - nullable: true - description: - De datum waarop volgens de planning verwacht wordt dat de zaak - afgerond wordt. - title: einddatum gepland - uiterlijkeEinddatumAfdoening: - type: string - format: date - nullable: true - description: - De laatste datum waarop volgens wet- en regelgeving de zaak - afgerond dient te zijn. - title: uiterlijke einddatum afdoening - publicatiedatum: - type: string - format: date - nullable: true - description: Datum waarop (het starten van) de zaak gepubliceerd is of wordt. - title: publicatiedatum - communicatiekanaal: - type: string - format: uri - description: - Het medium waarlangs de aanleiding om een zaak te starten is - ontvangen. URL naar een communicatiekanaal in de VNG-Referentielijst van - communicatiekanalen. - title: communicatiekanaal - maxLength: 1000 - productenOfDiensten: - type: array - items: - type: string - format: uri - title: URL naar product/dienst - maxLength: 1000 - description: - De producten en/of diensten die door de zaak worden voortgebracht. - Dit zijn URLs naar de resources zoals die door de producten- en dienstencatalogus-API - wordt ontsloten. De producten/diensten moeten bij het zaaktype vermeld - zijn. - title: producten of diensten - vertrouwelijkheidaanduiding: - allOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - title: Vertrouwlijkheidaanduiding - description: - Aanduiding van de mate waarin het zaakdossier van de ZAAK voor - de openbaarheid bestemd is. Optioneel - indien geen waarde gekozen wordt, - dan wordt de waarde van het ZAAKTYPE overgenomen. Dit betekent dat de - API _altijd_ een waarde teruggeeft. - betalingsindicatie: - description: - 'Indicatie of de, met behandeling van de zaak gemoeide, kosten - betaald zijn door de desbetreffende betrokkene. - - - Uitleg bij mogelijke waarden: - - - * `nvt` - Er is geen sprake van te betalen, met de zaak gemoeide, kosten. - - * `nog_niet` - De met de zaak gemoeide kosten zijn (nog) niet betaald. - - * `gedeeltelijk` - De met de zaak gemoeide kosten zijn gedeeltelijk betaald. - - * `geheel` - De met de zaak gemoeide kosten zijn geheel betaald.' - title: betalingsindicatie - oneOf: - - $ref: '#/components/schemas/BetalingsindicatieEnum' - - $ref: '#/components/schemas/BlankEnum' - betalingsindicatieWeergave: - type: string - readOnly: true - description: Uitleg bij `betalingsindicatie`. - title: betalingsindicatieWeergave - laatsteBetaaldatum: - type: string - format: date-time - nullable: true - description: - De datum waarop de meest recente betaling is verwerkt van kosten - die gemoeid zijn met behandeling van de zaak. - title: laatste betaaldatum - zaakgeometrie: - allOf: - - $ref: '#/components/schemas/GeoJSONGeometry' - nullable: true - description: Punt, lijn of (multi-)vlak geometrie-informatie, in GeoJSON. - title: zaakgeometrie - verlenging: - allOf: - - $ref: '#/components/schemas/Verlenging' - nullable: true - description: - Gegevens omtrent het verlengen van de doorlooptijd van de behandeling - van de ZAAK - title: verlenging - opschorting: - allOf: - - $ref: '#/components/schemas/Opschorting' - nullable: true - description: - Gegevens omtrent het tijdelijk opschorten van de behandeling - van de ZAAK - title: opschorting - selectielijstklasse: - type: string - format: uri - description: - URL-referentie naar de categorie in de gehanteerde 'Selectielijst - Archiefbescheiden' die, gezien het zaaktype en het resultaattype van de - zaak, bepalend is voor het archiefregime van de zaak. - title: selectielijstklasse - maxLength: 1000 - hoofdzaak: - type: string - format: uri - nullable: true - title: Is deelzaak van - description: - "URL-referentie naar de ZAAK, waarom verzocht is door de initiator\ - \ daarvan, die behandeld wordt in twee of meer separate ZAAKen waarvan\ - \ de onderhavige ZAAK er \xE9\xE9n is." - minLength: 1 - maxLength: 1000 - deelzaken: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: URL-referenties naar deel ZAAKen. - title: is deelzaak van - uniqueItems: true - relevanteAndereZaken: - type: array - items: - $ref: '#/components/schemas/RelevanteZaak' - description: Een lijst van relevante andere zaken. - title: zaak - eigenschappen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: zaak - uniqueItems: true - rollen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: zaak - uniqueItems: true - status: - type: string - format: uri - readOnly: true - nullable: true - description: Indien geen status bekend is, dan is de waarde 'null' - title: status - zaakinformatieobjecten: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: zaak - uniqueItems: true - zaakobjecten: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: zaak - uniqueItems: true - kenmerken: - type: array - items: - $ref: '#/components/schemas/ZaakKenmerk' - description: - Lijst van kenmerken. Merk op dat refereren naar gerelateerde - objecten beter kan via `ZaakObject`. - title: zaak - archiefnominatie: - nullable: true - description: - 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - - - Uitleg bij mogelijke waarden: - - - * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum - overgedragen worden naar een archiefbewaarplaats. - - * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd - worden.' - title: archiefnominatie - oneOf: - - $ref: '#/components/schemas/ArchiefnominatieEnum' - - $ref: '#/components/schemas/BlankEnum' - - $ref: '#/components/schemas/NullEnum' - archiefstatus: - allOf: - - $ref: '#/components/schemas/ArchiefstatusEnum' - description: - 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - - - Uitleg bij mogelijke waarden: - - - * `nog_te_archiveren` - De zaak cq. het zaakdossier is nog niet als geheel - gearchiveerd. - - * `gearchiveerd` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar - bewaarbaar gemaakt. - - * `gearchiveerd_procestermijn_onbekend` - De zaak cq. het zaakdossier - is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum - kan nog niet bepaald worden. - - * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een - archiefbewaarplaats.' - title: archiefstatus - archiefactiedatum: - type: string - format: date - nullable: true - description: - De datum waarop het gearchiveerde zaakdossier vernietigd moet - worden dan wel overgebracht moet worden naar een archiefbewaarplaats. - Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT - aan deze ZAAK indien nog leeg. - title: archiefactiedatum - resultaat: - type: string - format: uri - readOnly: true - nullable: true - description: - URL-referentie naar het RESULTAAT. Indien geen resultaat bekend - is, dan is de waarde 'null' - title: resultaat - opdrachtgevendeOrganisatie: - type: string - description: - De krachtens publiekrecht ingestelde rechtspersoon dan wel - ander niet-natuurlijk persoon waarbinnen het (bestuurs)orgaan zetelt dat - opdracht heeft gegeven om taken uit te voeren waaraan de zaak invulling - geeft. - title: opdrachtgevende organisatie - maxLength: 9 - processobjectaard: - type: string - nullable: true - title: Procesobjectaard - description: - Omschrijving van het object, subject of gebeurtenis waarop, - vanuit archiveringsoptiek, de zaak betrekking heeft. - maxLength: 200 - startdatumBewaartermijn: - type: string - format: date - nullable: true - description: - De datum die de start markeert van de termijn waarop het zaakdossier - vernietigd moet worden. - title: startdatum bewaartermijn - processobject: - allOf: - - $ref: '#/components/schemas/Processobject' - nullable: true - description: - Specificatie van de attribuutsoort van het object, subject - of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking - heeft en dat bepalend is voor de start van de archiefactietermijn. - title: processobject - PatchedZaakEigenschap: - type: object - description: - "A type of `ModelSerializer` that uses hyperlinked relationships - with compound keys instead - - of primary key relationships. Specifically: - - - * A 'url' field is included instead of the 'id' field. - - * Relationships to other instances are hyperlinks, instead of primary keys. - - - NOTE: this only works with DRF 3.1.0 and above." - properties: - url: - type: string - format: uri - readOnly: true - title: url - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - title: zaak - eigenschap: - type: string - format: uri - description: URL-referentie naar de EIGENSCHAP (in de Catalogi API). - title: eigenschap - maxLength: 1000 - naam: - type: string - readOnly: true - description: De naam van de EIGENSCHAP (overgenomen uit de Catalogi API). - title: ' naam' - waarde: - type: string - title: waarde - PatchedZaakInformatieObject: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - informatieobject: - type: string - format: uri - description: - URL-referentie naar het INFORMATIEOBJECT (in de Documenten - API), waar ook de relatieinformatie opgevraagd kan worden. - title: informatieobject - maxLength: 1000 - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - aardRelatieWeergave: - allOf: - - $ref: '#/components/schemas/AardRelatieWeergaveEnum' - readOnly: true - title: aardRelatieWeergave - titel: - type: string - description: - De naam waaronder het INFORMATIEOBJECT binnen het OBJECT bekend - is. - title: titel - maxLength: 200 - beschrijving: - type: string - description: - Een op het object gerichte beschrijving van de inhoud vanhet - INFORMATIEOBJECT. - title: beschrijving - registratiedatum: - type: string - format: date-time - readOnly: true - description: - De datum waarop de behandelende organisatie het INFORMATIEOBJECT - heeft geregistreerd bij het OBJECT. Geldige waardes zijn datumtijden gelegen - op of voor de huidige datum en tijd. - title: registratiedatum - vernietigingsdatum: - type: string - format: date-time - nullable: true - description: - De datum waarop het informatieobject uit het zaakdossier verwijderd - moet worden. - title: vernietigingsdatum - status: - type: string - format: uri - nullable: true - description: - De bij de desbetreffende ZAAK behorende STATUS waarvoor het - ZAAK-INFORMATIEOBJECT relevant is (geweest) met het oog op het bereiken - van die STATUS en/of de communicatie daarover. - title: status - minLength: 1 - maxLength: 1000 - PatchedZaakObject: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - object: - type: string - format: uri - description: URL-referentie naar de resource die het OBJECT beschrijft. - title: object - maxLength: 1000 - zaakobjecttype: - type: string - format: uri - description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API). - title: zaakobjecttype - maxLength: 1000 - objectType: - allOf: - - $ref: '#/components/schemas/ObjectTypeEnum' - description: - 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er - geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. - - - Uitleg bij mogelijke waarden: - - - * `adres` - Adres - - * `besluit` - Besluit - - * `buurt` - Buurt - - * `enkelvoudig_document` - Enkelvoudig document - - * `gemeente` - Gemeente - - * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte - - * `huishouden` - Huishouden - - * `inrichtingselement` - Inrichtingselement - - * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak - - * `kunstwerkdeel` - Kunstwerkdeel - - * `maatschappelijke_activiteit` - Maatschappelijke activiteit - - * `medewerker` - Medewerker - - * `natuurlijk_persoon` - Natuurlijk persoon - - * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon - - * `openbare_ruimte` - Openbare ruimte - - * `organisatorische_eenheid` - Organisatorische eenheid - - * `pand` - Pand - - * `spoorbaandeel` - Spoorbaandeel - - * `status` - Status - - * `terreindeel` - Terreindeel - - * `terrein_gebouwd_object` - Terrein gebouwd object - - * `vestiging` - Vestiging - - * `waterdeel` - Waterdeel - - * `wegdeel` - Wegdeel - - * `wijk` - Wijk - - * `woonplaats` - Woonplaats - - * `woz_deelobject` - Woz deel object - - * `woz_object` - Woz object - - * `woz_waarde` - Woz waarde - - * `zakelijk_recht` - Zakelijk recht - - * `overige` - Overige' - title: object type - objectTypeOverige: - type: string - description: - Beschrijft het type OBJECT als `objectType` de waarde "overige" - heeft. - title: object type overige - pattern: '[a-z\_]+' - maxLength: 100 - objectTypeOverigeDefinitie: - allOf: - - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie' - nullable: true - title: definitie object type overige - description: - 'Verwijzing naar het schema van het type OBJECT als `objectType` - de waarde "overige" heeft. - - - * De URL referentie moet naar een JSON endpoint wijzen waarin het objecttype - gedefinieerd is, inclusief het [JSON-schema](https://json-schema.org/). - - * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen de - objecttype resource (deze gebruikt het [jq](http://stedolan.github.io/jq/) - formaat. - - * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens binnen - het OBJECT. Deze gebruikt ook het [jq](http://stedolan.github.io/jq/) - formaat. - - - Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven - en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven - OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.' - relatieomschrijving: - type: string - description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. - title: relatieomschrijving - maxLength: 80 - discriminator: - propertyName: objectType - mapping: - adres: '#/components/schemas/adres_PatchedZaakObject' - besluit: '#/components/schemas/besluit_PatchedZaakObject' - buurt: '#/components/schemas/buurt_PatchedZaakObject' - enkelvoudig_document: '#/components/schemas/enkelvoudig_document_PatchedZaakObject' - gemeente: '#/components/schemas/gemeente_PatchedZaakObject' - gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_PatchedZaakObject' - huishouden: '#/components/schemas/huishouden_PatchedZaakObject' - inrichtingselement: '#/components/schemas/inrichtingselement_PatchedZaakObject' - kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_PatchedZaakObject' - kunstwerkdeel: '#/components/schemas/kunstwerkdeel_PatchedZaakObject' - maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_PatchedZaakObject' - medewerker: '#/components/schemas/medewerker_PatchedZaakObject' - natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_PatchedZaakObject' - niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_PatchedZaakObject' - openbare_ruimte: '#/components/schemas/openbare_ruimte_PatchedZaakObject' - organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_PatchedZaakObject' - pand: '#/components/schemas/pand_PatchedZaakObject' - spoorbaandeel: '#/components/schemas/spoorbaandeel_PatchedZaakObject' - status: '#/components/schemas/status_PatchedZaakObject' - terreindeel: '#/components/schemas/terreindeel_PatchedZaakObject' - terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_PatchedZaakObject' - vestiging: '#/components/schemas/vestiging_PatchedZaakObject' - waterdeel: '#/components/schemas/waterdeel_PatchedZaakObject' - wegdeel: '#/components/schemas/wegdeel_PatchedZaakObject' - wijk: '#/components/schemas/wijk_PatchedZaakObject' - woonplaats: '#/components/schemas/woonplaats_PatchedZaakObject' - woz_deelobject: '#/components/schemas/woz_deelobject_PatchedZaakObject' - woz_object: '#/components/schemas/woz_object_PatchedZaakObject' - woz_waarde: '#/components/schemas/woz_waarde_PatchedZaakObject' - zakelijk_recht: '#/components/schemas/zakelijk_recht_PatchedZaakObject' - overige: '#/components/schemas/overige_PatchedZaakObject' - Point: - title: Point - description: GeoJSON point geometry - type: object - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.2 - allOf: - - $ref: '#/components/schemas/Geometry' - - type: object - required: - - coordinates - properties: - coordinates: - $ref: '#/components/schemas/Point2D' - Point2D: - title: Point2D - type: array - items: - type: number - maxItems: 2 - minItems: 2 - Polygon: - title: Polygon - description: GeoJSON polygon geometry - type: object - externalDocs: - url: https://tools.ietf.org/html/rfc7946#section-3.1.6 - allOf: - - $ref: '#/components/schemas/Geometry' - - type: object - required: - - coordinates - properties: - coordinates: - type: array - items: - type: array - items: - $ref: '#/components/schemas/Point2D' - Processobject: - type: object - description: - Specificatie van de attribuutsoort van het object, subject of gebeurtenis waarop, - vanuit archiveringsoptiek, de zaak betrekking heeft en dat bepalend is voor - de start van de archiefactietermijn. - properties: - datumkenmerk: - type: string - description: - De naam van de attribuutsoort van het procesobject dat bepalend - is voor het einde van de procestermijn. - title: datumkenmerk - maxLength: 250 - identificatie: - type: string - description: De unieke aanduiding van het procesobject. - title: identificatie - maxLength: 250 - objecttype: - type: string - description: Het soort object dat het procesobject representeert. - title: objecttype - maxLength: 250 - registratie: - type: string - description: - De naam van de registratie waarvan het procesobject deel uit - maakt. - title: registratie - maxLength: 250 - required: - - datumkenmerk - - identificatie - - objecttype - - registratie - nullable: true - RelevanteZaak: - type: object - properties: - url: - type: string - format: uri - title: URL-referentie naar de ZAAK. - maxLength: 1000 - aardRelatie: - allOf: - - $ref: '#/components/schemas/AardRelatieEnum' - description: - 'Benamingen van de aard van de relaties van andere zaken tot - (onderhanden) zaken. - - - Uitleg bij mogelijke waarden: - - - * `vervolg` - De andere zaak gaf aanleiding tot het starten van de onderhanden - zaak. - - * `onderwerp` - De andere zaak is relevant voor cq. is onderwerp van de - onderhanden zaak. - - * `bijdrage` - Aan het bereiken van de uitkomst van de andere zaak levert - de onderhanden zaak een bijdrage.' - title: aard relatie - required: - - aardRelatie - - url - Resultaat: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - resultaattype: - type: string - format: uri - description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API). - title: resultaattype - maxLength: 1000 - toelichting: - type: string - description: Een toelichting op wat het resultaat van de zaak inhoudt. - title: toelichting - maxLength: 1000 - required: - - resultaattype - - url - - uuid - - zaak - ResultaatExpanded: - allOf: - - $ref: '#/components/schemas/Resultaat' - - properties: - _expand: - $ref: '#/components/schemas/ResultaatEmbedded' - ResultaatEmbedded: - type: object - properties: - zaak: - $ref: '#/components/schemas/ZaakExpanded' - resultaattype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ResultaatTypeExpanded' - Rol: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - betrokkene: - type: string - format: uri - description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. - title: betrokkene - maxLength: 1000 - betrokkeneType: - allOf: - - $ref: '#/components/schemas/BetrokkeneTypeEnum' - description: 'Type van de `betrokkene`. - - - Uitleg bij mogelijke waarden: - - - * `natuurlijk_persoon` - Natuurlijk persoon - - * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon - - * `vestiging` - Vestiging - - * `organisatorische_eenheid` - Organisatorische eenheid - - * `medewerker` - Medewerker' - title: betrokkene type - afwijkendeNaamBetrokkene: - type: string - description: - De naam van de betrokkene waaronder deze in relatie tot de - zaak aangesproken wil worden. - title: afwijkende naam betrokkene - maxLength: 625 - roltype: - type: string - format: uri - description: - URL-referentie naar een roltype binnen het ZAAKTYPE van de - ZAAK. - title: roltype - maxLength: 1000 - omschrijving: - type: string - readOnly: true - description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. - title: omschrijving - omschrijvingGeneriek: - type: string - readOnly: true - description: - "Algemeen gehanteerde benaming van de aard van de ROL, afgeleid\ - \ uit het ROLTYPE.\n\nUitleg bij mogelijke waarden:\n\n* `adviseur` -\ - \ (Adviseur) Kennis in dienst stellen van de behandeling van (een deel\ - \ van) een zaak.\n* `behandelaar` - (Behandelaar) De vakinhoudelijke behandeling\ - \ doen van (een deel van) een zaak.\n* `belanghebbende` - (Belanghebbende)\ - \ Vanuit eigen en objectief belang rechtstreeks betrokken zijn bij de\ - \ behandeling en/of de uitkomst van een zaak.\n* `beslisser` - (Beslisser)\ - \ Nemen van besluiten die voor de uitkomst van een zaak noodzakelijk zijn.\n\ - * `initiator` - (Initiator) Aanleiding geven tot de start van een zaak\ - \ ..\n* `klantcontacter` - (Klantcontacter) Het eerste aanspreekpunt zijn\ - \ voor vragen van burgers en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6\ - rdinator) Er voor zorg dragen dat de behandeling van de zaak in samenhang\ - \ uitgevoerd wordt conform de daarover gemaakte afspraken.\n* `mede_initiator`\ - \ - Mede-initiator" - title: omschrijving generiek - roltoelichting: - type: string - title: roltoelichting - maxLength: 1000 - registratiedatum: - type: string - format: date-time - readOnly: true - description: De datum waarop dit object is geregistreerd. - title: registratiedatum - indicatieMachtiging: - description: 'Indicatie machtiging - - - Uitleg bij mogelijke waarden: - - - * `gemachtigde` - De betrokkene in de rol bij de zaak is door een andere - betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen - - * `machtiginggever` - De betrokkene in de rol bij de zaak heeft een andere - betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen' - title: indicatie machtiging - oneOf: - - $ref: '#/components/schemas/IndicatieMachtigingEnum' - - $ref: '#/components/schemas/BlankEnum' - contactpersoonRol: - allOf: - - $ref: '#/components/schemas/ContactPersoonRol' - nullable: true - description: - De gegevens van de persoon die anderen desgevraagd in contact - brengt met medewerkers van de BETROKKENE, een NIET-NATUURLIJK PERSOON - of VESTIGING zijnde, of met BETROKKENE zelf, een NATUURLIJK PERSOON zijnde - , vanuit het belang van BETROKKENE in haar ROL bij een ZAAK. - title: contactpersoonRol - statussen: - type: array - items: - type: string - format: uri - title: '' - minLength: 1 - maxLength: 1000 - readOnly: true - description: - De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd - dat STATUSsen in die ZAAK bereikt zijn. - title: statussen - uniqueItems: true - required: - - betrokkeneType - - omschrijving - - omschrijvingGeneriek - - registratiedatum - - roltoelichting - - roltype - - statussen - - url - - uuid - - zaak - discriminator: - propertyName: betrokkeneType - mapping: - medewerker: '#/components/schemas/medewerker_Rol' - natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_Rol' - niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_Rol' - organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_Rol' - vestiging: '#/components/schemas/vestiging_Rol' - RolExpanded: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - betrokkene: - type: string - format: uri - description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. - title: betrokkene - maxLength: 1000 - betrokkeneType: - allOf: - - $ref: '#/components/schemas/BetrokkeneTypeEnum' - description: 'Type van de `betrokkene`. - - - Uitleg bij mogelijke waarden: - - - * `natuurlijk_persoon` - Natuurlijk persoon - - * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon - - * `vestiging` - Vestiging - - * `organisatorische_eenheid` - Organisatorische eenheid - - * `medewerker` - Medewerker' - title: betrokkene type - afwijkendeNaamBetrokkene: - type: string - description: - De naam van de betrokkene waaronder deze in relatie tot de - zaak aangesproken wil worden. - title: afwijkende naam betrokkene - maxLength: 625 - roltype: - type: string - format: uri - description: - URL-referentie naar een roltype binnen het ZAAKTYPE van de - ZAAK. - title: roltype - maxLength: 1000 - omschrijving: - type: string - readOnly: true - description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. - title: omschrijving - omschrijvingGeneriek: - type: string - readOnly: true - description: - "Algemeen gehanteerde benaming van de aard van de ROL, afgeleid\ - \ uit het ROLTYPE.\n\nUitleg bij mogelijke waarden:\n\n* `adviseur` -\ - \ (Adviseur) Kennis in dienst stellen van de behandeling van (een deel\ - \ van) een zaak.\n* `behandelaar` - (Behandelaar) De vakinhoudelijke behandeling\ - \ doen van (een deel van) een zaak.\n* `belanghebbende` - (Belanghebbende)\ - \ Vanuit eigen en objectief belang rechtstreeks betrokken zijn bij de\ - \ behandeling en/of de uitkomst van een zaak.\n* `beslisser` - (Beslisser)\ - \ Nemen van besluiten die voor de uitkomst van een zaak noodzakelijk zijn.\n\ - * `initiator` - (Initiator) Aanleiding geven tot de start van een zaak\ - \ ..\n* `klantcontacter` - (Klantcontacter) Het eerste aanspreekpunt zijn\ - \ voor vragen van burgers en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6\ - rdinator) Er voor zorg dragen dat de behandeling van de zaak in samenhang\ - \ uitgevoerd wordt conform de daarover gemaakte afspraken.\n* `mede_initiator`\ - \ - Mede-initiator" - title: omschrijving generiek - roltoelichting: - type: string - title: roltoelichting - maxLength: 1000 - registratiedatum: - type: string - format: date-time - readOnly: true - description: De datum waarop dit object is geregistreerd. - title: registratiedatum - indicatieMachtiging: - description: 'Indicatie machtiging - - - Uitleg bij mogelijke waarden: - - - * `gemachtigde` - De betrokkene in de rol bij de zaak is door een andere - betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen - - * `machtiginggever` - De betrokkene in de rol bij de zaak heeft een andere - betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen' - title: indicatie machtiging - oneOf: - - $ref: '#/components/schemas/IndicatieMachtigingEnum' - - $ref: '#/components/schemas/BlankEnum' - contactpersoonRol: - allOf: - - $ref: '#/components/schemas/ContactPersoonRol' - nullable: true - description: - De gegevens van de persoon die anderen desgevraagd in contact - brengt met medewerkers van de BETROKKENE, een NIET-NATUURLIJK PERSOON - of VESTIGING zijnde, of met BETROKKENE zelf, een NATUURLIJK PERSOON zijnde - , vanuit het belang van BETROKKENE in haar ROL bij een ZAAK. - title: contactpersoonRol - statussen: - type: array - items: - type: string - format: uri - title: '' - minLength: 1 - maxLength: 1000 - readOnly: true - description: - De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd - dat STATUSsen in die ZAAK bereikt zijn. - title: statussen - uniqueItems: true - _expand: - $ref: '#/components/schemas/RolEmbedded' - required: - - betrokkeneType - - omschrijving - - omschrijvingGeneriek - - registratiedatum - - roltoelichting - - roltype - - statussen - - url - - uuid - - zaak - discriminator: - propertyName: betrokkeneType - mapping: - medewerker: '#/components/schemas/medewerker_RolExpanded' - natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_RolExpanded' - niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_RolExpanded' - organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_RolExpanded' - vestiging: '#/components/schemas/vestiging_RolExpanded' - - RolEmbedded: - type: object - properties: - zaak: - $ref: '#/components/schemas/ZaakExpanded' - example: {} - roltype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/RolTypeExpanded' - statussen: - type: array - items: - $ref: '#/components/schemas/StatusExpanded' - RolMedewerker: - type: object - properties: - identificatie: - type: string - description: Een korte unieke aanduiding van de MEDEWERKER. - title: identificatie - maxLength: 24 - achternaam: - type: string - description: - De achternaam zoals de MEDEWERKER die in het dagelijkse verkeer - gebruikt. - title: achternaam - maxLength: 200 - voorletters: - type: string - description: - De verzameling letters die gevormd wordt door de eerste letter - van alle in volgorde voorkomende voornamen. - title: voorletters - maxLength: 20 - voorvoegselAchternaam: - type: string - description: - Dat deel van de geslachtsnaam dat voorkomt in Tabel 36 (GBA), - voorvoegseltabel, en door een spatie van de geslachtsnaam is - title: voorvoegsel achternaam - maxLength: 10 - RolNatuurlijkPersoon: - type: object - properties: - inpBsn: - type: string - description: - Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet - algemene bepalingen burgerservicenummer. - title: inp bsn - maxLength: 9 - anpIdentificatie: - type: string - description: - Het door de gemeente uitgegeven unieke nummer voor een ANDER - NATUURLIJK PERSOON - title: anp identificatie - maxLength: 17 - inpA_nummer: - type: string - description: Het administratienummer van de persoon, bedoeld in de Wet BRP - title: inp a nummer - pattern: ^[1-9][0-9]{9}$ - maxLength: 10 - geslachtsnaam: - type: string - description: De stam van de geslachtsnaam. - title: geslachtsnaam - maxLength: 200 - voorvoegselGeslachtsnaam: - type: string - title: voorvoegsel geslachtsnaam - maxLength: 80 - voorletters: - type: string - description: - De verzameling letters die gevormd wordt door de eerste letter - van alle in volgorde voorkomende voornamen. - title: voorletters - maxLength: 20 - voornamen: - type: string - description: Voornamen bij de naam die de persoon wenst te voeren. - title: voornamen - maxLength: 200 - geslachtsaanduiding: - description: - 'Een aanduiding die aangeeft of de persoon een man of een vrouw - is, of dat het geslacht nog onbekend is. - - - Uitleg bij mogelijke waarden: - - - * `m` - Man - - * `v` - Vrouw - - * `o` - Onbekend' - title: geslachtsaanduiding - oneOf: - - $ref: '#/components/schemas/GeslachtsaanduidingEnum' - - $ref: '#/components/schemas/BlankEnum' - geboortedatum: - type: string - title: geboortedatum - maxLength: 18 - verblijfsadres: - allOf: - - $ref: '#/components/schemas/VerblijfsAdres' - nullable: true - title: verblijfsadres - subVerblijfBuitenland: - allOf: - - $ref: '#/components/schemas/SubVerblijfBuitenland' - nullable: true - title: subVerblijfBuitenland - RolNietNatuurlijkPersoon: - type: object - properties: - innNnpId: - type: string - description: - Het door een kamer toegekend uniek nummer voor de INGESCHREVEN - NIET-NATUURLIJK PERSOON - title: inn nnp id - maxLength: 9 - annIdentificatie: - type: string - description: - Het door de gemeente uitgegeven unieke nummer voor een ANDER - NIET-NATUURLIJK PERSOON - title: ann identificatie - maxLength: 17 - statutaireNaam: - type: string - description: - Naam van de niet-natuurlijke persoon zoals deze is vastgelegd - in de statuten (rechtspersoon) of in de vennootschapsovereenkomst is overeengekomen - (Vennootschap onder firma of Commanditaire vennootschap). - title: statutaire naam - maxLength: 500 - innRechtsvorm: - description: De juridische vorm van de NIET-NATUURLIJK PERSOON. - title: inn rechtsvorm - oneOf: - - $ref: '#/components/schemas/InnRechtsvormEnum' - - $ref: '#/components/schemas/BlankEnum' - bezoekadres: - type: string - description: De gegevens over het adres van de NIET-NATUURLIJK PERSOON - title: bezoekadres - maxLength: 1000 - subVerblijfBuitenland: - allOf: - - $ref: '#/components/schemas/SubVerblijfBuitenland' - nullable: true - title: subVerblijfBuitenland - RolOrganisatorischeEenheid: - type: object - properties: - identificatie: - type: string - description: Een korte identificatie van de organisatorische eenheid. - title: identificatie - maxLength: 24 - naam: - type: string - description: De feitelijke naam van de organisatorische eenheid. - title: naam - maxLength: 50 - isGehuisvestIn: - type: string - title: is gehuisvest in - maxLength: 24 - RolVestiging: - type: object - properties: - vestigingsNummer: - type: string - description: Een korte unieke aanduiding van de Vestiging. - title: vestigings nummer - maxLength: 24 - handelsnaam: - type: array - items: - type: string - maxLength: 625 - description: De naam van de vestiging waaronder gehandeld wordt. - title: handelsnaam - verblijfsadres: - allOf: - - $ref: '#/components/schemas/VerblijfsAdres' - nullable: true - title: verblijfsadres - subVerblijfBuitenland: - allOf: - - $ref: '#/components/schemas/SubVerblijfBuitenland' - nullable: true - title: subVerblijfBuitenland - kvkNummer: - type: string - description: Een uniek nummer gekoppeld aan de onderneming. - title: kvk nummer - maxLength: 8 - Status: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - statustype: - type: string - format: uri - description: URL-referentie naar het STATUSTYPE (in de Catalogi API). - title: statustype - maxLength: 1000 - datumStatusGezet: - type: string - format: date-time - description: De datum waarop de ZAAK de status heeft verkregen. - title: datum status gezet - statustoelichting: - type: string - description: - Een, voor de initiator van de zaak relevante, toelichting op - de status van een zaak. - title: statustoelichting - maxLength: 1000 - indicatieLaatstGezetteStatus: - type: boolean - readOnly: true - description: - Het gegeven is afleidbaar uit de historie van de attribuutsoort - Datum status gezet van van alle statussen bij de desbetreffende zaak. - title: indicatieLaatstGezetteStatus - gezetdoor: - type: string - format: uri - title: Gezet door - description: - De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd - dat STATUSsen in die ZAAK bereikt zijn. - maxLength: 200 - zaakinformatieobjecten: - type: array - items: - type: string - format: uri - title: '' - minLength: 1 - maxLength: 1000 - readOnly: true - title: zaakInformatieobjecten - uniqueItems: true - required: - - datumStatusGezet - - indicatieLaatstGezetteStatus - - statustype - - url - - uuid - - zaak - - zaakinformatieobjecten - StatusExpanded: - allOf: - - $ref: '#/components/schemas/Status' - - properties: - _expand: - $ref: '#/components/schemas/StatusEmbedded' - StatusEmbedded: - type: object - properties: - statustype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/StatusTypeExpanded' - gezetdoor: - $ref: '#/components/schemas/Rol' - zaakinformatieobjecten: - type: array - items: - $ref: '#/components/schemas/ZaakInformatieObject' - StatusRequestbody: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - statustype: - type: string - format: uri - description: URL-referentie naar het STATUSTYPE (in de Catalogi API). - title: statustype - maxLength: 1000 - datumStatusGezet: - type: string - format: date-time - description: De datum waarop de ZAAK de status heeft verkregen. - title: datum status gezet - statustoelichting: - type: string - description: - Een, voor de initiator van de zaak relevante, toelichting op - de status van een zaak. - title: statustoelichting - maxLength: 1000 - indicatieLaatstGezetteStatus: - type: boolean - readOnly: true - description: - Het gegeven is afleidbaar uit de historie van de attribuutsoort - Datum status gezet van van alle statussen bij de desbetreffende zaak. - title: indicatieLaatstGezetteStatus - gezetdoor: - type: string - format: uri - title: Gezet door - description: - De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd - dat STATUSsen in die ZAAK bereikt zijn. - maxLength: 200 - required: - - datumStatusGezet - - indicatieLaatstGezetteStatus - - statustype - - url - - uuid - - zaak - - zaakinformatieobjecten - SubVerblijfBuitenland: - type: object - properties: - lndLandcode: - type: string - description: - De code, behorende bij de landnaam, zoals opgenomen in de Land/Gebied-tabel - van de BRP. - title: lnd landcode - maxLength: 4 - lndLandnaam: - type: string - description: - De naam van het land, zoals opgenomen in de Land/Gebied-tabel - van de BRP. - title: lnd landnaam - maxLength: 40 - subAdresBuitenland_1: - type: string - title: sub adres buitenland 1 - maxLength: 35 - subAdresBuitenland_2: - type: string - title: sub adres buitenland 2 - maxLength: 35 - subAdresBuitenland_3: - type: string - title: sub adres buitenland 3 - maxLength: 35 - required: - - lndLandcode - - lndLandnaam - TerreinGebouwdObjectAdres: - type: object - properties: - numIdentificatie: - type: string - title: num identificatie - maxLength: 100 - oaoIdentificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - wplWoonplaatsNaam: - type: string - title: wpl woonplaats naam - maxLength: 80 - gorOpenbareRuimteNaam: - type: string - description: - Een door het bevoegde gemeentelijke orgaan aan een OPENBARE - RUIMTE toegekende benaming - title: gor openbare ruimte naam - maxLength: 80 - aoaPostcode: - type: string - title: postcode - maxLength: 7 - aoaHuisnummer: - type: integer - maximum: 99999 - minimum: 0 - title: huisnummer - aoaHuisletter: - type: string - title: huisletter - maxLength: 1 - aoaHuisnummertoevoeging: - type: string - title: huisnummertoevoeging - maxLength: 4 - ogoLocatieAanduiding: - type: string - title: locatie aanduiding - maxLength: 100 - required: - - aoaHuisnummer - - gorOpenbareRuimteNaam - - oaoIdentificatie - - wplWoonplaatsNaam - TypeWaterdeelEnum: - enum: - - zee - - waterloop - - watervlakte - - greppel_droge_sloot - type: string - ValidatieFout: - type: object - description: Formaat van HTTP 4xx en 5xx fouten. - properties: - type: - type: string - description: URI referentie naar het type fout, bedoeld voor developers - title: type - code: - type: string - description: Systeemcode die het type fout aangeeft - title: code - title: - type: string - description: Generieke titel voor het type fout - title: title - status: - type: integer - description: De HTTP status code - title: status - detail: - type: string - description: Extra informatie bij de fout, indien beschikbaar - title: detail - instance: - type: string - description: - URI met referentie naar dit specifiek voorkomen van de fout. - Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. - title: instance - invalidParams: - type: array - items: - $ref: '#/components/schemas/FieldValidationError' - title: invalidParams - required: - - code - - detail - - instance - - invalidParams - - status - - title - VerblijfsAdres: - type: object - properties: - aoaIdentificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - wplWoonplaatsNaam: - type: string - title: wpl woonplaats naam - maxLength: 80 - gorOpenbareRuimteNaam: - type: string - description: - Een door het bevoegde gemeentelijke orgaan aan een OPENBARE - RUIMTE toegekende benaming - title: gor openbare ruimte naam - maxLength: 80 - aoaPostcode: - type: string - title: postcode - maxLength: 7 - aoaHuisnummer: - type: integer - maximum: 99999 - minimum: 0 - title: huisnummer - aoaHuisletter: - type: string - title: huisletter - maxLength: 1 - aoaHuisnummertoevoeging: - type: string - title: huisnummertoevoeging - maxLength: 4 - inpLocatiebeschrijving: - type: string - title: locatie omschrijving - maxLength: 1000 - required: - - aoaHuisnummer - - aoaIdentificatie - - gorOpenbareRuimteNaam - - wplWoonplaatsNaam - Verlenging: - type: object - description: - Gegevens omtrent het verlengen van de doorlooptijd van de behandeling - van de ZAAK - properties: - reden: - type: string - description: - Omschrijving van de reden voor het verlengen van de behandeling - van de zaak. - title: reden verlenging - maxLength: 200 - duur: - type: string - description: - Het aantal werkbare dagen waarmee de doorlooptijd van de behandeling - van de ZAAK is verlengd (of verkort) ten opzichte van de eerder gecommuniceerde - doorlooptijd. - title: duur verlenging - format: duration - required: - - duur - - reden - nullable: true - VertrouwelijkheidaanduidingEnum: - enum: - - openbaar - - beperkt_openbaar - - intern - - zaakvertrouwelijk - - vertrouwelijk - - confidentieel - - geheim - - zeer_geheim - type: string - Wijzigingen: - type: object - properties: - oud: - type: object - additionalProperties: {} - description: - Volledige JSON body van het object zoals dat bestond voordat - de actie heeft plaatsgevonden. - title: oud - nieuw: - type: object - additionalProperties: {} - description: Volledige JSON body van het object na de actie. - title: nieuw - WozObjectAdres: - type: object - properties: - aoaIdentificatie: - type: string - description: De unieke identificatie van het OBJECT - title: identificatie - maxLength: 100 - wplWoonplaatsNaam: - type: string - title: wpl woonplaats naam - maxLength: 80 - gorOpenbareRuimteNaam: - type: string - description: - Een door het bevoegde gemeentelijke orgaan aan een OPENBARE - RUIMTE toegekende benaming - title: gor openbare ruimte naam - maxLength: 80 - aoaPostcode: - type: string - title: postcode - maxLength: 7 - aoaHuisnummer: - type: integer - maximum: 99999 - minimum: 0 - title: huisnummer - aoaHuisletter: - type: string - title: huisletter - maxLength: 1 - aoaHuisnummertoevoeging: - type: string - title: huisnummertoevoeging - maxLength: 4 - locatieOmschrijving: - type: string - title: locatie omschrijving - maxLength: 1000 - required: - - aoaHuisnummer - - aoaIdentificatie - - gorOpenbareRuimteNaam - - wplWoonplaatsNaam - Zaak: - type: object - description: 'Set gegevensgroepdata from validated nested data. - - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - identificatie: - type: string - description: - De unieke identificatie van de ZAAK binnen de organisatie die - verantwoordelijk is voor de behandeling van de ZAAK. - title: identificatie - maxLength: 40 - bronorganisatie: - type: string - description: - Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers - en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef - title: bronorganisatie - maxLength: 9 - omschrijving: - type: string - description: Een korte omschrijving van de zaak. - title: omschrijving - maxLength: 80 - toelichting: - type: string - description: Een toelichting op de zaak. - title: toelichting - maxLength: 1000 - zaaktype: - type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de - CATALOGUS waar deze voorkomt - title: zaaktype - maxLength: 1000 - registratiedatum: - type: string - format: date - description: - De datum waarop de zaakbehandelende organisatie de ZAAK heeft - geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag - gebruikt. - title: registratiedatum - verantwoordelijkeOrganisatie: - type: string - description: - Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die eindverantwoordelijk is voor de behandeling van de zaak. Dit moet - een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef - title: verantwoordelijke organisatie - maxLength: 9 - startdatum: - type: string - format: date - description: De datum waarop met de uitvoering van de zaak is gestart - title: startdatum - einddatum: - type: string - format: date - readOnly: true - nullable: true - description: De datum waarop de uitvoering van de zaak afgerond is. - title: einddatum - einddatumGepland: - type: string - format: date - nullable: true - description: - De datum waarop volgens de planning verwacht wordt dat de zaak - afgerond wordt. - title: einddatum gepland - uiterlijkeEinddatumAfdoening: - type: string - format: date - nullable: true - description: - De laatste datum waarop volgens wet- en regelgeving de zaak - afgerond dient te zijn. - title: uiterlijke einddatum afdoening - publicatiedatum: - type: string - format: date - nullable: true - description: Datum waarop (het starten van) de zaak gepubliceerd is of wordt. - title: publicatiedatum - communicatiekanaal: - type: string - format: uri - description: - Het medium waarlangs de aanleiding om een zaak te starten is - ontvangen. URL naar een communicatiekanaal in de VNG-Referentielijst van - communicatiekanalen. - title: communicatiekanaal - maxLength: 1000 - productenOfDiensten: - type: array - items: - type: string - format: uri - title: URL naar product/dienst - maxLength: 1000 - description: - De producten en/of diensten die door de zaak worden voortgebracht. - Dit zijn URLs naar de resources zoals die door de producten- en dienstencatalogus-API - wordt ontsloten. De producten/diensten moeten bij het zaaktype vermeld - zijn. - title: producten of diensten - vertrouwelijkheidaanduiding: - allOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - title: Vertrouwlijkheidaanduiding - description: - Aanduiding van de mate waarin het zaakdossier van de ZAAK voor - de openbaarheid bestemd is. Optioneel - indien geen waarde gekozen wordt, - dan wordt de waarde van het ZAAKTYPE overgenomen. Dit betekent dat de - API _altijd_ een waarde teruggeeft. - betalingsindicatie: - description: - 'Indicatie of de, met behandeling van de zaak gemoeide, kosten - betaald zijn door de desbetreffende betrokkene. - - - Uitleg bij mogelijke waarden: - - - * `nvt` - Er is geen sprake van te betalen, met de zaak gemoeide, kosten. - - * `nog_niet` - De met de zaak gemoeide kosten zijn (nog) niet betaald. - - * `gedeeltelijk` - De met de zaak gemoeide kosten zijn gedeeltelijk betaald. - - * `geheel` - De met de zaak gemoeide kosten zijn geheel betaald.' - title: betalingsindicatie - oneOf: - - $ref: '#/components/schemas/BetalingsindicatieEnum' - - $ref: '#/components/schemas/BlankEnum' - betalingsindicatieWeergave: - type: string - readOnly: true - description: Uitleg bij `betalingsindicatie`. - title: betalingsindicatieWeergave - laatsteBetaaldatum: - type: string - format: date-time - nullable: true - description: - De datum waarop de meest recente betaling is verwerkt van kosten - die gemoeid zijn met behandeling van de zaak. - title: laatste betaaldatum - zaakgeometrie: - allOf: - - $ref: '#/components/schemas/GeoJSONGeometry' - nullable: true - description: Punt, lijn of (multi-)vlak geometrie-informatie, in GeoJSON. - title: zaakgeometrie - verlenging: - allOf: - - $ref: '#/components/schemas/Verlenging' - nullable: true - description: - Gegevens omtrent het verlengen van de doorlooptijd van de behandeling - van de ZAAK - title: verlenging - opschorting: - allOf: - - $ref: '#/components/schemas/Opschorting' - nullable: true - description: - Gegevens omtrent het tijdelijk opschorten van de behandeling - van de ZAAK - title: opschorting - selectielijstklasse: - type: string - format: uri - description: - URL-referentie naar de categorie in de gehanteerde 'Selectielijst - Archiefbescheiden' die, gezien het zaaktype en het resultaattype van de - zaak, bepalend is voor het archiefregime van de zaak. - title: selectielijstklasse - maxLength: 1000 - hoofdzaak: - type: string - format: uri - nullable: true - title: Is deelzaak van - description: - "URL-referentie naar de ZAAK, waarom verzocht is door de initiator\ - \ daarvan, die behandeld wordt in twee of meer separate ZAAKen waarvan\ - \ de onderhavige ZAAK er \xE9\xE9n is." - minLength: 1 - maxLength: 1000 - deelzaken: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - description: URL-referenties naar deel ZAAKen. - title: is deelzaak van - uniqueItems: true - relevanteAndereZaken: - type: array - items: - $ref: '#/components/schemas/RelevanteZaak' - description: Een lijst van relevante andere zaken. - title: zaak - eigenschappen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: zaak - uniqueItems: true - rollen: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: zaak - uniqueItems: true - status: - type: string - format: uri - readOnly: true - nullable: true - description: Indien geen status bekend is, dan is de waarde 'null' - title: status - zaakinformatieobjecten: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: zaak - uniqueItems: true - zaakobjecten: - type: array - items: - type: string - format: uri - title: '' - readOnly: true - title: zaak - uniqueItems: true - kenmerken: - type: array - items: - $ref: '#/components/schemas/ZaakKenmerk' - description: - Lijst van kenmerken. Merk op dat refereren naar gerelateerde - objecten beter kan via `ZaakObject`. - title: zaak - archiefnominatie: - nullable: true - description: - 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - - - Uitleg bij mogelijke waarden: - - - * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum - overgedragen worden naar een archiefbewaarplaats. - - * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd - worden.' - title: archiefnominatie - oneOf: - - $ref: '#/components/schemas/ArchiefnominatieEnum' - - $ref: '#/components/schemas/BlankEnum' - - $ref: '#/components/schemas/NullEnum' - archiefstatus: - allOf: - - $ref: '#/components/schemas/ArchiefstatusEnum' - description: - 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - - - Uitleg bij mogelijke waarden: - - - * `nog_te_archiveren` - De zaak cq. het zaakdossier is nog niet als geheel - gearchiveerd. - - * `gearchiveerd` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar - bewaarbaar gemaakt. - - * `gearchiveerd_procestermijn_onbekend` - De zaak cq. het zaakdossier - is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum - kan nog niet bepaald worden. - - * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een - archiefbewaarplaats.' - title: archiefstatus - archiefactiedatum: - type: string - format: date - nullable: true - description: - De datum waarop het gearchiveerde zaakdossier vernietigd moet - worden dan wel overgebracht moet worden naar een archiefbewaarplaats. - Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT - aan deze ZAAK indien nog leeg. - title: archiefactiedatum - resultaat: - type: string - format: uri - readOnly: true - nullable: true - description: - URL-referentie naar het RESULTAAT. Indien geen resultaat bekend - is, dan is de waarde 'null' - title: resultaat - opdrachtgevendeOrganisatie: - type: string - description: - De krachtens publiekrecht ingestelde rechtspersoon dan wel - ander niet-natuurlijk persoon waarbinnen het (bestuurs)orgaan zetelt dat - opdracht heeft gegeven om taken uit te voeren waaraan de zaak invulling - geeft. - title: opdrachtgevende organisatie - maxLength: 9 - processobjectaard: - type: string - nullable: true - title: Procesobjectaard - description: - Omschrijving van het object, subject of gebeurtenis waarop, - vanuit archiveringsoptiek, de zaak betrekking heeft. - maxLength: 200 - startdatumBewaartermijn: - type: string - format: date - nullable: true - description: - De datum die de start markeert van de termijn waarop het zaakdossier - vernietigd moet worden. - title: startdatum bewaartermijn - processobject: - allOf: - - $ref: '#/components/schemas/Processobject' - nullable: true - description: - Specificatie van de attribuutsoort van het object, subject - of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking - heeft en dat bepalend is voor de start van de archiefactietermijn. - title: processobject - required: - - betalingsindicatieWeergave - - bronorganisatie - - deelzaken - - eigenschappen - - einddatum - - resultaat - - rollen - - startdatum - - status - - url - - uuid - - verantwoordelijkeOrganisatie - - zaakinformatieobjecten - - zaakobjecten - - zaaktype - ZaakExpanded: - allOf: - - $ref: '#/components/schemas/Zaak' - - properties: - _expand: - $ref: '#/components/schemas/ZaakEmbedded' - ZaakEmbedded: - type: object - properties: - zaaktype: - - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakTypeExpanded' - hoofdzaak: - oneOf: - - $ref: '#/components/schemas/ZaakExpanded' - - $ref: '#/components/schemas/EmptyObject' - example: {} - deelzaken: - type: array - items: - $ref: '#/components/schemas/ZaakExpanded' - example: [{}] - relevanteAndereZaken: - type: array - items: - $ref: '#/components/schemas/ZaakExpanded' - example: [{}] - eigenschappen: - type: array - items: - $ref: '#/components/schemas/ZaakEigenschapExpanded' - rollen: - type: array - items: - $ref: '#/components/schemas/RolExpanded' - status: - oneOf: - - $ref: '#/components/schemas/StatusExpanded' - - $ref: '#/components/schemas/EmptyObject' - zaakobjecten: - type: array - items: - $ref: '#/components/schemas/ZaakObjectExpanded' - resultaat: - oneOf: - - $ref: '#/components/schemas/ResultaatExpanded' - - $ref: '#/components/schemas/EmptyObject' - EmptyObject: - type: object - description: Leeg object. Dit wordt teruggeven indien het te expanderen veld een null waarde heeft. - example: {} - ExpandCatalogusObject: - type: object - properties: - _expand: - type: object - description: Zie de Catalogus API hoe dit object verder geëxpandeerd kan worden. - ZaakBesluit: - type: object - description: - "A type of `ModelSerializer` that uses hyperlinked relationships - with compound keys instead - - of primary key relationships. Specifically: - - - * A 'url' field is included instead of the 'id' field. - - * Relationships to other instances are hyperlinks, instead of primary keys. - - - NOTE: this only works with DRF 3.1.0 and above." - properties: - url: - type: string - format: uri - readOnly: true - title: url - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - besluit: - type: string - format: uri - description: - URL-referentie naar het BESLUIT (in de Besluiten API), waar - ook de relatieinformatie opgevraagd kan worden. - title: besluit - maxLength: 1000 - required: - - besluit - - url - - uuid - ZaakContactMoment: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - contactmoment: - type: string - format: uri - description: - URL-referentie naar het CONTACTMOMENT (in de Klantinteractie - API) - title: contactmoment - maxLength: 1000 - required: - - contactmoment - - url - - uuid - - zaak - ZaakEigenschap: - type: object - description: - "A type of `ModelSerializer` that uses hyperlinked relationships - with compound keys instead - - of primary key relationships. Specifically: - - - * A 'url' field is included instead of the 'id' field. - - * Relationships to other instances are hyperlinks, instead of primary keys. - - - NOTE: this only works with DRF 3.1.0 and above." - properties: - url: - type: string - format: uri - readOnly: true - title: url - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - title: zaak - eigenschap: - type: string - format: uri - description: URL-referentie naar de EIGENSCHAP (in de Catalogi API). - title: eigenschap - maxLength: 1000 - naam: - type: string - readOnly: true - description: De naam van de EIGENSCHAP (overgenomen uit de Catalogi API). - title: ' naam' - waarde: - type: string - title: waarde - required: - - eigenschap - - naam - - url - - uuid - - waarde - - zaak - ZaakEigenschapExpanded: - allOf: - - $ref: '#/components/schemas/ZaakEigenschap' - - properties: - _expand: - $ref: '#/components/schemas/ZaakEigenschapEmbedded' - ZaakEigenschapEmbedded: - type: object - properties: - zaak: - oneOf: - - $ref: '#/components/schemas/ZaakExpanded' - - $ref: '#/components/schemas/EmptyObject' - eigenschap: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/EigenschapExpanded' - ZaakInformatieObject: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - informatieobject: - type: string - format: uri - description: - URL-referentie naar het INFORMATIEOBJECT (in de Documenten - API), waar ook de relatieinformatie opgevraagd kan worden. - title: informatieobject - maxLength: 1000 - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - aardRelatieWeergave: - allOf: - - $ref: '#/components/schemas/AardRelatieWeergaveEnum' - readOnly: true - title: aardRelatieWeergave - titel: - type: string - description: - De naam waaronder het INFORMATIEOBJECT binnen het OBJECT bekend - is. - title: titel - maxLength: 200 - beschrijving: - type: string - description: - Een op het object gerichte beschrijving van de inhoud vanhet - INFORMATIEOBJECT. - title: beschrijving - registratiedatum: - type: string - format: date-time - readOnly: true - description: - De datum waarop de behandelende organisatie het INFORMATIEOBJECT - heeft geregistreerd bij het OBJECT. Geldige waardes zijn datumtijden gelegen - op of voor de huidige datum en tijd. - title: registratiedatum - vernietigingsdatum: - type: string - format: date-time - nullable: true - description: - De datum waarop het informatieobject uit het zaakdossier verwijderd - moet worden. - title: vernietigingsdatum - status: - type: string - format: uri - nullable: true - description: - De bij de desbetreffende ZAAK behorende STATUS waarvoor het - ZAAK-INFORMATIEOBJECT relevant is (geweest) met het oog op het bereiken - van die STATUS en/of de communicatie daarover. - title: status - minLength: 1 - maxLength: 1000 - required: - - aardRelatieWeergave - - informatieobject - - registratiedatum - - url - - uuid - - zaak - ZaakInformatieObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakInformatieObject' - - properties: - _expand: - $ref: '#/components/schemas/ZaakInformatieObjectEmbedded' - ZaakInformatieObjectEmbedded: - type: object - properties: - status: - $ref: '#/components/schemas/StatusExpanded' - ZaakKenmerk: - type: object - properties: - kenmerk: - type: string - description: Identificeert uniek de zaak in een andere administratie. - title: kenmerk - maxLength: 40 - bron: - type: string - description: De aanduiding van de administratie waar het kenmerk op slaat. - title: bron - maxLength: 40 - required: - - bron - - kenmerk - ZaakObject: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - object: - type: string - format: uri - description: URL-referentie naar de resource die het OBJECT beschrijft. - title: object - maxLength: 1000 - zaakobjecttype: - type: string - format: uri - description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API). - title: zaakobjecttype - maxLength: 1000 - objectType: - allOf: - - $ref: '#/components/schemas/ObjectTypeEnum' - description: - 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er - geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. - - - Uitleg bij mogelijke waarden: - - - * `adres` - Adres - - * `besluit` - Besluit - - * `buurt` - Buurt - - * `enkelvoudig_document` - Enkelvoudig document - - * `gemeente` - Gemeente - - * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte - - * `huishouden` - Huishouden - - * `inrichtingselement` - Inrichtingselement - - * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak - - * `kunstwerkdeel` - Kunstwerkdeel - - * `maatschappelijke_activiteit` - Maatschappelijke activiteit - - * `medewerker` - Medewerker - - * `natuurlijk_persoon` - Natuurlijk persoon - - * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon - - * `openbare_ruimte` - Openbare ruimte - - * `organisatorische_eenheid` - Organisatorische eenheid - - * `pand` - Pand - - * `spoorbaandeel` - Spoorbaandeel - - * `status` - Status - - * `terreindeel` - Terreindeel - - * `terrein_gebouwd_object` - Terrein gebouwd object - - * `vestiging` - Vestiging - - * `waterdeel` - Waterdeel - - * `wegdeel` - Wegdeel - - * `wijk` - Wijk - - * `woonplaats` - Woonplaats - - * `woz_deelobject` - Woz deel object - - * `woz_object` - Woz object - - * `woz_waarde` - Woz waarde - - * `zakelijk_recht` - Zakelijk recht - - * `overige` - Overige' - title: object type - objectTypeOverige: - type: string - description: - Beschrijft het type OBJECT als `objectType` de waarde "overige" - heeft. - title: object type overige - pattern: '[a-z\_]+' - maxLength: 100 - objectTypeOverigeDefinitie: - allOf: - - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie' - nullable: true - title: definitie object type overige - description: - 'Verwijzing naar het schema van het type OBJECT als `objectType` - de waarde "overige" heeft. - - - * De URL referentie moet naar een JSON endpoint wijzen waarin het objecttype - gedefinieerd is, inclusief het [JSON-schema](https://json-schema.org/). - - * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen de - objecttype resource (deze gebruikt het [jq](http://stedolan.github.io/jq/) - formaat. - - * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens binnen - het OBJECT. Deze gebruikt ook het [jq](http://stedolan.github.io/jq/) - formaat. - - - Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven - en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven - OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.' - relatieomschrijving: - type: string - description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. - title: relatieomschrijving - maxLength: 80 - required: - - objectType - - url - - uuid - - zaak - discriminator: - propertyName: objectType - mapping: - adres: '#/components/schemas/adres_ZaakObject' - besluit: '#/components/schemas/besluit_ZaakObject' - buurt: '#/components/schemas/buurt_ZaakObject' - enkelvoudig_document: '#/components/schemas/enkelvoudig_document_ZaakObject' - gemeente: '#/components/schemas/gemeente_ZaakObject' - gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_ZaakObject' - huishouden: '#/components/schemas/huishouden_ZaakObject' - inrichtingselement: '#/components/schemas/inrichtingselement_ZaakObject' - kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_ZaakObject' - kunstwerkdeel: '#/components/schemas/kunstwerkdeel_ZaakObject' - maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_ZaakObject' - medewerker: '#/components/schemas/medewerker_ZaakObject' - natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_ZaakObject' - niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_ZaakObject' - openbare_ruimte: '#/components/schemas/openbare_ruimte_ZaakObject' - organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_ZaakObject' - pand: '#/components/schemas/pand_ZaakObject' - spoorbaandeel: '#/components/schemas/spoorbaandeel_ZaakObject' - status: '#/components/schemas/status_ZaakObject' - terreindeel: '#/components/schemas/terreindeel_ZaakObject' - terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_ZaakObject' - vestiging: '#/components/schemas/vestiging_ZaakObject' - waterdeel: '#/components/schemas/waterdeel_ZaakObject' - wegdeel: '#/components/schemas/wegdeel_ZaakObject' - wijk: '#/components/schemas/wijk_ZaakObject' - woonplaats: '#/components/schemas/woonplaats_ZaakObject' - woz_deelobject: '#/components/schemas/woz_deelobject_ZaakObject' - woz_object: '#/components/schemas/woz_object_ZaakObject' - woz_waarde: '#/components/schemas/woz_waarde_ZaakObject' - zakelijk_recht: '#/components/schemas/zakelijk_recht_ZaakObject' - overige: '#/components/schemas/overige_ZaakObject' - ZaakObjectExpanded: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - object: - type: string - format: uri - description: URL-referentie naar de resource die het OBJECT beschrijft. - title: object - maxLength: 1000 - zaakobjecttype: - type: string - format: uri - description: URL-referentie naar het ZAAKOBJECTTYPE (in de Catalogi API). - title: zaakobjecttype - maxLength: 1000 - objectType: - allOf: - - $ref: '#/components/schemas/ObjectTypeEnum' - description: - 'Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er - geen passend type is, dan moet het type worden opgegeven onder `objectTypeOverige`. - - - Uitleg bij mogelijke waarden: - - - * `adres` - Adres - - * `besluit` - Besluit - - * `buurt` - Buurt - - * `enkelvoudig_document` - Enkelvoudig document - - * `gemeente` - Gemeente - - * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte - - * `huishouden` - Huishouden - - * `inrichtingselement` - Inrichtingselement - - * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak - - * `kunstwerkdeel` - Kunstwerkdeel - - * `maatschappelijke_activiteit` - Maatschappelijke activiteit - - * `medewerker` - Medewerker - - * `natuurlijk_persoon` - Natuurlijk persoon - - * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon - - * `openbare_ruimte` - Openbare ruimte - - * `organisatorische_eenheid` - Organisatorische eenheid - - * `pand` - Pand - - * `spoorbaandeel` - Spoorbaandeel - - * `status` - Status - - * `terreindeel` - Terreindeel - - * `terrein_gebouwd_object` - Terrein gebouwd object - - * `vestiging` - Vestiging - - * `waterdeel` - Waterdeel - - * `wegdeel` - Wegdeel - - * `wijk` - Wijk - - * `woonplaats` - Woonplaats - - * `woz_deelobject` - Woz deel object - - * `woz_object` - Woz object - - * `woz_waarde` - Woz waarde - - * `zakelijk_recht` - Zakelijk recht - - * `overige` - Overige' - title: object type - objectTypeOverige: - type: string - description: - Beschrijft het type OBJECT als `objectType` de waarde "overige" - heeft. - title: object type overige - pattern: '[a-z\_]+' - maxLength: 100 - objectTypeOverigeDefinitie: - allOf: - - $ref: '#/components/schemas/ObjectTypeOverigeDefinitie' - nullable: true - title: definitie object type overige - description: - 'Verwijzing naar het schema van het type OBJECT als `objectType` - de waarde "overige" heeft. - - - * De URL referentie moet naar een JSON endpoint wijzen waarin het objecttype - gedefinieerd is, inclusief het [JSON-schema](https://json-schema.org/). - - * Gebruik het `schema` attribuut om te verwijzen naar het schema binnen de - objecttype resource (deze gebruikt het [jq](http://stedolan.github.io/jq/) - formaat. - - * Gebruik het `objectData` attribuut om te verwijzen naar de gegevens binnen - het OBJECT. Deze gebruikt ook het [jq](http://stedolan.github.io/jq/) - formaat. - - - Indien je hier gebruikt van maakt, dan moet je een OBJECT url opgeven - en is het gebruik van objectIdentificatie niet mogelijk. De opgegeven - OBJECT url wordt gevalideerd tegen het schema van het opgegeven objecttype.' - relatieomschrijving: - type: string - description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. - title: relatieomschrijving - maxLength: 80 - _expand: - $ref: '#/components/schemas/ZaakObjectEmbedded' - required: - - objectType - - url - - uuid - - zaak - discriminator: - propertyName: objectType - mapping: - adres: '#/components/schemas/adres_ZaakObjectExpanded' - besluit: '#/components/schemas/besluit_ZaakObjectExpanded' - buurt: '#/components/schemas/buurt_ZaakObjectExpanded' - enkelvoudig_document: '#/components/schemas/enkelvoudig_document_ZaakObjectExpanded' - gemeente: '#/components/schemas/gemeente_ZaakObjectExpanded' - gemeentelijke_openbare_ruimte: '#/components/schemas/gemeentelijke_openbare_ruimte_ZaakObjectExpanded' - huishouden: '#/components/schemas/huishouden_ZaakObjectExpanded' - inrichtingselement: '#/components/schemas/inrichtingselement_ZaakObjectExpanded' - kadastrale_onroerende_zaak: '#/components/schemas/kadastrale_onroerende_zaak_ZaakObjectExpanded' - kunstwerkdeel: '#/components/schemas/kunstwerkdeel_ZaakObjectExpanded' - maatschappelijke_activiteit: '#/components/schemas/maatschappelijke_activiteit_ZaakObjectExpanded' - medewerker: '#/components/schemas/medewerker_ZaakObjectExpanded' - natuurlijk_persoon: '#/components/schemas/natuurlijk_persoon_ZaakObjectExpanded' - niet_natuurlijk_persoon: '#/components/schemas/niet_natuurlijk_persoon_ZaakObjectExpanded' - openbare_ruimte: '#/components/schemas/openbare_ruimte_ZaakObjectExpanded' - organisatorische_eenheid: '#/components/schemas/organisatorische_eenheid_ZaakObjectExpanded' - pand: '#/components/schemas/pand_ZaakObjectExpanded' - spoorbaandeel: '#/components/schemas/spoorbaandeel_ZaakObjectExpanded' - status: '#/components/schemas/status_ZaakObjectExpanded' - terreindeel: '#/components/schemas/terreindeel_ZaakObjectExpanded' - terrein_gebouwd_object: '#/components/schemas/terrein_gebouwd_object_ZaakObjectExpanded' - vestiging: '#/components/schemas/vestiging_ZaakObjectExpanded' - waterdeel: '#/components/schemas/waterdeel_ZaakObjectExpanded' - wegdeel: '#/components/schemas/wegdeel_ZaakObjectExpanded' - wijk: '#/components/schemas/wijk_ZaakObjectExpanded' - woonplaats: '#/components/schemas/woonplaats_ZaakObjectExpanded' - woz_deelobject: '#/components/schemas/woz_deelobject_ZaakObjectExpanded' - woz_object: '#/components/schemas/woz_object_ZaakObjectExpanded' - woz_waarde: '#/components/schemas/woz_waarde_ZaakObjectExpanded' - zakelijk_recht: '#/components/schemas/zakelijk_recht_ZaakObjectExpanded' - overige: '#/components/schemas/overige_ZaakObjectExpanded' - ZaakObjectEmbedded: - type: object - properties: - zaakobjecttype: - $ref: '../../../ztc/1.3.x/1.3.2/openapi.yaml#/components/schemas/ZaakObjectType' - ZaakVerzoek: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - uuid: - type: string - format: uuid - readOnly: true - description: Unieke resource identifier (UUID4) - title: uuid - zaak: - type: string - format: uri - description: URL-referentie naar de ZAAK. - title: zaak - minLength: 1 - maxLength: 1000 - verzoek: - type: string - format: uri - description: URL-referentie naar het VERZOEK (in de Klantinteractie API) - title: verzoek - maxLength: 1000 - required: - - url - - uuid - - verzoek - - zaak - ZaakZoek: - type: object - properties: - zaakgeometrie: - $ref: '#/components/schemas/GeoWithin' - uuid__in: - description: Array of unieke resource identifiers (UUID4) - type: array - items: - type: string - format: uuid - example: ["e80b7507-199a-484c-ad49-c41a1e43a6e7", "78e12133-c467-4202-91ba-4417baa52801"] - identificatie: - title: Identificatie - description: De unieke identificatie van de ZAAK binnen de organisatie die - verantwoordelijk is voor de behandeling van de ZAAK. - type: string - example: "zaak123" - bronorganisatie: - title: Bronorganisatie - description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers - en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef - type: string - example: "000000000" - bronorganisatie__in: - description: Array van bronorganisaties. - type: array - items: - type: string - format: string - example: ["000000000","479559740","875883461"] - zaaktype: - title: Zaaktype - description: URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de - CATALOGUS waar deze voorkomt - type: string - example: "https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/e80b7507-199a-484c-ad49-c41a1e43a6e7" - zaaktype__in: - description: Array van zaaktypen. - type: array - items: - type: string - format: uri - example: ["https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/e80b7507-199a-484c-ad49-c41a1e43a6e7","https://catalogi-api.test.vng.cloud/api/v1/zaaktypen/78e12133-c467-4202-91ba-4417baa52801"] - archiefnominatie: - title: Archiefnominatie - description: 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - Uitleg bij mogelijke waarden: - * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum - overgedragen worden naar een archiefbewaarplaats. - * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd - worden.' - type: string - enum: - - blijvend_bewaren - - vernietigen - example: "blijvend_bewaren" - archiefnominatie__in: - title: Archiefnominatie in - description: Multiple values may be separated by commas. - type: array - items: - type: string - example: [ "blijvend_bewaren", "vernietigen" ] - archiefactiedatum: - title: Archiefactiedatum - description: De datum waarop het gearchiveerde zaakdossier vernietigd moet - worden dan wel overgebracht moet worden naar een archiefbewaarplaats. - Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT - aan deze ZAAK indien nog leeg. - type: string - example: "2019-01-02" - archiefactiedatum__isnull: - title: Archiefactiedatum is leeg - type: boolean - example: false - archiefactiedatum__lt: - title: Archiefactiedatum kleiner dan - type: string - example: "2020-01-02" - archiefactiedatum__gt: - title: Archiefactiedatum groter dan - type: string - example: "2018-01-02" - archiefstatus: - title: Archiefstatus - description: 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - Uitleg bij mogelijke waarden: - * `nog_te_archiveren` - De zaak cq. het zaakdossier is nog niet als geheel - gearchiveerd. - * `gearchiveerd` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar - bewaarbaar gemaakt. - * `gearchiveerd_procestermijn_onbekend` - De zaak cq. het zaakdossier - is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum - kan nog niet bepaald worden. - * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een - archiefbewaarplaats.' - type: string - enum: - - nog_te_archiveren - - gearchiveerd - - gearchiveerd_procestermijn_onbekend - - overgedragen - example: "nog_te_archiveren" - archiefstatus__in: - title: Archiefstatus in - description: Multiple values may be separated by commas. - type: array - items: - type: string - example: [ "nog_te_archiveren","gearchiveerd","gearchiveerd_procestermijn_onbekend","overgedragen" ] - startdatum: - title: Startdatum - description: De datum waarop met de uitvoering van de zaak is gestart - type: string - example: "2017-01-02" - startdatum__gt: - title: Startdatum groter dan - type: string - example: "2018-01-02" - startdatum__gte: - title: Startdatum groter dan of gelijk - type: string - example: "2016-01-02" - startdatum__lt: - title: Startdatum kleiner dan - type: string - example: "2018-01-02" - startdatum__lte: - title: Startdatum kleiner dan of gelijk - type: string - example: "2018-01-02" - registratiedatum: - title: Registratiedatum - description: De datum waarop de zaakbehandelende organisatie de ZAAK heeft geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag gebruikt. - type: string - example: "2015-01-02" - registratiedatum__gt: - title: Registratiedatum groter dan - type: string - example: "2014-01-02" - registratiedatum__lt: - title: Registratiedatum kleiner dan - type: string - example: "2016-01-02" - einddatum: - title: Einddatum - description: De datum waarop de uitvoering van de zaak afgerond is. - type: string - example: "2022-01-02" - einddatum__isnull: - title: Einddatum is leeg - type: boolean - example: false - einddatum__gt: - title: Einddatum groter dan - type: string - example: "2021-01-02" - einddatum__lt: - title: Einddatum kleiner dan - type: string - minLength: 1 - example: "2023-01-02" - einddatumGepland: - title: Einddatum gepland - description: De datum waarop volgens de planning verwacht wordt dat de zaak afgerond wordt. - type: string - example: "2022-01-02" - einddatumGepland__gt: - title: Einddatum gepland groter dan - type: string - example: "2021-01-02" - einddatumGepland__lt: - title: Einddatum gepland kleiner dan - type: string - example: "2024-01-02" - uiterlijkeEinddatumAfdoening: - title: Uiterlijke einddatumAfdoening - description: De laatste datum waarop volgens wet- en regelgeving de zaak afgerond dient te zijn. - type: string - example: "2024-01-02" - uiterlijkeEinddatumAfdoening__gt: - title: Uiterlijke einddatumAfdoening groter dan - type: string - example: "2023-01-02" - uiterlijkeEinddatumAfdoening__lt: - title: Uiterlijke einddatumAfdoening kleiner dan - type: string - example: "2025-01-02" - rol__betrokkeneType: - title: Rol betrokkenetype - description: 'Type van de `betrokkene`. - Uitleg bij mogelijke waarden: - * `natuurlijk_persoon` - Natuurlijk persoon - * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon - * `vestiging` - Vestiging - * `organisatorische_eenheid` - Organisatorische eenheid - * `medewerker` - Medewerker' - type: string - enum: - - natuurlijk_persoon - - niet_natuurlijk_persoon - - vestiging - - organisatorische_eenheid - - medewerker - example: "natuurlijk_persoon" - rol__betrokkene: - title: Rol betrokkene - description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. - type: string - example: "https://example.com" - rol__omschrijvingGeneriek: - title: Rol omschrijvinggeneriek - description: - Algemeen gehanteerde benaming van de aard van de ROL, afgeleid uit het ROLTYPE. - type: string - enum: - - adviseur - - behandelaar - - belanghebbende - - beslisser - - initiator - - klantcontacter - - zaakcoordinator - - mede_initiator - example: "initiator" - maximaleVertrouwelijkheidaanduiding: - title: Maximalevertrouwelijkheidaanduiding - description: - Zaken met een vertrouwelijkheidaanduiding die beperkter is - dan de aangegeven aanduiding worden uit de resultaten gefiltered. - type: string - enum: - - openbaar - - beperkt_openbaar - - intern - - zaakvertrouwelijk - - vertrouwelijk - - confidentieel - - geheim - - zeer_geheim - example: "zaakvertrouwelijk" - rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn: - title: Rol betrokkeneidentificatie natuurlijkpersoon inpbsn - description: Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet - algemene bepalingen burgerservicenummer. - type: string - example: "123456789" - rol__betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie: - title: Rol betrokkeneidentificatie natuurlijkpersoon anpidentificatie - description: Het door de gemeente uitgegeven unieke nummer voor een ANDER - NATUURLIJK PERSOON - type: string - example: "123456789" - rol__betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer: - title: Rol betrokkeneidentificatie natuurlijkpersoon inpa nummer - description: Het administratienummer van de persoon, bedoeld in de Wet BRP - type: string - example: "123456789" - rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId: - title: Rol betrokkeneidentificatie nietnatuurlijkpersoon innnnpid - description: Het door een kamer toegekend uniek nummer voor de INGESCHREVEN - NIET-NATUURLIJK PERSOON - type: string - example: "123456789" - rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie: - title: Rol betrokkeneidentificatie nietnatuurlijkpersoon annidentificatie - description: Het door de gemeente uitgegeven unieke nummer voor een ANDER - NIET-NATUURLIJK PERSOON - type: string - example: "123456789" - rol__betrokkeneIdentificatie__vestiging__vestigingsNummer: - title: Rol betrokkeneidentificatie vestiging vestigingsnummer - description: Een korte unieke aanduiding van de Vestiging. - type: string - example: "123456789" - rol__betrokkeneIdentificatie__medewerker__identificatie: - title: Rol betrokkeneidentificatie medewerker identificatie - description: Een korte unieke aanduiding van de MEDEWERKER. - type: string - example: "123456789" - rol__betrokkeneIdentificatie__organisatorischeEenheid__identificatie: - title: Rol betrokkeneidentificatie organisatorischeeenheid identificatie - description: Een korte identificatie van de organisatorische eenheid. - type: string - example: "123456789" - expand: - description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,` \ - \ hoofdzaak.deelzaken.status.statustype`Haal details van gelinkte resources direct op. - Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. - Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt." - title: expand - type: string - example: zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype - ordering: - title: Ordering - description: Het veld waarop de resultaten geordend worden. Het minnetje betekent omgekeerde volgorde. - type: string - enum: - - startdatum - - -startdatum - - einddatum - - -einddatum - - publicatiedatum - - -publicatiedatum - - archiefactiedatum - - -archiefactiedatum - - registratiedatum - - -registratiedatum - - identificatie - - -identificatie - example: "-startdatum" - ZakelijkRechtHeeftAlsGerechtigde: - type: object - properties: - natuurlijkPersoon: - allOf: - - $ref: '#/components/schemas/RolNatuurlijkPersoon' - title: natuurlijkPersoon - nietNatuurlijkPersoon: - allOf: - - $ref: '#/components/schemas/RolNietNatuurlijkPersoon' - title: nietNatuurlijkPersoon - adres_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectAdres' - adres_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectAdres' - adres_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectAdres' - besluit_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - besluit_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - besluit_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - betrokkene_identificatie_RolMedewerker: - type: object - properties: - betrokkeneIdentificatie: - allOf: - - $ref: '#/components/schemas/RolMedewerker' - title: betrokkeneIdentificatie - betrokkene_identificatie_RolNatuurlijkPersoon: - type: object - properties: - betrokkeneIdentificatie: - allOf: - - $ref: '#/components/schemas/RolNatuurlijkPersoon' - title: betrokkeneIdentificatie - betrokkene_identificatie_RolNietNatuurlijkPersoon: - type: object - properties: - betrokkeneIdentificatie: - allOf: - - $ref: '#/components/schemas/RolNietNatuurlijkPersoon' - title: betrokkeneIdentificatie - betrokkene_identificatie_RolOrganisatorischeEenheid: - type: object - properties: - betrokkeneIdentificatie: - allOf: - - $ref: '#/components/schemas/RolOrganisatorischeEenheid' - title: betrokkeneIdentificatie - betrokkene_identificatie_RolVestiging: - type: object - properties: - betrokkeneIdentificatie: - allOf: - - $ref: '#/components/schemas/RolVestiging' - title: betrokkeneIdentificatie - buurt_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' - buurt_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' - buurt_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' - enkelvoudig_document_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - enkelvoudig_document_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - enkelvoudig_document_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - gemeente_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' - gemeente_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' - gemeente_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' - gemeentelijke_openbare_ruimte_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' - gemeentelijke_openbare_ruimte_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' - gemeentelijke_openbare_ruimte_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' - huishouden_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' - huishouden_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' - huishouden_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' - inrichtingselement_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' - inrichtingselement_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' - inrichtingselement_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' - kadastrale_onroerende_zaak_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' - kadastrale_onroerende_zaak_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' - kadastrale_onroerende_zaak_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' - kunstwerkdeel_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' - kunstwerkdeel_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' - kunstwerkdeel_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' - maatschappelijke_activiteit_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' - maatschappelijke_activiteit_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' - maatschappelijke_activiteit_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' - medewerker_Rol: - allOf: - - $ref: '#/components/schemas/Rol' - - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' - medewerker_RolExpanded: - allOf: - - $ref: '#/components/schemas/RolExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' - medewerker_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' - medewerker_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' - medewerker_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' - natuurlijk_persoon_Rol: - allOf: - - $ref: '#/components/schemas/Rol' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' - natuurlijk_persoon_RolExpanded: - allOf: - - $ref: '#/components/schemas/RolExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' - natuurlijk_persoon_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' - natuurlijk_persoon_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' - natuurlijk_persoon_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' - niet_natuurlijk_persoon_Rol: - allOf: - - $ref: '#/components/schemas/Rol' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' - niet_natuurlijk_persoon_RolExpanded: - allOf: - - $ref: '#/components/schemas/RolExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' - niet_natuurlijk_persoon_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' - niet_natuurlijk_persoon_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' - niet_natuurlijk_persoon_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' - object_identificatie_ObjectAdres: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectAdres' - title: objectIdentificatie - object_identificatie_ObjectBuurt: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectBuurt' - title: objectIdentificatie - object_identificatie_ObjectGemeente: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectGemeente' - title: objectIdentificatie - object_identificatie_ObjectGemeentelijkeOpenbareRuimte: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectGemeentelijkeOpenbareRuimte' - title: objectIdentificatie - object_identificatie_ObjectHuishouden: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectHuishouden' - title: objectIdentificatie - object_identificatie_ObjectInrichtingselement: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectInrichtingselement' - title: objectIdentificatie - object_identificatie_ObjectKadastraleOnroerendeZaak: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectKadastraleOnroerendeZaak' - title: objectIdentificatie - object_identificatie_ObjectKunstwerkdeel: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectKunstwerkdeel' - title: objectIdentificatie - object_identificatie_ObjectMaatschappelijkeActiviteit: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectMaatschappelijkeActiviteit' - title: objectIdentificatie - object_identificatie_ObjectOpenbareRuimte: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectOpenbareRuimte' - title: objectIdentificatie - object_identificatie_ObjectOverige: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectOverige' - title: objectIdentificatie - object_identificatie_ObjectPand: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectPand' - title: objectIdentificatie - object_identificatie_ObjectSpoorbaandeel: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectSpoorbaandeel' - title: objectIdentificatie - object_identificatie_ObjectTerreinGebouwdObject: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectTerreinGebouwdObject' - title: objectIdentificatie - object_identificatie_ObjectTerreindeel: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectTerreindeel' - title: objectIdentificatie - object_identificatie_ObjectWaterdeel: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectWaterdeel' - title: objectIdentificatie - object_identificatie_ObjectWegdeel: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectWegdeel' - title: objectIdentificatie - object_identificatie_ObjectWijk: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectWijk' - title: objectIdentificatie - object_identificatie_ObjectWoonplaats: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectWoonplaats' - title: objectIdentificatie - object_identificatie_ObjectWozDeelobject: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectWozDeelobject' - title: objectIdentificatie - object_identificatie_ObjectWozObject: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectWozObject' - title: objectIdentificatie - object_identificatie_ObjectWozWaarde: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectWozWaarde' - title: objectIdentificatie - object_identificatie_ObjectZakelijkRecht: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/ObjectZakelijkRecht' - title: objectIdentificatie - object_identificatie_RolMedewerker: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/RolMedewerker' - title: objectIdentificatie - object_identificatie_RolNatuurlijkPersoon: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/RolNatuurlijkPersoon' - title: objectIdentificatie - object_identificatie_RolNietNatuurlijkPersoon: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/RolNietNatuurlijkPersoon' - title: objectIdentificatie - object_identificatie_RolOrganisatorischeEenheid: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/RolOrganisatorischeEenheid' - title: objectIdentificatie - object_identificatie_RolVestiging: - type: object - properties: - objectIdentificatie: - allOf: - - $ref: '#/components/schemas/RolVestiging' - title: objectIdentificatie - openbare_ruimte_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' - openbare_ruimte_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' - openbare_ruimte_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' - organisatorische_eenheid_Rol: - allOf: - - $ref: '#/components/schemas/Rol' - - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' - organisatorische_eenheid_RolExpanded: - allOf: - - $ref: '#/components/schemas/RolExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' - organisatorische_eenheid_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' - organisatorische_eenheid_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' - organisatorische_eenheid_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' - overige_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectOverige' - overige_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectOverige' - overige_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectOverige' - pand_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectPand' - pand_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectPand' - pand_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectPand' - spoorbaandeel_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' - spoorbaandeel_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' - spoorbaandeel_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' - status_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - status_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - status_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - terrein_gebouwd_object_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' - terrein_gebouwd_object_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' - terrein_gebouwd_object_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' - terreindeel_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' - terreindeel_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' - terreindeel_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' - vestiging_Rol: - allOf: - - $ref: '#/components/schemas/Rol' - - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' - vestiging_RolExpanded: - allOf: - - $ref: '#/components/schemas/RolExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' - vestiging_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' - vestiging_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' - vestiging_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' - waterdeel_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' - waterdeel_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' - waterdeel_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' - wegdeel_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' - wegdeel_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' - wegdeel_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' - wijk_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWijk' - wijk_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectWijk' - wijk_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWijk' - woonplaats_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' - woonplaats_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' - woonplaats_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' - woz_deelobject_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' - woz_deelobject_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' - woz_deelobject_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' - woz_object_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' - woz_object_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' - woz_object_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' - woz_waarde_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' - woz_waarde_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' - woz_waarde_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' - zakelijk_recht_ZaakObject: - allOf: - - $ref: '#/components/schemas/ZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' - zakelijk_recht_ZaakObjectExpanded: - allOf: - - $ref: '#/components/schemas/ZaakObjectExpanded' - - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' - zakelijk_recht_PatchedZaakObject: - allOf: - - $ref: '#/components/schemas/PatchedZaakObject' - - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' - securitySchemes: - JWT-Claims: - type: http - bearerFormat: JWT - scheme: bearer -servers: - - url: https://zaken-api.test.vng.cloud/api/v1 - - url: https://zaken-api.vng.cloud/api/v1 -tags: - - name: klantcontacten - description: '' - - name: resultaten - description: '' - - name: rollen - description: '' - - name: statussen - description: '' - - name: zaakcontactmomenten - description: '' - - name: zaakinformatieobjecten - description: '' - - name: zaakobjecten - description: '' - - name: zaakverzoeken - description: '' - - name: zaken - description: - Een zaak mag (in principe) niet meer gewijzigd worden als de `archiefstatus` - een andere status heeft dan "nog_te_archiveren". Voor praktische redenen is er - geen harde validatie regel aan de provider kant. From 8ba02a108f7c443a293291d54cec5c231ddd73b1 Mon Sep 17 00:00:00 2001 From: HenriKorver Date: Fri, 21 Feb 2025 15:01:42 +0100 Subject: [PATCH 36/36] Update workaround link for expand support in known issues documentation --- docs/standaard/zaken/expand.xlsx | Bin 0 -> 13980 bytes docs/standaard/zaken/known_issues.md | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) create mode 100644 docs/standaard/zaken/expand.xlsx diff --git a/docs/standaard/zaken/expand.xlsx b/docs/standaard/zaken/expand.xlsx new file mode 100644 index 0000000000000000000000000000000000000000..9d9a133b0dce9655a1663672a1a62063491a41be GIT binary patch literal 13980 zcmeHu1zQ|jwszz0?he7Nad#&W+zIYYaQEP@!QJUVaF;-k;O-JUxD)*2oHKLJOlH1c zaBp=#Rb9Pnt*Y9!-sPpD00oT=fCaz<000Vr7*Ei+0|Wp74FdpR0pKC^BtQ-><_<1K z>Yk3~&IT+V_IBh2(2#HP0FbZ8|KIYzcm}G}haA4Lp?7Ed!AG}1XBQCmS$8xXpmf9GpGzRQ+F7zau zD-~2!r5RHfAH|i2k8*knJKX@M*t}%IVng{tNrTH(kI1>#bD{iGyfR!wf~JFEw*vBR z;ZSJks}7_By(_*6uSf7ZWP%-64VL8F7<%k4DlPT*WO4`Jr?B%3 zzE~0POOT0LS3#87bC4l(h9aPUVaL88w+w(~rCM$M-pqm6yX4_xd?+e)M6u&0f#m zq|3;AzH#e_W2kH{%U2j$r;?sNm;8c0&Z0$#fK^N!iYt^JsN1ikvu5(^GsLX8+A%n^ zrimx-AZa|)e?GP3CyGcopW@L}I?kZ8iRI#FpFul{>pMaXH7h>r8j~C+eo9XxGrR6f z$;>XSCm&|ztigAbK+Inp<1zy@dDs5B^}zGtY|lO(gx<=*v!S3Uva+>Ti}jx%IoJv! z(Sia1oZ$cfwAY#Ouw!)xIoXF_u__INxJ+JbUnA=mDBDp+c3K~5E7_C~Ns{t5 z!iLowcBgIx&29^Oy7z7~FP-z~yM>e%&(LB;!l)>jTU51=N?a#THfG*ke5cEQvq+8*san#yw0p-=?v zML7*MD2axFR@G?SRHEpsN7Q zJy2j}IX^KGPns(fx}M>O%ZWhB(y^qrj`&CiM))?G{Aq??QfG9ez~>q)CIfqoOMN+J zcMIr=W;$OSk#jbR>UR@{dmHw$5SmAQ_9(g9<@2`N7oj?YWXj zxy^T0Zf#pQ4^s;B`AU~~VEbZ*ZFTibjUE)nci6ouIg6LjlEty3n}dwn*M%O6=s7|| zcZNLx8cwIIUAb(`R1bTDI8dhnA>_nX);Sa4&e9T>*ouRs zq8^RXq=mNYUfDGDFVaqvNR@#b#d$a^=_)?X@rYUNftEZ4UxVd<&+h*HRrcL|zdl<1 zY>@C1Z3H&y^v0J9XFNYYREeoD5EOZWlA&(h7vbKF(|HA%+)d*1efu`*u7bv~7OqcY zc8SkK$*Mal;f~{t#Y4WhVjwxWM56{092*ow)k*@P$3`aVPZiR$%GYerBjz1xDfmyh zX;TI?GZ#?l}ZI0h~zMJ3{mPsrhvH3ymx(n9989VnT9Dp zq(q75sBL3bUWLu~Iye1F!7EXm^uWA3lNGtmIrl|~_T5~TI}0^WEs!~NYMHQXJYV6` zH{h&tjXpz?U;T+V)4GO{O(ndDmDbJf@W3*(5zu#%e-f$u=-~l27GTkSpAAjUDvejB zq!-~;uj70e8%@|+oS_rEQ-9F-!o4nXsRm2*VuM((g~G@gGh&1|K!>t7~T= zZMcc~UwYYBJ%I$BKB+XnCVe!4BHgzaRLjidB-}Q(C>zU7B({R>To11h`%er83MZ#s zzGAQS)ld-v;2~Zy_?NBvS0w(^Zb7`dm9I$t-@R15Q&Q-Ab*qq`!`R$2-Ec4#U05lP zG!D_=hwAB4UuGWbdS`D=46j-4^p`NFs18%omsGCq&*FB77k(kh4SazoZFrd-P zQ7CwmV=!ru3=9_L(ZONmF%oKqGggam;viEFHt+7QH#7ucg(Z}dS1nVaK$|f(R}LHJ z36k%xdV9EjJK#Pa~qVgx#>RR!U+v zwr!r+1ct$8wCW`Fze?Weazw>>k)$g_F?Psut6~m#Qm0$Vz5R6Pj9*a!9me>L2UB-h z0tg&2c`m`t=9{1vful?JTX3QJY!()tVimIL{RV+Lcm1fe-hDq(jN+o;m z&~oKN^*u;%pcfR9(5m<7B+&jKk&4vy_QXXcqCe=lK)wo+X3|L&k*TAO$f^v{Np6oP z+2SN7?Gd|%i|)9)c2)@3&Af4y4E+A@iLcgs zgo;Ynwzc6emjztyT?k0*a~jc7tDgdUT^aLDGW-41mWj|0m&~(1TFsv>c(!yw_MXG% z*RhcZuxO!(pOMP`=!EfrUKkqyzp;-214sJlmC(QPz;-+l-ov?8_xg08ZsjSI?Cm?o zd64vrrA@KDP5SvlI|575FUE^7pu;g-iZxP?YmU&7&6C(4=;ss-W$HHK3Da+ghT{*F zfCe8OcFjNZqBv+4U@XYAMx8Y!80Fk_Wclta^LW*m_|2kTag@)_%b#BOpW>Qja2&fV zi|UhNOuAtrmuk*R3&CAW($#Ow(Y+R@gqnV|wz{0VaG}HWuIgm2ORPc;XOWCawf5ri zd0=_D`f|8BZG2qB|M8)B{O#M(>9AY>4j=#A=lf&cr>CFgzV~PM^AFWz{)YaKkC!`I zgcrFMFBkXAO)oj?YewsxZ(kZ8WadSD{rqt7x}xIDcpy%vyPls~j&ntxpYHCq4t)pl zM2dPa3dz_v!Y?D^s8Cy~*cN}pAAWa@POD~=Ku%jmOfw%Gpl^zUe*1F<;dv`}y|crY zRrbK_R(7wG>nC>U(12+;g7eI76c^iJJVEZ3wWFep;0OMtcFv@dFS}+Xwr(g|JU2#M z3#>?JCaa*Vk3%e|dRZ4WJ&za!Y==A?nMWoTo5`HhyB2jhTqU&7R%F~$IY%Z-o5|C2 zyJ6QMs9eKdgv8SrZ?j^#n=BLhS8C_-7F&(x*#|qbW)5a{_1p=G2Y7Sura$23P%o_< zjn(zrMdQI5a#>;3#EL;Gb0K_!9Y8>T>yy~vY1*6v0sPs*c2*&l2@$jkoMW}5C@Ni? z-IkFaK#=eB2<;X#Wq2S^&7_JnglN!#bc9!a?thaNojfVfld`(an1pzo$L{*Tgi4z3 zMig40C2GJBG`v~Crc0fKSRtCx4xK=uP}6uoWiu?C$D)nSGu#r@qdAlrdO#$`83xU3 zb)(tJ5#ubTmxgG6_zogAZP8&YwYLNSe#7##{^18pf5fwq^2A>LhLSWf&71V}+B1_V)su zNa{rq)iRMnL@|ve90uKU)>z=**MIWHmQ2U-i+jWBbtOg+`10BUfX+t@^QF` z?WTpQT`N|WFoJD6jV%0*E!H}!DgLi>ShmGt64NM#lsBs(ECNygJ*v7mM1Wr~-!V@WB` z(v*WJT*M9pPf3>!idoHa0D)2k+KlG_tV*R@cb!P8jts0~+G5XR=E1m>fr5f?o?CWI zc&n>)8;gm+>i2UcxRoHzlFBJ;4*nbsQG@0HHw%zH;QH9v*PsnN0rZkrp<&=>U;tcy z5J&4>6AuR4W~*EwmJN$L>S(X5YJw?3%{IA~7G+F~iIn23ow0MhNK!}wyi63`R=VBb zy)akj=r~MdF)LKZiB!~vK^rYdC*`FBImc7`)?uaygP+#Nx=4!j^^qFufDM~1cfM|Z;Ob_gz%d7_2T zc2|t*O{GImIIhL2kXH%GTF#^+{DvfkyyXjLWf}od;ZU6iJQ{@xb+V|}j9jjX;)h&H z@83k3%oFRZ_97%Nlq39+vsjE#k<}pwIj-Cduu3y2=cIIjUbd3c zYS_80KY=({>{hDlU6Ilzm$bw9g8rOCR6tCbGh~@py7`GKBq6v0jN^=kGmSA_Mh9Ew`3okt@K)|d52*w{(Z^ueZB0qzx#byRHoa)1|d~R^iqvdGlI0bnW4*MgdhrwO5Cz^Z+MxStdn2 z7eX5~X?otNsnx_F1#h{R+TI<1{3Nwi%za+Z9QG}zhub0fmyzP4JgB(G!en*1a8l}! zRlV9lMk9#Zu%DG*mmJedPgM2dBu5ekmi>Wfyh-Gftl- zhcF8gngxZo)a>9ZD@gPB)r82j4i! zu35Z|sy+m_j=Le8i9#eXf1l=X87$N{L9`sabzf>?^CB?R&00Iy_E}0R7luP z1w|wZsMGTiD7}N^A1a2nTcwam(KksKxJ61PzKBC@0i$$5;kX7Y%1E<2QA3UOrAK+JT~gf+S? z(~!0-ekw-GML{>5Y^=0-J;N~hL6AjE9p^&pJ9;ZOE!_J44Tc||t1#7}aMZ(FlLPW< zeaUOC>FLqcH!0kCdo^ZAkWLoC%5_;4`wt&*0RRc(%2+jK~5|a{xfEF zpbS{=fa8Z zNhCfF@1|S+akw?mDwM3Dv5ZpMJhYjn4}juDD`T)(`Dqf9)dA0h zmk}i)(%k$8q!T+e{dKPQZZqz6z_i5Gz$bwKFf*GKG$0#cdjf>GMqh~}ZV(=XQ<4h& zMJZ-GYAM3;lOZT? z01v}ZHOKaQl;?wQ0v_;N8GkTHoG}ilr9l3nAv{#JgXYRQ7G;4>?Bg5(1IXAxwT>J# zIY?pzN+zM9AyEW&$4TU8N8ILrPSG&*9UQB6c69S#Q3wO#`L*n)^$25Iqh2Vz+{B<% zxkzef45Tg* zCj1&gZxScB9Yduf^xOiLi~w|`EqO?!*c83{b-Ha8p^8+!TQwMNNij9vj)@y9gfB1T z{Oh3>j@v+i%f7NlC?1m*CYwv{#k6gYz?f}(4Aj_ci>B)#f<4-$I= z8_N)*%1GHq`RSpY{a&?N_)vCDSo}>XzW0>x0~5u_9voTI2SjiVALUE)4-qM7PBEg+` zmnl2kU8P@lA1W#EeNi1OljXi82cVu0qZmJAffEitD-Jz6+eo7Ij2hK(A{GV->?4em z7>^tDp70z+%sHWd+-?%~wsupw6Y>lY@Ml2`p;oRnA!3b%Dhv0w zOu}rafvdKZZX94aDtp{-PYh5oJ>wqEt+fk2qrcm?2{!t9+7|B5{qYJL_n2t-HHKdK zLUt>pe$@2E1MAL)IQe#fpw|eVShlJb|44^yP5KaH4a@`oDOu{G8pub6v6FOL3*T65 z$p}7#JDVx%adC|y|9qUP&o^>J^A*YVsy;8)PH9r2RhJ4la*i*9E~Mz|USt|zT)3Dm z5Z^-tjVsfk>$*aO%)~H9FOGKyCDXGGXX)sh(*IF*Mq@8}d)nMw&+;;ZjHy~erfBDn z1nYms@~*<^)=97cKs4bW<-|W@c^4~ldvn%5*MElbM>={@%hK3>tXCrN9Ri(lwH2XLZ-nE0|JmaA&8` z(euN0u`|yzq~sA(B{nMunK*j;^3#|eAr~vSyYIBW{lSf)&mC>;MQ&i)EB>A?Oe11L zfpltyPrUwETm;Kau(5emRdN0+THFZ+iLGl}}-l#*~vs2rOv6Hr%Z%N%` ztJ?TwM_%1cH9*~N^FGFJ0&VUY8xS+VHWeLpGJV?EDkL&slXo<=**3pFTM27;X|%qv za=tU(&8V`wzTAxlOCdS=`aATNncaFu{Expw(YViIua>{>ZOi2z>w1^ZqwCzYwcz|YtKa?RH&9pC zccJKJ_-~h>oOX}`W@q zoy?yfC^-V=Q^S`W4eUbC+z=T|p$rXIxSB~Ne~P0kjB6Dx08Tii+n5?)H!6-4qRt!> zMvk&ekx1OJ@~QOJDdeM}Z}FVtwM?7|q!;o$g9{|{2$X9aw>jOyznHtY!?SO;zU`;q zvSY{+==(`&f-)2z9WBlf{W%{0qP89*M4jl%V%Mj_20g4*PW^k`noXP`8MrKgdz-I z{oRU0^v^+30c0xdad4I#=Ff$GwK93K9Ze!7*YjG@T@wFHv&QcUE$eoC%=c!{oE=DH^auAcldm}yVKJQQ%< zNe%_|KEb85h2ajNAhQndj$Dg1i@-NMbm5)YpI+PzyXH@juYJ=s0IzI;k#6bpuSA*X z*S2hq$KD%eAm^#tGt7)RbtGiUIHrTJkXM+bzW2+e|B4RZCl`0t-q4!mcIkJX=R6r9 z2y^YS(IhhQ`QEf7#I)(lJ#vh0FQq~QcRn9rb6C~=btrI0bNRaCh#1hQ z9=;hdqUJ_j^Zm2pSc`?19$UE~L`|f&hG@di)a_PR4<{F$@($?|6inTgbn1GJ=n3e( z*>bY1EX&V&Qt~KX9N3jj`FWF8opJgK7<|Pjz{!*#+OZGICF)@?v$I9>5(bCR| zZNi3OSPM9L1&N}7-apo*b$03Tg!&4ZHsoD6xWXg4%O&Ji+;-09XGO7!DI)b6V1v%8 zY33ny?wS&Ui!$Z>g5r141yP=`T9mCNg(q|D6DJq! z5~4g3yct6XH`$h}b)_~0d`iG5zG)R4KHH^lS5Hb8gq0?kT-xSS;6{}8iPky!!#ovm zT^~W+iLD|$VM76DaE4hseeb)vOU7Di2{rqYsiYa*NFxf^Da~mF$!bVYEz0Z1nEhbZ@WO4J($P zK22+H)uQKmQtp^JfAVTL)ne>$IEGMUqKvHcyO}fxz^S^V`+KP#6XhCh&gv|GWRDtF z^fjbs+&s8cXlQ)8jFJ#_Ie}{st6V#PE!OPdeB;^SP&b1Z>`;yu60??vcRxC}5qL;U zUo&4GW;g*#4YI*cZO^0p$)i^ss#WRQE?v5K%a3+pjvOtR6eoy_Zurgi7W7|j*!ldo zK9tuoVkiOtfby3Ob9V8xGk5+Y3Ei%#_jZ{L+b_5N#rRIBPcCyxQx3gYQrradU3$G1 z&xgp5tm#{|F4NBsu}N1!#x*#73Z`Ua{(Hp!dsDxv5+H@x)SSVX#98RkpT4{H%rf*C zfjB|Ys`lj!WfPG!9=$d`seaGc^KMiNo3ZRs0P$Ib&br2od%x^;cDX|=19lj?V(vuU zg^Uy8DCU$r+e-zy(2}4kCQ;8%ngY%0gWWc zO03two$U8o>)V*yCLcD`BE)v9-a=1%7yFlukU;cyXcEqgOhVz1Bh=*fx8N?3BhB;- zH(*N990FO&HWYfZb>(RAGL?z>#fIIg>G;|^unxHwU0U8@`1FKu z-qSV48ocQ2LNDy7s~y*yEb{TNM96+CU%hFr|=oZI0`uy^89?;%E?W!fnl+C znx{C&DfyY?(WorHz+$qv_J~%}%h+y5|uSw+bC3rz$4zS8a`>=;pph3g^`9pgUPAApe2FaID8RLc{$XqzN z%Qxn3+f?&1nC(_!R9rAF%Q+JD`p)lLyl71UjaD~&3z}fpt%}jHYzo~@ zJrCD-nr96mmZuF4zk(Z?C4+7cZM7JB22%)Zk6clh2|BIpJ%aoV#+2zUhncSW&A4wu zp>REuthjFretfeN9;cMZv%ciYFW_S8%!Wz7{0^+}2riE}I zyB9`~*%m|$PeYO2K#_4dijfH(94;WwiVLk9eiMc26BkPi?n4W5kQLY~EZ<2)_}r*( zPr#oHDOcl50q;K?()9wB^88=R?~UOOU;SQjBaQ?BVE+R*R_~q6&D30+tQ{=>gio~Q zDhP`Y-Cw5lrDtg`7+X0jPdR72tfig54T z;l`)`sgE5C>bZFZnCW1rpeyD@>v`> z+ead>0s$jP^%3=@5(mz8c=9_6@=D}NZC$_m1w6X65o31Aj9iRc!;ZefD*j782=&Pd zQgl$s2wA8#_PyqkfHSIt)7^M{SC$c4^sw&W-LiyGq)E{kgWM{dVer`EPU*@NVsIS^ zRl~jrUb{tbX(ZzbT0=p})Fv~mIk=LBnHeTNze$LLKeAEeF6*%CZL4e$Csq+bRYpjf z;P;k&IL3kPAI)~C*(;imO3dk3#hSsFhXJu?&6nZww2gXEIQPvD@omqYY5sPdnxV43 zrG9{+SP1MH;6Wv@=5KW#w_M^c6x)Et*q7MiR&C`4DjiIt3dGICYD=Gqf zk?JH79h_fpLheI$ODDMY(_yirwTkOCzyGV?=Lxa zx^;)M7tXRqW>{b52u}C%6n@6;7RZod=`z5b(Nx--){IY@A!$4}$e@YX9NHq3jn; z-fT0iDvn9zpliujAt36s7AHQE{q}YWSis0aHLQHZ;?}PIZF)A<*3aZLdQT>7BpS4_ z!}?$CoPa%tLeJ}n_$!*J{=(}YMf!i#UH_`u|6P6kvt}O>*Aw}b4O{9K>RH0WJ8AAC zvV~dQCE%uXl9kF@$&W_{w4tM5*U^$TmY68P<$Hgp$7 zG*MMyV}D@;SI?^4aLTmps};;I^iJpbDAt!u(4nwvO!i_tM2;`sShzrzZ&2#^BEUrK z(ETRI))y7J#C~M>^5)f+|7Wz?HznJ%{95VrK?DHk{+a>DS5@U=?xbe!;_`>iV*PEO zoyEl3;Yf4TVOkXZc|}DM20oS;qtwZ2tGs1wl`*Wd_O?oksRVh@Fkim}a)uML`xE?WsS_D{zA+*QWW%GY;s|GN9#jwB=1t2Z zQOL?wy=S1#-iW^vSjOrlWiKRZ*o8V`lxgXeJ6-KqHPY!^6-oYNPPEW0y6~d$v_<+W z6Vy3A?AGvwA=d>j|043PE*uhf0cnIfriH4|aDamk<#JndFr_86$)Z_pdrk0x(i$Sp zqigVvi;K{2LFxPFIGpK;t0BAn10B)21Y zrJ2uQDhhV^V>(p29g=OlhNj-TB?VeoN&qFQU|EaG=xN?ZkYId+wAe-z`GCoDrpf~j z)!-m3|ETzAJ%7Gp7AIX`KhW#6;i)WMuIn|hwo%@dB32_w?6InzV92wJH)DWGk0Cjm zN5gT#^!@`cLY1wT>)Ghsq3hQ0JZRLK;i0<@3UzTUUO8cHlXv4xr(?#CtZ`ZTE2#;B z=M6rQRo#?*FNKK0ffJp0w?=@{TGkH#h99X=&YjhV*)3~fa4O8)gdo@|tGC|fJ~`pG zQQ9r^*u@GI#}By%D$YRu9twSzPPIL@OCQ^+y~0qax|zEFf_+PS&VLoMZ+cqv#@{4I zAn?Axmzf=J|Mt>2^^M5&Q&xvD_RZ{rr=W1HN9u>kABRY$hMmY{l~u}?aeLXO$sA~K z%>#v72d1VgX(-@$|DSpwK4a5E&><+N;C(7Qr=}5axw3Xy1WtYEvFdp>X!I?3~nfOyv>tb zKK+%;`n~IvYTKPi@l`umzhVUAwVB5ZWUAr>a&%@j1v#1jqc!~hdU#$HhfkuaLN6Qk z$90$&i6QUI5?AMtMyM2uGIDKIAEcpGO}nIc$+jo&X}8MRh`1rX+hM*mvta`@xLjkq zVzXFT>_PywRzYGWu~1s2V<6<=C+sRsOs9IdsMK$FI{jQb-@6M{38O2!VRNXNclc%W z_JH3OE|`HM(rXkQ&6*|e$H+!uZTr_3VI46CoL2%&gZM%PjLT#w`N?6(67G9vghU;Y zxq#%^->4~nEgyCRZ^i=+(|I$$A2*!3gbSD>35OSYTUJgkG}_OU_#)@#Zp?>0ly=%^ z4>@QNt0W*Ow?OPB(>sV|Ff^<6pYru$ELu)N7E4xc0XPq$>WhO2N z8Ht?h6TA89HvXrImX$N+i+mM9j914J{a;1!y`$s*N#LvK{bR{W6ay`@A%8rDx+gim1IfKo2*$SrnQ4_d)i(1z!Dc5qtFo`+j_TFA%oHbHYTBdl>O0psbepSRnC6jUgcjR( zmsDxItt3VHsBZQUHSb0fi8si*pn#xb_JZkz4JiaUOvtZ$g_e30#2nRgjCp@ehKXDj8dNThZ?KWZb6 zDXRiB*R@;PjC3pdt8?r!f2lFPW*3ha`~XymYaiMUjdw-zi@R>y1HJcn-1`}JxN}_4 z&T?m9$w?#fT>Jc*EBH%(At0Gw1EBx@hRr{p*FU%a<$W6!g@0%8@4f&3B>ZDr`U;AF zc@yAw!r%L$|0W%IP0|0>9sN7;zc+IJO$q?0yn0Lj|F+KG`TXA9_cy0t