From 3e5a4e6d742c0cd306c6ffcd53ef1052e20dadb4 Mon Sep 17 00:00:00 2001 From: Sonny Bakker Date: Tue, 5 Jul 2022 11:27:59 +0200 Subject: [PATCH] Revert "Merge pull request #207 from VNG-Realisatie/feature/1890-zaken-expand" This reverts commit 4de09c1f36e5747e06d6ebbd907ee7f873a8af00, reversing changes made to 062ec1541f0908dcbaa62bdd877127ad88d90d4d. --- src/openapi.yaml | 8321 +++++++++++++++--------------- src/resources.md | 9 +- src/swagger2.0.json | 392 +- src/zrc/api/filters.py | 20 - src/zrc/api/serializers/core.py | 1159 ++--- src/zrc/api/tests/test_zaken.py | 385 +- src/zrc/api/viewsets.py | 27 +- src/zrc/datamodel/models/core.py | 4 +- src/zrc/utils/serializers.py | 47 - 9 files changed, 5049 insertions(+), 5315 deletions(-) delete mode 100644 src/zrc/utils/serializers.py diff --git a/src/openapi.yaml b/src/openapi.yaml index dab11ce9..59662711 100644 --- a/src/openapi.yaml +++ b/src/openapi.yaml @@ -1,13 +1,12 @@ openapi: 3.0.0 info: title: Zaken API - description: > - Een API om een zaakregistratiecomponent (ZRC) te benaderen. + description: '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 + resources gerelateerd zijn. De Zaken API werkt samen met andere API''s voor Zaakgericht werken om tot volledige functionaliteit te komen. @@ -56,11 +55,15 @@ info: **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 + * `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 + * `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. + * `vertrouwelijkheidaanduiding`: Aanduiding van de mate waarin het zaakdossier + van de ZAAK voor de openbaarheid bestemd is. **Resources en acties** @@ -95,6 +98,8 @@ info: * [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard) * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken) + + ' contact: url: https://vng-realisatie.github.io/gemma-zaken email: standaarden.ondersteuning@vng.nl @@ -103,40 +108,39 @@ info: url: https://opensource.org/licenses/EUPL-1.2 version: 1.3.0-alpha5 security: - - JWT-Claims: [] +- JWT-Claims: [] paths: /klantcontacten: get: operationId: klantcontact_list summary: Alle KLANTCONTACTen opvragen. - description: >- - Alle KLANTCONTACTen opvragen. + description: 'Alle KLANTCONTACTen opvragen. - **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint. + **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' parameters: - - name: zaak - in: query - description: URL-referentie naar de ZAAK. - required: false - schema: - type: string - format: uri - - name: page - in: query - description: Een pagina binnen de gepagineerde set resultaten. - required: false - schema: - type: integer + - name: zaak + in: query + description: URL-referentie naar de ZAAK. + required: false + schema: + type: string + format: uri + - name: page + in: query + description: Een pagina binnen de gepagineerde set resultaten. + required: false + schema: + type: integer responses: - "200": + '200': description: OK 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: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' Warning: schema: type: string @@ -146,8 +150,8 @@ paths: application/json: schema: required: - - count - - results + - count + - results type: object properties: count: @@ -163,77 +167,76 @@ paths: results: type: array items: - $ref: "#/components/schemas/KlantContact" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/KlantContact' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - klantcontacten + - klantcontacten security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen deprecated: true post: operationId: klantcontact_create summary: Maak een KLANTCONTACT bij een ZAAK aan. - description: >- - Indien geen identificatie gegeven is, dan wordt deze automatisch + description: 'Indien geen identificatie gegeven is, dan wordt deze automatisch gegenereerd. - **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint. + **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string requestBody: content: application/json: schema: - $ref: "#/components/schemas/KlantContact" + $ref: '#/components/schemas/KlantContact' required: true responses: - "201": + '201': description: Created 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: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' Location: schema: type: string @@ -247,50 +250,74 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/KlantContact" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/KlantContact' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - klantcontacten + - klantcontacten security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) deprecated: true parameters: [] - "/klantcontacten/{uuid}": + /klantcontacten/{uuid}: get: operationId: klantcontact_read summary: Een specifiek KLANTCONTACT bij een ZAAK opvragen. - description: >- - Een specifiek KLANTCONTACT bij een ZAAK opvragen. + description: 'Een specifiek KLANTCONTACT bij een ZAAK opvragen. - **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint. + **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' + parameters: + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: + ETag: + 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. + schema: + type: string API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' Warning: schema: type: string @@ -299,80 +326,80 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/KlantContact" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/KlantContact' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - klantcontacten + - klantcontacten security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen deprecated: true parameters: - - name: uuid - in: path - description: Unieke resource identifier (UUID4) - required: true - schema: - type: string - format: uuid + - name: uuid + in: path + description: Unieke resource identifier (UUID4) + required: true + schema: + type: string + format: uuid /resultaten: get: operationId: resultaat_list summary: Alle RESULTAATen van ZAAKen opvragen. description: Deze lijst kan gefilterd wordt met query-string parameters. parameters: - - name: zaak - in: query - description: URL-referentie naar de ZAAK. - required: false - schema: - type: string - format: uri - - name: resultaattype - in: query - description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API). - required: false - schema: - type: string - format: uri - - name: page - in: query - description: Een pagina binnen de gepagineerde set resultaten. - required: false - schema: - type: integer + - name: zaak + in: query + description: URL-referentie naar de ZAAK. + required: false + schema: + type: string + format: uri + - name: resultaattype + in: query + description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API). + required: false + schema: + type: string + format: uri + - name: page + in: query + description: Een pagina binnen de gepagineerde set resultaten. + required: false + schema: + type: integer responses: - "200": + '200': description: OK 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: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: required: - - count - - results + - count + - results type: object properties: count: @@ -388,69 +415,70 @@ paths: results: type: array items: - $ref: "#/components/schemas/Resultaat" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/Resultaat' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - resultaten + - resultaten security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen post: operationId: resultaat_create summary: Maak een RESULTAAT bij een ZAAK aan. - description: |- - **Er wordt gevalideerd op** + description: '**Er wordt gevalideerd op** + - geldigheid URL naar de ZAAK - - geldigheid URL naar het RESULTAATTYPE + + - geldigheid URL naar het RESULTAATTYPE' parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string requestBody: - $ref: "#/components/requestBodies/Resultaat" + $ref: '#/components/requestBodies/Resultaat' responses: - "201": + '201': description: Created 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: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' Location: schema: type: string @@ -459,443 +487,469 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/Resultaat" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/Resultaat' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - resultaten + - resultaten security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) parameters: [] - "/resultaten/{uuid}": + /resultaten/{uuid}: get: operationId: resultaat_read summary: Een specifiek RESULTAAT opvragen. description: Een specifiek RESULTAAT opvragen. parameters: - - name: If-None-Match - in: header - 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. - required: false - examples: - oneValue: - summary: Eén ETag-waarde - value: '"79054025255fb1a26e4bc422aef54eb4"' - multipleValues: - summary: Meerdere ETag-waardes - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - schema: - type: string + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: ETag: - 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. + 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. schema: type: string API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: '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" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/Resultaat' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - resultaten + - resultaten security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen head: operationId: resultaat_headers summary: De headers voor een specifiek(e) RESULTAAT opvragen description: Vraag de headers op die je bij een GET request zou krijgen. + parameters: + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: + ETag: + 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. + schema: + type: string API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' tags: - - resultaten + - resultaten security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen put: operationId: resultaat_update summary: Werk een RESULTAAT in zijn geheel bij. - description: |- - **Er wordt gevalideerd op** + description: '**Er wordt gevalideerd op** + - geldigheid URL naar de ZAAK - - het RESULTAATTYPE mag niet gewijzigd worden + + - het RESULTAATTYPE mag niet gewijzigd worden' parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string requestBody: - $ref: "#/components/requestBodies/Resultaat" + $ref: '#/components/requestBodies/Resultaat' responses: - "200": + '200': description: OK 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: '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" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/Resultaat' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - resultaten + - resultaten security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) patch: operationId: resultaat_partial_update summary: Werk een RESULTAAT deels bij. - description: |- - **Er wordt gevalideerd op** + description: '**Er wordt gevalideerd op** + - geldigheid URL naar de ZAAK - - het RESULTAATTYPE mag niet gewijzigd worden + + - het RESULTAATTYPE mag niet gewijzigd worden' parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string requestBody: - $ref: "#/components/requestBodies/Resultaat" + $ref: '#/components/requestBodies/Resultaat' responses: - "200": + '200': description: OK 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: '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" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/Resultaat' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - resultaten + - resultaten security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) delete: operationId: resultaat_delete summary: Verwijder een RESULTAAT van een ZAAK. description: Verwijder een RESULTAAT van een ZAAK. parameters: - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string responses: - "204": + '204': description: No content headers: API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - resultaten + - resultaten security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) parameters: - - name: uuid - in: path - description: Unieke resource identifier (UUID4) - required: true - schema: - type: string - format: uuid + - name: uuid + in: path + description: Unieke resource identifier (UUID4) + required: true + schema: + type: string + format: uuid /rollen: get: operationId: rol_list summary: Alle ROLlen bij ZAAKen opvragen. description: Deze lijst kan gefilterd wordt met query-string parameters. parameters: - - name: zaak - in: query - description: URL-referentie naar de ZAAK. - required: false - schema: - type: string - format: uri - - name: betrokkene - in: query - description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. - required: false - schema: - type: string - format: uri - - name: betrokkeneType - in: query - description: Type van de `betrokkene`. - required: false - schema: - type: string - enum: - - natuurlijk_persoon - - niet_natuurlijk_persoon - - vestiging - - organisatorische_eenheid - - medewerker - - name: betrokkeneIdentificatie__natuurlijkPersoon__inpBsn - in: query - description: Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene - bepalingen burgerservicenummer. - required: false - schema: - type: string - - name: betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie - in: query - description: Het door de gemeente uitgegeven unieke nummer voor een ANDER - NATUURLIJK PERSOON - required: false - schema: - type: string - - name: betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer - in: query - description: Het administratienummer van de persoon, bedoeld in de Wet BRP - required: false - schema: - type: string - - name: betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId - in: query - description: Het door een kamer toegekend uniek nummer voor de INGESCHREVEN - NIET-NATUURLIJK PERSOON - required: false - schema: - type: string - - name: betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie - in: query - description: Het door de gemeente uitgegeven unieke nummer voor een ANDER - NIET-NATUURLIJK PERSOON - required: false - schema: - type: string - - name: betrokkeneIdentificatie__vestiging__vestigingsNummer - in: query - description: Een korte unieke aanduiding van de Vestiging. - required: false - schema: - type: string - - name: betrokkeneIdentificatie__organisatorischeEenheid__identificatie - in: query - description: Een korte identificatie van de organisatorische eenheid. - required: false - schema: - type: string - - name: betrokkeneIdentificatie__medewerker__identificatie - in: query - description: Een korte unieke aanduiding van de MEDEWERKER. - required: false - schema: - type: string - - name: roltype - in: query - description: URL-referentie naar een roltype binnen het ZAAKTYPE van de ZAAK. - required: false - schema: - type: string - format: uri - - name: omschrijving - in: query - description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. - required: false - schema: - type: string - - name: omschrijvingGeneriek - in: query - description: Algemeen gehanteerde benaming van de aard van de ROL, afgeleid uit - het ROLTYPE. - required: false - schema: - type: string - enum: - - adviseur - - behandelaar - - belanghebbende - - beslisser - - initiator - - klantcontacter - - zaakcoordinator - - mede_initiator - - name: page - in: query - description: Een pagina binnen de gepagineerde set resultaten. - required: false - schema: - type: integer + - name: zaak + in: query + description: URL-referentie naar de ZAAK. + required: false + schema: + type: string + format: uri + - name: betrokkene + in: query + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + required: false + schema: + type: string + format: uri + - name: betrokkeneType + in: query + description: Type van de `betrokkene`. + required: false + schema: + type: string + enum: + - natuurlijk_persoon + - niet_natuurlijk_persoon + - vestiging + - organisatorische_eenheid + - medewerker + - name: betrokkeneIdentificatie__natuurlijkPersoon__inpBsn + in: query + description: Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene + bepalingen burgerservicenummer. + required: false + schema: + type: string + - name: betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie + in: query + description: Het door de gemeente uitgegeven unieke nummer voor een ANDER + NATUURLIJK PERSOON + required: false + schema: + type: string + - name: betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer + in: query + description: Het administratienummer van de persoon, bedoeld in de Wet BRP + required: false + schema: + type: string + - name: betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId + in: query + description: Het door een kamer toegekend uniek nummer voor de INGESCHREVEN + NIET-NATUURLIJK PERSOON + required: false + schema: + type: string + - name: betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie + in: query + description: Het door de gemeente uitgegeven unieke nummer voor een ANDER + NIET-NATUURLIJK PERSOON + required: false + schema: + type: string + - name: betrokkeneIdentificatie__vestiging__vestigingsNummer + in: query + description: Een korte unieke aanduiding van de Vestiging. + required: false + schema: + type: string + - name: betrokkeneIdentificatie__organisatorischeEenheid__identificatie + in: query + description: Een korte identificatie van de organisatorische eenheid. + required: false + schema: + type: string + - name: betrokkeneIdentificatie__medewerker__identificatie + in: query + description: Een korte unieke aanduiding van de MEDEWERKER. + required: false + schema: + type: string + - name: roltype + in: query + description: URL-referentie naar een roltype binnen het ZAAKTYPE van de ZAAK. + required: false + schema: + type: string + format: uri + - name: omschrijving + in: query + description: Omschrijving van de aard van de ROL, afgeleid uit het ROLTYPE. + required: false + schema: + type: string + - name: omschrijvingGeneriek + in: query + description: Algemeen gehanteerde benaming van de aard van de ROL, afgeleid + uit het ROLTYPE. + required: false + schema: + type: string + enum: + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator + - name: page + in: query + description: Een pagina binnen de gepagineerde set resultaten. + required: false + schema: + type: integer responses: - "200": + '200': description: OK 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: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: required: - - count - - results + - count + - results type: object properties: count: @@ -911,70 +965,70 @@ paths: results: type: array items: - $ref: "#/components/schemas/Rol" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/Rol' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - rollen + - rollen security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen post: operationId: rol_create summary: Maak een ROL aan bij een ZAAK. description: Maak een ROL aan bij een ZAAK. parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string requestBody: content: application/json: schema: - $ref: "#/components/schemas/Rol" + $ref: '#/components/schemas/Rol' required: true responses: - "201": + '201': description: Created 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: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' Location: schema: type: string @@ -983,214 +1037,238 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/Rol" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/Rol' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - rollen + - rollen security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) parameters: [] - "/rollen/{uuid}": + /rollen/{uuid}: get: operationId: rol_read summary: Een specifieke ROL bij een ZAAK opvragen. description: Een specifieke ROL bij een ZAAK opvragen. parameters: - - name: If-None-Match - in: header - 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. - required: false - examples: - oneValue: - summary: Eén ETag-waarde - value: '"79054025255fb1a26e4bc422aef54eb4"' - multipleValues: - summary: Meerdere ETag-waardes - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - schema: - type: string + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: ETag: - 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. + 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. schema: type: string API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: '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" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/Rol' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - rollen + - rollen security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen head: operationId: rol_headers summary: De headers voor een specifiek(e) ROL opvragen description: Vraag de headers op die je bij een GET request zou krijgen. + parameters: + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: + ETag: + 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. + schema: + type: string API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' tags: - - rollen + - rollen security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen delete: operationId: rol_delete summary: Verwijder een ROL van een ZAAK. description: Verwijder een ROL van een ZAAK. parameters: - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string responses: - "204": + '204': description: No content headers: API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - rollen + - rollen security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) parameters: - - name: uuid - in: path - description: Unieke resource identifier (UUID4) - required: true - schema: - type: string - format: uuid + - name: uuid + in: path + description: Unieke resource identifier (UUID4) + required: true + schema: + type: string + format: uuid /statussen: get: operationId: status_list summary: Alle STATUSsen van ZAAKen opvragen. description: Deze lijst kan gefilterd wordt met query-string parameters. parameters: - - name: zaak - in: query - description: URL-referentie naar de ZAAK. - required: false - schema: - type: string - format: uri - - name: statustype - in: query - description: URL-referentie naar het STATUSTYPE (in de Catalogi API). - required: false - schema: - type: string - format: uri - - name: page - in: query - description: Een pagina binnen de gepagineerde set resultaten. - required: false - schema: - type: integer - responses: - "200": - description: OK - headers: + - name: zaak + in: query + description: URL-referentie naar de ZAAK. + required: false + schema: + type: string + format: uri + - name: statustype + in: query + description: URL-referentie naar het STATUSTYPE (in de Catalogi API). + required: false + schema: + type: string + format: uri + - name: page + in: query + description: Een pagina binnen de gepagineerde set resultaten. + required: false + schema: + type: integer + responses: + '200': + description: OK + 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: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: required: - - count - - results + - count + - results type: object properties: count: @@ -1206,80 +1284,75 @@ paths: results: type: array items: - $ref: "#/components/schemas/Status" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/Status' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - statussen + - statussen security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen post: operationId: status_create summary: Maak een STATUS aan voor een ZAAK. - 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 die aan - de zaak gerelateerd zijn - - **Opmerkingen** - - Indien het statustype de eindstatus is (volgens het ZTC), dan wordt de - zaak afgesloten door de einddatum te zetten. + description: "**Er wordt gevalideerd op**\n- geldigheid URL naar de ZAAK\n-\ + \ geldigheid URL naar het STATUSTYPE\n- indien het de eindstatus betreft,\ + \ dan moet het attribuut\n `indicatieGebruiksrecht` gezet zijn op alle informatieobjecten\ + \ die aan\n de zaak gerelateerd zijn\n\n**Opmerkingen**\n- Indien het statustype\ + \ de eindstatus is (volgens het ZTC), dan wordt de\n zaak afgesloten door\ + \ de einddatum te zetten." parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string requestBody: content: application/json: schema: - $ref: "#/components/schemas/Status" + $ref: '#/components/schemas/Status' required: true responses: - "201": + '201': description: Created 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: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' Location: schema: type: string @@ -1288,224 +1361,249 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/Status" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/Status' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - statussen + - statussen security: - - JWT-Claims: - - (zaken.aanmaken | zaken.statussen.toevoegen | zaken.heropenen) + - JWT-Claims: + - (zaken.aanmaken | zaken.statussen.toevoegen | zaken.heropenen) parameters: [] - "/statussen/{uuid}": + /statussen/{uuid}: get: operationId: status_read summary: Een specifieke STATUS van een ZAAK opvragen. description: Een specifieke STATUS van een ZAAK opvragen. parameters: - - name: If-None-Match - in: header - 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. - required: false - examples: - oneValue: - summary: Eén ETag-waarde - value: '"79054025255fb1a26e4bc422aef54eb4"' - multipleValues: - summary: Meerdere ETag-waardes - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - schema: - type: string + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: ETag: - 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. + 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. schema: type: string API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: '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" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/Status' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - statussen + - statussen security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen head: operationId: status_headers summary: De headers voor een specifiek(e) STATUS opvragen description: Vraag de headers op die je bij een GET request zou krijgen. + parameters: + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: + ETag: + 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. + schema: + type: string API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' tags: - - statussen + - statussen security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen parameters: - - name: uuid - in: path - description: Unieke resource identifier (UUID4) - required: true - schema: - type: string - format: uuid + - name: uuid + in: path + description: Unieke resource identifier (UUID4) + required: true + schema: + type: string + format: uuid /zaakcontactmomenten: get: operationId: zaakcontactmoment_list summary: Alle ZAAKCONTACTMOMENTen opvragen. description: Alle ZAAKCONTACTMOMENTen opvragen. parameters: - - name: zaak - in: query - description: URL-referentie naar de ZAAK. - required: false - schema: - type: string - format: uri - - name: contactmoment - in: query - description: URL-referentie naar het CONTACTMOMENT (in de Klantinteractie API) - required: false - schema: - type: string - format: uri + - name: zaak + in: query + description: URL-referentie naar de ZAAK. + required: false + schema: + type: string + format: uri + - name: contactmoment + in: query + description: URL-referentie naar het CONTACTMOMENT (in de Klantinteractie + API) + required: false + schema: + type: string + format: uri responses: - "200": + '200': description: OK 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: '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" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakContactMoment' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakcontactmomenten + - zaakcontactmomenten security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen post: operationId: zaakcontactmoment_create summary: Maak een ZAAKCONTACTMOMENT aan. - description: |- - **Er wordt gevalideerd op** - - geldigheid URL naar de CONTACTMOMENT + description: '**Er wordt gevalideerd op** + + - geldigheid URL naar de CONTACTMOMENT' parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string requestBody: content: application/json: schema: - $ref: "#/components/schemas/ZaakContactMoment" + $ref: '#/components/schemas/ZaakContactMoment' required: true responses: - "201": + '201': description: Created 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: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' Location: schema: type: string @@ -1514,252 +1612,255 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ZaakContactMoment" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakContactMoment' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakcontactmomenten + - zaakcontactmomenten security: - - JWT-Claims: - - zaken.bijwerken + - JWT-Claims: + - zaken.bijwerken parameters: [] - "/zaakcontactmomenten/{uuid}": + /zaakcontactmomenten/{uuid}: get: operationId: zaakcontactmoment_read summary: Een specifiek ZAAKCONTACTMOMENT opvragen. description: Een specifiek ZAAKCONTACTMOMENT opvragen. + parameters: + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: + ETag: + 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. + schema: + type: string API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: '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" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakContactMoment' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakcontactmomenten + - zaakcontactmomenten security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen delete: operationId: zaakcontactmoment_delete description: Verwijder een ZAAKCONTACTMOMENT. parameters: - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string responses: - "204": + '204': description: No content headers: API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakcontactmomenten + - zaakcontactmomenten security: - - JWT-Claims: - - zaken.bijwerken + - JWT-Claims: + - zaken.bijwerken parameters: - - name: uuid - in: path - description: Unieke resource identifier (UUID4) - required: true - schema: - type: string - format: uuid + - name: uuid + in: path + description: Unieke resource identifier (UUID4) + required: true + schema: + type: string + format: uuid /zaakinformatieobjecten: get: operationId: zaakinformatieobject_list summary: Alle ZAAK-INFORMATIEOBJECT relaties opvragen. description: Deze lijst kan gefilterd wordt met querystringparameters. parameters: - - name: zaak - in: query - description: URL-referentie naar de ZAAK. - required: false - schema: - type: string - format: uri - - name: informatieobject - in: query - description: URL-referentie naar het INFORMATIEOBJECT (in de Documenten API), - waar ook de relatieinformatie opgevraagd kan worden. - required: false - schema: - type: string - format: uri + - name: zaak + in: query + description: URL-referentie naar de ZAAK. + required: false + schema: + type: string + format: uri + - name: informatieobject + in: query + description: URL-referentie naar het INFORMATIEOBJECT (in de Documenten API), + waar ook de relatieinformatie opgevraagd kan worden. + required: false + schema: + type: string + format: uri responses: - "200": + '200': description: OK 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: '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" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakInformatieObject' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakinformatieobjecten + - zaakinformatieobjecten security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen post: operationId: zaakinformatieobject_create summary: Maak een ZAAK-INFORMATIEOBJECT relatie aan. - description: >- - Er worden twee types van - - relaties met andere objecten gerealiseerd: - - - **Er wordt gevalideerd op** - - - geldigheid zaak URL - - - geldigheid informatieobject URL - - - de combinatie informatieobject en zaak moet uniek zijn - - - **Opmerkingen** - - - De registratiedatum wordt door het systeem op 'NU' gezet. De `aardRelatie` - wordt ook door het systeem gezet. - - Bij het aanmaken wordt ook in de Documenten API de gespiegelde relatie aangemaakt, - echter zonder de relatie-informatie. - - Registreer welk(e) INFORMATIEOBJECT(en) een ZAAK kent. - - - **Er wordt gevalideerd op** - - - geldigheid informatieobject URL - - - uniek zijn van relatie ZAAK-INFORMATIEOBJECT + description: "Er worden twee types van\nrelaties met andere objecten gerealiseerd:\n\ + \n**Er wordt gevalideerd op**\n- geldigheid zaak URL\n- geldigheid informatieobject\ + \ URL\n- de combinatie informatieobject en zaak moet uniek zijn\n\n**Opmerkingen**\n\ + - De registratiedatum wordt door het systeem op 'NU' gezet. De `aardRelatie`\n\ + \ wordt ook door het systeem gezet.\n- Bij het aanmaken wordt ook in de Documenten\ + \ API de gespiegelde relatie aangemaakt,\n echter zonder de relatie-informatie.\n\ + \nRegistreer welk(e) INFORMATIEOBJECT(en) een ZAAK kent.\n\n**Er wordt gevalideerd\ + \ op**\n- geldigheid informatieobject URL\n- uniek zijn van relatie ZAAK-INFORMATIEOBJECT" parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string requestBody: - $ref: "#/components/requestBodies/ZaakInformatieObject" + $ref: '#/components/requestBodies/ZaakInformatieObject' responses: - "201": + '201': description: Created 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: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' Location: schema: type: string @@ -1768,396 +1869,424 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ZaakInformatieObject" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakInformatieObject' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakinformatieobjecten + - zaakinformatieobjecten security: - - JWT-Claims: - - (zaken.aanmaken | zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.aanmaken | zaken.bijwerken | zaken.geforceerd-bijwerken) parameters: [] - "/zaakinformatieobjecten/{uuid}": + /zaakinformatieobjecten/{uuid}: get: operationId: zaakinformatieobject_read summary: Een specifieke ZAAK-INFORMATIEOBJECT relatie opvragen. description: Een specifieke ZAAK-INFORMATIEOBJECT relatie opvragen. parameters: - - name: If-None-Match - in: header - 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. - required: false - examples: - oneValue: - summary: Eén ETag-waarde - value: '"79054025255fb1a26e4bc422aef54eb4"' - multipleValues: - summary: Meerdere ETag-waardes - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - schema: - type: string + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: ETag: - 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. + 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. schema: type: string API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: '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" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakInformatieObject' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakinformatieobjecten + - zaakinformatieobjecten security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen head: operationId: zaakinformatieobject_headers summary: De headers voor een specifiek(e) ZAAKINFORMATIEOBJECT opvragen description: Vraag de headers op die je bij een GET request zou krijgen. + parameters: + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: + ETag: + 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. + schema: + type: string API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' tags: - - zaakinformatieobjecten + - zaakinformatieobjecten security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen put: operationId: zaakinformatieobject_update summary: Werk een ZAAK-INFORMATIEOBJECT relatie in zijn geheel bij. - description: |- - Je mag enkel de gegevens + description: 'Je mag enkel de gegevens + van de relatie bewerken, en niet de relatie zelf aanpassen. + **Er wordt gevalideerd op** - - informatieobject URL en zaak URL mogen niet veranderen + + - informatieobject URL en zaak URL mogen niet veranderen' parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string requestBody: - $ref: "#/components/requestBodies/ZaakInformatieObject" + $ref: '#/components/requestBodies/ZaakInformatieObject' responses: - "200": + '200': description: OK 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: '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" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakInformatieObject' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakinformatieobjecten + - zaakinformatieobjecten security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) patch: operationId: zaakinformatieobject_partial_update summary: Werk een ZAAK-INFORMATIEOBJECT relatie in deels bij. - description: |- - Je mag enkel de gegevens + description: 'Je mag enkel de gegevens + van de relatie bewerken, en niet de relatie zelf aanpassen. + **Er wordt gevalideerd op** - - informatieobject URL en zaak URL mogen niet veranderen + + - informatieobject URL en zaak URL mogen niet veranderen' parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string requestBody: - $ref: "#/components/requestBodies/ZaakInformatieObject" + $ref: '#/components/requestBodies/ZaakInformatieObject' responses: - "200": + '200': description: OK 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: '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" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakInformatieObject' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakinformatieobjecten + - zaakinformatieobjecten security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) delete: operationId: zaakinformatieobject_delete summary: Verwijder een ZAAK-INFORMATIEOBJECT relatie. - description: |- - De gespiegelde relatie in de Documenten API wordt door de Zaken API - verwijderd. Consumers kunnen dit niet handmatig doen.. + description: 'De gespiegelde relatie in de Documenten API wordt door de Zaken + API + + verwijderd. Consumers kunnen dit niet handmatig doen..' parameters: - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string responses: - "204": + '204': description: No content headers: API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakinformatieobjecten + - zaakinformatieobjecten security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken | zaken.verwijderen) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken | zaken.verwijderen) parameters: - - name: uuid - in: path - description: Unieke resource identifier (UUID4) - required: true - schema: - type: string - format: uuid + - name: uuid + in: path + description: Unieke resource identifier (UUID4) + required: true + schema: + type: string + format: uuid /zaakobjecten: get: operationId: zaakobject_list summary: Alle ZAAKOBJECTen opvragen. description: Deze lijst kan gefilterd wordt met query-string parameters. parameters: - - name: zaak - in: query - description: URL-referentie naar de ZAAK. - required: false - schema: - type: string - format: uri - - name: object - in: query - description: URL-referentie naar de resource die het OBJECT beschrijft. - required: false - schema: - type: string - format: uri - - name: objectType - 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`. - required: false - 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 - in: query - description: Een pagina binnen de gepagineerde set resultaten. - required: false - schema: - type: integer + - name: zaak + in: query + description: URL-referentie naar de ZAAK. + required: false + schema: + type: string + format: uri + - name: object + in: query + description: URL-referentie naar de resource die het OBJECT beschrijft. + required: false + schema: + type: string + format: uri + - name: objectType + 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`. + required: false + 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 + in: query + description: Een pagina binnen de gepagineerde set resultaten. + required: false + schema: + type: integer responses: - "200": + '200': description: OK 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: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: required: - - count - - results + - count + - results type: object properties: count: @@ -2173,76 +2302,69 @@ paths: results: type: array items: - $ref: "#/components/schemas/ZaakObject" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakObject' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakobjecten + - zaakobjecten security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen post: operationId: zaakobject_create summary: Maak een ZAAKOBJECT aan. - 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. + description: "Maak een ZAAKOBJECT aan.\n\n**Er wordt gevalideerd op**\n\n- Indien\ + \ de `object` URL opgegeveven is, dan moet deze een geldige response\n (HTTP\ + \ 200) geven.\n- Indien opgegeven, dan wordt `objectIdentificatie` gevalideerd\ + \ tegen de\n `objectType` discriminator." parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string requestBody: - $ref: "#/components/requestBodies/ZaakObject" + $ref: '#/components/requestBodies/ZaakObject' responses: - "201": + '201': description: Created 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: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' Location: schema: type: string @@ -2251,340 +2373,354 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ZaakObject" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakObject' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakobjecten + - zaakobjecten security: - - JWT-Claims: - - (zaken.aanmaken | zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.aanmaken | zaken.bijwerken | zaken.geforceerd-bijwerken) parameters: [] - "/zaakobjecten/{uuid}": + /zaakobjecten/{uuid}: get: operationId: zaakobject_read summary: Een specifiek ZAAKOBJECT opvragen. description: Een specifiek ZAAKOBJECT opvragen. + parameters: + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: + ETag: + 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. + schema: + type: string API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: '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" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakObject' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakobjecten + - zaakobjecten security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen put: operationId: zaakobject_update summary: Werk een ZAAKOBJECT in zijn geheel bij. - description: >- - **Er wordt gevalideerd op** - - - - De attributen `zaak`, `object` en `objectType` mogen niet gewijzigd worden. - - - Indien opgegeven, dan wordt `objectIdentificatie` gevalideerd tegen de - `objectType` discriminator. + description: "**Er wordt gevalideerd op**\n\n- De attributen `zaak`, `object`\ + \ en `objectType` mogen niet gewijzigd worden.\n- Indien opgegeven, dan wordt\ + \ `objectIdentificatie` gevalideerd tegen de\n `objectType` discriminator." parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json requestBody: - $ref: "#/components/requestBodies/ZaakObject" + $ref: '#/components/requestBodies/ZaakObject' responses: - "200": + '200': description: OK 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: '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" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakObject' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakobjecten + - zaakobjecten security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) patch: operationId: zaakobject_partial_update summary: Werk een ZAAKOBJECT deels bij. - description: >- - **Er wordt gevalideerd op** - - - - De attributen `zaak`, `object` en `objectType` mogen niet gewijzigd worden. - - - Indien opgegeven, dan wordt `objectIdentificatie` gevalideerd tegen de - `objectType` discriminator. + description: "**Er wordt gevalideerd op**\n\n- De attributen `zaak`, `object`\ + \ en `objectType` mogen niet gewijzigd worden.\n- Indien opgegeven, dan wordt\ + \ `objectIdentificatie` gevalideerd tegen de\n `objectType` discriminator." parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - requestBody: - $ref: "#/components/requestBodies/ZaakObject" - responses: - "200": + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/ZaakObject' + responses: + '200': description: OK 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: '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" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakObject' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakobjecten + - zaakobjecten security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) delete: operationId: zaakobject_delete summary: Verwijder een ZAAKOBJECT. - description: >- - Verbreek de relatie tussen een ZAAK en een OBJECT door de ZAAKOBJECT + description: 'Verbreek de relatie tussen een ZAAK en een OBJECT door de ZAAKOBJECT resource te - verwijderen. + verwijderen.' responses: - "204": + '204': description: No content headers: API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakobjecten + - zaakobjecten security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken | zaken.verwijderen) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken | zaken.verwijderen) parameters: - - name: uuid - in: path - description: Unieke resource identifier (UUID4) - required: true - schema: - type: string - format: uuid + - name: uuid + in: path + description: Unieke resource identifier (UUID4) + required: true + schema: + type: string + format: uuid /zaakverzoeken: get: operationId: zaakverzoek_list summary: Alle ZAAK-VERZOEK opvragen. description: Alle ZAAK-VERZOEK opvragen. parameters: - - name: zaak - in: query - description: URL-referentie naar de ZAAK. - required: false - schema: - type: string - format: uri - - name: verzoek - in: query - description: URL-referentie naar het VERZOEK (in de Klantinteractie API) - required: false - schema: - type: string - format: uri + - name: zaak + in: query + description: URL-referentie naar de ZAAK. + required: false + schema: + type: string + format: uri + - name: verzoek + in: query + description: URL-referentie naar het VERZOEK (in de Klantinteractie API) + required: false + schema: + type: string + format: uri responses: - "200": + '200': description: OK 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: '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" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakVerzoek' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakverzoeken + - zaakverzoeken security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen post: operationId: zaakverzoek_create summary: Maak een ZAAK-VERZOEK aan. - description: |- - **Er wordt gevalideerd op** - - geldigheid URL naar de VERZOEK + description: '**Er wordt gevalideerd op** + + - geldigheid URL naar de VERZOEK' parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string requestBody: content: application/json: schema: - $ref: "#/components/schemas/ZaakVerzoek" + $ref: '#/components/schemas/ZaakVerzoek' required: true responses: - "201": + '201': description: Created 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: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' Location: schema: type: string @@ -2593,441 +2729,448 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ZaakVerzoek" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakVerzoek' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakverzoeken + - zaakverzoeken security: - - JWT-Claims: - - zaken.bijwerken + - JWT-Claims: + - zaken.bijwerken parameters: [] - "/zaakverzoeken/{uuid}": + /zaakverzoeken/{uuid}: get: operationId: zaakverzoek_read summary: Een specifiek ZAAK-VERZOEK opvragen. description: Een specifiek ZAAK-VERZOEK opvragen. + parameters: + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: + ETag: + 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. + schema: + type: string API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: '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" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakVerzoek' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakverzoeken + - zaakverzoeken security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen delete: operationId: zaakverzoek_delete description: Verwijder een ZAAK-VERZOEK. parameters: - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string responses: - "204": + '204': description: No content headers: API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaakverzoeken + - zaakverzoeken security: - - JWT-Claims: - - zaken.bijwerken + - JWT-Claims: + - zaken.bijwerken parameters: - - name: uuid - in: path - description: Unieke resource identifier (UUID4) - required: true - schema: - type: string - format: uuid + - name: uuid + in: path + description: Unieke resource identifier (UUID4) + required: true + schema: + type: string + format: uuid /zaken: get: operationId: zaak_list summary: Alle ZAAKen opvragen. - description: >- - Deze lijst kan gefilterd wordt met query-string parameters. - - - **Opmerking** - - - er worden enkel zaken getoond van de zaaktypes waar u toe geautoriseerd - bent. + description: "Deze lijst kan gefilterd wordt met query-string parameters.\n\n\ + **Opmerking**\n- er worden enkel zaken getoond van de zaaktypes waar u toe\ + \ geautoriseerd\n bent." parameters: - - name: identificatie - in: query - description: De unieke identificatie van de ZAAK binnen de organisatie die - verantwoordelijk is voor de behandeling van de ZAAK. - required: false - schema: - type: string - - name: bronorganisatie - 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 - required: false - schema: - type: string - - name: zaaktype - in: query - description: URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de - CATALOGUS waar deze voorkomt - required: false - schema: - type: string - format: uri - - name: archiefnominatie - in: query - description: Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - required: false - schema: - type: string - enum: - - blijvend_bewaren - - vernietigen - - name: archiefnominatie__in - in: query - description: Multiple values may be separated by commas. - required: false - schema: - type: string - - name: archiefactiedatum - 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. - required: false - schema: - type: string - - name: archiefactiedatum__lt - 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. - required: false - schema: - type: string - - name: archiefactiedatum__gt - 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. - required: false - schema: - type: string - - name: archiefstatus - in: query - description: Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde - termijn vernietigd moet worden. - required: false - schema: - type: string - enum: - - nog_te_archiveren - - gearchiveerd - - gearchiveerd_procestermijn_onbekend - - overgedragen - - name: archiefstatus__in - in: query - description: Multiple values may be separated by commas. - required: false - schema: - type: string - - name: startdatum - in: query - description: De datum waarop met de uitvoering van de zaak is gestart - required: false - schema: - type: string - - name: startdatum__gt - in: query - description: De datum waarop met de uitvoering van de zaak is gestart - required: false - schema: - type: string - - name: startdatum__gte - in: query - description: De datum waarop met de uitvoering van de zaak is gestart - required: false - schema: - type: string - - name: startdatum__lt - in: query - description: De datum waarop met de uitvoering van de zaak is gestart - required: false - schema: - type: string - - name: startdatum__lte - in: query - description: De datum waarop met de uitvoering van de zaak is gestart - required: false - schema: - type: string - - name: rol__betrokkeneType - in: query - description: Type van de `betrokkene`. - required: false - schema: - type: string - enum: - - natuurlijk_persoon - - niet_natuurlijk_persoon - - vestiging - - organisatorische_eenheid - - medewerker - - name: rol__betrokkene - in: query - description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. - required: false - schema: - type: string - format: uri - - name: rol__omschrijvingGeneriek - in: query - description: Algemeen gehanteerde benaming van de aard van de ROL, afgeleid uit - het ROLTYPE. - required: false - schema: - type: string - enum: - - adviseur - - behandelaar - - belanghebbende - - beslisser - - initiator - - klantcontacter - - zaakcoordinator - - mede_initiator - - name: maximaleVertrouwelijkheidaanduiding - in: query - description: Zaken met een vertrouwelijkheidaanduiding die beperkter is dan de - aangegeven aanduiding worden uit de resultaten gefiltered. - required: false - schema: - type: string - enum: - - openbaar - - beperkt_openbaar - - intern - - zaakvertrouwelijk - - vertrouwelijk - - confidentieel - - geheim - - zeer_geheim - - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn - in: query - description: Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene - bepalingen burgerservicenummer. - required: false - schema: - type: string - maxLength: 9 - - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie - in: query - description: Het door de gemeente uitgegeven unieke nummer voor een ANDER - NATUURLIJK PERSOON - required: false - schema: - type: string - maxLength: 17 - - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer - in: query - description: Het administratienummer van de persoon, bedoeld in de Wet BRP - required: false - schema: - type: string - maxLength: 10 - - name: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId - in: query - description: Het door een kamer toegekend uniek nummer voor de INGESCHREVEN - NIET-NATUURLIJK PERSOON - required: false - schema: - type: string - - name: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie - in: query - description: Het door de gemeente uitgegeven unieke nummer voor een ANDER - NIET-NATUURLIJK PERSOON - required: false - schema: - type: string - maxLength: 17 - - name: rol__betrokkeneIdentificatie__vestiging__vestigingsNummer - in: query - description: Een korte unieke aanduiding van de Vestiging. - required: false - schema: - type: string - maxLength: 24 - - name: rol__betrokkeneIdentificatie__medewerker__identificatie - in: query - description: Een korte unieke aanduiding van de MEDEWERKER. - required: false - schema: - type: string - maxLength: 24 - - name: rol__betrokkeneIdentificatie__organisatorischeEenheid__identificatie - in: query - description: Een korte identificatie van de organisatorische eenheid. - required: false - schema: - type: string - - name: ordering - in: query - description: Het veld waarop de resultaten geordend worden. - required: false - schema: - type: string - enum: - - startdatum - - -startdatum - - einddatum - - -einddatum - - publicatiedatum - - -publicatiedatum - - archiefactiedatum - - -archiefactiedatum - - name: expand - in: query - description: Haal details van inline resources direct op. - schema: - type: string - enum: - - status - - resultaat - - eigenschappen - - rollen - - zaakobjecten - - zaakinformatieobjecten - - name: page - in: query - description: Een pagina binnen de gepagineerde set resultaten. - required: false - schema: - type: integer - - name: Accept-Crs - in: header - 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 - schema: - type: string - enum: - - EPSG:4326 - - name: Content-Crs - in: header - 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 - schema: - type: string - enum: - - EPSG:4326 + - name: identificatie + in: query + description: De unieke identificatie van de ZAAK binnen de organisatie die + verantwoordelijk is voor de behandeling van de ZAAK. + required: false + schema: + type: string + - name: bronorganisatie + 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 + required: false + schema: + type: string + - name: zaaktype + in: query + description: URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS + waar deze voorkomt + required: false + schema: + type: string + format: uri + - name: archiefnominatie + in: query + description: Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + required: false + schema: + type: string + enum: + - blijvend_bewaren + - vernietigen + - name: archiefnominatie__in + in: query + description: Multiple values may be separated by commas. + required: false + schema: + type: string + - name: archiefactiedatum + 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. + required: false + schema: + type: string + - name: archiefactiedatum__lt + 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. + required: false + schema: + type: string + - name: archiefactiedatum__gt + 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. + required: false + schema: + type: string + - name: archiefstatus + in: query + description: Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + termijn vernietigd moet worden. + required: false + schema: + type: string + enum: + - nog_te_archiveren + - gearchiveerd + - gearchiveerd_procestermijn_onbekend + - overgedragen + - name: archiefstatus__in + in: query + description: Multiple values may be separated by commas. + required: false + schema: + type: string + - name: startdatum + in: query + description: De datum waarop met de uitvoering van de zaak is gestart + required: false + schema: + type: string + - name: startdatum__gt + in: query + description: De datum waarop met de uitvoering van de zaak is gestart + required: false + schema: + type: string + - name: startdatum__gte + in: query + description: De datum waarop met de uitvoering van de zaak is gestart + required: false + schema: + type: string + - name: startdatum__lt + in: query + description: De datum waarop met de uitvoering van de zaak is gestart + required: false + schema: + type: string + - name: startdatum__lte + in: query + description: De datum waarop met de uitvoering van de zaak is gestart + required: false + schema: + type: string + - name: rol__betrokkeneType + in: query + description: Type van de `betrokkene`. + required: false + schema: + type: string + enum: + - natuurlijk_persoon + - niet_natuurlijk_persoon + - vestiging + - organisatorische_eenheid + - medewerker + - name: rol__betrokkene + in: query + description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. + required: false + schema: + type: string + format: uri + - name: rol__omschrijvingGeneriek + in: query + description: Algemeen gehanteerde benaming van de aard van de ROL, afgeleid + uit het ROLTYPE. + required: false + schema: + type: string + enum: + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator + - name: maximaleVertrouwelijkheidaanduiding + in: query + description: Zaken met een vertrouwelijkheidaanduiding die beperkter is dan + de aangegeven aanduiding worden uit de resultaten gefiltered. + required: false + schema: + type: string + enum: + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim + - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn + in: query + description: Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene + bepalingen burgerservicenummer. + required: false + schema: + type: string + maxLength: 9 + - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie + in: query + description: Het door de gemeente uitgegeven unieke nummer voor een ANDER + NATUURLIJK PERSOON + required: false + schema: + type: string + maxLength: 17 + - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer + in: query + description: Het administratienummer van de persoon, bedoeld in de Wet BRP + required: false + schema: + type: string + maxLength: 10 + - name: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId + in: query + description: Het door een kamer toegekend uniek nummer voor de INGESCHREVEN + NIET-NATUURLIJK PERSOON + required: false + schema: + type: string + - name: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie + in: query + description: Het door de gemeente uitgegeven unieke nummer voor een ANDER + NIET-NATUURLIJK PERSOON + required: false + schema: + type: string + maxLength: 17 + - name: rol__betrokkeneIdentificatie__vestiging__vestigingsNummer + in: query + description: Een korte unieke aanduiding van de Vestiging. + required: false + schema: + type: string + maxLength: 24 + - name: rol__betrokkeneIdentificatie__medewerker__identificatie + in: query + description: Een korte unieke aanduiding van de MEDEWERKER. + required: false + schema: + type: string + maxLength: 24 + - name: rol__betrokkeneIdentificatie__organisatorischeEenheid__identificatie + in: query + description: Een korte identificatie van de organisatorische eenheid. + required: false + schema: + type: string + - name: ordering + in: query + description: Het veld waarop de resultaten geordend worden. + required: false + schema: + type: string + enum: + - startdatum + - -startdatum + - einddatum + - -einddatum + - publicatiedatum + - -publicatiedatum + - archiefactiedatum + - -archiefactiedatum + - name: page + in: query + description: Een pagina binnen de gepagineerde set resultaten. + required: false + schema: + type: integer + - name: Accept-Crs + in: header + 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 + schema: + type: string + enum: + - EPSG:4326 + - name: Content-Crs + in: header + 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 + schema: + type: string + enum: + - EPSG:4326 responses: - "200": + '200': description: OK headers: Content-Crs: description: Het 'Coordinate Reference System' (CRS) van de antwoorddata. - Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is - hetzelfde als WGS84). + Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde + als WGS84). schema: type: string enum: - - EPSG:4326 + - EPSG:4326 API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: required: - - count - - results + - count + - results type: object properties: count: @@ -3043,110 +3186,100 @@ paths: results: type: array items: - $ref: "#/components/schemas/Zaak" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "412": - $ref: "#/components/responses/412" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/Zaak' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '412': + $ref: '#/components/responses/412' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen post: operationId: zaak_create summary: Maak een ZAAK aan. - 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. - - `archiefnominatie` 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. + description: "Indien geen identificatie gegeven is, dan wordt deze automatisch\n\ + gegenereerd. De identificatie moet uniek zijn binnen de bronorganisatie.\n\ + \n**Er wordt gevalideerd op**:\n- geldigheid `zaaktype` URL - de resource\ + \ moet opgevraagd kunnen\n worden uit de Catalogi API en de vorm van een\ + \ ZAAKTYPE hebben.\n- `zaaktype` is geen concept (`zaaktype.concept` = False)\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\n waarde \"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." parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: Accept-Crs - in: header - 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 - schema: - type: string - enum: - - EPSG:4326 - - name: Content-Crs - in: header - 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 - schema: - type: string - enum: - - EPSG:4326 - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: Accept-Crs + in: header + 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 + schema: + type: string + enum: + - EPSG:4326 + - name: Content-Crs + in: header + 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 + schema: + type: string + enum: + - EPSG:4326 + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string requestBody: - $ref: "#/components/requestBodies/Zaak" + $ref: '#/components/requestBodies/Zaak' responses: - "201": + '201': description: Created 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: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' Location: schema: type: string @@ -3155,116 +3288,104 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/Zaak" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "412": - $ref: "#/components/responses/412" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/Zaak' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '412': + $ref: '#/components/responses/412' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - zaken.aanmaken + - JWT-Claims: + - zaken.aanmaken parameters: [] /zaken/_zoek: post: operationId: zaak__zoek summary: Voer een (geo)-zoekopdracht uit op ZAAKen. - description: |- - Zoeken/filteren gaat normaal via de `list` operatie, deze is echter - niet geschikt voor geo-zoekopdrachten. + description: 'Zoeken/filteren gaat normaal via de `list` operatie, deze is echter + + niet geschikt voor geo-zoekopdrachten.' parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: page - in: query - description: Een pagina binnen de gepagineerde set resultaten. - required: false - schema: - type: integer - - name: expand - in: query - description: Haal details van inline resources direct op. - schema: - type: string - enum: - - status - - resultaat - - eigenschappen - - rollen - - zaakobjecten - - zaakinformatieobjecten - - name: Accept-Crs - in: header - 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 - schema: - type: string - enum: - - EPSG:4326 - - name: Content-Crs - in: header - 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 - schema: - type: string - enum: - - EPSG:4326 + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: page + in: query + description: Een pagina binnen de gepagineerde set resultaten. + required: false + schema: + type: integer + - name: Accept-Crs + in: header + 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 + schema: + type: string + enum: + - EPSG:4326 + - name: Content-Crs + in: header + 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 + schema: + type: string + enum: + - EPSG:4326 requestBody: content: application/json: schema: - $ref: "#/components/schemas/ZaakZoek" + $ref: '#/components/schemas/ZaakZoek' required: true responses: - "200": + '200': description: OK headers: Content-Crs: description: Het 'Coordinate Reference System' (CRS) van de antwoorddata. - Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is - hetzelfde als WGS84). + Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde + als WGS84). schema: type: string enum: - - EPSG:4326 + - EPSG:4326 API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: required: - - count - - results + - count + - results type: object properties: count: @@ -3280,699 +3401,701 @@ paths: results: type: array items: - $ref: "#/components/schemas/Zaak" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "412": - $ref: "#/components/responses/412" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/Zaak' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '412': + $ref: '#/components/responses/412' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen parameters: [] - "/zaken/{uuid}": + /zaken/{uuid}: get: operationId: zaak_read summary: Een specifieke ZAAK opvragen. description: Een specifieke ZAAK opvragen. parameters: - - name: expand - in: query - description: Haal details van inline resources direct op. - schema: - type: string - enum: - - status - - resultaat - - eigenschappen - - rollen - - zaakobjecten - - zaakinformatieobjecten - - name: Accept-Crs - in: header - 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 - schema: - type: string - enum: - - EPSG:4326 - - name: Content-Crs - in: header - 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 - schema: - type: string - enum: - - EPSG:4326 - - name: If-None-Match - in: header - 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. - required: false - examples: - oneValue: - summary: Eén ETag-waarde - value: '"79054025255fb1a26e4bc422aef54eb4"' - multipleValues: - summary: Meerdere ETag-waardes - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - schema: - type: string + - name: Accept-Crs + in: header + 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 + schema: + type: string + enum: + - EPSG:4326 + - name: Content-Crs + in: header + 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 + schema: + type: string + enum: + - EPSG:4326 + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: Content-Crs: description: Het 'Coordinate Reference System' (CRS) van de antwoorddata. - Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is - hetzelfde als WGS84). + Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde + als WGS84). schema: type: string enum: - - EPSG:4326 + - EPSG:4326 ETag: - 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. + 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. schema: type: string API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: '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" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "412": - $ref: "#/components/responses/412" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/Zaak' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '412': + $ref: '#/components/responses/412' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen head: operationId: zaak_headers summary: De headers voor een specifiek(e) ZAAK opvragen description: Vraag de headers op die je bij een GET request zou krijgen. parameters: - - name: Accept-Crs - in: header - 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 - schema: - type: string - enum: - - EPSG:4326 - - name: Content-Crs - in: header - 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 - schema: - type: string - enum: - - EPSG:4326 + - name: Accept-Crs + in: header + 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 + schema: + type: string + enum: + - EPSG:4326 + - name: Content-Crs + in: header + 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 + schema: + type: string + enum: + - EPSG:4326 + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: Content-Crs: description: Het 'Coordinate Reference System' (CRS) van de antwoorddata. - Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is - hetzelfde als WGS84). + Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde + als WGS84). schema: type: string enum: - - EPSG:4326 + - EPSG:4326 + ETag: + 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. + schema: + type: string API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' tags: - - zaken + - zaken security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen put: operationId: zaak_update summary: Werk een ZAAK in zijn geheel bij. - description: >- - **Er wordt gevalideerd op** - - - `zaaktype` mag niet gewijzigd worden. - - - `identificatie` mag niet gewijzigd worden. - - - `laatsteBetaaldatum` mag niet in de toekomst liggen. - - - `laatsteBetaaldatum` mag niet gezet worden als de betalingsindicatie - "nvt" is. - - `archiefnominatie` 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. - - **Opmerkingen** - - - er worden enkel zaken getoond van de zaaktypes waar u toe geautoriseerd - bent. - - indien een zaak heropend moet worden, doe dit dan door een nieuwe status - toe te voegen die NIET de eindstatus is. - Zie de `Status` resource. + description: "**Er wordt gevalideerd op**\n- `zaaktype` mag niet gewijzigd worden.\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\n waarde \"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\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.\n Zie de `Status` resource." parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: Accept-Crs - in: header - 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 - schema: - type: string - enum: - - EPSG:4326 - - name: Content-Crs - in: header - 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 - schema: - type: string - enum: - - EPSG:4326 - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: Accept-Crs + in: header + 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 + schema: + type: string + enum: + - EPSG:4326 + - name: Content-Crs + in: header + 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 + schema: + type: string + enum: + - EPSG:4326 + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string requestBody: - $ref: "#/components/requestBodies/Zaak" + $ref: '#/components/requestBodies/Zaak' responses: - "200": + '200': description: OK headers: Content-Crs: description: Het 'Coordinate Reference System' (CRS) van de antwoorddata. - Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is - hetzelfde als WGS84). + Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde + als WGS84). schema: type: string enum: - - EPSG:4326 + - EPSG:4326 API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: '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" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "412": - $ref: "#/components/responses/412" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/Zaak' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '412': + $ref: '#/components/responses/412' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) patch: operationId: zaak_partial_update summary: Werk een ZAAK deels bij. - description: >- - **Er wordt gevalideerd op** - - - `zaaktype` mag niet gewijzigd worden. - - - `identificatie` mag niet gewijzigd worden. - - - `laatsteBetaaldatum` mag niet in de toekomst liggen. - - - `laatsteBetaaldatum` mag niet gezet worden als de betalingsindicatie - "nvt" is. - - `archiefnominatie` 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. - - **Opmerkingen** - - - er worden enkel zaken getoond van de zaaktypes waar u toe geautoriseerd - bent. - - indien een zaak heropend moet worden, doe dit dan door een nieuwe status - toe te voegen die NIET de eindstatus is. Zie de `Status` resource. + description: "**Er wordt gevalideerd op**\n- `zaaktype` mag niet gewijzigd worden.\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\n waarde \"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\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." parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: Accept-Crs - in: header - 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 - schema: - type: string - enum: - - EPSG:4326 - - name: Content-Crs - in: header - 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 - schema: - type: string - enum: - - EPSG:4326 - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: Accept-Crs + in: header + 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 + schema: + type: string + enum: + - EPSG:4326 + - name: Content-Crs + in: header + 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 + schema: + type: string + enum: + - EPSG:4326 + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string requestBody: - $ref: "#/components/requestBodies/Zaak" + $ref: '#/components/requestBodies/Zaak' responses: - "200": + '200': description: OK headers: Content-Crs: description: Het 'Coordinate Reference System' (CRS) van de antwoorddata. - Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is - hetzelfde als WGS84). + Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde + als WGS84). schema: type: string enum: - - EPSG:4326 + - EPSG:4326 API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: '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" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "412": - $ref: "#/components/responses/412" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/Zaak' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '412': + $ref: '#/components/responses/412' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) delete: operationId: zaak_delete summary: Verwijder een ZAAK. - 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 + description: "**De gerelateerde resources zijn hierbij**\n- `zaak` - de deelzaken\ + \ van de verwijderde hoofzaak\n- `status` - alle statussen van de verwijderde\ + \ zaak\n- `resultaat` - het resultaat van de verwijderde zaak\n- `rol` - alle\ + \ rollen bij de zaak\n- `zaakobject` - alle zaakobjecten bij de zaak\n- `zaakeigenschap`\ + \ - alle eigenschappen van de zaak\n- `zaakkenmerk` - alle kenmerken van de\ + \ zaak\n- `zaakinformatieobject` - dit moet door-cascaden naar de Documenten\ + \ API,\n zie ook: https://github.com/VNG-Realisatie/gemma-zaken/issues/791\ + \ (TODO)\n- `klantcontact` - alle klantcontacten bij een zaak" parameters: - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string responses: - "204": + '204': description: No content headers: API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "412": - $ref: "#/components/responses/412" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '412': + $ref: '#/components/responses/412' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - zaken.verwijderen + - JWT-Claims: + - zaken.verwijderen parameters: - - name: uuid - in: path - description: Unieke resource identifier (UUID4) - required: true - schema: - type: string - format: uuid - "/zaken/{zaak_uuid}/audittrail": + - name: uuid + in: path + description: Unieke resource identifier (UUID4) + required: true + schema: + type: string + format: uuid + /zaken/{zaak_uuid}/audittrail: get: operationId: audittrail_list summary: Alle audit trail regels behorend bij de ZAAK. description: Alle audit trail regels behorend bij de ZAAK. responses: - "200": + '200': description: OK 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: '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" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/AuditTrail' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - audittrails.lezen + - JWT-Claims: + - audittrails.lezen parameters: - - name: zaak_uuid - in: path - required: true - description: Unieke resource identifier (UUID4) - schema: - type: string - format: uuid - "/zaken/{zaak_uuid}/audittrail/{uuid}": + - name: zaak_uuid + in: path + required: true + description: Unieke resource identifier (UUID4) + schema: + type: string + format: uuid + /zaken/{zaak_uuid}/audittrail/{uuid}: get: operationId: audittrail_read summary: Een specifieke audit trail regel opvragen. description: Een specifieke audit trail regel opvragen. + parameters: + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: - API-version: + ETag: + 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. schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." - content: - application/json: + API-version: schema: - $ref: "#/components/schemas/AuditTrail" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" - tags: - - zaken - security: - - JWT-Claims: - - audittrails.lezen - parameters: - - name: uuid - in: path - description: Unieke identificatie van de audit regel. - required: true - schema: - type: string - format: uuid - - name: zaak_uuid - in: path - required: true - description: Unieke resource identifier (UUID4) - schema: - type: string - format: uuid - "/zaken/{zaak_uuid}/besluiten": + type: string + description: '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' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - zaken + security: + - JWT-Claims: + - audittrails.lezen + parameters: + - name: uuid + in: path + description: Unieke identificatie van de audit regel. + required: true + schema: + type: string + format: uuid + - name: zaak_uuid + in: path + required: true + description: Unieke resource identifier (UUID4) + schema: + type: string + format: uuid + /zaken/{zaak_uuid}/besluiten: get: operationId: zaakbesluit_list summary: Alle ZAAKBESLUITen opvragen. description: Alle ZAAKBESLUITen opvragen. responses: - "200": + '200': description: OK 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: '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" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakBesluit' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen post: operationId: zaakbesluit_create summary: Maak een ZAAKBESLUIT aan. - description: |- - **LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** + 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 + + - geldigheid URL naar de ZAAK' parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string requestBody: content: application/json: schema: - $ref: "#/components/schemas/ZaakBesluit" + $ref: '#/components/schemas/ZaakBesluit' required: true responses: - "201": + '201': description: Created 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: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' Location: schema: type: string @@ -3981,230 +4104,253 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ZaakBesluit" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakBesluit' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - zaken.bijwerken + - JWT-Claims: + - zaken.bijwerken parameters: - - name: zaak_uuid - in: path - required: true - description: Unieke resource identifier (UUID4) - schema: - type: string - format: uuid - "/zaken/{zaak_uuid}/besluiten/{uuid}": + - name: zaak_uuid + in: path + required: true + description: Unieke resource identifier (UUID4) + schema: + type: string + format: uuid + /zaken/{zaak_uuid}/besluiten/{uuid}: get: operationId: zaakbesluit_read summary: Een specifiek ZAAKBESLUIT opvragen. description: Een specifiek ZAAKBESLUIT opvragen. + parameters: + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: + ETag: + 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. + schema: + type: string API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: '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" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakBesluit' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen delete: operationId: zaakbesluit_delete summary: Verwijder een ZAAKBESLUIT. - description: |- - **LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** + 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. + + daarom is dit endpoint in de Zaken API geimplementeerd.' parameters: - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string responses: - "204": + '204': description: No content headers: API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - zaken.bijwerken + - JWT-Claims: + - zaken.bijwerken parameters: - - name: uuid - in: path - description: Unieke resource identifier (UUID4) - required: true - schema: - type: string - format: uuid - - name: zaak_uuid - in: path - required: true - description: Unieke resource identifier (UUID4) - schema: - type: string - format: uuid - "/zaken/{zaak_uuid}/zaakeigenschappen": + - name: uuid + in: path + description: Unieke resource identifier (UUID4) + required: true + schema: + type: string + format: uuid + - name: zaak_uuid + in: path + required: true + description: Unieke resource identifier (UUID4) + schema: + type: string + format: uuid + /zaken/{zaak_uuid}/zaakeigenschappen: get: operationId: zaakeigenschap_list summary: Alle ZAAKEIGENSCHAPpen opvragen. description: Alle ZAAKEIGENSCHAPpen opvragen. responses: - "200": + '200': description: OK 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: '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" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakEigenschap' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen post: operationId: zaakeigenschap_create summary: Maak een ZAAKEIGENSCHAP aan. - 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 + description: "Maak een ZAAKEIGENSCHAP aan.\n\n**Er wordt gevalideerd op:**\n\ + - geldigheid `eigenschap` URL - de resource moet opgevraagd kunnen\n worden\ + \ uit de Catalogi API en de vorm van een EIGENSCHAP hebben.\n- de `eigenschap`\ + \ moet bij het `ZAAK.zaaktype` horen" parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json - - name: X-NLX-Logrecord-ID - in: header - description: Identifier of the request, traceable throughout the network - required: false - schema: - type: string - - name: X-Audit-Toelichting - in: header - description: Toelichting waarom een bepaald verzoek wordt gedaan - required: false - schema: - type: string + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + - name: X-NLX-Logrecord-ID + in: header + description: Identifier of the request, traceable throughout the network + required: false + schema: + type: string + - name: X-Audit-Toelichting + in: header + description: Toelichting waarom een bepaald verzoek wordt gedaan + required: false + schema: + type: string requestBody: - $ref: "#/components/requestBodies/ZaakEigenschap" + $ref: '#/components/requestBodies/ZaakEigenschap' responses: - "201": + '201': description: Created 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: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' Location: schema: type: string @@ -4213,471 +4359,496 @@ paths: content: application/json: schema: - $ref: "#/components/schemas/ZaakEigenschap" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakEigenschap' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) parameters: - - name: zaak_uuid - in: path - required: true - description: Unieke resource identifier (UUID4) - schema: - type: string - format: uuid - "/zaken/{zaak_uuid}/zaakeigenschappen/{uuid}": + - name: zaak_uuid + in: path + required: true + description: Unieke resource identifier (UUID4) + schema: + type: string + format: uuid + /zaken/{zaak_uuid}/zaakeigenschappen/{uuid}: get: operationId: zaakeigenschap_read summary: Een specifieke ZAAKEIGENSCHAP opvragen. description: Een specifieke ZAAKEIGENSCHAP opvragen. parameters: - - name: If-None-Match - in: header - 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. - required: false - examples: - oneValue: - summary: Eén ETag-waarde - value: '"79054025255fb1a26e4bc422aef54eb4"' - multipleValues: - summary: Meerdere ETag-waardes - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - schema: - type: string + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: ETag: - 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. + 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. schema: type: string API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: '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" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakEigenschap' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen head: operationId: zaakeigenschap_headers summary: De headers voor een specifiek(e) ZAAKEIGENSCHAP opvragen description: Vraag de headers op die je bij een GET request zou krijgen. + parameters: + - name: If-None-Match + in: header + 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." + required: false + examples: + oneValue: + summary: "E\xE9n ETag-waarde" + value: '"79054025255fb1a26e4bc422aef54eb4"' + multipleValues: + summary: Meerdere ETag-waardes + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + schema: + type: string responses: - "200": + '200': description: OK headers: + ETag: + 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. + schema: + type: string API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' tags: - - zaken + - zaken security: - - JWT-Claims: - - zaken.lezen + - JWT-Claims: + - zaken.lezen put: operationId: zaakeigenschap_update summary: Werk een ZAAKEIGENSCHAP in zijn geheel bij. - description: |- - **Er wordt gevalideerd op** - - Alleen de WAARDE mag gewijzigd worden + description: '**Er wordt gevalideerd op** + + - Alleen de WAARDE mag gewijzigd worden' parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json requestBody: - $ref: "#/components/requestBodies/ZaakEigenschap" + $ref: '#/components/requestBodies/ZaakEigenschap' responses: - "200": + '200': description: OK 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: '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" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakEigenschap' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) patch: operationId: zaakeigenschap_partial_update summary: Werk een ZAAKEIGENSCHAP deels bij. - description: |- - **Er wordt gevalideerd op** - - Alleen de WAARDE mag gewijzigd worden + description: '**Er wordt gevalideerd op** + + - Alleen de WAARDE mag gewijzigd worden' parameters: - - name: Content-Type - in: header - description: Content type van de verzoekinhoud. - required: true - schema: - type: string - enum: - - application/json + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json requestBody: - $ref: "#/components/requestBodies/ZaakEigenschap" + $ref: '#/components/requestBodies/ZaakEigenschap' responses: - "200": + '200': description: OK 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: '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" - "400": - $ref: "#/components/responses/400" - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + $ref: '#/components/schemas/ZaakEigenschap' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) delete: operationId: zaakeigenschap_delete description: Verwijder een ZAAKEIGENSCHAP. responses: - "204": + '204': description: No content headers: API-version: schema: type: string - description: "Geeft een specifieke API-versie aan in de context van een - specifieke aanroep. Voorbeeld: 1.2.1." - "401": - $ref: "#/components/responses/401" - "403": - $ref: "#/components/responses/403" - "404": - $ref: "#/components/responses/404" - "406": - $ref: "#/components/responses/406" - "409": - $ref: "#/components/responses/409" - "410": - $ref: "#/components/responses/410" - "415": - $ref: "#/components/responses/415" - "429": - $ref: "#/components/responses/429" - "500": - $ref: "#/components/responses/500" + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' tags: - - zaken + - zaken security: - - JWT-Claims: - - (zaken.bijwerken | zaken.geforceerd-bijwerken) + - JWT-Claims: + - (zaken.bijwerken | zaken.geforceerd-bijwerken) parameters: - - name: uuid - in: path - description: Unieke resource identifier (UUID4) - required: true - schema: - type: string - format: uuid - - name: zaak_uuid - in: path - required: true - description: Unieke resource identifier (UUID4) - schema: - type: string - format: uuid + - name: uuid + in: path + description: Unieke resource identifier (UUID4) + required: true + schema: + type: string + format: uuid + - name: zaak_uuid + in: path + required: true + description: Unieke resource identifier (UUID4) + schema: + type: string + format: uuid 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. +- 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.' servers: - - url: /api/v1 +- url: /api/v1 components: responses: - "400": + '400': description: Bad request 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: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: - $ref: "#/components/schemas/ValidatieFout" - "401": + $ref: '#/components/schemas/ValidatieFout' + '401': description: Unauthorized 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: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: - $ref: "#/components/schemas/Fout" - "403": + $ref: '#/components/schemas/Fout' + '403': description: Forbidden 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: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: - $ref: "#/components/schemas/Fout" - "404": + $ref: '#/components/schemas/Fout' + '404': description: Not found 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: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: - $ref: "#/components/schemas/Fout" - "406": + $ref: '#/components/schemas/Fout' + '406': description: Not acceptable 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: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: - $ref: "#/components/schemas/Fout" - "409": + $ref: '#/components/schemas/Fout' + '409': description: Conflict 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: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: - $ref: "#/components/schemas/Fout" - "410": + $ref: '#/components/schemas/Fout' + '410': description: Gone 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: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: - $ref: "#/components/schemas/Fout" - "412": + $ref: '#/components/schemas/Fout' + '412': description: Precondition failed 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: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: - $ref: "#/components/schemas/Fout" - "415": + $ref: '#/components/schemas/Fout' + '415': description: Unsupported media type 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: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: - $ref: "#/components/schemas/Fout" - "429": + $ref: '#/components/schemas/Fout' + '429': description: Too many requests 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: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: - $ref: "#/components/schemas/Fout" - "500": + $ref: '#/components/schemas/Fout' + '500': description: Internal server error 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: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: - $ref: "#/components/schemas/Fout" + $ref: '#/components/schemas/Fout' requestBodies: Resultaat: content: application/json: schema: - $ref: "#/components/schemas/Resultaat" + $ref: '#/components/schemas/Resultaat' required: true ZaakInformatieObject: content: application/json: schema: - $ref: "#/components/schemas/ZaakInformatieObject" + $ref: '#/components/schemas/ZaakInformatieObject' required: true ZaakObject: content: application/json: schema: - $ref: "#/components/schemas/ZaakObject" + $ref: '#/components/schemas/ZaakObject' required: true Zaak: content: application/json: schema: - $ref: "#/components/schemas/Zaak" + $ref: '#/components/schemas/Zaak' required: true ZaakEigenschap: content: application/json: schema: - $ref: "#/components/schemas/ZaakEigenschap" + $ref: '#/components/schemas/ZaakEigenschap' required: true securitySchemes: JWT-Claims: @@ -4687,14 +4858,14 @@ components: schemas: KlantContact: required: - - zaak - - datumtijd + - zaak + - datumtijd type: object properties: url: title: Url - description: URL-referentie naar dit object. Dit is de unieke identificatie en - locatie van dit object. + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. type: string format: uri readOnly: true @@ -4739,11 +4910,11 @@ components: maxLength: 1000 Fout: required: - - code - - title - - status - - detail - - instance + - code + - title + - status + - detail + - instance type: object properties: type: @@ -4771,15 +4942,15 @@ components: minLength: 1 instance: title: Instance - description: URI met referentie naar dit specifiek voorkomen van de fout. Deze - kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + description: URI met referentie naar dit specifiek voorkomen van de fout. + Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. type: string minLength: 1 FieldValidationError: required: - - name - - code - - reason + - name + - code + - reason type: object properties: name: @@ -4799,12 +4970,12 @@ components: minLength: 1 ValidatieFout: required: - - code - - title - - status - - detail - - instance - - invalidParams + - code + - title + - status + - detail + - instance + - invalidParams type: object properties: type: @@ -4832,24 +5003,24 @@ components: minLength: 1 instance: title: Instance - description: URI met referentie naar dit specifiek voorkomen van de fout. Deze - kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + description: URI met referentie naar dit specifiek voorkomen van de fout. + Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. type: string minLength: 1 invalidParams: type: array items: - $ref: "#/components/schemas/FieldValidationError" + $ref: '#/components/schemas/FieldValidationError' Resultaat: required: - - zaak - - resultaattype + - zaak + - resultaattype type: object properties: url: title: Url - description: URL-referentie naar dit object. Dit is de unieke identificatie en - locatie van dit object. + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. type: string format: uri readOnly: true @@ -4879,12 +5050,12 @@ components: type: string maxLength: 1000 ContactPersoonRol: - 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. + 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. required: - - naam + - naam type: object properties: emailadres: @@ -4896,13 +5067,14 @@ components: maxLength: 254 functie: title: Functie - description: "De aanduiding van de taken, rechten en plichten die de - contactpersoon heeft binnen de organisatie van BETROKKENE. " + description: 'De aanduiding van de taken, rechten en plichten die de contactpersoon + heeft binnen de organisatie van BETROKKENE. ' type: string maxLength: 50 telefoonnummer: title: Telefoonnummer - description: Telefoonnummer waaronder de contactpersoon in de regel bereikbaar is. + description: Telefoonnummer waaronder de contactpersoon in de regel bereikbaar + is. type: string maxLength: 20 naam: @@ -4914,16 +5086,16 @@ components: nullable: true Rol: required: - - zaak - - betrokkeneType - - roltype - - roltoelichting + - zaak + - betrokkeneType + - roltype + - roltoelichting type: object properties: url: title: Url - description: URL-referentie naar dit object. Dit is de unieke identificatie en - locatie van dit object. + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. type: string format: uri readOnly: true @@ -4948,32 +5120,38 @@ components: maxLength: 1000 betrokkeneType: title: Betrokkene type - description: |- - Type van de `betrokkene`. + 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 + + * `medewerker` - Medewerker' type: string enum: - - natuurlijk_persoon - - niet_natuurlijk_persoon - - vestiging - - organisatorische_eenheid - - medewerker + - natuurlijk_persoon + - niet_natuurlijk_persoon + - vestiging + - organisatorische_eenheid + - medewerker afwijkendeNaamBetrokkene: title: Afwijkende naam betrokkene - description: De naam van de betrokkene waaronder deze in relatie tot de zaak - aangesproken wil worden. + description: De naam van de betrokkene waaronder deze in relatie tot de + zaak aangesproken wil worden. type: string maxLength: 625 roltype: title: Roltype - description: URL-referentie naar een roltype binnen het ZAAKTYPE van de ZAAK. + description: URL-referentie naar een roltype binnen het ZAAKTYPE van de + ZAAK. type: string format: uri maxLength: 1000 @@ -4986,29 +5164,20 @@ components: minLength: 1 omschrijvingGeneriek: title: Omschrijving generiek - description: >- - Algemeen gehanteerde benaming van de aard van de ROL, afgeleid uit - het ROLTYPE. - - - Uitleg bij mogelijke waarden: - - - * `adviseur` - (Adviseur) Kennis in dienst stellen van de behandeling van (een deel van) een zaak. - - * `behandelaar` - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van) een zaak. - - * `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst van een zaak. - - * `beslisser` - (Beslisser) Nemen van besluiten die voor de uitkomst van een zaak noodzakelijk zijn. - - * `initiator` - (Initiator) Aanleiding geven tot de start van een zaak .. - - * `klantcontacter` - (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers en bedrijven .. - - * `zaakcoordinator` - (Zaakcoördinator) Er voor zorg dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt conform de daarover gemaakte afspraken. - - * `mede_initiator` - Mede-initiator + 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" type: string readOnly: true minLength: 1 @@ -5025,22 +5194,23 @@ components: readOnly: true indicatieMachtiging: title: Indicatie machtiging - description: >- - Indicatie machtiging + 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 + * `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 + * `machtiginggever` - De betrokkene in de rol bij de zaak heeft een andere + betrokkene bij dezelfde zaak gemachtigd om namens hem of haar te handelen' type: string enum: - - gemachtigde - - machtiginggever + - gemachtigde + - machtiginggever contactpersoonRol: - $ref: "#/components/schemas/ContactPersoonRol" + $ref: '#/components/schemas/ContactPersoonRol' statussen: description: De BETROKKENE die in zijn/haar ROL in een ZAAK heeft geregistreerd dat STATUSsen in die ZAAK bereikt zijn. @@ -5056,10 +5226,10 @@ components: propertyName: betrokkeneType VerblijfsAdres: required: - - aoaIdentificatie - - wplWoonplaatsNaam - - gorOpenbareRuimteNaam - - aoaHuisnummer + - aoaIdentificatie + - wplWoonplaatsNaam + - gorOpenbareRuimteNaam + - aoaHuisnummer type: object properties: aoaIdentificatie: @@ -5075,8 +5245,8 @@ components: minLength: 1 gorOpenbareRuimteNaam: title: Gor openbare ruimte naam - description: Een door het bevoegde gemeentelijke orgaan aan een OPENBARE RUIMTE - toegekende benaming + description: Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming type: string maxLength: 80 minLength: 1 @@ -5104,21 +5274,21 @@ components: nullable: true SubVerblijfBuitenland: required: - - lndLandcode - - lndLandnaam + - lndLandcode + - lndLandnaam type: object properties: lndLandcode: title: Lnd landcode - description: De code, behorende bij de landnaam, zoals opgenomen in de - Land/Gebied-tabel van de BRP. + description: De code, behorende bij de landnaam, zoals opgenomen in de Land/Gebied-tabel + van de BRP. type: string maxLength: 4 minLength: 1 lndLandnaam: title: Lnd landnaam - description: De naam van het land, zoals opgenomen in de Land/Gebied-tabel van - de BRP. + description: De naam van het land, zoals opgenomen in de Land/Gebied-tabel + van de BRP. type: string maxLength: 40 minLength: 1 @@ -5140,8 +5310,8 @@ components: properties: inpBsn: title: Inp bsn - description: Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene - bepalingen burgerservicenummer. + description: Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet + algemene bepalingen burgerservicenummer. type: string maxLength: 9 anpIdentificatie: @@ -5167,8 +5337,8 @@ components: maxLength: 80 voorletters: title: Voorletters - description: De verzameling letters die gevormd wordt door de eerste letter van - alle in volgorde voorkomende voornamen. + description: De verzameling letters die gevormd wordt door de eerste letter + van alle in volgorde voorkomende voornamen. type: string maxLength: 20 voornamen: @@ -5178,9 +5348,8 @@ components: maxLength: 200 geslachtsaanduiding: title: Geslachtsaanduiding - description: >- - Een aanduiding die aangeeft of de persoon een man of een vrouw is, - of dat het geslacht nog onbekend is. + 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: @@ -5190,30 +5359,30 @@ components: * `v` - Vrouw - * `o` - Onbekend + * `o` - Onbekend' type: string enum: - - m - - v - - o + - m + - v + - o geboortedatum: title: Geboortedatum type: string maxLength: 18 verblijfsadres: - $ref: "#/components/schemas/VerblijfsAdres" + $ref: '#/components/schemas/VerblijfsAdres' subVerblijfBuitenland: - $ref: "#/components/schemas/SubVerblijfBuitenland" + $ref: '#/components/schemas/SubVerblijfBuitenland' betrokkene_identificatie_RolNatuurlijkPersoon: type: object properties: betrokkeneIdentificatie: - $ref: "#/components/schemas/RolNatuurlijkPersoon" + $ref: '#/components/schemas/RolNatuurlijkPersoon' natuurlijk_persoon: type: object allOf: - - $ref: "#/components/schemas/Rol" - - $ref: "#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon" + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNatuurlijkPersoon' RolNietNatuurlijkPersoon: type: object properties: @@ -5231,10 +5400,9 @@ components: maxLength: 17 statutaireNaam: title: Statutaire naam - 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). + 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). type: string maxLength: 500 innRechtsvorm: @@ -5242,42 +5410,42 @@ components: description: De juridische vorm van de NIET-NATUURLIJK PERSOON. type: string 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 + - 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 bezoekadres: title: Bezoekadres description: De gegevens over het adres van de NIET-NATUURLIJK PERSOON type: string maxLength: 1000 subVerblijfBuitenland: - $ref: "#/components/schemas/SubVerblijfBuitenland" + $ref: '#/components/schemas/SubVerblijfBuitenland' betrokkene_identificatie_RolNietNatuurlijkPersoon: type: object properties: betrokkeneIdentificatie: - $ref: "#/components/schemas/RolNietNatuurlijkPersoon" + $ref: '#/components/schemas/RolNietNatuurlijkPersoon' niet_natuurlijk_persoon: type: object allOf: - - $ref: "#/components/schemas/Rol" - - $ref: "#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon" + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolNietNatuurlijkPersoon' RolVestiging: type: object properties: @@ -5294,19 +5462,19 @@ components: type: string maxLength: 625 verblijfsadres: - $ref: "#/components/schemas/VerblijfsAdres" + $ref: '#/components/schemas/VerblijfsAdres' subVerblijfBuitenland: - $ref: "#/components/schemas/SubVerblijfBuitenland" + $ref: '#/components/schemas/SubVerblijfBuitenland' betrokkene_identificatie_RolVestiging: type: object properties: betrokkeneIdentificatie: - $ref: "#/components/schemas/RolVestiging" + $ref: '#/components/schemas/RolVestiging' vestiging: type: object allOf: - - $ref: "#/components/schemas/Rol" - - $ref: "#/components/schemas/betrokkene_identificatie_RolVestiging" + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolVestiging' RolOrganisatorischeEenheid: type: object properties: @@ -5328,12 +5496,12 @@ components: type: object properties: betrokkeneIdentificatie: - $ref: "#/components/schemas/RolOrganisatorischeEenheid" + $ref: '#/components/schemas/RolOrganisatorischeEenheid' organisatorische_eenheid: type: object allOf: - - $ref: "#/components/schemas/Rol" - - $ref: "#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid" + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolOrganisatorischeEenheid' RolMedewerker: type: object properties: @@ -5350,8 +5518,8 @@ components: maxLength: 200 voorletters: title: Voorletters - description: De verzameling letters die gevormd wordt door de eerste letter van - alle in volgorde voorkomende voornamen. + description: De verzameling letters die gevormd wordt door de eerste letter + van alle in volgorde voorkomende voornamen. type: string maxLength: 20 voorvoegselAchternaam: @@ -5364,23 +5532,23 @@ components: type: object properties: betrokkeneIdentificatie: - $ref: "#/components/schemas/RolMedewerker" + $ref: '#/components/schemas/RolMedewerker' medewerker: type: object allOf: - - $ref: "#/components/schemas/Rol" - - $ref: "#/components/schemas/betrokkene_identificatie_RolMedewerker" + - $ref: '#/components/schemas/Rol' + - $ref: '#/components/schemas/betrokkene_identificatie_RolMedewerker' Status: required: - - zaak - - statustype - - datumStatusGezet + - zaak + - statustype + - datumStatusGezet type: object properties: url: title: Url - description: URL-referentie naar dit object. Dit is de unieke identificatie en - locatie van dit object. + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. type: string format: uri readOnly: true @@ -5411,15 +5579,14 @@ components: format: date-time statustoelichting: title: Statustoelichting - description: Een, voor de initiator van de zaak relevante, toelichting op de - status van een zaak. + description: Een, voor de initiator van de zaak relevante, toelichting op + de status van een zaak. type: string maxLength: 1000 indicatieLaatstGezetteStatus: title: Indicatie laatst gezette status description: Het gegeven is afleidbaar uit de historie van de attribuutsoort - Datum status gezet van van alle statussen bij de desbetreffende - zaak. + Datum status gezet van van alle statussen bij de desbetreffende zaak. type: boolean gezetdoor: title: Gezet door @@ -5437,14 +5604,14 @@ components: uniqueItems: true ZaakContactMoment: required: - - zaak - - contactmoment + - zaak + - contactmoment type: object properties: url: title: Url - description: URL-referentie naar dit object. Dit is de unieke identificatie en - locatie van dit object. + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. type: string format: uri readOnly: true @@ -5463,21 +5630,22 @@ components: format: uri contactmoment: title: Contactmoment - description: URL-referentie naar het CONTACTMOMENT (in de Klantinteractie API) + description: URL-referentie naar het CONTACTMOMENT (in de Klantinteractie + API) type: string format: uri maxLength: 1000 minLength: 1 ZaakInformatieObject: required: - - informatieobject - - zaak + - informatieobject + - zaak type: object properties: url: title: Url - description: URL-referentie naar dit object. Dit is de unieke identificatie en - locatie van dit object. + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. type: string format: uri readOnly: true @@ -5491,8 +5659,8 @@ components: readOnly: true informatieobject: title: Informatieobject - description: URL-referentie naar het INFORMATIEOBJECT (in de Documenten API), - waar ook de relatieinformatie opgevraagd kan worden. + description: URL-referentie naar het INFORMATIEOBJECT (in de Documenten + API), waar ook de relatieinformatie opgevraagd kan worden. type: string format: uri maxLength: 1000 @@ -5506,12 +5674,13 @@ components: title: Aard relatie weergave type: string enum: - - "Hoort bij, omgekeerd: kent" - - "Legt vast, omgekeerd: kan vastgelegd zijn als" + - 'Hoort bij, omgekeerd: kent' + - 'Legt vast, omgekeerd: kan vastgelegd zijn als' readOnly: true titel: title: Titel - description: De naam waaronder het INFORMATIEOBJECT binnen het OBJECT bekend is. + description: De naam waaronder het INFORMATIEOBJECT binnen het OBJECT bekend + is. type: string maxLength: 200 beschrijving: @@ -5522,8 +5691,8 @@ components: registratiedatum: title: Registratiedatum 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. + heeft geregistreerd bij het OBJECT. Geldige waardes zijn datumtijden gelegen + op of voor de huidige datum en tijd. type: string format: date-time readOnly: true @@ -5537,69 +5706,73 @@ components: status: title: Status 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. + ZAAK-INFORMATIEOBJECT relevant is (geweest) met het oog op het bereiken + van die STATUS en/of de communicatie daarover. type: string format: uri nullable: true ObjectTypeOverigeDefinitie: - description: >- - Verwijzing naar het schema van het type OBJECT als `objectType` de - waarde "overige" heeft. + 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/). + * 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 `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. + * 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. + 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.' required: - - url - - schema - - objectData + - url + - schema + - objectData type: object properties: url: 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. + resource moet de [JSON-schema](https://json-schema.org/)-definitie van + het objecttype bevatten. type: string format: uri maxLength: 1000 minLength: 1 schema: 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`." + 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`.' type: string maxLength: 100 minLength: 1 objectData: 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`." + 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`.' type: string maxLength: 100 minLength: 1 nullable: true ZaakObject: required: - - zaak - - objectType + - zaak + - objectType type: object properties: url: title: Url - description: URL-referentie naar dit object. Dit is de unieke identificatie en - locatie van dit object. + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. type: string format: uri readOnly: true @@ -5624,10 +5797,8 @@ components: maxLength: 1000 objectType: title: Object type - description: >- - Beschrijft het type OBJECT gerelateerd aan de ZAAK. Als er geen - passend type is, dan moet het type worden opgegeven onder - `objectTypeOverige`. + 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: @@ -5693,49 +5864,49 @@ components: * `zakelijk_recht` - Zakelijk recht - * `overige` - Overige + * `overige` - Overige' 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 + - 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 objectTypeOverige: title: Object type overige description: Beschrijft het type OBJECT als `objectType` de waarde "overige" heeft. type: string - pattern: "[a-z\\_]+" + pattern: '[a-z\_]+' maxLength: 100 objectTypeOverigeDefinitie: - $ref: "#/components/schemas/ObjectTypeOverigeDefinitie" + $ref: '#/components/schemas/ObjectTypeOverigeDefinitie' relatieomschrijving: title: Relatieomschrijving description: Omschrijving van de betrekking tussen de ZAAK en het OBJECT. @@ -5745,10 +5916,10 @@ components: propertyName: objectType ObjectAdres: required: - - identificatie - - wplWoonplaatsNaam - - gorOpenbareRuimteNaam - - huisnummer + - identificatie + - wplWoonplaatsNaam + - gorOpenbareRuimteNaam + - huisnummer type: object properties: identificatie: @@ -5764,8 +5935,8 @@ components: minLength: 1 gorOpenbareRuimteNaam: title: Gor openbare ruimte naam - description: Een door het bevoegde gemeentelijke orgaan aan een OPENBARE RUIMTE - toegekende benaming + description: Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming type: string maxLength: 80 minLength: 1 @@ -5790,22 +5961,22 @@ components: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectAdres" + $ref: '#/components/schemas/ObjectAdres' adres: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectAdres" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectAdres' besluit: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" + - $ref: '#/components/schemas/ZaakObject' ObjectBuurt: required: - - buurtCode - - buurtNaam - - gemGemeenteCode - - wykWijkCode + - buurtCode + - buurtNaam + - gemGemeenteCode + - wykWijkCode type: object properties: buurtCode: @@ -5837,25 +6008,25 @@ components: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectBuurt" + $ref: '#/components/schemas/ObjectBuurt' buurt: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectBuurt" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectBuurt' enkelvoudig_document: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" + - $ref: '#/components/schemas/ZaakObject' ObjectGemeente: required: - - gemeenteNaam - - gemeenteCode + - gemeenteNaam + - gemeenteCode type: object properties: gemeenteNaam: title: Gemeente naam - description: De officiële door de gemeente vastgestelde gemeentenaam. + description: "De offici\xEBle door de gemeente vastgestelde gemeentenaam." type: string maxLength: 80 minLength: 1 @@ -5870,16 +6041,16 @@ components: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectGemeente" + $ref: '#/components/schemas/ObjectGemeente' gemeente: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectGemeente" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeente' ObjectGemeentelijkeOpenbareRuimte: required: - - identificatie - - openbareRuimteNaam + - identificatie + - openbareRuimteNaam type: object properties: identificatie: @@ -5890,8 +6061,8 @@ components: minLength: 1 openbareRuimteNaam: title: Openbare ruimte naam - description: Een door het bevoegde gemeentelijke orgaan aan een OPENBARE RUIMTE - toegekende benaming + description: Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming type: string maxLength: 80 minLength: 1 @@ -5899,19 +6070,18 @@ components: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectGemeentelijkeOpenbareRuimte" + $ref: '#/components/schemas/ObjectGemeentelijkeOpenbareRuimte' gemeentelijke_openbare_ruimte: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRui\ - mte" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectGemeentelijkeOpenbareRuimte' TerreinGebouwdObjectAdres: required: - - oaoIdentificatie - - wplWoonplaatsNaam - - gorOpenbareRuimteNaam - - aoaHuisnummer + - oaoIdentificatie + - wplWoonplaatsNaam + - gorOpenbareRuimteNaam + - aoaHuisnummer type: object properties: numIdentificatie: @@ -5931,8 +6101,8 @@ components: minLength: 1 gorOpenbareRuimteNaam: title: Gor openbare ruimte naam - description: Een door het bevoegde gemeentelijke orgaan aan een OPENBARE RUIMTE - toegekende benaming + description: Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming type: string maxLength: 80 minLength: 1 @@ -5960,7 +6130,7 @@ components: nullable: true ObjectTerreinGebouwdObject: required: - - identificatie + - identificatie type: object properties: identificatie: @@ -5970,67 +6140,77 @@ components: maxLength: 100 minLength: 1 adresAanduidingGrp: - $ref: "#/components/schemas/TerreinGebouwdObjectAdres" + $ref: '#/components/schemas/TerreinGebouwdObjectAdres' nullable: true ObjectHuishouden: required: - - nummer + - nummer type: object properties: nummer: title: Nummer - description: Uniek identificerend administratienummer van een huishouden zoals - toegekend door de gemeente waarin het huishouden woonachtig is. + description: Uniek identificerend administratienummer van een huishouden + zoals toegekend door de gemeente waarin het huishouden woonachtig is. type: string maxLength: 12 minLength: 1 isGehuisvestIn: - $ref: "#/components/schemas/ObjectTerreinGebouwdObject" + $ref: '#/components/schemas/ObjectTerreinGebouwdObject' object_identificatie_ObjectHuishouden: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectHuishouden" + $ref: '#/components/schemas/ObjectHuishouden' huishouden: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectHuishouden" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectHuishouden' ObjectInrichtingselement: required: - - type - - identificatie + - type + - identificatie type: object properties: type: title: Type - description: |- - Specificatie van de aard van het inrichtingselement. + 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 + + * `weginrichtingselement` - Weginrichtingselement' type: string enum: - - bak - - bord - - installatie - - kast - - mast - - paal - - sensor - - straatmeubilair - - waterinrichtingselement - - weginrichtingselement + - bak + - bord + - installatie + - kast + - mast + - paal + - sensor + - straatmeubilair + - waterinrichtingselement + - weginrichtingselement identificatie: title: Identificatie description: De unieke identificatie van het OBJECT @@ -6046,16 +6226,16 @@ components: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectInrichtingselement" + $ref: '#/components/schemas/ObjectInrichtingselement' inrichtingselement: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectInrichtingselement" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectInrichtingselement' ObjectKadastraleOnroerendeZaak: required: - - kadastraleIdentificatie - - kadastraleAanduiding + - kadastraleIdentificatie + - kadastraleAanduiding type: object properties: kadastraleIdentificatie: @@ -6066,8 +6246,8 @@ components: minLength: 1 kadastraleAanduiding: title: Kadastrale aanduiding - description: De typering van de kadastrale aanduiding van een onroerende zaak - conform Kadaster + description: De typering van de kadastrale aanduiding van een onroerende + zaak conform Kadaster type: string maxLength: 1000 minLength: 1 @@ -6075,23 +6255,22 @@ components: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectKadastraleOnroerendeZaak" + $ref: '#/components/schemas/ObjectKadastraleOnroerendeZaak' kadastrale_onroerende_zaak: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectKadastraleOnroerendeZaak' ObjectKunstwerkdeel: required: - - type - - identificatie - - naam + - type + - identificatie + - naam type: object properties: type: title: Type - description: >- - Specificatie van het soort Kunstwerk waartoe het kunstwerkdeel + description: 'Specificatie van het soort Kunstwerk waartoe het kunstwerkdeel behoort. @@ -6128,25 +6307,25 @@ components: * `steiger` - Steiger - * `stuw` - Stuw + * `stuw` - Stuw' type: string enum: - - keermuur - - overkluizing - - duiker - - faunavoorziening - - vispassage - - bodemval - - coupure - - ponton - - voorde - - hoogspanningsmast - - gemaal - - perron - - sluis - - strekdam - - steiger - - stuw + - keermuur + - overkluizing + - duiker + - faunavoorziening + - vispassage + - bodemval + - coupure + - ponton + - voorde + - hoogspanningsmast + - gemaal + - perron + - sluis + - strekdam + - steiger + - stuw identificatie: title: Identificatie description: De unieke identificatie van het OBJECT @@ -6162,23 +6341,23 @@ components: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectKunstwerkdeel" + $ref: '#/components/schemas/ObjectKunstwerkdeel' kunstwerkdeel: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectKunstwerkdeel" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectKunstwerkdeel' ObjectMaatschappelijkeActiviteit: required: - - kvkNummer - - handelsnaam + - kvkNummer + - handelsnaam type: object properties: kvkNummer: title: Kvk nummer description: Landelijk uniek identificerend administratienummer van een - MAATSCHAPPELIJKE ACTIVITEIT zoals toegewezen door de Kamer van - Koophandel (KvK). + MAATSCHAPPELIJKE ACTIVITEIT zoals toegewezen door de Kamer van Koophandel + (KvK). type: string maxLength: 8 minLength: 1 @@ -6192,33 +6371,32 @@ components: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectMaatschappelijkeActiviteit" + $ref: '#/components/schemas/ObjectMaatschappelijkeActiviteit' maatschappelijke_activiteit: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectMaatschappelijkeActivite\ - it" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectMaatschappelijkeActiviteit' object_identificatie_RolMedewerker: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/RolMedewerker" + $ref: '#/components/schemas/RolMedewerker' object_identificatie_RolNatuurlijkPersoon: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/RolNatuurlijkPersoon" + $ref: '#/components/schemas/RolNatuurlijkPersoon' object_identificatie_RolNietNatuurlijkPersoon: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/RolNietNatuurlijkPersoon" + $ref: '#/components/schemas/RolNietNatuurlijkPersoon' ObjectOpenbareRuimte: required: - - identificatie - - wplWoonplaatsNaam - - gorOpenbareRuimteNaam + - identificatie + - wplWoonplaatsNaam + - gorOpenbareRuimteNaam type: object properties: identificatie: @@ -6234,8 +6412,8 @@ components: minLength: 1 gorOpenbareRuimteNaam: title: Gor openbare ruimte naam - description: Een door het bevoegde gemeentelijke orgaan aan een OPENBARE RUIMTE - toegekende benaming + description: Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming type: string maxLength: 80 minLength: 1 @@ -6243,20 +6421,20 @@ components: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectOpenbareRuimte" + $ref: '#/components/schemas/ObjectOpenbareRuimte' openbare_ruimte: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectOpenbareRuimte" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectOpenbareRuimte' object_identificatie_RolOrganisatorischeEenheid: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/RolOrganisatorischeEenheid" + $ref: '#/components/schemas/RolOrganisatorischeEenheid' ObjectPand: required: - - identificatie + - identificatie type: object properties: identificatie: @@ -6269,35 +6447,39 @@ components: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectPand" + $ref: '#/components/schemas/ObjectPand' pand: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectPand" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectPand' ObjectSpoorbaandeel: required: - - type - - identificatie + - type + - identificatie type: object properties: type: title: Type - description: |- - Specificatie van het soort Spoorbaan + description: 'Specificatie van het soort Spoorbaan + Uitleg bij mogelijke waarden: + * `breedspoor` - breedspoor + * `normaalspoor` - normaalspoor + * `smalspoor` - smalspoor - * `spoorbaan` - spoorbaan + + * `spoorbaan` - spoorbaan' type: string enum: - - breedspoor - - normaalspoor - - smalspoor - - spoorbaan + - breedspoor + - normaalspoor + - smalspoor + - spoorbaan identificatie: title: Identificatie description: De unieke identificatie van het OBJECT @@ -6313,20 +6495,20 @@ components: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectSpoorbaandeel" + $ref: '#/components/schemas/ObjectSpoorbaandeel' spoorbaandeel: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectSpoorbaandeel" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectSpoorbaandeel' status: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" + - $ref: '#/components/schemas/ZaakObject' ObjectTerreindeel: required: - - type - - identificatie + - type + - identificatie type: object properties: type: @@ -6349,50 +6531,54 @@ components: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectTerreindeel" + $ref: '#/components/schemas/ObjectTerreindeel' terreindeel: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectTerreindeel" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreindeel' object_identificatie_ObjectTerreinGebouwdObject: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectTerreinGebouwdObject" + $ref: '#/components/schemas/ObjectTerreinGebouwdObject' terrein_gebouwd_object: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectTerreinGebouwdObject' object_identificatie_RolVestiging: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/RolVestiging" + $ref: '#/components/schemas/RolVestiging' ObjectWaterdeel: required: - - typeWaterdeel - - identificatie + - typeWaterdeel + - identificatie type: object properties: typeWaterdeel: title: Type waterdeel - description: |- - Specificatie van het soort water + description: 'Specificatie van het soort water + Uitleg bij mogelijke waarden: + * `zee` - Zee + * `waterloop` - Waterloop + * `watervlakte` - Watervlakte - * `greppel_droge_sloot` - Greppel, droge sloot + + * `greppel_droge_sloot` - Greppel, droge sloot' type: string enum: - - zee - - waterloop - - watervlakte - - greppel_droge_sloot + - zee + - waterloop + - watervlakte + - greppel_droge_sloot identificatie: title: Identificatie description: De unieke identificatie van het OBJECT @@ -6408,16 +6594,16 @@ components: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectWaterdeel" + $ref: '#/components/schemas/ObjectWaterdeel' waterdeel: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectWaterdeel" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWaterdeel' ObjectWegdeel: required: - - type - - identificatie + - type + - identificatie type: object properties: type: @@ -6440,17 +6626,17 @@ components: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectWegdeel" + $ref: '#/components/schemas/ObjectWegdeel' wegdeel: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectWegdeel" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWegdeel' ObjectWijk: required: - - wijkCode - - wijkNaam - - gemGemeenteCode + - wijkCode + - wijkNaam + - gemGemeenteCode type: object properties: wijkCode: @@ -6476,16 +6662,16 @@ components: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectWijk" + $ref: '#/components/schemas/ObjectWijk' wijk: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectWijk" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWijk' ObjectWoonplaats: required: - - identificatie - - woonplaatsNaam + - identificatie + - woonplaatsNaam type: object properties: identificatie: @@ -6505,18 +6691,18 @@ components: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectWoonplaats" + $ref: '#/components/schemas/ObjectWoonplaats' woonplaats: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectWoonplaats" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWoonplaats' WozObjectAdres: required: - - aoaIdentificatie - - wplWoonplaatsNaam - - gorOpenbareRuimteNaam - - aoaHuisnummer + - aoaIdentificatie + - wplWoonplaatsNaam + - gorOpenbareRuimteNaam + - aoaHuisnummer type: object properties: aoaIdentificatie: @@ -6532,8 +6718,8 @@ components: minLength: 1 gorOpenbareRuimteNaam: title: Gor openbare ruimte naam - description: Een door het bevoegde gemeentelijke orgaan aan een OPENBARE RUIMTE - toegekende benaming + description: Een door het bevoegde gemeentelijke orgaan aan een OPENBARE + RUIMTE toegekende benaming type: string maxLength: 80 minLength: 1 @@ -6561,7 +6747,7 @@ components: nullable: true ObjectWozObject: required: - - wozObjectNummer + - wozObjectNummer type: object properties: wozObjectNummer: @@ -6571,10 +6757,10 @@ components: maxLength: 100 minLength: 1 aanduidingWozObject: - $ref: "#/components/schemas/WozObjectAdres" + $ref: '#/components/schemas/WozObjectAdres' ObjectWozDeelobject: required: - - nummerWozDeelObject + - nummerWozDeelObject type: object properties: nummerWozDeelObject: @@ -6584,30 +6770,30 @@ components: maxLength: 6 minLength: 1 isOnderdeelVan: - $ref: "#/components/schemas/ObjectWozObject" + $ref: '#/components/schemas/ObjectWozObject' object_identificatie_ObjectWozDeelobject: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectWozDeelobject" + $ref: '#/components/schemas/ObjectWozDeelobject' woz_deelobject: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectWozDeelobject" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozDeelobject' object_identificatie_ObjectWozObject: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectWozObject" + $ref: '#/components/schemas/ObjectWozObject' woz_object: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectWozObject" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozObject' ObjectWozWaarde: required: - - waardepeildatum + - waardepeildatum type: object properties: waardepeildatum: @@ -6617,28 +6803,28 @@ components: maxLength: 9 minLength: 1 isVoor: - $ref: "#/components/schemas/ObjectWozObject" + $ref: '#/components/schemas/ObjectWozObject' object_identificatie_ObjectWozWaarde: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectWozWaarde" + $ref: '#/components/schemas/ObjectWozWaarde' woz_waarde: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectWozWaarde" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectWozWaarde' ZakelijkRechtHeeftAlsGerechtigde: type: object properties: natuurlijkPersoon: - $ref: "#/components/schemas/RolNatuurlijkPersoon" + $ref: '#/components/schemas/RolNatuurlijkPersoon' nietNatuurlijkPersoon: - $ref: "#/components/schemas/RolNietNatuurlijkPersoon" + $ref: '#/components/schemas/RolNietNatuurlijkPersoon' ObjectZakelijkRecht: required: - - identificatie - - avgAard + - identificatie + - avgAard type: object properties: identificatie: @@ -6654,22 +6840,22 @@ components: maxLength: 1000 minLength: 1 heeftBetrekkingOp: - $ref: "#/components/schemas/ObjectKadastraleOnroerendeZaak" + $ref: '#/components/schemas/ObjectKadastraleOnroerendeZaak' heeftAlsGerechtigde: - $ref: "#/components/schemas/ZakelijkRechtHeeftAlsGerechtigde" + $ref: '#/components/schemas/ZakelijkRechtHeeftAlsGerechtigde' object_identificatie_ObjectZakelijkRecht: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectZakelijkRecht" + $ref: '#/components/schemas/ObjectZakelijkRecht' zakelijk_recht: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectZakelijkRecht" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectZakelijkRecht' ObjectOverige: required: - - overigeData + - overigeData type: object properties: overigeData: @@ -6679,22 +6865,22 @@ components: type: object properties: objectIdentificatie: - $ref: "#/components/schemas/ObjectOverige" + $ref: '#/components/schemas/ObjectOverige' overige: type: object allOf: - - $ref: "#/components/schemas/ZaakObject" - - $ref: "#/components/schemas/object_identificatie_ObjectOverige" + - $ref: '#/components/schemas/ZaakObject' + - $ref: '#/components/schemas/object_identificatie_ObjectOverige' ZaakVerzoek: required: - - zaak - - verzoek + - zaak + - verzoek type: object properties: url: title: Url - description: URL-referentie naar dit object. Dit is de unieke identificatie en - locatie van dit object. + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. type: string format: uri readOnly: true @@ -6722,22 +6908,22 @@ components: title: Geometry description: GeoJSON geometry required: - - type + - type type: object properties: type: description: The geometry type type: string enum: - - Point - - MultiPoint - - LineString - - MultiLineString - - Polygon - - MultiPolygon - - Feature - - FeatureCollection - - GeometryCollection + - Point + - MultiPoint + - LineString + - MultiLineString + - Polygon + - MultiPolygon + - Feature + - FeatureCollection + - GeometryCollection externalDocs: url: https://tools.ietf.org/html/rfc7946#section-3.1 Point2D: @@ -6752,112 +6938,112 @@ components: description: GeoJSON point geometry type: object allOf: - - $ref: "#/components/schemas/Geometry" - - required: - - coordinates - type: object - properties: - coordinates: - $ref: "#/components/schemas/Point2D" + - $ref: '#/components/schemas/Geometry' + - required: + - coordinates + type: object + properties: + coordinates: + $ref: '#/components/schemas/Point2D' externalDocs: url: https://tools.ietf.org/html/rfc7946#section-3.1.2 MultiPoint: description: GeoJSON multi-point geometry type: object allOf: - - $ref: "#/components/schemas/Geometry" - - required: - - coordinates - type: object - properties: - coordinates: - type: array - items: - $ref: "#/components/schemas/Point2D" + - $ref: '#/components/schemas/Geometry' + - required: + - coordinates + type: object + properties: + coordinates: + type: array + items: + $ref: '#/components/schemas/Point2D' externalDocs: url: https://tools.ietf.org/html/rfc7946#section-3.1.3 LineString: description: GeoJSON line-string geometry type: object allOf: - - $ref: "#/components/schemas/Geometry" - - required: - - coordinates - type: object - properties: - coordinates: - type: array - items: - $ref: "#/components/schemas/Point2D" - minItems: 2 + - $ref: '#/components/schemas/Geometry' + - required: + - coordinates + type: object + properties: + coordinates: + type: array + items: + $ref: '#/components/schemas/Point2D' + minItems: 2 externalDocs: url: https://tools.ietf.org/html/rfc7946#section-3.1.4 MultiLineString: description: GeoJSON multi-line-string geometry type: object allOf: - - $ref: "#/components/schemas/Geometry" - - required: - - coordinates - type: object - properties: - coordinates: + - $ref: '#/components/schemas/Geometry' + - required: + - coordinates + type: object + properties: + coordinates: + type: array + items: type: array items: - type: array - items: - $ref: "#/components/schemas/Point2D" + $ref: '#/components/schemas/Point2D' externalDocs: url: https://tools.ietf.org/html/rfc7946#section-3.1.5 Polygon: description: GeoJSON polygon geometry type: object allOf: - - $ref: "#/components/schemas/Geometry" - - required: - - coordinates - type: object - properties: - coordinates: + - $ref: '#/components/schemas/Geometry' + - required: + - coordinates + type: object + properties: + coordinates: + type: array + items: type: array items: - type: array - items: - $ref: "#/components/schemas/Point2D" + $ref: '#/components/schemas/Point2D' externalDocs: url: https://tools.ietf.org/html/rfc7946#section-3.1.6 MultiPolygon: description: GeoJSON multi-polygon geometry type: object allOf: - - $ref: "#/components/schemas/Geometry" - - required: - - coordinates - type: object - properties: - coordinates: + - $ref: '#/components/schemas/Geometry' + - required: + - coordinates + type: object + properties: + coordinates: + type: array + items: type: array items: type: array items: - type: array - items: - $ref: "#/components/schemas/Point2D" + $ref: '#/components/schemas/Point2D' externalDocs: url: https://tools.ietf.org/html/rfc7946#section-3.1.7 GeometryCollection: description: GeoJSON multi-polygon geometry type: object allOf: - - $ref: "#/components/schemas/Geometry" - - required: - - geometries - type: object - properties: - geometries: - type: array - items: - $ref: "#/components/schemas/Geometry" + - $ref: '#/components/schemas/Geometry' + - required: + - geometries + type: object + properties: + geometries: + type: array + items: + $ref: '#/components/schemas/Geometry' externalDocs: url: https://tools.ietf.org/html/rfc7946#section-3.1.8 GeoJSONGeometry: @@ -6866,41 +7052,42 @@ components: discriminator: propertyName: type 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" + - $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' Verlenging: - description: Gegevens omtrent het verlengen van de doorlooptijd van de - behandeling van de ZAAK + description: Gegevens omtrent het verlengen van de doorlooptijd van de behandeling + van de ZAAK required: - - reden - - duur + - reden + - duur type: object properties: reden: title: Reden - description: Omschrijving van de reden voor het verlengen van de behandeling van - de zaak. + description: Omschrijving van de reden voor het verlengen van de behandeling + van de zaak. type: string maxLength: 200 minLength: 1 duur: title: Duur - 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. + 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. type: string format: duration nullable: true Opschorting: - description: Gegevens omtrent het tijdelijk opschorten van de behandeling van de ZAAK + description: Gegevens omtrent het tijdelijk opschorten van de behandeling van + de ZAAK required: - - indicatie - - reden + - indicatie + - reden type: object properties: indicatie: @@ -6917,8 +7104,8 @@ components: RelevanteZaak: description: Een lijst van relevante andere zaken. required: - - url - - aardRelatie + - url + - aardRelatie type: object properties: url: @@ -6929,30 +7116,32 @@ components: minLength: 1 aardRelatie: title: Aard relatie - description: >- - Benamingen van de aard van de relaties van andere zaken tot + 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. + * `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. + * `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. + * `bijdrage` - Aan het bereiken van de uitkomst van de andere zaak levert + de onderhanden zaak een bijdrage.' type: string enum: - - vervolg - - onderwerp - - bijdrage + - vervolg + - onderwerp + - bijdrage ZaakKenmerk: - description: Lijst van kenmerken. Merk op dat refereren naar gerelateerde - objecten beter kan via `ZaakObject`. + description: Lijst van kenmerken. Merk op dat refereren naar gerelateerde objecten + beter kan via `ZaakObject`. required: - - kenmerk - - bron + - kenmerk + - bron type: object properties: kenmerk: @@ -6971,11 +7160,11 @@ components: description: Een ZAAK bij een andere organisatie waarin een bijdrage geleverd wordt aan het bereiken van de uitkomst van de onderhanden ZAAK. required: - - aanvraagdatum - - aardRelatie - - datumStatusGezet - - zaaktypeOmschrijvingGeneriek - - zaaktypecode + - aanvraagdatum + - aardRelatie + - datumStatusGezet + - zaaktypeOmschrijvingGeneriek + - zaaktypecode type: object properties: aanvraagdatum: @@ -6990,35 +7179,36 @@ components: ZAAK uit te gaan voeren. type: string enum: - - opdrachtgever - - opdrachtnemer + - opdrachtgever + - opdrachtnemer datumStatusGezet: title: Datum status gezet - description: De datum waarop de gerelateerde ZAAK de laatst bekende status heeft - verkregen. + description: De datum waarop de gerelateerde ZAAK de laatst bekende status + heeft verkregen. type: string format: date-time eindDatum: title: Einddatum - description: De datum waarop de uitvoering van de gerelateerde ZAAK afgerond is. + description: De datum waarop de uitvoering van de gerelateerde ZAAK afgerond + is. type: string format: date resultaatomschrijving: title: Resultaatomschrijving - description: Een korte omschrijving wat het resultaat van de gerelateerde ZAAK - inhoudt. + description: Een korte omschrijving wat het resultaat van de gerelateerde + ZAAK inhoudt. type: string maxLength: 80 startdatum: title: Startdatum - description: De datum waarop met de uitvoering van de gerelateerde ZAAK is - gestart. + description: De datum waarop met de uitvoering van de gerelateerde ZAAK + is gestart. type: string format: date statusOmschrijvingGeneriek: title: Status-omschrijving generiek - description: Algemeen gehanteerde omschrijving van de aard van de laatst bekende - status van de gerelateerde ZAAK. + description: Algemeen gehanteerde omschrijving van de aard van de laatst + bekende status van de gerelateerde ZAAK. type: string maxLength: 80 verantwoordelijkeOrganisatie: @@ -7034,8 +7224,8 @@ components: maxLength: 40 zaaktypeOmschrijvingGeneriek: title: Zaaktype-omschrijving generiek - description: Algemeen gehanteerde omschrijving van de aard van ZAAKen van het - ZAAKTYPE waartoe de gerelateerde zaak behoort. + description: Algemeen gehanteerde omschrijving van de aard van ZAAKen van + het ZAAKTYPE waartoe de gerelateerde zaak behoort. type: string maxLength: 80 minLength: 1 @@ -7053,20 +7243,20 @@ components: maxLength: 200 nullable: true Processobject: - 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. + 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. required: - - datumkenmerk - - identificatie - - objecttype - - registratie + - datumkenmerk + - identificatie + - objecttype + - registratie type: object properties: datumkenmerk: title: Datumkenmerk - description: De naam van de attribuutsoort van het procesobject dat bepalend is - voor het einde van de procestermijn. + description: De naam van de attribuutsoort van het procesobject dat bepalend + is voor het einde van de procestermijn. type: string maxLength: 250 minLength: 1 @@ -7084,23 +7274,24 @@ components: minLength: 1 registratie: title: Registratie - description: De naam van de registratie waarvan het procesobject deel uit maakt. + description: De naam van de registratie waarvan het procesobject deel uit + maakt. type: string maxLength: 250 minLength: 1 nullable: true Zaak: required: - - bronorganisatie - - zaaktype - - verantwoordelijkeOrganisatie - - startdatum + - bronorganisatie + - zaaktype + - verantwoordelijkeOrganisatie + - startdatum type: object properties: url: title: Url - description: URL-referentie naar dit object. Dit is de unieke identificatie en - locatie van dit object. + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. type: string format: uri readOnly: true @@ -7120,10 +7311,9 @@ components: maxLength: 40 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 + 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 maxLength: 9 minLength: 1 @@ -7148,16 +7338,15 @@ components: 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. + geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag + gebruikt. type: string format: date verantwoordelijkeOrganisatie: title: Verantwoordelijke organisatie - 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 + 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 type: string maxLength: 9 minLength: 1 @@ -7196,16 +7385,16 @@ components: communicatiekanaal: title: Communicatiekanaal description: Het medium waarlangs de aanleiding om een zaak te starten is - ontvangen. URL naar een communicatiekanaal in de VNG-Referentielijst - van communicatiekanalen. + ontvangen. URL naar een communicatiekanaal in de VNG-Referentielijst van + communicatiekanalen. type: string format: uri maxLength: 1000 productenOfDiensten: 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. + 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. type: array items: title: URL naar product/dienst @@ -7215,24 +7404,23 @@ components: minLength: 1 vertrouwelijkheidaanduiding: 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. + 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. type: string enum: - - openbaar - - beperkt_openbaar - - intern - - zaakvertrouwelijk - - vertrouwelijk - - confidentieel - - geheim - - zeer_geheim + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim betalingsindicatie: title: Betalingsindicatie - description: >- - Indicatie of de, met behandeling van de zaak gemoeide, kosten + description: 'Indicatie of de, met behandeling van de zaak gemoeide, kosten betaald zijn door de desbetreffende betrokkene. @@ -7245,13 +7433,13 @@ components: * `gedeeltelijk` - De met de zaak gemoeide kosten zijn gedeeltelijk betaald. - * `geheel` - De met de zaak gemoeide kosten zijn geheel betaald. + * `geheel` - De met de zaak gemoeide kosten zijn geheel betaald.' type: string enum: - - nvt - - nog_niet - - gedeeltelijk - - geheel + - nvt + - nog_niet + - gedeeltelijk + - geheel betalingsindicatieWeergave: title: Betalingsindicatie weergave description: Uitleg bij `betalingsindicatie`. @@ -7266,24 +7454,24 @@ components: format: date-time nullable: true zaakgeometrie: - $ref: "#/components/schemas/GeoJSONGeometry" + $ref: '#/components/schemas/GeoJSONGeometry' verlenging: - $ref: "#/components/schemas/Verlenging" + $ref: '#/components/schemas/Verlenging' opschorting: - $ref: "#/components/schemas/Opschorting" + $ref: '#/components/schemas/Opschorting' selectielijstklasse: title: Selectielijstklasse 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. + Archiefbescheiden' die, gezien het zaaktype en het resultaattype van de + zaak, bepalend is voor het archiefregime van de zaak. type: string format: uri maxLength: 1000 hoofdzaak: 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 één is. + 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." type: string format: uri nullable: true @@ -7300,7 +7488,7 @@ components: description: Een lijst van relevante andere zaken. type: array items: - $ref: "#/components/schemas/RelevanteZaak" + $ref: '#/components/schemas/RelevanteZaak' eigenschappen: type: array items: @@ -7308,13 +7496,6 @@ components: format: uri readOnly: true uniqueItems: true - rollen: - type: array - items: - type: string - format: uri - readOnly: true - uniqueItems: true status: title: Status description: Indien geen status bekend is, dan is de waarde 'null' @@ -7322,125 +7503,97 @@ components: format: uri readOnly: true nullable: true - zaakinformatieobjecten: - type: array - items: - type: string - format: uri - readOnly: true - uniqueItems: true - zaakobjecten: - type: array - items: - type: string - format: uri - readOnly: true - uniqueItems: true kenmerken: description: Lijst van kenmerken. Merk op dat refereren naar gerelateerde objecten beter kan via `ZaakObject`. type: array items: - $ref: "#/components/schemas/ZaakKenmerk" + $ref: '#/components/schemas/ZaakKenmerk' archiefnominatie: title: Archiefnominatie - description: >- - Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + 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. + * `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. + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' type: string enum: - - blijvend_bewaren - - vernietigen + - blijvend_bewaren + - vernietigen nullable: true archiefstatus: title: Archiefstatus - description: >- - Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + 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. + * `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` - 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. + * `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. + * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een + archiefbewaarplaats.' type: string enum: - - nog_te_archiveren - - gearchiveerd - - gearchiveerd_procestermijn_onbekend - - overgedragen + - nog_te_archiveren + - gearchiveerd + - gearchiveerd_procestermijn_onbekend + - overgedragen 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. + 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 format: date nullable: true resultaat: title: Resultaat - description: URL-referentie naar het RESULTAAT. Indien geen resultaat bekend is, - dan is de waarde 'null' + description: URL-referentie naar het RESULTAAT. Indien geen resultaat bekend + is, dan is de waarde 'null' type: string format: uri readOnly: true nullable: true opdrachtgevendeOrganisatie: title: Opdrachtgevende organisatie - 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. + 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. type: string maxLength: 9 - processobjectaard: - title: Procesobjectaard - description: Omschrijving van het object, subject of gebeurtenis waarop, vanuit - archiveringsoptiek, de zaak betrekking heeft. - type: string - maxLength: 200 - nullable: true - resultaattoelichting: - title: Resultaattoelichting - description: Een toelichting op wat het resultaat van de zaak inhoudt. - type: string - maxLength: 1000 - startdatumBewaartermijn: - title: Startdatum bewaartermijn - description: De datum die de start markeert van de termijn waarop het - zaakdossier vernietigd moet worden. - type: string - format: date - nullable: true gerelateerdeExterneZaken: - $ref: "#/components/schemas/GerelateerdeExterneZaken" + $ref: '#/components/schemas/GerelateerdeExterneZaken' processobject: - $ref: "#/components/schemas/Processobject" + $ref: '#/components/schemas/Processobject' GeoWithin: type: object properties: within: - $ref: "#/components/schemas/GeoJSONGeometry" + $ref: '#/components/schemas/GeoJSONGeometry' ZaakZoek: type: object properties: zaakgeometrie: - $ref: "#/components/schemas/GeoWithin" + $ref: '#/components/schemas/GeoWithin' uuid__in: description: Array of unieke resource identifiers (UUID4) type: array @@ -7455,10 +7608,9 @@ components: minLength: 1 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 + 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 minLength: 1 zaaktype: @@ -7469,21 +7621,22 @@ components: minLength: 1 archiefnominatie: title: Archiefnominatie - description: >- - Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + 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. + * `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. + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd + worden.' type: string enum: - - blijvend_bewaren - - vernietigen + - blijvend_bewaren + - vernietigen archiefnominatie__in: title: Archiefnominatie in description: Multiple values may be separated by commas. @@ -7492,50 +7645,54 @@ components: 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. + 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 minLength: 1 archiefactiedatum__lt: title: Archiefactiedatum lt 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. + 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 minLength: 1 archiefactiedatum__gt: title: Archiefactiedatum gt 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. + 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 minLength: 1 archiefstatus: title: Archiefstatus - description: >- - Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde + 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. + * `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` - 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. + * `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. + * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een + archiefbewaarplaats.' type: string enum: - - nog_te_archiveren - - gearchiveerd - - gearchiveerd_procestermijn_onbekend - - overgedragen + - nog_te_archiveren + - gearchiveerd + - gearchiveerd_procestermijn_onbekend + - overgedragen archiefstatus__in: title: Archiefstatus in description: Multiple values may be separated by commas. @@ -7568,23 +7725,28 @@ components: minLength: 1 rol__betrokkeneType: title: Rol betrokkenetype - description: |- - Type van de `betrokkene`. + 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 + + * `medewerker` - Medewerker' type: string enum: - - natuurlijk_persoon - - niet_natuurlijk_persoon - - vestiging - - organisatorische_eenheid - - medewerker + - natuurlijk_persoon + - niet_natuurlijk_persoon + - vestiging + - organisatorische_eenheid + - medewerker rol__betrokkene: title: Rol betrokkene description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. @@ -7592,44 +7754,26 @@ components: minLength: 1 rol__omschrijvingGeneriek: title: Rol omschrijvinggeneriek - description: >- - Algemeen gehanteerde benaming van de aard van de ROL, afgeleid uit - het ROLTYPE. - - - Uitleg bij mogelijke waarden: - - - * `adviseur` - Adviseur - - * `behandelaar` - Behandelaar - - * `belanghebbende` - Belanghebbende - - * `beslisser` - Beslisser - - * `initiator` - Initiator - - * `klantcontacter` - Klantcontacter - - * `zaakcoordinator` - Zaakcoördinator - - * `mede_initiator` - Mede-initiator + description: "Algemeen gehanteerde benaming van de aard van de ROL, afgeleid\ + \ uit het ROLTYPE.\n\nUitleg bij mogelijke waarden:\n\n* `adviseur` -\ + \ Adviseur\n* `behandelaar` - Behandelaar\n* `belanghebbende` - Belanghebbende\n\ + * `beslisser` - Beslisser\n* `initiator` - Initiator\n* `klantcontacter`\ + \ - Klantcontacter\n* `zaakcoordinator` - Zaakco\xF6rdinator\n* `mede_initiator`\ + \ - Mede-initiator" type: string enum: - - adviseur - - behandelaar - - belanghebbende - - beslisser - - initiator - - klantcontacter - - zaakcoordinator - - mede_initiator + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator maximaleVertrouwelijkheidaanduiding: title: Maximalevertrouwelijkheidaanduiding - description: >- - Zaken met een vertrouwelijkheidaanduiding die beperkter is dan de - aangegeven aanduiding worden uit de resultaten gefiltered. + description: 'Zaken met een vertrouwelijkheidaanduiding die beperkter is + dan de aangegeven aanduiding worden uit de resultaten gefiltered. Uitleg bij mogelijke waarden: @@ -7649,21 +7793,21 @@ components: * `geheim` - Geheim - * `zeer_geheim` - Zeer geheim + * `zeer_geheim` - Zeer geheim' type: string enum: - - openbaar - - beperkt_openbaar - - intern - - zaakvertrouwelijk - - vertrouwelijk - - confidentieel - - geheim - - zeer_geheim + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn: title: Rol betrokkeneidentificatie natuurlijkpersoon inpbsn - description: Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene - bepalingen burgerservicenummer. + description: Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet + algemene bepalingen burgerservicenummer. type: string minLength: 1 rol__betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie: @@ -7706,57 +7850,44 @@ components: minLength: 1 ordering: title: Ordering - description: |- - Het veld waarop de resultaten geordend worden. + description: 'Het veld waarop de resultaten geordend worden. + Uitleg bij mogelijke waarden: + * `startdatum` - Startdatum + * `-startdatum` - Startdatum (descending) + * `einddatum` - Einddatum + * `-einddatum` - Einddatum (descending) + * `publicatiedatum` - Publicatiedatum + * `-publicatiedatum` - Publicatiedatum (descending) - * `archiefactiedatum` - Archiefactiedatum - * `-archiefactiedatum` - Archiefactiedatum (descending) - type: string - enum: - - startdatum - - -startdatum - - einddatum - - -einddatum - - publicatiedatum - - -publicatiedatum - - archiefactiedatum - - -archiefactiedatum - expand: - title: Expand - description: |- - Haal details van inline resources direct op. - Uitleg bij mogelijke waarden: + * `archiefactiedatum` - Archiefactiedatum - * `status` - status - * `resultaat` - resultaat - * `eigenschappen` - eigenschappen - * `rollen` - rollen - * `zaakobjecten` - zaakobjecten - * `zaakinformatieobjecten` - zaakinformatieobjecten + * `-archiefactiedatum` - Archiefactiedatum (descending)' type: string enum: - - status - - resultaat - - eigenschappen - - rollen - - zaakobjecten - - zaakinformatieobjecten + - startdatum + - -startdatum + - einddatum + - -einddatum + - publicatiedatum + - -publicatiedatum + - archiefactiedatum + - -archiefactiedatum Wijzigingen: type: object properties: oud: title: Oud - description: Volledige JSON body van het object zoals dat bestond voordat de - actie heeft plaatsgevonden. + description: Volledige JSON body van het object zoals dat bestond voordat + de actie heeft plaatsgevonden. type: object nieuw: title: Nieuw @@ -7764,14 +7895,14 @@ components: type: object AuditTrail: required: - - bron - - actie - - resultaat - - hoofdObject - - resource - - resourceUrl - - resourceWeergave - - wijzigingen + - bron + - actie + - resultaat + - hoofdObject + - resource + - resourceUrl + - resourceWeergave + - wijzigingen type: object properties: uuid: @@ -7781,31 +7912,37 @@ components: format: uuid bron: title: Bron - description: |- - De naam van het component waar de wijziging in is gedaan. + 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 + + * `kc` - Klanten API' type: string enum: - - ac - - nrc - - zrc - - ztc - - drc - - brc - - cmc - - kc - - vrc + - ac + - nrc + - zrc + - ztc + - drc + - brc + - cmc + - kc applicatieId: title: Applicatie id description: Unieke identificatie van de applicatie, binnen de organisatie. @@ -7829,11 +7966,11 @@ components: maxLength: 255 actie: title: Actie - description: >- - De uitgevoerde handeling. + description: 'De uitgevoerde handeling. - De bekende waardes voor dit veld zijn hieronder aangegeven, maar andere waardes zijn ook toegestaan + De bekende waardes voor dit veld zijn hieronder aangegeven, maar + andere waardes zijn ook toegestaan Uitleg bij mogelijke waarden: @@ -7849,7 +7986,7 @@ components: * `update` - Object bijgewerkt - * `partial_update` - Object deels bijgewerkt + * `partial_update` - Object deels bijgewerkt' type: string maxLength: 50 minLength: 1 @@ -7901,10 +8038,10 @@ components: format: date-time readOnly: true wijzigingen: - $ref: "#/components/schemas/Wijzigingen" + $ref: '#/components/schemas/Wijzigingen' ZaakBesluit: required: - - besluit + - besluit type: object properties: url: @@ -7920,17 +8057,17 @@ components: readOnly: true besluit: title: Besluit - description: URL-referentie naar het BESLUIT (in de Besluiten API), waar ook de - relatieinformatie opgevraagd kan worden. + description: URL-referentie naar het BESLUIT (in de Besluiten API), waar + ook de relatieinformatie opgevraagd kan worden. type: string format: uri maxLength: 1000 minLength: 1 ZaakEigenschap: required: - - zaak - - eigenschap - - waarde + - zaak + - eigenschap + - waarde type: object properties: url: diff --git a/src/resources.md b/src/resources.md index 4613c1b8..3c6ae542 100755 --- a/src/resources.md +++ b/src/resources.md @@ -244,10 +244,7 @@ Uitleg bij mogelijke waarden: | deelzaken | URL-referenties naar deel ZAAKen. | array | nee | ~~C~~​R​~~U~~​~~D~~ | | relevanteAndereZaken | Een lijst van relevante andere zaken. | array | nee | C​R​U​D | | eigenschappen | | array | nee | ~~C~~​R​~~U~~​~~D~~ | -| rollen | | array | nee | ~~C~~​R​~~U~~​~~D~~ | | status | Indien geen status bekend is, dan is de waarde 'null' | string | nee | ~~C~~​R​~~U~~​~~D~~ | -| zaakinformatieobjecten | | array | nee | ~~C~~​R​~~U~~​~~D~~ | -| zaakobjecten | | array | nee | ~~C~~​R​~~U~~​~~D~~ | | kenmerken | Lijst van kenmerken. Merk op dat refereren naar gerelateerde objecten beter kan via `ZaakObject`. | array | nee | C​R​U​D | | archiefnominatie | Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde termijn vernietigd moet worden. @@ -266,9 +263,6 @@ Uitleg bij mogelijke waarden: | archiefactiedatum | 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. | string | nee | C​R​U​D | | resultaat | URL-referentie naar het RESULTAAT. Indien geen resultaat bekend is, dan is de waarde 'null' | string | nee | ~~C~~​R​~~U~~​~~D~~ | | opdrachtgevendeOrganisatie | 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. | string | nee | C​R​U​D | -| processobjectaard | Omschrijving van het object, subject of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking heeft. | string | nee | C​R​U​D | -| resultaattoelichting | Een toelichting op wat het resultaat van de zaak inhoudt. | string | nee | C​R​U​D | -| startdatumBewaartermijn | De datum die de start markeert van de termijn waarop het zaakdossier vernietigd moet worden. | string | nee | C​R​U​D | ## AuditTrail @@ -288,8 +282,7 @@ Uitleg bij mogelijke waarden: * `drc` - Documenten API * `brc` - Besluiten API * `cmc` - Contactmomenten API -* `kc` - Klanten API -* `vrc` - Verzoeken API | string | ja | C​R​U​D | +* `kc` - Klanten API | string | ja | C​R​U​D | | applicatieId | Unieke identificatie van de applicatie, binnen de organisatie. | string | nee | C​R​U​D | | applicatieWeergave | Vriendelijke naam van de applicatie. | string | nee | C​R​U​D | | gebruikersId | Unieke identificatie van de gebruiker die binnen de organisatie herleid kan worden naar een persoon. | string | nee | C​R​U​D | diff --git a/src/swagger2.0.json b/src/swagger2.0.json index 6b31bd86..693dde26 100755 --- a/src/swagger2.0.json +++ b/src/swagger2.0.json @@ -254,7 +254,25 @@ "operationId": "klantcontact_read", "summary": "Een specifiek KLANTCONTACT bij een ZAAK opvragen.", "description": "Een specifiek KLANTCONTACT bij een ZAAK opvragen.\n\n**DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.", - "parameters": [], + "parameters": [ + { + "name": "If-None-Match", + "in": "header", + "description": "Voer een voorwaardelijk verzoek uit. Deze header moet \u00e9\u00e9n 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.", + "required": false, + "type": "string", + "examples": { + "oneValue": { + "summary": "E\u00e9n ETag-waarde", + "value": "\"79054025255fb1a26e4bc422aef54eb4\"" + }, + "multipleValues": { + "summary": "Meerdere ETag-waardes", + "value": "\"79054025255fb1a26e4bc422aef54eb4\", \"e4d909c290d0fb1ca068ffaddf22cbd0\"" + } + } + } + ], "responses": { "200": { "description": "OK", @@ -262,6 +280,10 @@ "$ref": "#/definitions/KlantContact" }, "headers": { + "ETag": { + "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.", + "type": "string" + }, "API-version": { "schema": { "type": "string" @@ -623,11 +645,33 @@ "operationId": "resultaat_headers", "summary": "De headers voor een specifiek(e) RESULTAAT opvragen", "description": "Vraag de headers op die je bij een GET request zou krijgen.", - "parameters": [], + "parameters": [ + { + "name": "If-None-Match", + "in": "header", + "description": "Voer een voorwaardelijk verzoek uit. Deze header moet \u00e9\u00e9n 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.", + "required": false, + "type": "string", + "examples": { + "oneValue": { + "summary": "E\u00e9n ETag-waarde", + "value": "\"79054025255fb1a26e4bc422aef54eb4\"" + }, + "multipleValues": { + "summary": "Meerdere ETag-waardes", + "value": "\"79054025255fb1a26e4bc422aef54eb4\", \"e4d909c290d0fb1ca068ffaddf22cbd0\"" + } + } + } + ], "responses": { "200": { "description": "OK", "headers": { + "ETag": { + "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.", + "type": "string" + }, "API-version": { "schema": { "type": "string" @@ -1318,11 +1362,33 @@ "operationId": "rol_headers", "summary": "De headers voor een specifiek(e) ROL opvragen", "description": "Vraag de headers op die je bij een GET request zou krijgen.", - "parameters": [], + "parameters": [ + { + "name": "If-None-Match", + "in": "header", + "description": "Voer een voorwaardelijk verzoek uit. Deze header moet \u00e9\u00e9n 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.", + "required": false, + "type": "string", + "examples": { + "oneValue": { + "summary": "E\u00e9n ETag-waarde", + "value": "\"79054025255fb1a26e4bc422aef54eb4\"" + }, + "multipleValues": { + "summary": "Meerdere ETag-waardes", + "value": "\"79054025255fb1a26e4bc422aef54eb4\", \"e4d909c290d0fb1ca068ffaddf22cbd0\"" + } + } + } + ], "responses": { "200": { "description": "OK", "headers": { + "ETag": { + "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.", + "type": "string" + }, "API-version": { "schema": { "type": "string" @@ -1721,11 +1787,33 @@ "operationId": "status_headers", "summary": "De headers voor een specifiek(e) STATUS opvragen", "description": "Vraag de headers op die je bij een GET request zou krijgen.", - "parameters": [], + "parameters": [ + { + "name": "If-None-Match", + "in": "header", + "description": "Voer een voorwaardelijk verzoek uit. Deze header moet \u00e9\u00e9n 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.", + "required": false, + "type": "string", + "examples": { + "oneValue": { + "summary": "E\u00e9n ETag-waarde", + "value": "\"79054025255fb1a26e4bc422aef54eb4\"" + }, + "multipleValues": { + "summary": "Meerdere ETag-waardes", + "value": "\"79054025255fb1a26e4bc422aef54eb4\", \"e4d909c290d0fb1ca068ffaddf22cbd0\"" + } + } + } + ], "responses": { "200": { "description": "OK", "headers": { + "ETag": { + "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.", + "type": "string" + }, "API-version": { "schema": { "type": "string" @@ -1943,7 +2031,25 @@ "operationId": "zaakcontactmoment_read", "summary": "Een specifiek ZAAKCONTACTMOMENT opvragen.", "description": "Een specifiek ZAAKCONTACTMOMENT opvragen.", - "parameters": [], + "parameters": [ + { + "name": "If-None-Match", + "in": "header", + "description": "Voer een voorwaardelijk verzoek uit. Deze header moet \u00e9\u00e9n 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.", + "required": false, + "type": "string", + "examples": { + "oneValue": { + "summary": "E\u00e9n ETag-waarde", + "value": "\"79054025255fb1a26e4bc422aef54eb4\"" + }, + "multipleValues": { + "summary": "Meerdere ETag-waardes", + "value": "\"79054025255fb1a26e4bc422aef54eb4\", \"e4d909c290d0fb1ca068ffaddf22cbd0\"" + } + } + } + ], "responses": { "200": { "description": "OK", @@ -1951,6 +2057,10 @@ "$ref": "#/definitions/ZaakContactMoment" }, "headers": { + "ETag": { + "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.", + "type": "string" + }, "API-version": { "schema": { "type": "string" @@ -2346,11 +2456,33 @@ "operationId": "zaakinformatieobject_headers", "summary": "De headers voor een specifiek(e) ZAAKINFORMATIEOBJECT opvragen", "description": "Vraag de headers op die je bij een GET request zou krijgen.", - "parameters": [], + "parameters": [ + { + "name": "If-None-Match", + "in": "header", + "description": "Voer een voorwaardelijk verzoek uit. Deze header moet \u00e9\u00e9n 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.", + "required": false, + "type": "string", + "examples": { + "oneValue": { + "summary": "E\u00e9n ETag-waarde", + "value": "\"79054025255fb1a26e4bc422aef54eb4\"" + }, + "multipleValues": { + "summary": "Meerdere ETag-waardes", + "value": "\"79054025255fb1a26e4bc422aef54eb4\", \"e4d909c290d0fb1ca068ffaddf22cbd0\"" + } + } + } + ], "responses": { "200": { "description": "OK", "headers": { + "ETag": { + "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.", + "type": "string" + }, "API-version": { "schema": { "type": "string" @@ -2898,7 +3030,25 @@ "operationId": "zaakobject_read", "summary": "Een specifiek ZAAKOBJECT opvragen.", "description": "Een specifiek ZAAKOBJECT opvragen.", - "parameters": [], + "parameters": [ + { + "name": "If-None-Match", + "in": "header", + "description": "Voer een voorwaardelijk verzoek uit. Deze header moet \u00e9\u00e9n 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.", + "required": false, + "type": "string", + "examples": { + "oneValue": { + "summary": "E\u00e9n ETag-waarde", + "value": "\"79054025255fb1a26e4bc422aef54eb4\"" + }, + "multipleValues": { + "summary": "Meerdere ETag-waardes", + "value": "\"79054025255fb1a26e4bc422aef54eb4\", \"e4d909c290d0fb1ca068ffaddf22cbd0\"" + } + } + } + ], "responses": { "200": { "description": "OK", @@ -2906,6 +3056,10 @@ "$ref": "#/definitions/ZaakObject" }, "headers": { + "ETag": { + "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.", + "type": "string" + }, "API-version": { "schema": { "type": "string" @@ -3368,7 +3522,25 @@ "operationId": "zaakverzoek_read", "summary": "Een specifiek ZAAK-VERZOEK opvragen.", "description": "Een specifiek ZAAK-VERZOEK opvragen.", - "parameters": [], + "parameters": [ + { + "name": "If-None-Match", + "in": "header", + "description": "Voer een voorwaardelijk verzoek uit. Deze header moet \u00e9\u00e9n 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.", + "required": false, + "type": "string", + "examples": { + "oneValue": { + "summary": "E\u00e9n ETag-waarde", + "value": "\"79054025255fb1a26e4bc422aef54eb4\"" + }, + "multipleValues": { + "summary": "Meerdere ETag-waardes", + "value": "\"79054025255fb1a26e4bc422aef54eb4\", \"e4d909c290d0fb1ca068ffaddf22cbd0\"" + } + } + } + ], "responses": { "200": { "description": "OK", @@ -3376,6 +3548,10 @@ "$ref": "#/definitions/ZaakVerzoek" }, "headers": { + "ETag": { + "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.", + "type": "string" + }, "API-version": { "schema": { "type": "string" @@ -3761,20 +3937,6 @@ "-archiefactiedatum" ] }, - { - "name": "expand", - "in": "query", - "description": "Haal details van inline resources direct op.", - "type": "string", - "enum": [ - "status", - "resultaat", - "eigenschappen", - "rollen", - "zaakobjecten", - "zaakinformatieobjecten" - ] - }, { "name": "page", "in": "query", @@ -4047,20 +4209,6 @@ "required": false, "type": "integer" }, - { - "name": "expand", - "in": "query", - "description": "Haal details van inline resources direct op.", - "type": "string", - "enum": [ - "status", - "resultaat", - "eigenschappen", - "rollen", - "zaakobjecten", - "zaakinformatieobjecten" - ] - }, { "name": "Accept-Crs", "in": "header", @@ -4179,20 +4327,6 @@ "summary": "Een specifieke ZAAK opvragen.", "description": "Een specifieke ZAAK opvragen.", "parameters": [ - { - "name": "expand", - "in": "query", - "description": "Haal details van inline resources direct op.", - "type": "string", - "enum": [ - "status", - "resultaat", - "eigenschappen", - "rollen", - "zaakobjecten", - "zaakinformatieobjecten" - ] - }, { "name": "Accept-Crs", "in": "header", @@ -4323,6 +4457,23 @@ "enum": [ "EPSG:4326" ] + }, + { + "name": "If-None-Match", + "in": "header", + "description": "Voer een voorwaardelijk verzoek uit. Deze header moet \u00e9\u00e9n 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.", + "required": false, + "type": "string", + "examples": { + "oneValue": { + "summary": "E\u00e9n ETag-waarde", + "value": "\"79054025255fb1a26e4bc422aef54eb4\"" + }, + "multipleValues": { + "summary": "Meerdere ETag-waardes", + "value": "\"79054025255fb1a26e4bc422aef54eb4\", \"e4d909c290d0fb1ca068ffaddf22cbd0\"" + } + } } ], "responses": { @@ -4336,6 +4487,10 @@ "EPSG:4326" ] }, + "ETag": { + "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.", + "type": "string" + }, "API-version": { "schema": { "type": "string" @@ -4767,7 +4922,25 @@ "operationId": "audittrail_read", "summary": "Een specifieke audit trail regel opvragen.", "description": "Een specifieke audit trail regel opvragen.", - "parameters": [], + "parameters": [ + { + "name": "If-None-Match", + "in": "header", + "description": "Voer een voorwaardelijk verzoek uit. Deze header moet \u00e9\u00e9n 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.", + "required": false, + "type": "string", + "examples": { + "oneValue": { + "summary": "E\u00e9n ETag-waarde", + "value": "\"79054025255fb1a26e4bc422aef54eb4\"" + }, + "multipleValues": { + "summary": "Meerdere ETag-waardes", + "value": "\"79054025255fb1a26e4bc422aef54eb4\", \"e4d909c290d0fb1ca068ffaddf22cbd0\"" + } + } + } + ], "responses": { "200": { "description": "OK", @@ -4775,6 +4948,10 @@ "$ref": "#/definitions/AuditTrail" }, "headers": { + "ETag": { + "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.", + "type": "string" + }, "API-version": { "schema": { "type": "string" @@ -5016,7 +5193,25 @@ "operationId": "zaakbesluit_read", "summary": "Een specifiek ZAAKBESLUIT opvragen.", "description": "Een specifiek ZAAKBESLUIT opvragen.", - "parameters": [], + "parameters": [ + { + "name": "If-None-Match", + "in": "header", + "description": "Voer een voorwaardelijk verzoek uit. Deze header moet \u00e9\u00e9n 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.", + "required": false, + "type": "string", + "examples": { + "oneValue": { + "summary": "E\u00e9n ETag-waarde", + "value": "\"79054025255fb1a26e4bc422aef54eb4\"" + }, + "multipleValues": { + "summary": "Meerdere ETag-waardes", + "value": "\"79054025255fb1a26e4bc422aef54eb4\", \"e4d909c290d0fb1ca068ffaddf22cbd0\"" + } + } + } + ], "responses": { "200": { "description": "OK", @@ -5024,6 +5219,10 @@ "$ref": "#/definitions/ZaakBesluit" }, "headers": { + "ETag": { + "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.", + "type": "string" + }, "API-version": { "schema": { "type": "string" @@ -5417,11 +5616,33 @@ "operationId": "zaakeigenschap_headers", "summary": "De headers voor een specifiek(e) ZAAKEIGENSCHAP opvragen", "description": "Vraag de headers op die je bij een GET request zou krijgen.", - "parameters": [], + "parameters": [ + { + "name": "If-None-Match", + "in": "header", + "description": "Voer een voorwaardelijk verzoek uit. Deze header moet \u00e9\u00e9n 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.", + "required": false, + "type": "string", + "examples": { + "oneValue": { + "summary": "E\u00e9n ETag-waarde", + "value": "\"79054025255fb1a26e4bc422aef54eb4\"" + }, + "multipleValues": { + "summary": "Meerdere ETag-waardes", + "value": "\"79054025255fb1a26e4bc422aef54eb4\", \"e4d909c290d0fb1ca068ffaddf22cbd0\"" + } + } + } + ], "responses": { "200": { "description": "OK", "headers": { + "ETag": { + "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.", + "type": "string" + }, "API-version": { "schema": { "type": "string" @@ -8775,15 +8996,6 @@ "readOnly": true, "uniqueItems": true }, - "rollen": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "readOnly": true, - "uniqueItems": true - }, "status": { "title": "Status", "description": "Indien geen status bekend is, dan is de waarde 'null'", @@ -8792,24 +9004,6 @@ "readOnly": true, "x-nullable": true }, - "zaakinformatieobjecten": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "readOnly": true, - "uniqueItems": true - }, - "zaakobjecten": { - "type": "array", - "items": { - "type": "string", - "format": "uri" - }, - "readOnly": true, - "uniqueItems": true - }, "kenmerken": { "description": "Lijst van kenmerken. Merk op dat refereren naar gerelateerde objecten beter kan via `ZaakObject`.", "type": "array", @@ -8859,26 +9053,6 @@ "type": "string", "maxLength": 9 }, - "processobjectaard": { - "title": "Procesobjectaard", - "description": "Omschrijving van het object, subject of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking heeft.", - "type": "string", - "maxLength": 200, - "x-nullable": true - }, - "resultaattoelichting": { - "title": "Resultaattoelichting", - "description": "Een toelichting op wat het resultaat van de zaak inhoudt.", - "type": "string", - "maxLength": 1000 - }, - "startdatumBewaartermijn": { - "title": "Startdatum bewaartermijn", - "description": "De datum die de start markeert van de termijn waarop het zaakdossier vernietigd moet worden.", - "type": "string", - "format": "date", - "x-nullable": true - }, "gerelateerdeExterneZaken": { "$ref": "#/definitions/GerelateerdeExterneZaken" }, @@ -9117,19 +9291,6 @@ "archiefactiedatum", "-archiefactiedatum" ] - }, - "expand": { - "title": "Expand", - "description": "Haal details van inline resources direct op.\n\nUitleg bij mogelijke waarden:\n\n* `status` - status\n* `resultaat` - resultaat\n* `eigenschappen` - eigenschappen\n* `rollen` - rollen\n* `zaakobjecten` - zaakobjecten\n* `zaakinformatieobjecten` - zaakinformatieobjecten", - "type": "string", - "enum": [ - "status", - "resultaat", - "eigenschappen", - "rollen", - "zaakobjecten", - "zaakinformatieobjecten" - ] } } }, @@ -9169,7 +9330,7 @@ }, "bron": { "title": "Bron", - "description": "De naam van het component waar de wijziging in is gedaan.\n\nUitleg bij mogelijke waarden:\n\n* `ac` - Autorisaties API\n* `nrc` - Notificaties API\n* `zrc` - Zaken API\n* `ztc` - Catalogi API\n* `drc` - Documenten API\n* `brc` - Besluiten API\n* `cmc` - Contactmomenten API\n* `kc` - Klanten API\n* `vrc` - Verzoeken API", + "description": "De naam van het component waar de wijziging in is gedaan.\n\nUitleg bij mogelijke waarden:\n\n* `ac` - Autorisaties API\n* `nrc` - Notificaties API\n* `zrc` - Zaken API\n* `ztc` - Catalogi API\n* `drc` - Documenten API\n* `brc` - Besluiten API\n* `cmc` - Contactmomenten API\n* `kc` - Klanten API", "type": "string", "enum": [ "ac", @@ -9179,8 +9340,7 @@ "drc", "brc", "cmc", - "kc", - "vrc" + "kc" ] }, "applicatieId": { diff --git a/src/zrc/api/filters.py b/src/zrc/api/filters.py index fdf4785a..aeaac8e8 100644 --- a/src/zrc/api/filters.py +++ b/src/zrc/api/filters.py @@ -15,8 +15,6 @@ ZaakVerzoek, ) -from .serializers import ZaakSerializer - class MaximaleVertrouwelijkheidaanduidingFilter(filters.ChoiceFilter): def __init__(self, *args, **kwargs): @@ -39,20 +37,6 @@ def filter(self, qs, value): return super().filter(qs, numeric_value) -# TODO move to vng-api-common -class ExpandFilter(filters.ChoiceFilter): - def __init__(self, *args, **kwargs): - serializer_class = kwargs.pop("serializer_class") - kwargs.setdefault( - "choices", [(x, x) for x in serializer_class.Meta.expandable_fields] - ) - - super().__init__(*args, **kwargs) - - def filter(self, qs, value): - return qs - - class ZaakFilter(FilterSet): maximale_vertrouwelijkheidaanduiding = MaximaleVertrouwelijkheidaanduidingFilter( field_name="vertrouwelijkheidaanduiding", @@ -135,10 +119,6 @@ class ZaakFilter(FilterSet): ), help_text="Het veld waarop de resultaten geordend worden.", ) - expand = ExpandFilter( - serializer_class=ZaakSerializer, - help_text="Haal details van inline resources direct op.", - ) class Meta: model = Zaak diff --git a/src/zrc/api/serializers/core.py b/src/zrc/api/serializers/core.py index 2464794c..24895312 100644 --- a/src/zrc/api/serializers/core.py +++ b/src/zrc/api/serializers/core.py @@ -60,7 +60,6 @@ from zrc.datamodel.utils import BrondatumCalculator from zrc.sync.signals import SyncError from zrc.utils.exceptions import DetermineProcessEndDateException -from zrc.utils.serializers import ExpandSerializer from ..auth import get_auth from ..validators import ( @@ -172,6 +171,338 @@ def __init__(self, *args, **kwargs): self.fields["aard_relatie"].help_text += f"\n\n{value_display_mapping}" +class ZaakSerializer( + NestedGegevensGroepMixin, + NestedCreateMixin, + NestedUpdateMixin, + serializers.HyperlinkedModelSerializer, +): + eigenschappen = NestedHyperlinkedRelatedField( + many=True, + read_only=True, + lookup_field="uuid", + view_name="zaakeigenschap-detail", + parent_lookup_kwargs={"zaak_uuid": "zaak__uuid"}, + source="zaakeigenschap_set", + ) + status = serializers.HyperlinkedRelatedField( + source="current_status_uuid", + read_only=True, + allow_null=True, + view_name="status-detail", + lookup_url_kwarg="uuid", + help_text=_("Indien geen status bekend is, dan is de waarde 'null'"), + ) + + kenmerken = ZaakKenmerkSerializer( + source="zaakkenmerk_set", + many=True, + required=False, + help_text="Lijst van kenmerken. Merk op dat refereren naar gerelateerde objecten " + "beter kan via `ZaakObject`.", + ) + + betalingsindicatie_weergave = serializers.CharField( + source="get_betalingsindicatie_display", + read_only=True, + help_text=_("Uitleg bij `betalingsindicatie`."), + ) + + verlenging = VerlengingSerializer( + required=False, + allow_null=True, + help_text=_( + "Gegevens omtrent het verlengen van de doorlooptijd van de behandeling van de ZAAK" + ), + ) + + opschorting = OpschortingSerializer( + required=False, + allow_null=True, + help_text=_( + "Gegevens omtrent het tijdelijk opschorten van de behandeling van de ZAAK" + ), + ) + + deelzaken = serializers.HyperlinkedRelatedField( + read_only=True, + many=True, + view_name="zaak-detail", + lookup_url_kwarg="uuid", + lookup_field="uuid", + help_text=_("URL-referenties naar deel ZAAKen."), + ) + + resultaat = serializers.HyperlinkedRelatedField( + read_only=True, + allow_null=True, + view_name="resultaat-detail", + lookup_url_kwarg="uuid", + lookup_field="uuid", + help_text=_( + "URL-referentie naar het RESULTAAT. Indien geen resultaat bekend is, dan is de waarde 'null'" + ), + ) + + relevante_andere_zaken = RelevanteZaakSerializer( + many=True, required=False, help_text=_("Een lijst van relevante andere zaken.") + ) + + gerelateerde_externe_zaken = GerelateerdeExterneZakenSerializer( + required=False, + allow_null=True, + help_text=_( + "Een ZAAK bij een andere organisatie waarin een bijdrage geleverd wordt " + "aan het bereiken van de uitkomst van de onderhanden ZAAK." + ), + ) + + processobject = ProcessobjectSerializer( + required=False, + allow_null=True, + help_text=_( + "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." + ), + ) + + class Meta: + model = Zaak + fields = ( + "url", + "uuid", + "identificatie", + "bronorganisatie", + "omschrijving", + "toelichting", + "zaaktype", + "registratiedatum", + "verantwoordelijke_organisatie", + "startdatum", + "einddatum", + "einddatum_gepland", + "uiterlijke_einddatum_afdoening", + "publicatiedatum", + "communicatiekanaal", + # TODO: add shape validator once we know the shape + "producten_of_diensten", + "vertrouwelijkheidaanduiding", + "betalingsindicatie", + "betalingsindicatie_weergave", + "laatste_betaaldatum", + "zaakgeometrie", + "verlenging", + "opschorting", + "selectielijstklasse", + "hoofdzaak", + "deelzaken", + "relevante_andere_zaken", + "eigenschappen", + # read-only veld, on-the-fly opgevraagd + "status", + # Writable inline resource, as opposed to eigenschappen for demo + # purposes. Eventually, we need to choose one form. + "kenmerken", + # Archiving + "archiefnominatie", + "archiefstatus", + "archiefactiedatum", + "resultaat", + "opdrachtgevende_organisatie", + "gerelateerde_externe_zaken", + "processobject", + ) + extra_kwargs = { + "url": {"lookup_field": "uuid"}, + "uuid": {"read_only": True}, + "zaakgeometrie": { + "help_text": "Punt, lijn of (multi-)vlak geometrie-informatie, in GeoJSON." + }, + "identificatie": {"validators": [IsImmutableValidator()]}, + "zaaktype": { + # TODO: does order matter here with the default validators? + "validators": [ + IsImmutableValidator(), + PublishValidator( + "ZaakType", settings.ZTC_API_SPEC, get_auth=get_auth + ), + ] + }, + "einddatum": {"read_only": True, "allow_null": True}, + "communicatiekanaal": { + "validators": [ + ResourceValidator( + "CommunicatieKanaal", settings.REFERENTIELIJSTEN_API_SPEC + ) + ] + }, + "vertrouwelijkheidaanduiding": { + "required": False, + "help_text": _( + "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." + ), + }, + "selectielijstklasse": { + "validators": [ + ResourceValidator( + "Resultaat", + settings.REFERENTIELIJSTEN_API_SPEC, + get_auth=get_auth, + ) + ] + }, + "hoofdzaak": { + "lookup_field": "uuid", + "queryset": Zaak.objects.all(), + "validators": [NotSelfValidator(), HoofdzaakValidator()], + }, + "laatste_betaaldatum": {"validators": [UntilNowValidator()]}, + } + # Replace a default "unique together" constraint. + validators = [UniekeIdentificatieValidator(), HoofdZaaktypeRelationValidator()] + + def __init__(self, *args, **kwargs): + super().__init__(*args, **kwargs) + + value_display_mapping = add_choice_values_help_text(BetalingsIndicatie) + self.fields["betalingsindicatie"].help_text += f"\n\n{value_display_mapping}" + + value_display_mapping = add_choice_values_help_text(Archiefstatus) + self.fields["archiefstatus"].help_text += f"\n\n{value_display_mapping}" + + value_display_mapping = add_choice_values_help_text(Archiefnominatie) + self.fields["archiefnominatie"].help_text += f"\n\n{value_display_mapping}" + + def _get_zaaktype(self, zaaktype_url: str) -> dict: + if not hasattr(self, "_zaaktype"): + # dynamic so that it can be mocked in tests easily + Client = import_string(settings.ZDS_CLIENT_CLASS) + client = Client.from_url(zaaktype_url) + client.auth = APICredential.get_auth( + zaaktype_url, scopes=["zds.scopes.zaaktypes.lezen"] + ) + self._zaaktype = client.request(zaaktype_url, "zaaktype") + return self._zaaktype + + def _get_information_objects(self) -> list: + if not hasattr(self, "_information_objects"): + self._information_objects = [] + + if self.instance: + Client = import_string(settings.ZDS_CLIENT_CLASS) + + zios = self.instance.zaakinformatieobject_set.all() + for zio in zios: + io_url = zio.informatieobject + client = Client.from_url(io_url) + client.auth = APICredential.get_auth( + io_url, scopes=["scopes.documenten.lezen"] + ) + informatieobject = client.request( + io_url, "enkelvoudiginformatieobject" + ) + self._information_objects.append(informatieobject) + + return self._information_objects + + def validate(self, attrs): + super().validate(attrs) + + default_betalingsindicatie = ( + self.instance.betalingsindicatie if self.instance else None + ) + betalingsindicatie = attrs.get("betalingsindicatie", default_betalingsindicatie) + if betalingsindicatie == BetalingsIndicatie.nvt and attrs.get( + "laatste_betaaldatum" + ): + raise serializers.ValidationError( + { + "laatste_betaaldatum": _( + 'Laatste betaaldatum kan niet gezet worden als de betalingsindicatie "nvt" is' + ) + }, + code="betaling-nvt", + ) + + # check that productenOfDiensten are part of the ones on the zaaktype + default_zaaktype = self.instance.zaaktype if self.instance else None + zaaktype = attrs.get("zaaktype", default_zaaktype) + assert zaaktype, "Should not have passed validation - a zaaktype is needed" + producten_of_diensten = attrs.get("producten_of_diensten") + if producten_of_diensten: + zaaktype = self._get_zaaktype(zaaktype) + if not set(producten_of_diensten).issubset( + set(zaaktype["productenOfDiensten"]) + ): + raise serializers.ValidationError( + { + "producten_of_diensten": _( + "Niet alle producten/diensten komen voor in " + "de producten/diensten op het zaaktype" + ) + }, + code="invalid-products-services", + ) + + # Archiving + default_archiefstatus = ( + self.instance.archiefstatus + if self.instance + else Archiefstatus.nog_te_archiveren + ) + archiefstatus = ( + attrs.get("archiefstatus", default_archiefstatus) + != Archiefstatus.nog_te_archiveren + ) + if archiefstatus: + ios = self._get_information_objects() + for io in ios: + if io["status"] != "gearchiveerd": + raise serializers.ValidationError( + { + "archiefstatus", + _( + "Er zijn gerelateerde informatieobjecten waarvan de `status` nog niet gelijk is aan " + "`gearchiveerd`. Dit is een voorwaarde voor het zetten van de `archiefstatus` op een andere " + "waarde dan `nog_te_archiveren`." + ), + }, + code="documents-not-archived", + ) + + for attr in ["archiefnominatie", "archiefactiedatum"]: + if not attrs.get( + attr, getattr(self.instance, attr) if self.instance else None + ): + raise serializers.ValidationError( + { + attr: _( + "Moet van een waarde voorzien zijn als de 'Archiefstatus' een waarde heeft anders dan " + "'nog_te_archiveren'." + ) + }, + code=f"{attr}-not-set", + ) + # End archiving + + return attrs + + def create(self, validated_data: dict): + # set the derived value from ZTC + if "vertrouwelijkheidaanduiding" not in validated_data: + zaaktype = self._get_zaaktype(validated_data["zaaktype"]) + validated_data["vertrouwelijkheidaanduiding"] = zaaktype[ + "vertrouwelijkheidaanduiding" + ] + + return super().create(validated_data) + + class GeoWithinSerializer(serializers.Serializer): within = GeometryField(required=False) @@ -646,680 +977,266 @@ class Meta: "eigenschap": { "validators": [ ResourceValidator( - "Eigenschap", settings.ZTC_API_SPEC, get_auth=get_auth - ), - IsImmutableValidator(), - ] - }, - "naam": {"source": "_naam", "read_only": True}, - } - validators = [CorrectZaaktypeValidator("eigenschap")] - - def _get_eigenschap(self, eigenschap_url): - if not hasattr(self, "_eigenschap"): - self._eigenschap = None - if eigenschap_url: - Client = import_string(settings.ZDS_CLIENT_CLASS) - client = Client.from_url(eigenschap_url) - client.auth = APICredential.get_auth( - eigenschap_url, scopes=["zds.scopes.zaaktypes.lezen"] - ) - self._eigenschap = client.request(eigenschap_url, "eigenschap") - return self._eigenschap - - def validate(self, attrs): - super().validate(attrs) - - # assign _naam only when creating zaak eigenschap - if not self.instance: - eigenschap = self._get_eigenschap(attrs["eigenschap"]) - attrs["_naam"] = eigenschap["naam"] - - return attrs - - -class KlantContactSerializer(serializers.HyperlinkedModelSerializer): - class Meta: - model = KlantContact - fields = ( - "url", - "uuid", - "zaak", - "identificatie", - "datumtijd", - "kanaal", - "onderwerp", - "toelichting", - ) - extra_kwargs = { - "url": {"lookup_field": "uuid"}, - "uuid": {"read_only": True}, - "identificatie": {"required": False}, - "zaak": {"lookup_field": "uuid"}, - "datumtijd": {"validators": [DateNotInFutureValidator()]}, - } - - -class ContactPersoonRolSerializer(GegevensGroepSerializer): - class Meta: - model = Rol - gegevensgroep = "contactpersoon_rol" - - -class RolSerializer(PolymorphicSerializer): - discriminator = Discriminator( - discriminator_field="betrokkene_type", - mapping={ - RolTypes.natuurlijk_persoon: RolNatuurlijkPersoonSerializer(), - RolTypes.niet_natuurlijk_persoon: RolNietNatuurlijkPersoonSerializer(), - RolTypes.vestiging: RolVestigingSerializer(), - RolTypes.organisatorische_eenheid: RolOrganisatorischeEenheidSerializer(), - RolTypes.medewerker: RolMedewerkerSerializer(), - }, - group_field="betrokkene_identificatie", - same_model=False, - ) - - contactpersoon_rol = ContactPersoonRolSerializer( - allow_null=True, - required=False, - help_text=_( - "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." - ), - ) - - class Meta: - model = Rol - fields = ( - "url", - "uuid", - "zaak", - "betrokkene", - "betrokkene_type", - "afwijkende_naam_betrokkene", - "roltype", - "omschrijving", - "omschrijving_generiek", - "roltoelichting", - "registratiedatum", - "indicatie_machtiging", - "contactpersoon_rol", - "statussen", - ) - validators = [ - RolOccurenceValidator(RolOmschrijving.initiator, max_amount=1), - RolOccurenceValidator(RolOmschrijving.zaakcoordinator, max_amount=1), - CorrectZaaktypeValidator("roltype"), - ] - extra_kwargs = { - "url": {"lookup_field": "uuid"}, - "uuid": {"read_only": True}, - "zaak": {"lookup_field": "uuid"}, - "betrokkene": {"required": False}, - "roltype": { - "validators": [ - IsImmutableValidator(), - ResourceValidator( - "RolType", settings.ZTC_API_SPEC, get_auth=get_auth - ), - ] - }, - "statussen": {"lookup_field": "uuid", "read_only": True}, - } - - def __init__(self, *args, **kwargs): - super().__init__(*args, **kwargs) - - value_display_mapping = add_choice_values_help_text(IndicatieMachtiging) - self.fields["indicatie_machtiging"].help_text += f"\n\n{value_display_mapping}" - - value_display_mapping = add_choice_values_help_text(RolTypes) - self.fields["betrokkene_type"].help_text += f"\n\n{value_display_mapping}" - - value_display_mapping = add_choice_values_help_text(RolOmschrijving) - self.fields["omschrijving_generiek"].help_text += f"\n\n{value_display_mapping}" - - def validate(self, attrs): - validated_attrs = super().validate(attrs) - betrokkene = validated_attrs.get("betrokkene", None) - betrokkene_identificatie = validated_attrs.get("betrokkene_identificatie", None) - - if not betrokkene and not betrokkene_identificatie: - raise serializers.ValidationError( - _("betrokkene or betrokkeneIdentificatie must be provided"), - code="invalid-betrokkene", - ) - - return validated_attrs - - @transaction.atomic - def create(self, validated_data): - group_data = validated_data.pop("betrokkene_identificatie", None) - rol = super().create(validated_data) - - if group_data: - group_serializer = self.discriminator.mapping[ - validated_data["betrokkene_type"] - ] - serializer = group_serializer.get_fields()["betrokkene_identificatie"] - group_data["rol"] = rol - serializer.create(group_data) - - return rol - - -class ResultaatSerializer(serializers.HyperlinkedModelSerializer): - class Meta: - model = Resultaat - fields = ("url", "uuid", "zaak", "resultaattype", "toelichting") - validators = [CorrectZaaktypeValidator("resultaattype")] - extra_kwargs = { - "url": {"lookup_field": "uuid"}, - "uuid": {"read_only": True}, - "zaak": {"lookup_field": "uuid"}, - "resultaattype": { - "validators": [ - IsImmutableValidator(), - ResourceValidator( - "ResultaatType", settings.ZTC_API_SPEC, get_auth=get_auth - ), - ] - }, - } - - -class ZaakBesluitSerializer(NestedHyperlinkedModelSerializer): - parent_lookup_kwargs = {"zaak_uuid": "zaak__uuid"} - - class Meta: - model = ZaakBesluit - fields = ("url", "uuid", "besluit") - extra_kwargs = { - "url": {"lookup_field": "uuid"}, - "uuid": {"read_only": True}, - "zaak": {"lookup_field": "uuid"}, - "besluit": {"validators": [URLValidator(get_auth=get_auth)]}, - } - - def create(self, validated_data): - validated_data["zaak"] = self.context["parent_object"] - return super().create(validated_data) - - -class ZaakContactMomentSerializer(serializers.HyperlinkedModelSerializer): - class Meta: - model = ZaakContactMoment - fields = ("url", "uuid", "zaak", "contactmoment") - extra_kwargs = { - "url": {"lookup_field": "uuid"}, - "uuid": {"read_only": True}, - "zaak": {"lookup_field": "uuid"}, - "contactmoment": { - "validators": [ - ResourceValidator( - "ContactMoment", settings.CMC_API_SPEC, get_auth=get_auth - ) - ] - }, - } - - def save(self, **kwargs): - try: - return super().save(**kwargs) - except SyncError as sync_error: - # delete the object again - ZaakContactMoment.objects.filter( - contactmoment=self.validated_data["contactmoment"], - zaak=self.validated_data["zaak"], - )._raw_delete("default") - raise serializers.ValidationError( - {api_settings.NON_FIELD_ERRORS_KEY: sync_error.args[0]} - ) from sync_error - - -class ZaakVerzoekSerializer(serializers.HyperlinkedModelSerializer): - class Meta: - model = ZaakVerzoek - fields = ("url", "uuid", "zaak", "verzoek") - extra_kwargs = { - "url": {"lookup_field": "uuid"}, - "uuid": {"read_only": True}, - "zaak": {"lookup_field": "uuid"}, - "verzoek": { - "validators": [ - ResourceValidator( - "Verzoek", settings.VRC_API_SPEC, get_auth=get_auth - ) + "Eigenschap", settings.ZTC_API_SPEC, get_auth=get_auth + ), + IsImmutableValidator(), ] }, + "naam": {"source": "_naam", "read_only": True}, } + validators = [CorrectZaaktypeValidator("eigenschap")] - def save(self, **kwargs): - try: - return super().save(**kwargs) - except SyncError as sync_error: - # delete the object again - ZaakVerzoek.objects.filter( - verzoek=self.validated_data["verzoek"], - zaak=self.validated_data["zaak"], - )._raw_delete("default") - raise serializers.ValidationError( - {api_settings.NON_FIELD_ERRORS_KEY: sync_error.args[0]} - ) from sync_error + def _get_eigenschap(self, eigenschap_url): + if not hasattr(self, "_eigenschap"): + self._eigenschap = None + if eigenschap_url: + Client = import_string(settings.ZDS_CLIENT_CLASS) + client = Client.from_url(eigenschap_url) + client.auth = APICredential.get_auth( + eigenschap_url, scopes=["zds.scopes.zaaktypes.lezen"] + ) + self._eigenschap = client.request(eigenschap_url, "eigenschap") + return self._eigenschap + def validate(self, attrs): + super().validate(attrs) -class ZaakSerializer( - NestedGegevensGroepMixin, - NestedCreateMixin, - NestedUpdateMixin, - serializers.HyperlinkedModelSerializer, -): - eigenschappen = ExpandSerializer( - name="eigenschappen", - source="zaakeigenschap_set", - default_serializer=NestedHyperlinkedRelatedField, - expanded_serializer=ZaakEigenschapSerializer, - many=True, - read_only=True, - common_kwargs={ - "read_only": True, - }, - default_serializer_kwargs={ - "parent_lookup_kwargs": {"zaak_uuid": "zaak__uuid"}, - "lookup_field": "uuid", - "view_name": "zaakeigenschap-detail", - }, - ) - rollen = ExpandSerializer( - name="rollen", - source="rol_set", - default_serializer=NestedHyperlinkedRelatedField, - expanded_serializer=RolSerializer, - many=True, - read_only=True, - common_kwargs={ - "read_only": True, - }, - default_serializer_kwargs={ - "lookup_field": "uuid", - "view_name": "rol-detail", - }, - ) - status = ExpandSerializer( - name="status", - source="current_status", - default_serializer=serializers.HyperlinkedRelatedField, - expanded_serializer=StatusSerializer, - read_only=True, - common_kwargs={ - "allow_null": True, - "read_only": True, - }, - default_serializer_kwargs={ - "lookup_field": "uuid", - "view_name": "status-detail", - }, - help_text=_("Indien geen status bekend is, dan is de waarde 'null'"), - ) - zaakinformatieobjecten = ExpandSerializer( - name="zaakinformatieobjecten", - source="zaakinformatieobject_set", - default_serializer=NestedHyperlinkedRelatedField, - expanded_serializer=ZaakInformatieObjectSerializer, - many=True, - read_only=True, - common_kwargs={ - "read_only": True, - }, - default_serializer_kwargs={ - "lookup_field": "uuid", - "view_name": "zaakinformatieobject-detail", - }, - ) - zaakobjecten = ExpandSerializer( - name="zaakobjecten", - source="zaakobject_set", - default_serializer=NestedHyperlinkedRelatedField, - expanded_serializer=ZaakObjectSerializer, - many=True, - read_only=True, - common_kwargs={ - "read_only": True, - }, - default_serializer_kwargs={ - "lookup_field": "uuid", - "view_name": "zaakobject-detail", - }, - ) + # assign _naam only when creating zaak eigenschap + if not self.instance: + eigenschap = self._get_eigenschap(attrs["eigenschap"]) + attrs["_naam"] = eigenschap["naam"] - kenmerken = ZaakKenmerkSerializer( - source="zaakkenmerk_set", - many=True, - required=False, - help_text="Lijst van kenmerken. Merk op dat refereren naar gerelateerde objecten " - "beter kan via `ZaakObject`.", - ) + return attrs - betalingsindicatie_weergave = serializers.CharField( - source="get_betalingsindicatie_display", - read_only=True, - help_text=_("Uitleg bij `betalingsindicatie`."), - ) - verlenging = VerlengingSerializer( - required=False, - allow_null=True, - help_text=_( - "Gegevens omtrent het verlengen van de doorlooptijd van de behandeling van de ZAAK" - ), - ) +class KlantContactSerializer(serializers.HyperlinkedModelSerializer): + class Meta: + model = KlantContact + fields = ( + "url", + "uuid", + "zaak", + "identificatie", + "datumtijd", + "kanaal", + "onderwerp", + "toelichting", + ) + extra_kwargs = { + "url": {"lookup_field": "uuid"}, + "uuid": {"read_only": True}, + "identificatie": {"required": False}, + "zaak": {"lookup_field": "uuid"}, + "datumtijd": {"validators": [DateNotInFutureValidator()]}, + } - opschorting = OpschortingSerializer( - required=False, - allow_null=True, - help_text=_( - "Gegevens omtrent het tijdelijk opschorten van de behandeling van de ZAAK" - ), - ) - deelzaken = serializers.HyperlinkedRelatedField( - read_only=True, - many=True, - view_name="zaak-detail", - lookup_url_kwarg="uuid", - lookup_field="uuid", - help_text=_("URL-referenties naar deel ZAAKen."), - ) +class ContactPersoonRolSerializer(GegevensGroepSerializer): + class Meta: + model = Rol + gegevensgroep = "contactpersoon_rol" - resultaat = ExpandSerializer( - name="resultaat", - default_serializer=serializers.HyperlinkedRelatedField, - expanded_serializer=ResultaatSerializer, - read_only=True, - common_kwargs={ - "allow_null": True, - "read_only": True, - }, - default_serializer_kwargs={ - "lookup_field": "uuid", - "view_name": "resultaat-detail", - }, - help_text=_( - "URL-referentie naar het RESULTAAT. Indien geen resultaat bekend is, dan is de waarde 'null'" - ), - ) - relevante_andere_zaken = RelevanteZaakSerializer( - many=True, required=False, help_text=_("Een lijst van relevante andere zaken.") +class RolSerializer(PolymorphicSerializer): + discriminator = Discriminator( + discriminator_field="betrokkene_type", + mapping={ + RolTypes.natuurlijk_persoon: RolNatuurlijkPersoonSerializer(), + RolTypes.niet_natuurlijk_persoon: RolNietNatuurlijkPersoonSerializer(), + RolTypes.vestiging: RolVestigingSerializer(), + RolTypes.organisatorische_eenheid: RolOrganisatorischeEenheidSerializer(), + RolTypes.medewerker: RolMedewerkerSerializer(), + }, + group_field="betrokkene_identificatie", + same_model=False, ) - gerelateerde_externe_zaken = GerelateerdeExterneZakenSerializer( - required=False, + contactpersoon_rol = ContactPersoonRolSerializer( allow_null=True, - help_text=_( - "Een ZAAK bij een andere organisatie waarin een bijdrage geleverd wordt " - "aan het bereiken van de uitkomst van de onderhanden ZAAK." - ), - ) - - processobject = ProcessobjectSerializer( required=False, - allow_null=True, help_text=_( - "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." + "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." ), ) class Meta: - model = Zaak + model = Rol fields = ( "url", "uuid", - "identificatie", - "bronorganisatie", + "zaak", + "betrokkene", + "betrokkene_type", + "afwijkende_naam_betrokkene", + "roltype", "omschrijving", - "toelichting", - "zaaktype", + "omschrijving_generiek", + "roltoelichting", "registratiedatum", - "verantwoordelijke_organisatie", - "startdatum", - "einddatum", - "einddatum_gepland", - "uiterlijke_einddatum_afdoening", - "publicatiedatum", - "communicatiekanaal", - # TODO: add shape validator once we know the shape - "producten_of_diensten", - "vertrouwelijkheidaanduiding", - "betalingsindicatie", - "betalingsindicatie_weergave", - "laatste_betaaldatum", - "zaakgeometrie", - "verlenging", - "opschorting", - "selectielijstklasse", - "hoofdzaak", - "deelzaken", - "relevante_andere_zaken", - "eigenschappen", - # read-only veld, on-the-fly opgevraagd - "rollen", - "status", - "zaakinformatieobjecten", - "zaakobjecten", - # Writable inline resource, as opposed to eigenschappen for demo - # purposes. Eventually, we need to choose one form. - "kenmerken", - # Archiving - "archiefnominatie", - "archiefstatus", - "archiefactiedatum", - "resultaat", - "opdrachtgevende_organisatie", - "processobjectaard", - "resultaattoelichting", - "startdatum_bewaartermijn", - "gerelateerde_externe_zaken", - "processobject", + "indicatie_machtiging", + "contactpersoon_rol", + "statussen", ) + validators = [ + RolOccurenceValidator(RolOmschrijving.initiator, max_amount=1), + RolOccurenceValidator(RolOmschrijving.zaakcoordinator, max_amount=1), + CorrectZaaktypeValidator("roltype"), + ] extra_kwargs = { "url": {"lookup_field": "uuid"}, "uuid": {"read_only": True}, - "zaakgeometrie": { - "help_text": "Punt, lijn of (multi-)vlak geometrie-informatie, in GeoJSON." - }, - "identificatie": {"validators": [IsImmutableValidator()]}, - "zaaktype": { - # TODO: does order matter here with the default validators? - "validators": [ - IsImmutableValidator(), - PublishValidator( - "ZaakType", settings.ZTC_API_SPEC, get_auth=get_auth - ), - ] - }, - "einddatum": {"read_only": True, "allow_null": True}, - "communicatiekanaal": { - "validators": [ - ResourceValidator( - "CommunicatieKanaal", settings.REFERENTIELIJSTEN_API_SPEC - ) - ] - }, - "vertrouwelijkheidaanduiding": { - "required": False, - "help_text": _( - "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." - ), - }, - "selectielijstklasse": { + "zaak": {"lookup_field": "uuid"}, + "betrokkene": {"required": False}, + "roltype": { "validators": [ + IsImmutableValidator(), ResourceValidator( - "Resultaat", - settings.REFERENTIELIJSTEN_API_SPEC, - get_auth=get_auth, - ) + "RolType", settings.ZTC_API_SPEC, get_auth=get_auth + ), ] }, - "hoofdzaak": { - "lookup_field": "uuid", - "queryset": Zaak.objects.all(), - "validators": [NotSelfValidator(), HoofdzaakValidator()], - }, - "laatste_betaaldatum": {"validators": [UntilNowValidator()]}, + "statussen": {"lookup_field": "uuid", "read_only": True}, } - # Replace a default "unique together" constraint. - validators = [UniekeIdentificatieValidator(), HoofdZaaktypeRelationValidator()] - expandable_fields = [ - "status", - "resultaat", - "eigenschappen", - "rollen", - "zaakobjecten", - "zaakinformatieobjecten", - ] def __init__(self, *args, **kwargs): super().__init__(*args, **kwargs) - value_display_mapping = add_choice_values_help_text(BetalingsIndicatie) - self.fields["betalingsindicatie"].help_text += f"\n\n{value_display_mapping}" + value_display_mapping = add_choice_values_help_text(IndicatieMachtiging) + self.fields["indicatie_machtiging"].help_text += f"\n\n{value_display_mapping}" - value_display_mapping = add_choice_values_help_text(Archiefstatus) - self.fields["archiefstatus"].help_text += f"\n\n{value_display_mapping}" + value_display_mapping = add_choice_values_help_text(RolTypes) + self.fields["betrokkene_type"].help_text += f"\n\n{value_display_mapping}" - value_display_mapping = add_choice_values_help_text(Archiefnominatie) - self.fields["archiefnominatie"].help_text += f"\n\n{value_display_mapping}" + value_display_mapping = add_choice_values_help_text(RolOmschrijving) + self.fields["omschrijving_generiek"].help_text += f"\n\n{value_display_mapping}" - def _get_zaaktype(self, zaaktype_url: str) -> dict: - if not hasattr(self, "_zaaktype"): - # dynamic so that it can be mocked in tests easily - Client = import_string(settings.ZDS_CLIENT_CLASS) - client = Client.from_url(zaaktype_url) - client.auth = APICredential.get_auth( - zaaktype_url, scopes=["zds.scopes.zaaktypes.lezen"] + def validate(self, attrs): + validated_attrs = super().validate(attrs) + betrokkene = validated_attrs.get("betrokkene", None) + betrokkene_identificatie = validated_attrs.get("betrokkene_identificatie", None) + + if not betrokkene and not betrokkene_identificatie: + raise serializers.ValidationError( + _("betrokkene or betrokkeneIdentificatie must be provided"), + code="invalid-betrokkene", ) - self._zaaktype = client.request(zaaktype_url, "zaaktype") - return self._zaaktype - def _get_information_objects(self) -> list: - if not hasattr(self, "_information_objects"): - self._information_objects = [] + return validated_attrs - if self.instance: - Client = import_string(settings.ZDS_CLIENT_CLASS) + @transaction.atomic + def create(self, validated_data): + group_data = validated_data.pop("betrokkene_identificatie", None) + rol = super().create(validated_data) - zios = self.instance.zaakinformatieobject_set.all() - for zio in zios: - io_url = zio.informatieobject - client = Client.from_url(io_url) - client.auth = APICredential.get_auth( - io_url, scopes=["scopes.documenten.lezen"] - ) - informatieobject = client.request( - io_url, "enkelvoudiginformatieobject" - ) - self._information_objects.append(informatieobject) + if group_data: + group_serializer = self.discriminator.mapping[ + validated_data["betrokkene_type"] + ] + serializer = group_serializer.get_fields()["betrokkene_identificatie"] + group_data["rol"] = rol + serializer.create(group_data) - return self._information_objects + return rol - def validate(self, attrs): - super().validate(attrs) - default_betalingsindicatie = ( - self.instance.betalingsindicatie if self.instance else None - ) - betalingsindicatie = attrs.get("betalingsindicatie", default_betalingsindicatie) - if betalingsindicatie == BetalingsIndicatie.nvt and attrs.get( - "laatste_betaaldatum" - ): - raise serializers.ValidationError( - { - "laatste_betaaldatum": _( - 'Laatste betaaldatum kan niet gezet worden als de betalingsindicatie "nvt" is' - ) - }, - code="betaling-nvt", - ) +class ResultaatSerializer(serializers.HyperlinkedModelSerializer): + class Meta: + model = Resultaat + fields = ("url", "uuid", "zaak", "resultaattype", "toelichting") + validators = [CorrectZaaktypeValidator("resultaattype")] + extra_kwargs = { + "url": {"lookup_field": "uuid"}, + "uuid": {"read_only": True}, + "zaak": {"lookup_field": "uuid"}, + "resultaattype": { + "validators": [ + IsImmutableValidator(), + ResourceValidator( + "ResultaatType", settings.ZTC_API_SPEC, get_auth=get_auth + ), + ] + }, + } - # check that productenOfDiensten are part of the ones on the zaaktype - default_zaaktype = self.instance.zaaktype if self.instance else None - zaaktype = attrs.get("zaaktype", default_zaaktype) - assert zaaktype, "Should not have passed validation - a zaaktype is needed" - producten_of_diensten = attrs.get("producten_of_diensten") - if producten_of_diensten: - zaaktype = self._get_zaaktype(zaaktype) - if not set(producten_of_diensten).issubset( - set(zaaktype["productenOfDiensten"]) - ): - raise serializers.ValidationError( - { - "producten_of_diensten": _( - "Niet alle producten/diensten komen voor in " - "de producten/diensten op het zaaktype" - ) - }, - code="invalid-products-services", - ) - # Archiving - default_archiefstatus = ( - self.instance.archiefstatus - if self.instance - else Archiefstatus.nog_te_archiveren - ) - archiefstatus = ( - attrs.get("archiefstatus", default_archiefstatus) - != Archiefstatus.nog_te_archiveren - ) - if archiefstatus: - ios = self._get_information_objects() - for io in ios: - if io["status"] != "gearchiveerd": - raise serializers.ValidationError( - { - "archiefstatus", - _( - "Er zijn gerelateerde informatieobjecten waarvan de `status` nog niet gelijk is aan " - "`gearchiveerd`. Dit is een voorwaarde voor het zetten van de `archiefstatus` op een andere " - "waarde dan `nog_te_archiveren`." - ), - }, - code="documents-not-archived", - ) +class ZaakBesluitSerializer(NestedHyperlinkedModelSerializer): + parent_lookup_kwargs = {"zaak_uuid": "zaak__uuid"} - for attr in ["archiefnominatie", "archiefactiedatum"]: - if not attrs.get( - attr, getattr(self.instance, attr) if self.instance else None - ): - raise serializers.ValidationError( - { - attr: _( - "Moet van een waarde voorzien zijn als de 'Archiefstatus' een waarde heeft anders dan " - "'nog_te_archiveren'." - ) - }, - code=f"{attr}-not-set", + class Meta: + model = ZaakBesluit + fields = ("url", "uuid", "besluit") + extra_kwargs = { + "url": {"lookup_field": "uuid"}, + "uuid": {"read_only": True}, + "zaak": {"lookup_field": "uuid"}, + "besluit": {"validators": [URLValidator(get_auth=get_auth)]}, + } + + def create(self, validated_data): + validated_data["zaak"] = self.context["parent_object"] + return super().create(validated_data) + + +class ZaakContactMomentSerializer(serializers.HyperlinkedModelSerializer): + class Meta: + model = ZaakContactMoment + fields = ("url", "uuid", "zaak", "contactmoment") + extra_kwargs = { + "url": {"lookup_field": "uuid"}, + "uuid": {"read_only": True}, + "zaak": {"lookup_field": "uuid"}, + "contactmoment": { + "validators": [ + ResourceValidator( + "ContactMoment", settings.CMC_API_SPEC, get_auth=get_auth ) - # End archiving + ] + }, + } - return attrs + def save(self, **kwargs): + try: + return super().save(**kwargs) + except SyncError as sync_error: + # delete the object again + ZaakContactMoment.objects.filter( + contactmoment=self.validated_data["contactmoment"], + zaak=self.validated_data["zaak"], + )._raw_delete("default") + raise serializers.ValidationError( + {api_settings.NON_FIELD_ERRORS_KEY: sync_error.args[0]} + ) from sync_error - def create(self, validated_data: dict): - # set the derived value from ZTC - if "vertrouwelijkheidaanduiding" not in validated_data: - zaaktype = self._get_zaaktype(validated_data["zaaktype"]) - validated_data["vertrouwelijkheidaanduiding"] = zaaktype[ - "vertrouwelijkheidaanduiding" - ] - return super().create(validated_data) +class ZaakVerzoekSerializer(serializers.HyperlinkedModelSerializer): + class Meta: + model = ZaakVerzoek + fields = ("url", "uuid", "zaak", "verzoek") + extra_kwargs = { + "url": {"lookup_field": "uuid"}, + "uuid": {"read_only": True}, + "zaak": {"lookup_field": "uuid"}, + "verzoek": { + "validators": [ + ResourceValidator( + "Verzoek", settings.VRC_API_SPEC, get_auth=get_auth + ) + ] + }, + } + + def save(self, **kwargs): + try: + return super().save(**kwargs) + except SyncError as sync_error: + # delete the object again + ZaakVerzoek.objects.filter( + verzoek=self.validated_data["verzoek"], + zaak=self.validated_data["zaak"], + )._raw_delete("default") + raise serializers.ValidationError( + {api_settings.NON_FIELD_ERRORS_KEY: sync_error.args[0]} + ) from sync_error diff --git a/src/zrc/api/tests/test_zaken.py b/src/zrc/api/tests/test_zaken.py index be963788..59c3b785 100644 --- a/src/zrc/api/tests/test_zaken.py +++ b/src/zrc/api/tests/test_zaken.py @@ -1,5 +1,5 @@ import unittest -from datetime import date, timedelta +from datetime import date from unittest.mock import patch from django.contrib.gis.geos import Point @@ -12,7 +12,6 @@ from vng_api_common.constants import ( Archiefnominatie, BrondatumArchiefprocedureAfleidingswijze, - ComponentTypes, RolOmschrijving, RolTypes, VertrouwelijkheidsAanduiding, @@ -25,7 +24,7 @@ ) from zds_client.tests.mocks import mock_client -from zrc.datamodel.constants import AardExterneRelatie, BetalingsIndicatie +from zrc.datamodel.constants import BetalingsIndicatie from zrc.datamodel.models import ( Medewerker, NatuurlijkPersoon, @@ -35,14 +34,11 @@ Zaak, ) from zrc.datamodel.tests.factories import ( - ResultaatFactory, RolFactory, StatusFactory, ZaakBesluitFactory, ZaakEigenschapFactory, ZaakFactory, - ZaakInformatieObjectFactory, - ZaakObjectFactory, ) from zrc.tests.constants import POLYGON_AMSTERDAM_CENTRUM from zrc.tests.utils import ( @@ -60,7 +56,6 @@ SCOPE_ZAKEN_CREATE, SCOPEN_ZAKEN_HEROPENEN, ) -from .mixins import ZaakInformatieObjectSyncMixin # ZTC ZTC_ROOT = "https://example.com/ztc/api/v1" @@ -699,140 +694,6 @@ def test_filter_rol__betrokkeneIdentificatie__medewerker__identificatie_max_leng ) self.assertEqual(error["code"], "max_length") - def test_get_zaak_inline_resources(self): - self.applicatie.heeft_alle_autorisaties = True - self.applicatie.save() - - zaak = ZaakFactory.create() - url = reverse(zaak) - - rol = RolFactory.create(zaak=zaak) - zio = ZaakInformatieObjectFactory.create(zaak=zaak) - zaakobject = ZaakObjectFactory.create(zaak=zaak) - - rol_url = f"http://testserver{reverse(rol)}" - zio_url = f"http://testserver{reverse(zio)}" - zaakobject_url = f"http://testserver{reverse(zaakobject)}" - - response = self.client.get(url, **ZAAK_READ_KWARGS) - - self.assertEqual(response.status_code, status.HTTP_200_OK) - - expected_data = { - "archiefactiedatum": None, - "archiefnominatie": None, - "archiefstatus": zaak.archiefstatus, - "betalingsindicatie": "", - "betalingsindicatie_weergave": "", - "bronorganisatie": zaak.bronorganisatie, - "communicatiekanaal": "", - "deelzaken": [], - "eigenschappen": [], - "einddatum": None, - "einddatum_gepland": None, - "hoofdzaak": None, - "identificatie": zaak.identificatie, - "kenmerken": [], - "laatste_betaaldatum": None, - "omschrijving": "", - "opdrachtgevende_organisatie": "", - "opschorting": {"indicatie": False, "reden": ""}, - "producten_of_diensten": [], - "publicatiedatum": None, - "registratiedatum": str(zaak.registratiedatum), - "relevante_andere_zaken": [], - "resultaat": None, - "rollen": [rol_url], - "selectielijstklasse": "", - "startdatum": str(zaak.startdatum), - "status": None, - "toelichting": "", - "uiterlijke_einddatum_afdoening": None, - "url": f"http://testserver{url}", - "uuid": str(zaak.uuid), - "verantwoordelijke_organisatie": zaak.verantwoordelijke_organisatie, - "verlenging": {"reden": "", "duur": None}, - "vertrouwelijkheidaanduiding": zaak.vertrouwelijkheidaanduiding, - "zaakgeometrie": None, - "zaakinformatieobjecten": [zio_url], - "zaakobjecten": [zaakobject_url], - "zaaktype": zaak.zaaktype, - "processobjectaard": None, - "resultaattoelichting": "", - "startdatum_bewaartermijn": None, - "gerelateerde_externe_zaken": { - "aanvraagdatum": None, - "aard_relatie": "", - "datum_status_gezet": None, - "eind_datum": None, - "resultaatomschrijving": "", - "startdatum": None, - "status_omschrijving_generiek": "", - "verantwoordelijke_organisatie": "", - "zaakidentificatie": "", - "zaaktype_omschrijving_generiek": "", - "zaaktypecode": "", - "url": "", - }, - "processobject": { - "datumkenmerk": "", - "identificatie": "", - "objecttype": "", - "registratie": "", - }, - } - - self.assertDictEqual(dict(response.data), expected_data) - - def test_missing_processobject(self): - self.applicatie.heeft_alle_autorisaties = True - self.applicatie.save() - - zaak = ZaakFactory() - - response = self.client.patch( - reverse(zaak), - { - "processobject": { - "datumkenmerk": "XYZ", - "identificatie": "YZX", - "objecttype": "XZY", - } - }, - **ZAAK_WRITE_KWARGS, - ) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "processobject.registratie") - self.assertEqual(error["code"], "required") - - def test_missing_gerelateerde_externe_zaken(self): - self.applicatie.heeft_alle_autorisaties = True - self.applicatie.save() - - zaak = ZaakFactory() - - response = self.client.patch( - reverse(zaak), - { - "gerelateerdeExterneZaken": { - "aanvraagdatum": (timezone.now() - timedelta(days=3)).strftime( - "%Y-%m-%d" - ), - "datumStatusGezet": timezone.now() - timedelta(days=1), - "zaaktypeOmschrijvingGeneriek": "Omschrijving XY", - "zaaktypecode": "XYZ", - } - }, - **ZAAK_WRITE_KWARGS, - ) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "gerelateerdeExterneZaken.aardRelatie") - self.assertEqual(error["code"], "required") - @override_settings( LINK_FETCHER="vng_api_common.mocks.link_fetcher_200", @@ -1415,245 +1276,3 @@ def test_rol_organisatorische_eenheid_identificatie(self): self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual(response.data["count"], 1) - - -class ZakenExpandTests(ZaakInformatieObjectSyncMixin, JWTAuthMixin, APITestCase): - scopes = [SCOPE_ZAKEN_ALLES_LEZEN] - zaaktype = ZAAKTYPE - component = ComponentTypes.zrc - maxDiff = None - - def test_list_expand(self): - zaak = ZaakFactory.create(zaaktype=ZAAKTYPE) - zaak_url = reverse(zaak) - - # Create related resources - RolFactory.create_batch(2, zaak=zaak) - ZaakObjectFactory.create_batch(2, zaak=zaak) - ZaakInformatieObjectFactory.create_batch(2, zaak=zaak) - ZaakEigenschapFactory.create_batch(2, zaak=zaak) - zaak_status = StatusFactory.create(zaak=zaak) - resultaat = ResultaatFactory.create(zaak=zaak) - - # Create unrelated resources - RolFactory.create_batch(2) - ZaakObjectFactory.create_batch(2) - ZaakInformatieObjectFactory.create_batch(2) - ZaakEigenschapFactory.create_batch(2) - StatusFactory.create_batch(2) - ResultaatFactory.create_batch(2) - - url = reverse(Zaak) - - for resource in [ - "status", - "resultaat", - "eigenschappen", - "rollen", - "zaakobjecten", - "zaakinformatieobjecten", - ]: - with self.subTest(resource=resource): - response = self.client.get( - url, {"expand": resource}, **ZAAK_READ_KWARGS - ) - - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data["count"], 1) - - inline_resources = response.data["results"][0][resource] - - if resource == "status": - self.assertEqual( - inline_resources["zaak"], f"http://testserver{zaak_url}" - ) - self.assertEqual(inline_resources["uuid"], str(zaak_status.uuid)) - elif resource == "resultaat": - self.assertEqual( - inline_resources["zaak"], f"http://testserver{zaak_url}" - ) - self.assertEqual(inline_resources["uuid"], str(resultaat.uuid)) - else: - self.assertEqual(len(inline_resources), 2) - self.assertEqual( - *[r["zaak"] for r in inline_resources], - f"http://testserver{zaak_url}", - ) - - def test_list_expand_some(self): - zaak = ZaakFactory.create(startdatum="2019-01-01", zaaktype=ZAAKTYPE) - zaak_url = reverse(zaak) - RolFactory.create_batch(2, zaak=zaak) - ZaakObjectFactory.create_batch(2, zaak=zaak) - ZaakInformatieObjectFactory.create_batch(2, zaak=zaak) - - # Create unrelated resources - RolFactory.create_batch(2) - ZaakObjectFactory.create_batch(2) - ZaakInformatieObjectFactory.create_batch(2) - - url = reverse("zaak-list") - - response = self.client.get( - url, - {"expand": ["zaakobjecten", "zaakinformatieobjecten"]}, - **ZAAK_READ_KWARGS, - ) - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data["count"], 1) - - zaakobjecten = response.data["results"][0]["zaakobjecten"] - self.assertEqual(len(zaakobjecten), 2) - self.assertEqual( - *[r["zaak"] for r in zaakobjecten], - f"http://testserver{zaak_url}", - ) - - zaakinformatieobjecten = response.data["results"][0]["zaakinformatieobjecten"] - self.assertEqual(len(zaakinformatieobjecten), 2) - self.assertEqual( - *[r["zaak"] for r in zaakinformatieobjecten], - f"http://testserver{zaak_url}", - ) - - # Rollen should not be expanded - rollen = response.data["results"][0]["rollen"] - self.assertEqual(len(rollen), 2) - self.assertTrue(*[isinstance(r, str) for r in rollen]) - - def test_list_expand_all(self): - zaak = ZaakFactory.create(startdatum="2019-01-01", zaaktype=ZAAKTYPE) - zaak_url = reverse(zaak) - - # Create related resources - RolFactory.create_batch(2, zaak=zaak) - ZaakObjectFactory.create_batch(2, zaak=zaak) - ZaakInformatieObjectFactory.create_batch(2, zaak=zaak) - ZaakEigenschapFactory.create_batch(2, zaak=zaak) - zaak_status = StatusFactory.create(zaak=zaak) - resultaat = ResultaatFactory.create(zaak=zaak) - - # Create unrelated resources - RolFactory.create_batch(2) - ZaakObjectFactory.create_batch(2) - ZaakInformatieObjectFactory.create_batch(2) - ZaakEigenschapFactory.create_batch(2) - StatusFactory.create_batch(2) - ResultaatFactory.create_batch(2) - - url = reverse(Zaak) - - resources = [ - "status", - "resultaat", - "eigenschappen", - "rollen", - "zaakobjecten", - "zaakinformatieobjecten", - ] - - response = self.client.get(url, {"expand": resources}, **ZAAK_READ_KWARGS) - - for resource in resources: - with self.subTest(resource=resource): - self.assertEqual(response.status_code, status.HTTP_200_OK) - self.assertEqual(response.data["count"], 1) - - inline_resources = response.data["results"][0][resource] - - if resource == "status": - self.assertEqual( - inline_resources["zaak"], f"http://testserver{zaak_url}" - ) - self.assertEqual(inline_resources["uuid"], str(zaak_status.uuid)) - elif resource == "resultaat": - self.assertEqual( - inline_resources["zaak"], f"http://testserver{zaak_url}" - ) - self.assertEqual(inline_resources["uuid"], str(resultaat.uuid)) - else: - self.assertEqual(len(inline_resources), 2) - self.assertEqual( - *[r["zaak"] for r in inline_resources], - f"http://testserver{zaak_url}", - ) - - def test_detail_expand(self): - zaak = ZaakFactory.create(startdatum="2019-01-01", zaaktype=ZAAKTYPE) - zaak_url = reverse(zaak) - - # Create related resources - RolFactory.create_batch(2, zaak=zaak) - ZaakObjectFactory.create_batch(2, zaak=zaak) - ZaakInformatieObjectFactory.create_batch(2, zaak=zaak) - ZaakEigenschapFactory.create_batch(2, zaak=zaak) - zaak_status = StatusFactory.create(zaak=zaak) - resultaat = ResultaatFactory.create(zaak=zaak) - - # Create unrelated resources - RolFactory.create_batch(2) - ZaakObjectFactory.create_batch(2) - ZaakInformatieObjectFactory.create_batch(2) - ZaakEigenschapFactory.create_batch(2) - StatusFactory.create_batch(2) - ResultaatFactory.create_batch(2) - - url = reverse(zaak) - - for resource in [ - "status", - "resultaat", - "eigenschappen", - "rollen", - "zaakobjecten", - "zaakinformatieobjecten", - ]: - with self.subTest(resource=resource): - response = self.client.get( - url, {"expand": resource}, **ZAAK_READ_KWARGS - ) - - self.assertEqual(response.status_code, status.HTTP_200_OK) - - inline_resources = response.data[resource] - - if resource == "status": - self.assertEqual( - inline_resources["zaak"], f"http://testserver{zaak_url}" - ) - self.assertEqual(inline_resources["uuid"], str(zaak_status.uuid)) - elif resource == "resultaat": - self.assertEqual( - inline_resources["zaak"], f"http://testserver{zaak_url}" - ) - self.assertEqual(inline_resources["uuid"], str(resultaat.uuid)) - else: - self.assertEqual(len(inline_resources), 2) - self.assertEqual( - *[r["zaak"] for r in inline_resources], - f"http://testserver{zaak_url}", - ) - - def test_list_expand_invalid_parameter(self): - ZaakFactory.create(startdatum="2019-01-01", zaaktype=ZAAKTYPE) - - url = reverse(Zaak) - - response = self.client.get(url, {"expand": "foo"}, **ZAAK_READ_KWARGS) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "expand") - self.assertEqual(error["code"], "invalid_choice") - - def test_detail_expand_invalid_parameter(self): - zaak = ZaakFactory.create(startdatum="2019-01-01", zaaktype=ZAAKTYPE) - - url = reverse(zaak) - - response = self.client.get(url, {"expand": "foo"}, **ZAAK_READ_KWARGS) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "expand") - self.assertEqual(error["code"], "invalid_choice") diff --git a/src/zrc/api/viewsets.py b/src/zrc/api/viewsets.py index 72e10324..cfd89162 100644 --- a/src/zrc/api/viewsets.py +++ b/src/zrc/api/viewsets.py @@ -3,8 +3,6 @@ from django.core.cache import caches from django.shortcuts import get_object_or_404 -from drf_yasg import openapi -from drf_yasg.utils import swagger_auto_schema from rest_framework import mixins, serializers, viewsets from rest_framework.decorators import action from rest_framework.exceptions import PermissionDenied @@ -94,15 +92,6 @@ logger = logging.getLogger(__name__) -EXPAND_PARAMETER = openapi.Parameter( - "expand", - openapi.IN_QUERY, - description="Haal details van inline resources direct op.", - type=openapi.TYPE_STRING, - enum=ZaakSerializer.Meta.expandable_fields, -) - - @conditional_retrieve() class ZaakViewSet( NotificationViewSetMixin, @@ -218,12 +207,7 @@ class ZaakViewSet( - `klantcontact` - alle klantcontacten bij een zaak """ - queryset = Zaak.objects.prefetch_related( - "deelzaken", - "rol_set", - "zaakobject_set", - "zaakinformatieobject_set", - ).order_by("-pk") + queryset = Zaak.objects.prefetch_related("deelzaken").order_by("-pk") serializer_class = ZaakSerializer search_input_serializer_class = ZaakZoekSerializer filter_backends = (Backend,) @@ -244,15 +228,6 @@ class ZaakViewSet( notifications_kanaal = KANAAL_ZAKEN audit = AUDIT_ZRC - @swagger_auto_schema(manual_parameters=[EXPAND_PARAMETER]) - def retrieve(self, request, *args, **kwargs): - return super().retrieve(request, *args, **kwargs) - - @swagger_auto_schema(manual_parameters=[EXPAND_PARAMETER]) - def list(self, request, *args, **kwargs): - return super().list(request, *args, **kwargs) - - @swagger_auto_schema(manual_parameters=[EXPAND_PARAMETER]) @action(methods=("post",), detail=False) def _zoek(self, request, *args, **kwargs): """ diff --git a/src/zrc/datamodel/models/core.py b/src/zrc/datamodel/models/core.py index a8124272..1b5c8ad9 100644 --- a/src/zrc/datamodel/models/core.py +++ b/src/zrc/datamodel/models/core.py @@ -532,9 +532,9 @@ def save(self, *args, **kwargs): super().save(*args, **kwargs) @property - def current_status(self): + def current_status_uuid(self): status = self.status_set.order_by("-datum_status_gezet").first() - return status + return status.uuid if status else None @property def is_closed(self) -> bool: diff --git a/src/zrc/utils/serializers.py b/src/zrc/utils/serializers.py deleted file mode 100644 index 6a1e4f9e..00000000 --- a/src/zrc/utils/serializers.py +++ /dev/null @@ -1,47 +0,0 @@ -from django.utils.module_loading import import_string - -from rest_framework_nested.serializers import NestedHyperlinkedRelatedField - - -# TODO move to vng-api-common -class ExpandSerializer(NestedHyperlinkedRelatedField): - def __init__(self, *args, **kwargs): - # For some reason self.field_name is empty for `many=True` - self.name = kwargs.pop("name") - - self.default_serializer = kwargs.pop("default_serializer") - self.expanded_serializer = kwargs.pop("expanded_serializer") - - self.default_serializer_kwargs = kwargs.pop("default_serializer_kwargs", {}) - self.expanded_serializer_kwargs = kwargs.pop("expanded_serializer_kwargs", {}) - - # Update the serializer specific kwargs with the kwargs used for all - # serializers - common_kwargs = kwargs.pop("common_kwargs") - self.default_serializer_kwargs.update(common_kwargs) - self.expanded_serializer_kwargs.update(common_kwargs) - - kwargs.update(self.default_serializer_kwargs) - - super().__init__(*args, **kwargs) - - def to_representation(self, value): - serializer_class = self.default_serializer - if isinstance(self.default_serializer, str): - serializer_class = import_string(self.default_serializer) - serializer = serializer_class(**self.default_serializer_kwargs) - serializer.parent = self - - if hasattr(self.context["request"], "query_params"): - expand = self.context["request"].query_params.getlist("expand") - if self.name in expand: - serializer_class = self.expanded_serializer - if isinstance(self.expanded_serializer, str): - serializer_class = import_string(self.expanded_serializer) - serializer = serializer_class(**self.expanded_serializer_kwargs) - serializer.parent = self - - if self.default_serializer_kwargs.get("many", False): - value = value.all() - - return serializer.to_representation(value)