From 396c3b1c76e58bc45422fb8eb4271835fb30185d Mon Sep 17 00:00:00 2001 From: matthijsbekendam Date: Wed, 8 Mar 2023 15:43:15 +0100 Subject: [PATCH] feature: new history model for zaaktype/informatieobjecttype/besluittype --- .bumpversion.cfg | 2 +- README.rst | 2 +- package.json | 2 +- requirements/base.in | 2 +- src/openapi.yaml | 12050 ++++++++-------- src/ztc/__init__.py | 2 +- src/ztc/api/serializers/besluittype.py | 29 +- .../api/serializers/informatieobjecttype.py | 13 +- src/ztc/api/serializers/relatieklassen.py | 59 +- src/ztc/api/serializers/resultaattype.py | 10 + src/ztc/api/serializers/zaken.py | 28 +- src/ztc/api/tests/test_api_strategy.py | 1 + src/ztc/api/tests/test_besluittype.py | 280 +- .../api/tests/test_informatieobjecttype.py | 119 - src/ztc/api/tests/test_relatieklassen.py | 88 +- src/ztc/api/tests/test_resultaattype.py | 26 +- src/ztc/api/tests/test_zaken.py | 357 +- src/ztc/api/utils/viewsets.py | 108 + src/ztc/api/validators.py | 1 - src/ztc/api/views/besluittype.py | 71 +- src/ztc/api/views/informatieobjecttype.py | 40 +- src/ztc/api/views/relatieklassen.py | 62 +- src/ztc/api/views/resultaattype.py | 61 +- src/ztc/api/views/zaken.py | 90 +- src/ztc/conf/api.py | 2 +- .../migrations/0136_auto_20230309_1412.py | 21 + .../migrations/0137_auto_20230309_1415.py | 24 + ..._alter_zaaktypenrelatie_unique_together.py | 17 + src/ztc/datamodel/models/besluittype.py | 2 +- .../datamodel/models/informatieobjecttype.py | 2 +- src/ztc/datamodel/models/relatieklassen.py | 6 +- src/ztc/tests/test_userstory_history_model.py | 546 + 32 files changed, 7559 insertions(+), 6564 deletions(-) create mode 100644 src/ztc/datamodel/migrations/0136_auto_20230309_1412.py create mode 100644 src/ztc/datamodel/migrations/0137_auto_20230309_1415.py create mode 100644 src/ztc/datamodel/migrations/0138_alter_zaaktypenrelatie_unique_together.py create mode 100644 src/ztc/tests/test_userstory_history_model.py diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 3cc42df4..23c58aa4 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,7 +1,7 @@ [bumpversion] commit = False tag = False -current_version = 1.2.1 +current_version = 1.3.0-rc1 parse = (?P\d+)\.(?P\d+)\.(?P\d+)([-](?P(rc|alpha))+(?P\d+))? serialize = {major}.{minor}.{patch}-{release}{build} diff --git a/README.rst b/README.rst index 3095f3b7..1a68a603 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ Catalogi API ============ -:Version: 1.2.1 +:Version: 1.3.0-rc1 :Source: https://github.com/VNG-Realisatie/zaaktypecataloguscomponent :Keywords: zaaktypen, ztc, imztc, ztc2, ztcaas, saas, rest, api diff --git a/package.json b/package.json index aa8b7ca1..0054ade5 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "ztc", - "version": "1.2.1", + "version": "1.3.0-rc1", "description": "ztc referentie-implementatie API", "directories": {"doc": "doc"}, "scripts": {"build": "npm run bundle", "bundle": "webpack", "watch": "webpack -w"}, diff --git a/requirements/base.in b/requirements/base.in index 1c81344d..26117edd 100644 --- a/requirements/base.in +++ b/requirements/base.in @@ -21,7 +21,7 @@ django-filter~=21.1 djangorestframework-camel-case drf_spectacular -vng-api-common==2.0.4 +vng_api_common==2.0.4 drf-flex-fields django-cors-middleware drf-writable-nested diff --git a/src/openapi.yaml b/src/openapi.yaml index 1a9a324a..bacc9665 100644 --- a/src/openapi.yaml +++ b/src/openapi.yaml @@ -1,44 +1,116 @@ openapi: 3.0.3 info: title: Catalogi API - version: 1.2.1 - description: - "Een API om een zaaktypecatalogus (ZTC) te benaderen.\n\nDe zaaktypecatalogus\ - \ helpt gemeenten om het proces vanuit de 'vraag van een\nklant' (productaanvraag,\ - \ melding, aangifte, informatieverzoek e.d.) tot en met\nhet leveren van een passend\ - \ antwoord daarop in te richten, inclusief de\nbijbehorende informatievoorziening.\n\ - \nEen CATALOGUS bestaat uit ZAAKTYPEn, INFORMATIEOBJECTTYPEn en BESLUITTYPEn en\n\ - wordt typisch gebruikt om een ZAAK (in de Zaken API), INFORMATIEOBJECT (in de\n\ - Documenten API) en BESLUIT (in de Besluiten API) te voorzien van type,\nstandaardwaarden\ - \ en processtructuur.\n\n**Afhankelijkheden**\n\nDeze API is afhankelijk van:\n\ - \n* Gemeentelijke Selectielijst API\n* Autorisaties API *(optioneel)*\n\n\n**Autorisatie**\n\ - \nDeze API vereist autorisatie. Je kan de\n[token-tool](https://zaken-auth.vng.cloud/)\ - \ gebruiken om een token te\ngenereren.\n\n_Zelf een token genereren_\n\nDe tokens\ - \ die gebruikt worden voor autorisatie zijn [jwt.io][JWT's] (JSON web\ntoken).\ - \ In de API calls moeten deze gebruikt worden in de `Authorization`\nheader:\n\ - \n```\nAuthorization: Bearer \n```\n\nOm een JWT te genereren heb je een\ - \ `client ID` en een `secret` nodig. Het JWT\nmoet gebouwd worden volgens het\ - \ `HS256` algoritme. De vereiste payload is:\n\n```json\n{\n \"iss\": \"\",\n \"iat\": 1572863906,\n \"client_id\": \"\",\n \"\ - user_id\": \"\",\n \"user_representation\": \"\"\ - \n}\n```\n\nAls `issuer` gebruik je dus je eigen client ID. De `iat` timestamp\ - \ is een\nUNIX-timestamp die aangeeft op welk moment het token gegenereerd is.\n\ - \n`user_id` en `user_representation` zijn nodig voor de audit trails. Het zijn\n\ - vrije velden met als enige beperking dat de lengte maximaal de lengte van\nde\ - \ overeenkomstige velden in de audit trail resources is (zie rest API spec).\n\ - \n\n### Notificaties\n\nDeze API publiceert notificaties op het kanaal `zaaktypen`.\n\ - \n**Main resource**\n\n`zaaktype`\n\n\n\n**Kenmerken**\n\n* `catalogus`: URL-referentie\ - \ naar de CATALOGUS waartoe dit ZAAKTYPE behoort.\n\n**Resources en acties**\n\ - - `zaaktype`: create, update, destroy\n\n\nDeze API publiceert notificaties op\ - \ het kanaal `besluittypen`.\n\n**Main resource**\n\n`besluittype`\n\n\n\n**Kenmerken**\n\ - \n* `catalogus`: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort.\n\ - \n**Resources en acties**\n- `besluittype`: create, update, destroy\n\n\nDeze\ - \ API publiceert notificaties op het kanaal `informatieobjecttypen`.\n\n**Main\ - \ resource**\n\n`informatieobjecttype`\n\n\n\n**Kenmerken**\n\n* `catalogus`:\ - \ URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE behoort.\n\ - \n**Resources en acties**\n- `informatieobjecttype`: create, update, destroy\n\ - \n\n**Handige links**\n\n* [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard)\n\ - * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken)\n" + version: 1.3.0-rc1 + description: | + Een API om een zaaktypecatalogus (ZTC) te benaderen. + + De zaaktypecatalogus helpt gemeenten om het proces vanuit de 'vraag van een + klant' (productaanvraag, melding, aangifte, informatieverzoek e.d.) tot en met + het leveren van een passend antwoord daarop in te richten, inclusief de + bijbehorende informatievoorziening. + + Een CATALOGUS bestaat uit ZAAKTYPEn, INFORMATIEOBJECTTYPEn en BESLUITTYPEn en + wordt typisch gebruikt om een ZAAK (in de Zaken API), INFORMATIEOBJECT (in de + Documenten API) en BESLUIT (in de Besluiten API) te voorzien van type, + standaardwaarden en processtructuur. + + **Afhankelijkheden** + + Deze API is afhankelijk van: + + * Gemeentelijke Selectielijst API + * Autorisaties API *(optioneel)* + + + **Autorisatie** + + Deze API vereist autorisatie. Je kan de + [token-tool](https://zaken-auth.vng.cloud/) gebruiken om een token te + genereren. + + _Zelf een token genereren_ + + De tokens die gebruikt worden voor autorisatie zijn [jwt.io][JWT's] (JSON web + token). In de API calls moeten deze gebruikt worden in de `Authorization` + header: + + ``` + Authorization: Bearer + ``` + + Om een JWT te genereren heb je een `client ID` en een `secret` nodig. Het JWT + moet gebouwd worden volgens het `HS256` algoritme. De vereiste payload is: + + ```json + { + "iss": "", + "iat": 1572863906, + "client_id": "", + "user_id": "", + "user_representation": "" + } + ``` + + Als `issuer` gebruik je dus je eigen client ID. De `iat` timestamp is een + UNIX-timestamp die aangeeft op welk moment het token gegenereerd is. + + `user_id` en `user_representation` zijn nodig voor de audit trails. Het zijn + vrije velden met als enige beperking dat de lengte maximaal de lengte van + de overeenkomstige velden in de audit trail resources is (zie rest API spec). + + + ### Notificaties + + Deze API publiceert notificaties op het kanaal `zaaktypen`. + + **Main resource** + + `zaaktype` + + + + **Kenmerken** + + * `catalogus`: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. + + **Resources en acties** + + + Deze API publiceert notificaties op het kanaal `besluittypen`. + + **Main resource** + + `besluittype` + + + + **Kenmerken** + + * `catalogus`: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. + + **Resources en acties** + + + Deze API publiceert notificaties op het kanaal `informatieobjecttypen`. + + **Main resource** + + `informatieobjecttype` + + + + **Kenmerken** + + * `catalogus`: URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE behoort. + + **Resources en acties** + + + **Handige links** + + * [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard) + * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken) contact: email: standaarden.ondersteuning@vng.nl url: https://vng-realisatie.github.io/gemma-zaken @@ -52,72 +124,66 @@ paths: description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle BESLUITTYPEn opvragen. parameters: - - name: catalogus - required: false - in: query - description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. - schema: - type: string - format: uri - - name: zaaktypen - required: false - in: query - description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE - schema: - type: string - - name: informatieobjecttypen - required: false - in: query - description: - Het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten - van dit BESLUITTYPE worden vastgelegd. - schema: - type: string - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: omschrijving - required: false - in: query - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer + - name: catalogus + required: false + in: query + description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. + schema: + type: string + format: uri + - name: zaaktypen + required: false + in: query + description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE + schema: + type: string + - name: informatieobjecttypen + required: false + in: query + description: Het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten + van dit BESLUITTYPE worden vastgelegd. + schema: + type: string + - name: status + required: false + in: query + description: | + filter objects depending on their concept status: + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + schema: + type: string + - name: omschrijving + required: false + in: query + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer tags: - - besluittypen + - besluittypen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -129,11 +195,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -142,11 +207,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -155,11 +219,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -168,11 +231,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -181,11 +243,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -194,11 +255,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -207,11 +267,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -220,11 +279,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -233,11 +291,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -246,25 +303,25 @@ paths: description: Maak een BESLUITTYPE aan. summary: Maak een BESLUITTYPE aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - besluittypen + - besluittypen requestBody: content: application/json: schema: - $ref: '#/components/schemas/BesluitType' + $ref: '#/components/schemas/BesluitTypeCreate' required: true security: - - JWT-Claims: - - catalogi.schrijven + - JWT-Claims: + - catalogi.schrijven responses: '201': headers: @@ -276,8 +333,7 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -289,11 +345,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -302,11 +357,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -315,11 +369,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -328,11 +381,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -341,11 +393,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -354,11 +405,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -367,11 +417,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -380,11 +429,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -393,11 +441,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -407,52 +454,48 @@ paths: description: Een specifieke BESLUITTYPE opvragen. summary: Een specifieke BESLUITTYPE opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - besluittypen + - besluittypen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -464,11 +507,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -477,11 +519,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -490,11 +531,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -503,11 +543,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -516,11 +555,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -529,11 +567,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -542,11 +579,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -555,11 +591,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -568,56 +603,53 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: besluittype_update - description: - Werk een BESLUITTYPE in zijn geheel bij. Dit kan alleen als het + description: Werk een BESLUITTYPE in zijn geheel bij. Dit kan alleen als het een concept betreft. summary: Werk een BESLUITTYPE in zijn geheel bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - besluittypen + - besluittypen requestBody: content: application/json: schema: - $ref: '#/components/schemas/BesluitType' + $ref: '#/components/schemas/BesluitTypeUpdate' required: true security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -629,11 +661,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -642,11 +673,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -655,11 +685,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -668,11 +697,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -681,11 +709,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -694,11 +721,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -707,11 +733,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -720,11 +745,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -733,11 +757,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -746,55 +769,52 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: besluittype_partial_update - description: - Werk een BESLUITTYPE deels bij. Dit kan alleen als het een concept + description: Werk een BESLUITTYPE deels bij. Dit kan alleen als het een concept betreft. summary: Werk een BESLUITTYPE deels bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - besluittypen + - besluittypen requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedBesluitType' security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -806,11 +826,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -819,11 +838,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -832,11 +850,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -845,11 +862,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -858,11 +874,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -871,11 +886,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -884,11 +898,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -897,11 +910,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -910,11 +922,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -923,11 +934,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -936,19 +946,19 @@ paths: description: Verwijder een BESLUITTYPE. Dit kan alleen als het een concept betreft. summary: Verwijder een BESLUITTYPE. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true tags: - - besluittypen + - besluittypen security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '204': description: No content @@ -957,11 +967,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -970,11 +979,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -983,11 +991,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -996,11 +1003,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1009,11 +1015,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1022,11 +1027,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1035,11 +1039,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1048,11 +1051,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1061,11 +1063,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -1074,49 +1075,45 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) BESLUITTYPE opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - besluittypen + - besluittypen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -1126,42 +1123,40 @@ paths: /besluittypen/{uuid}/publish: post: operationId: besluittype_publish - description: - Publiceren van het besluittype zorgt ervoor dat dit in een Besluiten + description: Publiceren van het besluittype zorgt ervoor dat dit in een Besluiten API kan gebruikt worden. Na het publiceren van een besluittype zijn geen inhoudelijke wijzigingen meer mogelijk. Indien er na het publiceren nog wat gewijzigd moet worden, dan moet je een nieuwe versie aanmaken. summary: Publiceer het concept BESLUITTYPE. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - besluittypen + - besluittypen security: - - JWT-Claims: - - catalogi.schrijven + - JWT-Claims: + - catalogi.schrijven responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -1170,61 +1165,61 @@ paths: description: OK '400': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '404': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found '401': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -1234,49 +1229,48 @@ paths: description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle CATALOGUSsen opvragen. parameters: - - name: domein - required: false - in: query - description: domein - schema: - type: string - - name: domein__in - required: false - in: query - description: domein__in - schema: - type: string - - name: rsin - required: false - in: query - description: rsin - schema: - type: string - - name: rsin__in - required: false - in: query - description: rsin__in - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer + - name: domein + required: false + in: query + description: domein + schema: + type: string + - name: domein__in + required: false + in: query + description: domein__in + schema: + type: string + - name: rsin + required: false + in: query + description: rsin + schema: + type: string + - name: rsin__in + required: false + in: query + description: rsin__in + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer tags: - - catalogussen + - catalogussen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -1288,11 +1282,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -1301,11 +1294,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -1314,11 +1306,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -1327,11 +1318,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1340,11 +1330,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1353,11 +1342,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1366,11 +1354,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1379,11 +1366,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1392,11 +1378,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -1405,16 +1390,16 @@ paths: description: Maak een CATALOGUS aan. summary: Maak een CATALOGUS aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - catalogussen + - catalogussen requestBody: content: application/json: @@ -1422,8 +1407,8 @@ paths: $ref: '#/components/schemas/Catalogus' required: true security: - - JWT-Claims: - - catalogi.schrijven + - JWT-Claims: + - catalogi.schrijven responses: '201': headers: @@ -1435,8 +1420,7 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -1448,11 +1432,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -1461,11 +1444,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -1474,11 +1456,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -1487,11 +1468,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1500,11 +1480,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1513,11 +1492,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1526,11 +1504,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1539,11 +1516,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1552,11 +1528,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -1566,52 +1541,48 @@ paths: description: Een specifieke CATALOGUS opvragen. summary: Een specifieke CATALOGUS opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - catalogussen + - catalogussen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -1623,11 +1594,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -1636,11 +1606,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -1649,11 +1618,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -1662,11 +1630,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1675,11 +1642,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1688,11 +1654,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1701,11 +1666,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1714,11 +1678,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1727,11 +1690,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -1740,49 +1702,45 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) CATALOGUS opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - catalogussen + - catalogussen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -1795,60 +1753,54 @@ paths: description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle EIGENSCHAPpen opvragen. parameters: - - name: zaaktype - required: false - in: query - description: - URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze - EIGENSCHAP van belang is. - schema: - type: string - format: uri - - name: zaaktypeIdentificatie - required: false - in: query - description: zaaktype_identificatie - schema: - type: string - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer + - name: zaaktype + required: false + in: query + description: URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze + EIGENSCHAP van belang is. + schema: + type: string + format: uri + - name: zaaktypeIdentificatie + required: false + in: query + description: zaaktype_identificatie + schema: + type: string + - name: status + required: false + in: query + description: | + filter objects depending on their concept status: + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer tags: - - eigenschappen + - eigenschappen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -1860,11 +1812,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -1873,11 +1824,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -1886,11 +1836,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -1899,11 +1848,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1912,11 +1860,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1925,11 +1872,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1938,11 +1884,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1951,11 +1896,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1964,31 +1908,29 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: eigenschap_create - description: - Maak een EIGENSCHAP aan. Dit kan alleen als het bijbehorende ZAAKTYPE + description: Maak een EIGENSCHAP aan. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Maak een EIGENSCHAP aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - eigenschappen + - eigenschappen requestBody: content: application/json: @@ -1996,8 +1938,8 @@ paths: $ref: '#/components/schemas/Eigenschap' required: true security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '201': headers: @@ -2009,8 +1951,7 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -2022,11 +1963,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -2035,11 +1975,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2048,11 +1987,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2061,11 +1999,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2074,11 +2011,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2087,11 +2023,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2100,11 +2035,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2113,11 +2047,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2126,11 +2059,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -2140,52 +2072,48 @@ paths: description: Een specifieke EIGENSCHAP opvragen. summary: Een specifieke EIGENSCHAP opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - eigenschappen + - eigenschappen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -2197,11 +2125,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2210,11 +2137,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2223,11 +2149,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -2236,11 +2161,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2249,11 +2173,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2262,11 +2185,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2275,11 +2197,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2288,11 +2209,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2301,39 +2221,37 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: eigenschap_update - description: - Werk een EIGENSCHAP in zijn geheel bij. Dit kan alleen als het + description: Werk een EIGENSCHAP in zijn geheel bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Werk een EIGENSCHAP in zijn geheel bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - eigenschappen + - eigenschappen requestBody: content: application/json: @@ -2341,16 +2259,15 @@ paths: $ref: '#/components/schemas/Eigenschap' required: true security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -2362,11 +2279,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -2375,11 +2291,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2388,11 +2303,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2401,11 +2315,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -2414,11 +2327,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2427,11 +2339,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2440,11 +2351,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2453,11 +2363,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2466,11 +2375,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2479,55 +2387,52 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: eigenschap_partial_update - description: - Werk een EIGENSCHAP deels bij. Dit kan alleen als het bijbehorende + description: Werk een EIGENSCHAP deels bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Werk een EIGENSCHAP deels bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - eigenschappen + - eigenschappen requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedEigenschap' security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -2539,11 +2444,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -2552,11 +2456,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2565,11 +2468,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2578,11 +2480,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -2591,11 +2492,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2604,11 +2504,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2617,11 +2516,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2630,11 +2528,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2643,11 +2540,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2656,34 +2552,32 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: eigenschap_destroy - description: - Verwijder een EIGENSCHAP. Dit kan alleen als het bijbehorende ZAAKTYPE + description: Verwijder een EIGENSCHAP. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Verwijder een EIGENSCHAP. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true tags: - - eigenschappen + - eigenschappen security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '204': description: No content @@ -2692,11 +2586,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2705,11 +2598,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2718,11 +2610,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -2731,11 +2622,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2744,11 +2634,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2757,11 +2646,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2770,11 +2658,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2783,11 +2670,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2796,11 +2682,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -2809,49 +2694,45 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) EIGENSCHAP opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - eigenschappen + - eigenschappen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -2864,60 +2745,54 @@ paths: description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle INFORMATIEOBJECTTYPEn opvragen. parameters: - - name: catalogus - required: false - in: query - description: - URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE - behoort. - schema: - type: string - format: uri - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: omschrijving - required: false - in: query - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer + - name: catalogus + required: false + in: query + description: URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE + behoort. + schema: + type: string + format: uri + - name: status + required: false + in: query + description: | + filter objects depending on their concept status: + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: omschrijving + required: false + in: query + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer tags: - - informatieobjecttypen + - informatieobjecttypen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -2929,11 +2804,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -2942,11 +2816,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2955,11 +2828,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2968,11 +2840,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2981,11 +2852,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2994,11 +2864,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3007,11 +2876,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3020,11 +2888,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3033,11 +2900,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -3046,16 +2912,16 @@ paths: description: Maak een INFORMATIEOBJECTTYPE aan. summary: Maak een INFORMATIEOBJECTTYPE aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - informatieobjecttypen + - informatieobjecttypen requestBody: content: application/json: @@ -3063,8 +2929,8 @@ paths: $ref: '#/components/schemas/InformatieObjectType' required: true security: - - JWT-Claims: - - catalogi.schrijven + - JWT-Claims: + - catalogi.schrijven responses: '201': headers: @@ -3076,8 +2942,7 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -3089,11 +2954,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -3102,11 +2966,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3115,11 +2978,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3128,11 +2990,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3141,11 +3002,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3154,11 +3014,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3167,11 +3026,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3180,11 +3038,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3193,11 +3050,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -3207,52 +3063,48 @@ paths: description: Een specifieke INFORMATIEOBJECTTYPE opvragen. summary: Een specifieke INFORMATIEOBJECTTYPE opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - informatieobjecttypen + - informatieobjecttypen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -3264,11 +3116,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3277,11 +3128,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3290,11 +3140,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -3303,11 +3152,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3316,11 +3164,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3329,11 +3176,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3342,11 +3188,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3355,11 +3200,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3368,39 +3212,37 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: informatieobjecttype_update - description: - Werk een INFORMATIEOBJECTTYPE in zijn geheel bij. Dit kan alleen + description: Werk een INFORMATIEOBJECTTYPE in zijn geheel bij. Dit kan alleen als het een concept betreft. summary: Werk een INFORMATIEOBJECTTYPE in zijn geheel bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - informatieobjecttypen + - informatieobjecttypen requestBody: content: application/json: @@ -3408,16 +3250,15 @@ paths: $ref: '#/components/schemas/InformatieObjectType' required: true security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -3429,11 +3270,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -3442,11 +3282,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3455,11 +3294,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3468,11 +3306,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -3481,11 +3318,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3494,11 +3330,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3507,11 +3342,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3520,11 +3354,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3533,11 +3366,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3546,55 +3378,52 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: informatieobjecttype_partial_update - description: - Werk een INFORMATIEOBJECTTYPE deels bij. Dit kan alleen als het + description: Werk een INFORMATIEOBJECTTYPE deels bij. Dit kan alleen als het een concept betreft. summary: ' Werk een INFORMATIEOBJECTTYPE deels bij.' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - informatieobjecttypen + - informatieobjecttypen requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedInformatieObjectType' security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -3606,11 +3435,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -3619,11 +3447,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3632,11 +3459,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3645,11 +3471,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -3658,11 +3483,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3671,11 +3495,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3684,11 +3507,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3697,11 +3519,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3710,11 +3531,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3723,34 +3543,32 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: informatieobjecttype_destroy - description: - Verwijder een INFORMATIEOBJECTTYPE. Dit kan alleen als het een + description: Verwijder een INFORMATIEOBJECTTYPE. Dit kan alleen als het een concept betreft. summary: Verwijder een INFORMATIEOBJECTTYPE. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true tags: - - informatieobjecttypen + - informatieobjecttypen security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '204': description: No content @@ -3759,11 +3577,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3772,11 +3589,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3785,11 +3601,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -3798,11 +3613,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3811,11 +3625,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3824,11 +3637,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3837,11 +3649,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3850,11 +3661,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3863,11 +3673,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -3876,49 +3685,45 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) INFORMATIEOBJECTTYPE opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - informatieobjecttypen + - informatieobjecttypen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -3928,42 +3733,40 @@ paths: /informatieobjecttypen/{uuid}/publish: post: operationId: informatieobjecttype_publish - description: - Publiceren van het informatieobjecttype zorgt ervoor dat dit in + description: Publiceren van het informatieobjecttype zorgt ervoor dat dit in een Documenten API kan gebruikt worden. Na het publiceren van een informatieobjecttype zijn geen inhoudelijke wijzigingen meer mogelijk. Indien er na het publiceren nog wat gewijzigd moet worden, dan moet je een nieuwe versie aanmaken. summary: Publiceer het concept INFORMATIEOBJECTTYPE. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - informatieobjecttypen + - informatieobjecttypen security: - - JWT-Claims: - - catalogi.schrijven + - JWT-Claims: + - catalogi.schrijven responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -3972,61 +3775,61 @@ paths: description: OK '400': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '404': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found '401': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -4036,49 +3839,48 @@ paths: description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle RESULTAATTYPEn opvragen. parameters: - - name: zaaktype - required: false - in: query - description: zaaktype - schema: - type: string - - name: zaaktype_identificatie - required: false - in: query - description: zaaktype_identificatie - schema: - type: string - - name: status - required: false - in: query - description: status - schema: - type: string - - name: datum_geldigheid - required: false - in: query - description: datum_geldigheid - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer + - name: zaaktype + required: false + in: query + description: zaaktype + schema: + type: string + - name: zaaktype_identificatie + required: false + in: query + description: zaaktype_identificatie + schema: + type: string + - name: status + required: false + in: query + description: status + schema: + type: string + - name: datum_geldigheid + required: false + in: query + description: datum_geldigheid + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer tags: - - resultaattypen + - resultaattypen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -4090,11 +3892,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -4103,11 +3904,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4116,11 +3916,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4129,11 +3928,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4142,11 +3940,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4155,11 +3952,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4168,11 +3964,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4181,11 +3976,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4194,40 +3988,38 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: resultaattype_create - description: - Maak een RESULTAATTYPE aan. Dit kan alleen als het bijbehorende + description: Maak een RESULTAATTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Maak een RESULTAATTYPE aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - resultaattypen + - resultaattypen requestBody: content: application/json: schema: - $ref: '#/components/schemas/ResultaatType' + $ref: '#/components/schemas/ResultaatTypeCreate' required: true security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '201': headers: @@ -4239,8 +4031,7 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -4252,11 +4043,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -4265,11 +4055,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4278,11 +4067,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4291,11 +4079,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4304,11 +4091,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4317,11 +4103,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4330,11 +4115,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4343,11 +4127,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4356,11 +4139,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -4370,52 +4152,48 @@ paths: description: Een specifieke RESULTAATTYPE opvragen. summary: Een specifieke RESULTAATTYPE opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - resultaattypen + - resultaattypen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -4427,11 +4205,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4440,11 +4217,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4453,11 +4229,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -4466,11 +4241,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4479,11 +4253,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4492,11 +4265,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4505,11 +4277,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4518,11 +4289,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4531,72 +4301,68 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: resultaattype_update - description: - Werk een RESULTAATTYPE in zijn geheel bij. Dit kan alleen als het + description: Werk een RESULTAATTYPE in zijn geheel bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Werk een RESULTAATTYPE in zijn geheel bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - resultaattypen + - resultaattypen requestBody: content: application/json: schema: - $ref: '#/components/schemas/ResultaatType' + $ref: '#/components/schemas/ResultaatTypeCreate' required: true security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: - $ref: '#/components/schemas/ResultaatType' + $ref: '#/components/schemas/ResultaatTypeUpdate' description: OK '400': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -4605,11 +4371,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4618,11 +4383,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4631,11 +4395,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -4644,11 +4407,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4657,11 +4419,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4670,11 +4431,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4683,11 +4443,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4696,11 +4455,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4709,55 +4467,52 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: resultaattype_partial_update - description: - Werk een RESULTAATTYPE deels bij. Dit kan alleen als het bijbehorende + description: Werk een RESULTAATTYPE deels bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Werk een RESULTAATTYPE deels bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - resultaattypen + - resultaattypen requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedResultaatType' security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -4769,11 +4524,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -4782,11 +4536,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4795,11 +4548,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4808,11 +4560,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -4821,11 +4572,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4834,11 +4584,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4847,11 +4596,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4860,11 +4608,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4873,11 +4620,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4886,34 +4632,32 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: resultaattype_destroy - description: - Verwijder een RESULTAATTYPE. Dit kan alleen als het bijbehorende + description: Verwijder een RESULTAATTYPE. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Verwijder een RESULTAATTYPE. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true tags: - - resultaattypen + - resultaattypen security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '204': description: No content @@ -4922,11 +4666,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4935,11 +4678,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4948,11 +4690,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -4961,11 +4702,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4974,11 +4714,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4987,11 +4726,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -5000,11 +4738,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -5013,11 +4750,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -5026,11 +4762,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -5039,49 +4774,45 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) RESULTAATTYPE opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - resultaattypen + - resultaattypen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -5094,75 +4825,69 @@ paths: description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle ROLTYPEn opvragen. parameters: - - name: zaaktype - required: false - in: query - description: - URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken - kunnen zijn. - schema: - type: string - format: uri - - name: zaaktypeIdentificatie - required: false - in: query - description: zaaktype_identificatie - schema: - type: string - - name: omschrijvingGeneriek - required: false - in: query - description: Algemeen gehanteerde omschrijving van de aard van de ROL. - schema: - type: string - enum: - - adviseur - - behandelaar - - belanghebbende - - beslisser - - initiator - - klantcontacter - - zaakcoordinator - - mede_initiator - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer + - name: zaaktype + required: false + in: query + description: URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken + kunnen zijn. + schema: + type: string + format: uri + - name: zaaktypeIdentificatie + required: false + in: query + description: zaaktype_identificatie + schema: + type: string + - name: omschrijvingGeneriek + required: false + in: query + description: Algemeen gehanteerde omschrijving van de aard van de ROL. + schema: + type: string + enum: + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator + - name: status + required: false + in: query + description: | + filter objects depending on their concept status: + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer tags: - - roltypen + - roltypen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -5174,11 +4899,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -5187,11 +4911,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -5200,11 +4923,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -5213,11 +4935,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -5226,11 +4947,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -5239,11 +4959,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -5252,11 +4971,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -5265,11 +4983,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -5278,31 +4995,29 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: roltype_create - description: - Maak een ROLTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE + description: Maak een ROLTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Maak een ROLTYPE aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - roltypen + - roltypen requestBody: content: application/json: @@ -5310,8 +5025,8 @@ paths: $ref: '#/components/schemas/RolType' required: true security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '201': headers: @@ -5323,8 +5038,7 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -5336,11 +5050,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -5349,11 +5062,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -5362,11 +5074,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -5375,11 +5086,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -5388,11 +5098,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -5401,11 +5110,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -5414,11 +5122,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -5427,11 +5134,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -5440,11 +5146,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -5454,51 +5159,47 @@ paths: description: Een specifieke ROLTYPE opvragen. summary: Een specifieke ROLTYPE opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - roltypen + - roltypen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -5510,11 +5211,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -5523,11 +5223,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -5536,11 +5235,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -5549,11 +5247,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -5562,11 +5259,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -5575,11 +5271,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -5588,11 +5283,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -5601,11 +5295,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -5614,38 +5307,36 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: roltype_update - description: - Werk een ROLTYPE in zijn geheel bij. Dit kan alleen als het een + description: Werk een ROLTYPE in zijn geheel bij. Dit kan alleen als het een concept betreft. summary: Werk een ROLTYPE in zijn geheel bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - roltypen + - roltypen requestBody: content: application/json: @@ -5653,16 +5344,15 @@ paths: $ref: '#/components/schemas/RolType' required: true security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -5674,11 +5364,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -5687,11 +5376,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -5700,11 +5388,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -5713,11 +5400,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -5726,11 +5412,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -5739,11 +5424,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -5752,11 +5436,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -5765,11 +5448,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -5778,11 +5460,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -5791,54 +5472,51 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: roltype_partial_update - description: - Werk een ROLTYPE deels bij. Dit kan alleen als het een concept + description: Werk een ROLTYPE deels bij. Dit kan alleen als het een concept betreft. summary: Werk een ROLTYPE deels bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - roltypen + - roltypen requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRolType' security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -5850,11 +5528,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -5863,11 +5540,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -5876,11 +5552,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -5889,11 +5564,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -5902,11 +5576,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -5915,11 +5588,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -5928,11 +5600,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -5941,11 +5612,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -5954,11 +5624,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -5967,11 +5636,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -5980,18 +5648,18 @@ paths: description: Verwijder een ROLTYPE. Dit kan alleen als het een concept betreft. summary: Verwijder een ROLTYPE. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - title: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + title: uuid + required: true tags: - - roltypen + - roltypen security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '204': description: No content @@ -6000,11 +5668,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -6013,11 +5680,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -6026,11 +5692,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -6039,11 +5704,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -6052,11 +5716,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -6065,11 +5728,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -6078,11 +5740,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -6091,11 +5752,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -6104,11 +5764,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -6117,48 +5776,44 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) ROLTYPE opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - roltypen + - roltypen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -6171,60 +5826,54 @@ paths: description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle STATUSTYPEn opvragen. parameters: - - name: zaaktype - required: false - in: query - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen - van dit STATUSTYPE bereikt kunnen worden. - schema: - type: string - format: uri - - name: zaaktypeIdentificatie - required: false - in: query - description: zaaktype_identificatie - schema: - type: string - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer + - name: zaaktype + required: false + in: query + description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen + van dit STATUSTYPE bereikt kunnen worden. + schema: + type: string + format: uri + - name: zaaktypeIdentificatie + required: false + in: query + description: zaaktype_identificatie + schema: + type: string + - name: status + required: false + in: query + description: | + filter objects depending on their concept status: + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer tags: - - statustypen + - statustypen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -6236,11 +5885,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -6249,11 +5897,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -6262,11 +5909,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -6275,11 +5921,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -6288,11 +5933,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -6301,11 +5945,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -6314,11 +5957,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -6327,11 +5969,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -6340,31 +5981,29 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: statustype_create - description: - Maak een STATUSTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE + description: Maak een STATUSTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Maak een STATUSTYPE aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - statustypen + - statustypen requestBody: content: application/json: @@ -6372,8 +6011,8 @@ paths: $ref: '#/components/schemas/StatusType' required: true security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '201': headers: @@ -6385,8 +6024,7 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -6398,11 +6036,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -6411,11 +6048,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -6424,11 +6060,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -6437,11 +6072,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -6450,11 +6084,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -6463,11 +6096,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -6476,11 +6108,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -6489,11 +6120,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -6502,11 +6132,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -6516,52 +6145,48 @@ paths: description: Een specifieke STATUSTYPE opvragen. summary: Een specifieke STATUSTYPE opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - statustypen + - statustypen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -6573,11 +6198,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -6586,11 +6210,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -6599,11 +6222,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -6612,11 +6234,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -6625,11 +6246,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -6638,11 +6258,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -6651,11 +6270,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -6664,11 +6282,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -6677,39 +6294,37 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: statustype_update - description: - Werk een STATUSTYPE in zijn geheel bij. Dit kan alleen als het + description: Werk een STATUSTYPE in zijn geheel bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Werk een STATUSTYPE in zijn geheel bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - statustypen + - statustypen requestBody: content: application/json: @@ -6717,16 +6332,15 @@ paths: $ref: '#/components/schemas/StatusType' required: true security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -6738,11 +6352,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -6751,11 +6364,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -6764,11 +6376,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -6777,11 +6388,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -6790,11 +6400,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -6803,11 +6412,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -6816,11 +6424,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -6829,11 +6436,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -6842,11 +6448,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -6855,55 +6460,52 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: statustype_partial_update - description: - Werk een STATUSTYPE deels bij. Dit kan alleen als het bijbehorende + description: Werk een STATUSTYPE deels bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Werk een STATUSTYPE deels bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - statustypen + - statustypen requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedStatusType' security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -6915,11 +6517,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -6928,11 +6529,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -6941,11 +6541,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -6954,11 +6553,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -6967,11 +6565,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -6980,11 +6577,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -6993,11 +6589,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -7006,11 +6601,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -7019,11 +6613,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -7032,34 +6625,32 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: statustype_destroy - description: - Verwijder een STATUSTYPE. Dit kan alleen als het bijbehorende ZAAKTYPE + description: Verwijder een STATUSTYPE. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Verwijder een STATUSTYPE. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true tags: - - statustypen + - statustypen security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '204': description: No content @@ -7068,11 +6659,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -7081,11 +6671,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -7094,11 +6683,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -7107,11 +6695,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -7120,11 +6707,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -7133,11 +6719,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -7146,11 +6731,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -7159,11 +6743,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -7172,11 +6755,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -7185,49 +6767,45 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) STATUSTYPE opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - statustypen + - statustypen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -7240,88 +6818,84 @@ paths: description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle ZAAKOBJECTTYPEn opvragen. parameters: - - name: anderObjecttype - required: false - in: query - description: - Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een - ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. - schema: - type: string - - name: catalogus - required: false - in: query - description: URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE behoort. - schema: - type: string - format: uri - - name: datumBeginGeldigheid - required: false - in: query - description: De datum waarop het is ontstaan. - schema: - type: string - - name: datumEindeGeldigheid - required: false - in: query - description: De datum waarop het is opgeheven. - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: - type: string - - name: objecttype - required: false - in: query - description: - URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE - behoort. - schema: - type: string - format: uri - - name: relatieOmschrijving - required: false - in: query - description: - Omschrijving van de betrekking van het Objecttype op zaken van - het gerelateerde ZAAKTYPE. - schema: - type: string - - name: zaaktype - required: false - in: query - description: URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE behoort. - schema: - type: string - format: uri - - name: zaaktypeIdentificatie - required: false - in: query - description: zaaktype_identificatie - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer + - name: anderObjecttype + required: false + in: query + description: Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een + ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. + schema: + type: string + - name: catalogus + required: false + in: query + description: URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE behoort. + schema: + type: string + format: uri + - name: datumBeginGeldigheid + required: false + in: query + description: De datum waarop het is ontstaan. + schema: + type: string + - name: datumEindeGeldigheid + required: false + in: query + description: De datum waarop het is opgeheven. + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: objecttype + required: false + in: query + description: URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE + behoort. + schema: + type: string + format: uri + - name: relatieOmschrijving + required: false + in: query + description: Omschrijving van de betrekking van het Objecttype op zaken van + het gerelateerde ZAAKTYPE. + schema: + type: string + - name: zaaktype + required: false + in: query + description: URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE behoort. + schema: + type: string + format: uri + - name: zaaktypeIdentificatie + required: false + in: query + description: zaaktype_identificatie + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer tags: - - zaakobjecttypen + - zaakobjecttypen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -7333,11 +6907,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -7346,11 +6919,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -7359,11 +6931,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -7372,11 +6943,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -7385,11 +6955,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -7398,11 +6967,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -7411,11 +6979,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -7424,11 +6991,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -7437,11 +7003,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -7450,16 +7015,16 @@ paths: description: Maak een ZAAKOBJECTTYPE aan. summary: Maak een ZAAKOBJECTTYPE aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - zaakobjecttypen + - zaakobjecttypen requestBody: content: application/json: @@ -7467,8 +7032,8 @@ paths: $ref: '#/components/schemas/ZaakObjectType' required: true security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '201': headers: @@ -7480,8 +7045,7 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -7493,11 +7057,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -7506,11 +7069,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -7519,11 +7081,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -7532,11 +7093,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -7545,11 +7105,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -7558,11 +7117,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -7571,11 +7129,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -7584,11 +7141,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -7597,11 +7153,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -7611,52 +7166,48 @@ paths: description: Een specifieke ZAAKOBJECTTYPE opvragen. summary: Een specifieke ZAAKOBJECTTYPE opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - zaakobjecttypen + - zaakobjecttypen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -7668,11 +7219,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -7681,11 +7231,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -7694,11 +7243,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -7707,11 +7255,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -7720,11 +7267,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -7733,11 +7279,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -7746,11 +7291,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -7759,11 +7303,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -7772,11 +7315,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -7785,24 +7327,24 @@ paths: description: Werk een ZAAKOBJECTTYPE in zijn geheel bij. summary: Werk een ZAAKOBJECTTYPE in zijn geheel bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - zaakobjecttypen + - zaakobjecttypen requestBody: content: application/json: @@ -7810,16 +7352,15 @@ paths: $ref: '#/components/schemas/ZaakObjectType' required: true security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -7831,11 +7372,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -7844,11 +7384,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -7857,11 +7396,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -7870,11 +7408,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -7883,11 +7420,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -7896,11 +7432,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -7909,11 +7444,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -7922,11 +7456,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -7935,11 +7468,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -7948,11 +7480,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -7961,40 +7492,39 @@ paths: description: Werk een ZAAKOBJECTTYPE deels bij. summary: Werk een ZAAKOBJECTTYPE deels bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - zaakobjecttypen + - zaakobjecttypen requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedZaakObjectType' security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -8006,11 +7536,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -8019,11 +7548,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -8032,11 +7560,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -8045,11 +7572,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -8058,11 +7584,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -8071,11 +7596,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -8084,11 +7608,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -8097,11 +7620,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -8110,11 +7632,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -8123,11 +7644,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -8136,19 +7656,19 @@ paths: description: Verwijder een ZAAKOBJECTTYPE. summary: Verwijder een ZAAKOBJECTTYPE. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true tags: - - zaakobjecttypen + - zaakobjecttypen security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '204': description: No content @@ -8157,11 +7677,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -8170,11 +7689,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -8183,11 +7701,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -8196,11 +7713,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -8209,11 +7725,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -8222,11 +7737,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -8235,11 +7749,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -8248,11 +7761,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -8261,11 +7773,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -8274,49 +7785,45 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) ZAAKOBJECTTYPE opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - zaakobjecttypen + - zaakobjecttypen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -8329,65 +7836,59 @@ paths: description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle ZAAKTYPE-INFORMATIEOBJECTTYPE relaties opvragen. parameters: - - name: zaaktype - required: false - in: query - description: URL-referentie naar het ZAAKTYPE. - schema: - type: string - format: uri - - name: informatieobjecttype - required: false - in: query - description: URL-referentie naar het INFORMATIEOBJECTTYPE. - schema: - type: string - format: uri - - name: richting - required: false - in: query - description: - Aanduiding van de richting van informatieobjecten van het gerelateerde - INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. - schema: - type: string - enum: - - inkomend - - intern - - uitgaand - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer + - name: zaaktype + required: false + in: query + description: URL-referentie naar het ZAAKTYPE. + schema: + type: string + format: uri + - name: informatieobjecttype + required: false + in: query + description: URL-referentie naar het INFORMATIEOBJECTTYPE. + schema: + type: string + format: uri + - name: richting + required: false + in: query + description: Aanduiding van de richting van informatieobjecten van het gerelateerde + INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. + schema: + type: string + enum: + - inkomend + - intern + - uitgaand + - name: status + required: false + in: query + description: | + filter objects depending on their concept status: + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer tags: - - zaaktype-informatieobjecttypen + - zaaktype-informatieobjecttypen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -8399,11 +7900,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -8412,11 +7912,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -8425,11 +7924,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -8438,11 +7936,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -8451,11 +7948,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -8464,11 +7960,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -8477,11 +7972,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -8490,11 +7984,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -8503,42 +7996,39 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: zaakinformatieobjecttype_create - description: - 'Maak een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie aan. Dit kan alleen - als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op: - - - `zaaktype` en `informatieobjecttype` behoren tot dezelfde `catalogus`' + description: |- + Maak een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie aan. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op: + - `zaaktype` en `informatieobjecttype` behoren tot dezelfde `catalogus` summary: Maak een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - zaaktype-informatieobjecttypen + - zaaktype-informatieobjecttypen requestBody: content: application/json: schema: - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + $ref: '#/components/schemas/ZaakTypeInformatieObjectTypeCreate' required: true security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '201': headers: @@ -8550,8 +8040,7 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -8563,11 +8052,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -8576,11 +8064,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -8589,11 +8076,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -8602,11 +8088,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -8615,11 +8100,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -8628,11 +8112,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -8641,11 +8124,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -8654,11 +8136,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -8667,11 +8148,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -8681,52 +8161,48 @@ paths: description: Een specifieke ZAAKTYPE-INFORMATIEOBJECTTYPE relatie opvragen. summary: Een specifieke ZAAKTYPE-INFORMATIEOBJECTTYPE relatie opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - zaaktype-informatieobjecttypen + - zaaktype-informatieobjecttypen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -8738,11 +8214,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -8751,11 +8226,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -8764,11 +8238,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -8777,11 +8250,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -8790,11 +8262,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -8803,11 +8274,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -8816,11 +8286,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -8829,11 +8298,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -8842,58 +8310,54 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: zaakinformatieobjecttype_update - description: - "Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel\ - \ bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er\ - \ wordt gevalideerd op:\n - `zaaktype` en `informatieobjecttype` behoren tot\ - \ dezelfde `catalogus`" + description: |- + Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op: + - `zaaktype` en `informatieobjecttype` behoren tot dezelfde `catalogus` summary: Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - zaaktype-informatieobjecttypen + - zaaktype-informatieobjecttypen requestBody: content: application/json: schema: - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + $ref: '#/components/schemas/ZaakTypeInformatieObjectTypeUpdate' required: true security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -8905,11 +8369,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -8918,11 +8381,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -8931,11 +8393,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -8944,11 +8405,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -8957,11 +8417,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -8970,11 +8429,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -8983,11 +8441,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -8996,11 +8453,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -9009,11 +8465,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -9022,57 +8477,53 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: zaakinformatieobjecttype_partial_update - description: - "Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij. Dit\ - \ kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt\ - \ gevalideerd op:\n - `zaaktype` en `informatieobjecttype` behoren tot dezelfde\ - \ `catalogus`" + description: |- + Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op: + - `zaaktype` en `informatieobjecttype` behoren tot dezelfde `catalogus` summary: Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - zaaktype-informatieobjecttypen + - zaaktype-informatieobjecttypen requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedZaakTypeInformatieObjectType' security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -9084,11 +8535,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -9097,11 +8547,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -9110,11 +8559,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -9123,11 +8571,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -9136,11 +8583,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -9149,11 +8595,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -9162,11 +8607,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -9175,11 +8619,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -9188,11 +8631,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -9201,35 +8643,33 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: zaakinformatieobjecttype_destroy - description: - "Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie. Dit kan alleen\ - \ als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd\ - \ op:\n - `zaaktype` of `informatieobjecttype` is nog niet gepubliceerd" + description: |- + Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op: + - `zaaktype` of `informatieobjecttype` is nog niet gepubliceerd summary: Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true tags: - - zaaktype-informatieobjecttypen + - zaaktype-informatieobjecttypen security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '204': description: No content @@ -9238,11 +8678,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -9251,11 +8690,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -9264,11 +8702,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -9277,11 +8714,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -9290,11 +8726,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -9303,11 +8738,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -9316,11 +8750,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -9329,11 +8762,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -9342,11 +8774,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -9355,49 +8786,45 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) ZAAK-INFORMATIEOBJECT-TYPE opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - zaaktype-informatieobjecttypen + - zaaktype-informatieobjecttypen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -9410,70 +8837,64 @@ paths: description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle ZAAKTYPEn opvragen. parameters: - - name: catalogus - required: false - in: query - description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. - schema: - type: string - format: uri - - name: identificatie - required: false - in: query - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - schema: - type: string - - name: trefwoorden - required: false - in: query - description: Multiple values may be separated by commas. - schema: - type: array - items: - type: string - style: form - explode: false - - name: status - required: false - in: query - description: 'filter objects depending on their concept status: - - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - - ' - schema: - type: string - - name: datumGeldigheid - required: false - in: query - description: filter objecten op hun geldigheids datum. - schema: + - name: catalogus + required: false + in: query + description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. + schema: + type: string + format: uri + - name: identificatie + required: false + in: query + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + schema: + type: string + - name: trefwoorden + required: false + in: query + description: Multiple values may be separated by commas. + schema: + type: array + items: type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer + style: form + explode: false + - name: status + required: false + in: query + description: | + filter objects depending on their concept status: + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer tags: - - zaaktypen + - zaaktypen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -9485,11 +8906,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -9498,11 +8918,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -9511,11 +8930,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -9524,11 +8942,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -9537,11 +8954,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -9550,11 +8966,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -9563,11 +8978,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -9576,11 +8990,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -9589,43 +9002,41 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: zaaktype_create - description: - "Er wordt gevalideerd op:\n- geldigheid `catalogus` URL, dit moet\ - \ een catalogus binnen dezelfde API zijn\n - Uniciteit `catalogus` en `omschrijving`.\ - \ Dezelfde omeschrijving mag enkel opnieuw gebruikt worden als het zaaktype\ - \ een andere geldigheidsperiode kent dan bestaande zaaktypen.\n - `deelzaaktypen`\ - \ moeten tot dezelfde catalogus behoren als het ZAAKTYPE." + description: |- + Er wordt gevalideerd op: + - geldigheid `catalogus` URL, dit moet een catalogus binnen dezelfde API zijn + - Uniciteit `catalogus` en `omschrijving`. Dezelfde omeschrijving mag enkel opnieuw gebruikt worden als het zaaktype een andere geldigheidsperiode kent dan bestaande zaaktypen. + - `deelzaaktypen` moeten tot dezelfde catalogus behoren als het ZAAKTYPE. summary: Maak een ZAAKTYPE aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - zaaktypen + - zaaktypen requestBody: content: application/json: schema: - $ref: '#/components/schemas/ZaakType' + $ref: '#/components/schemas/ZaakTypeCreate' required: true security: - - JWT-Claims: - - catalogi.schrijven + - JWT-Claims: + - catalogi.schrijven responses: '201': headers: @@ -9637,8 +9048,7 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -9650,11 +9060,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -9663,11 +9072,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -9676,11 +9084,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -9689,11 +9096,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -9702,11 +9108,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -9715,11 +9120,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -9728,11 +9132,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -9741,11 +9144,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -9754,11 +9156,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -9768,52 +9169,48 @@ paths: description: Een specifieke ZAAKTYPE opvragen. summary: Een specifieke ZAAKTYPE opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - zaaktypen + - zaaktypen security: - - JWT-Claims: - - catalogi.lezen + - JWT-Claims: + - catalogi.lezen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -9825,11 +9222,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -9838,11 +9234,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -9851,11 +9246,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -9864,11 +9258,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -9877,11 +9270,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -9890,11 +9282,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -9903,11 +9294,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -9916,11 +9306,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -9929,57 +9318,54 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: zaaktype_update - description: - "Werk een ZAAKTYPE in zijn geheel bij. Dit kan alleen als het een\ - \ concept betreft. Er wordt gevalideerd op:\n - `deelzaaktypen` moeten tot\ - \ dezelfde catalogus behoren als het ZAAKTYPE." + description: |- + Werk een ZAAKTYPE in zijn geheel bij. Dit kan alleen als het een concept betreft. Er wordt gevalideerd op: + - `deelzaaktypen` moeten tot dezelfde catalogus behoren als het ZAAKTYPE. summary: Werk een ZAAKTYPE in zijn geheel bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - zaaktypen + - zaaktypen requestBody: content: application/json: schema: - $ref: '#/components/schemas/ZaakType' + $ref: '#/components/schemas/ZaakTypeUpdate' required: true security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -9991,11 +9377,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -10004,11 +9389,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -10017,11 +9401,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -10030,11 +9413,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -10043,11 +9425,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -10056,11 +9437,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -10069,11 +9449,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -10082,11 +9461,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -10095,11 +9473,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -10108,56 +9485,53 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: zaaktype_partial_update - description: - "Werk een ZAAKTYPE deels bij. Dit kan alleen als het een concept\ - \ betreft. Er wordt gevalideerd op:\n - `deelzaaktypen` moeten tot dezelfde\ - \ catalogus behoren als het ZAAKTYPE." + description: |- + Werk een ZAAKTYPE deels bij. Dit kan alleen als het een concept betreft. Er wordt gevalideerd op: + - `deelzaaktypen` moeten tot dezelfde catalogus behoren als het ZAAKTYPE. summary: Werk een ZAAKTYPE deels bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - zaaktypen + - zaaktypen requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedZaakType' security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -10169,11 +9543,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -10182,11 +9555,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -10195,11 +9567,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -10208,11 +9579,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -10221,11 +9591,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -10234,11 +9603,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -10247,11 +9615,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -10260,11 +9627,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -10273,11 +9639,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -10286,11 +9651,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -10299,19 +9663,19 @@ paths: description: Verwijder een ZAAKTYPE. Dit kan alleen als het een concept betreft. summary: Verwijder een ZAAKTYPE. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true tags: - - zaaktypen + - zaaktypen security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-verwijderen) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '204': description: No content @@ -10320,11 +9684,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -10333,11 +9696,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -10346,11 +9708,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -10359,11 +9720,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -10372,11 +9732,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -10385,11 +9744,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -10398,11 +9756,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -10411,11 +9768,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -10424,11 +9780,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -10437,49 +9792,45 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) ZAAKTYPE opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - zaaktypen + - zaaktypen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -10489,32 +9840,31 @@ paths: /zaaktypen/{uuid}/publish: post: operationId: zaaktype_publish - description: - Publiceren van het zaaktype zorgt ervoor dat dit in een Zaken API + description: Publiceren van het zaaktype zorgt ervoor dat dit in een Zaken API kan gebruiktworden. Na het publiceren van een zaaktype zijn geen inhoudelijke wijzigingenmeer mogelijk - ook niet de statustypen, eigenschappen... etc. Indien er na hetpubliceren nog wat gewijzigd moet worden, dan moet je een nieuwe versieaanmaken. summary: Publiceer het concept ZAAKTYPE. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - zaaktypen + - zaaktypen requestBody: content: application/json: @@ -10522,16 +9872,15 @@ paths: $ref: '#/components/schemas/ZaakType' required: true security: - - JWT-Claims: - - catalogi.schrijven + - JWT-Claims: + - catalogi.schrijven responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -10545,11 +9894,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -10558,11 +9906,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -10571,11 +9918,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -10584,11 +9930,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -10597,11 +9942,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -10610,11 +9954,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -10623,11 +9966,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -10636,11 +9978,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -10649,11 +9990,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -10662,37 +10002,36 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error schemas: AardRelatieEnum: enum: - - vervolg - - bijdrage - - onderwerp + - vervolg + - bijdrage + - onderwerp type: string AfleidingswijzeEnum: enum: - - afgehandeld - - ander_datumkenmerk - - eigenschap - - gerelateerde_zaak - - hoofdzaak - - ingangsdatum_besluit - - termijn - - vervaldatum_besluit - - zaakobject + - afgehandeld + - ander_datumkenmerk + - eigenschap + - gerelateerde_zaak + - hoofdzaak + - ingangsdatum_besluit + - termijn + - vervaldatum_besluit + - zaakobject type: string ArchiefnominatieEnum: enum: - - blijvend_bewaren - - vernietigen + - blijvend_bewaren + - vernietigen type: string BesluitType: type: object @@ -10702,8 +10041,7 @@ components: format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 @@ -10718,6 +10056,7 @@ components: type: string format: uri title: '' + readOnly: true description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE title: zaaktypen uniqueItems: true @@ -10728,8 +10067,7 @@ components: maxLength: 80 omschrijvingGeneriek: type: string - description: - Algemeen gehanteerde omschrijving van de aard van BESLUITen + description: Algemeen gehanteerde omschrijving van de aard van BESLUITen van het BESLUITTYPE title: omschrijving generiek maxLength: 80 @@ -10741,29 +10079,25 @@ components: reactietermijn: type: string nullable: true - description: - Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype mogelijk is. title: reactietermijn format: duration publicatieIndicatie: type: boolean - description: - Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten + description: Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten worden. title: publicatie indicatie publicatietekst: type: string - description: - De generieke tekst van de publicatie van BESLUITen van dit + description: De generieke tekst van de publicatie van BESLUITen van dit BESLUITTYPE title: publicatietekst publicatietermijn: type: string nullable: true - description: - Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten blijven. title: publicatietermijn @@ -10778,8 +10112,7 @@ components: type: string format: uri title: '' - description: - URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten + description: URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten van dit BESLUITTYPE worden vastgelegd. title: informatieobjecttypen uniqueItems: true @@ -10809,8 +10142,7 @@ components: concept: type: boolean readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn + description: Geeft aan of het object een concept betreft. Concepten zijn niet-definitieve versies en zouden niet gebruikt moeten worden buiten deze API. title: concept @@ -10822,8 +10154,7 @@ components: title: Is resultaat van readOnly: true title: Is resultaat van - description: - Het BESLUITTYPE van besluiten die gepaard gaan met resultaten + description: Het BESLUITTYPE van besluiten die gepaard gaan met resultaten van het RESULTAATTYPE. uniqueItems: true resultaattypenOmschrijving: @@ -10845,363 +10176,168 @@ components: title: informatieobjecttypen uniqueItems: true required: - - beginGeldigheid - - catalogus - - concept - - informatieobjecttypen - - publicatieIndicatie - - resultaattypen - - resultaattypenOmschrijving - - url - - vastgelegdIn - - zaaktypen - BlankEnum: - enum: - - '' - BronCatalogus: + - beginGeldigheid + - catalogus + - concept + - informatieobjecttypen + - publicatieIndicatie + - resultaattypen + - resultaattypenOmschrijving + - url + - vastgelegdIn + - zaaktypen + BesluitTypeCreate: type: object - description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. properties: url: type: string format: uri - title: URL-referentie broncatalogus - maxLength: 200 - domein: - type: string - description: Het domein van de CATALOGUS waaraan het ZAAKTYPE is ontleend. - title: broncatalogus domein - maxLength: 5 - rsin: - type: string - description: - Het RSIN van de INGESCHREVEN NIET-NATUURLIJK PERSOON die beheerder - is van de CATALOGUS waaraan het ZAAKTYPE is ontleend. - title: broncatalogus rsin - maxLength: 9 - required: - - domein - - rsin - - url - BronZaaktype: - type: object - description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. - properties: - url: + readOnly: true + title: url + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + catalogus: type: string format: uri - title: URL-referentie bronzaaktype - maxLength: 200 - identificatie: - type: string - description: De Zaaktype-identificatie van het bronzaaktype binnen de CATALOGUS. - title: bronzaaktype identificatie - maxLength: 50 + description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. + title: catalogus + zaaktypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE + title: zaaktypen + uniqueItems: true omschrijving: type: string - description: - De Zaaktype-omschrijving van het bronzaaktype, zoals gehanteerd - in de Broncatalogus. - title: bronzaaktype omschrijving + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: omschrijving maxLength: 80 - required: - - identificatie - - omschrijving - - url - BrondatumArchiefprocedure: - type: object - description: - Specificatie voor het bepalen van de brondatum voor de start van - de Archiefactietermijn (=brondatum) van het zaakdossier. - properties: - afleidingswijze: - allOf: - - $ref: '#/components/schemas/AfleidingswijzeEnum' - title: Afleidingswijze brondatum - description: - "Wijze van bepalen van de brondatum.\n\nUitleg bij mogelijke\ - \ waarden:\n\n* `afgehandeld` - (Afgehandeld) De termijn start op de datum\ - \ waarop de zaak is afgehandeld (ZAAK.Einddatum in het RGBZ).\n* `ander_datumkenmerk`\ - \ - (Ander datumkenmerk) De termijn start op de datum die is vastgelegd\ - \ in een ander datumveld dan de datumvelden waarop de overige waarden\ - \ (van deze attribuutsoort) betrekking hebben. `Objecttype`, `Registratie`\ - \ en `Datumkenmerk` zijn niet leeg.\n* `eigenschap` - (Eigenschap) De\ - \ termijn start op de datum die vermeld is in een zaaktype-specifieke\ - \ eigenschap (zijnde een `datumveld`). `ResultaatType.ZaakType` heeft\ - \ een `Eigenschap`; `Objecttype`, en `Datumkenmerk` zijn niet leeg.\n\ - * `gerelateerde_zaak` - (Gerelateerde zaak) De termijn start op de datum\ - \ waarop de gerelateerde zaak is afgehandeld (`ZAAK.Einddatum` of `ZAAK.Gerelateerde_zaak.Einddatum`\ - \ in het RGBZ). `ResultaatType.ZaakType` heeft gerelateerd `ZaakType`\n\ - * `hoofdzaak` - (Hoofdzaak) De termijn start op de datum waarop de gerelateerde\ - \ zaak is afgehandeld, waarvan de zaak een deelzaak is (`ZAAK.Einddatum`\ - \ van de hoofdzaak in het RGBZ). ResultaatType.ZaakType is deelzaaktype\ - \ van ZaakType.\n* `ingangsdatum_besluit` - (Ingangsdatum besluit) De\ - \ termijn start op de datum waarop het besluit van kracht wordt (`BESLUIT.Ingangsdatum`\ - \ in het RGBZ).\tResultaatType.ZaakType heeft relevant BesluitType\n*\ - \ `termijn` - (Termijn) De termijn start een vast aantal jaren na de datum\ - \ waarop de zaak is afgehandeld (`ZAAK.Einddatum` in het RGBZ).\n* `vervaldatum_besluit`\ - \ - (Vervaldatum besluit) De termijn start op de dag na de datum waarop\ - \ het besluit vervalt (`BESLUIT.Vervaldatum` in het RGBZ). ResultaatType.ZaakType\ - \ heeft relevant BesluitType\n* `zaakobject` - (Zaakobject) De termijn\ - \ start op de einddatum geldigheid van het zaakobject waarop de zaak betrekking\ - \ heeft (bijvoorbeeld de overlijdendatum van een Persoon). M.b.v. de attribuutsoort\ - \ `Objecttype` wordt vastgelegd om welke zaakobjecttype het gaat; m.b.v.\ - \ de attribuutsoort `Datumkenmerk` wordt vastgelegd welke datum-attribuutsoort\ - \ van het zaakobjecttype het betreft." - datumkenmerk: + omschrijvingGeneriek: type: string - description: - Naam van de attribuutsoort van het procesobject dat bepalend - is voor het einde van de procestermijn. - title: datumkenmerk + description: Algemeen gehanteerde omschrijving van de aard van BESLUITen + van het BESLUITTYPE + title: omschrijving generiek maxLength: 80 - einddatumBekend: + besluitcategorie: + type: string + description: Typering van de aard van BESLUITen van het BESLUITTYPE. + title: besluitcategorie + maxLength: 40 + reactietermijn: + type: string + nullable: true + description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype + mogelijk is. + title: reactietermijn + format: duration + publicatieIndicatie: type: boolean - description: - Indicatie dat de einddatum van het procesobject gedurende de - uitvoering van de zaak bekend moet worden. Indien deze nog niet bekend - is en deze waarde staat op `true`, dan kan de zaak (nog) niet afgesloten + description: Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten worden. - title: einddatum bekend - objecttype: - description: - 'Het soort object in de registratie dat het procesobject representeert. - - - Uitleg bij mogelijke waarden: - - - * `adres` - Adres - - * `besluit` - Besluit - - * `buurt` - Buurt - - * `enkelvoudig_document` - Enkelvoudig document - - * `gemeente` - Gemeente - - * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte - - * `huishouden` - Huishouden - - * `inrichtingselement` - Inrichtingselement - - * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak - - * `kunstwerkdeel` - Kunstwerkdeel - - * `maatschappelijke_activiteit` - Maatschappelijke activiteit - - * `medewerker` - Medewerker - - * `natuurlijk_persoon` - Natuurlijk persoon - - * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon - - * `openbare_ruimte` - Openbare ruimte - - * `organisatorische_eenheid` - Organisatorische eenheid - - * `pand` - Pand - - * `spoorbaandeel` - Spoorbaandeel - - * `status` - Status - - * `terreindeel` - Terreindeel - - * `terrein_gebouwd_object` - Terrein gebouwd object - - * `vestiging` - Vestiging - - * `waterdeel` - Waterdeel - - * `wegdeel` - Wegdeel - - * `wijk` - Wijk - - * `woonplaats` - Woonplaats - - * `woz_deelobject` - Woz deel object - - * `woz_object` - Woz object - - * `woz_waarde` - Woz waarde - - * `zakelijk_recht` - Zakelijk recht - - * `overige` - Overige' - title: objecttype - oneOf: - - $ref: '#/components/schemas/ObjecttypeEnum' - - $ref: '#/components/schemas/BlankEnum' - registratie: + title: publicatie indicatie + publicatietekst: type: string - description: - De naam van de registratie waarvan het procesobject deel uit - maakt. - title: registratie - maxLength: 80 - procestermijn: + description: De generieke tekst van de publicatie van BESLUITen van dit + BESLUITTYPE + title: publicatietekst + publicatietermijn: type: string nullable: true - title: Brondatum procestermijn - description: - De periode dat het zaakdossier na afronding van de zaak actief - gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening - van de organisatie. Enkel relevant indien de afleidingswijze 'termijn' - is. + description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten + blijven. + title: publicatietermijn format: duration - required: - - afleidingswijze - nullable: true - Catalogus: - type: object - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - domein: + toelichting: type: string - description: - Een afkorting waarmee wordt aangegeven voor welk domein in - een CATALOGUS ZAAKTYPEn zijn uitgewerkt. - title: domein - maxLength: 5 - rsin: + description: Een eventuele toelichting op dit BESLUITTYPE. + title: toelichting + informatieobjecttypen: + type: array + items: + type: string + title: '' + description: '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten + waarin besluiten van dit BESLUITTYPE worden vastgelegd.' + title: informatieobjecttypen + beginGeldigheid: type: string - description: - Het door een kamer toegekend uniek nummer voor de INGESCHREVEN - NIET-NATUURLIJK PERSOON die de eigenaar is van een CATALOGUS. - title: rsin - maxLength: 9 - contactpersoonBeheerNaam: + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: type: string - title: Naam contactpersoon - description: - De naam van de contactpersoon die verantwoordelijk is voor - het beheer van de CATALOGUS. - maxLength: 40 - contactpersoonBeheerTelefoonnummer: + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: type: string - title: Telefoonnummer - description: - Het telefoonnummer van de contactpersoon die verantwoordelijk - is voor het beheer van de CATALOGUS. - maxLength: 20 - contactpersoonBeheerEmailadres: + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: type: string - format: email - title: Emailadres - description: - Het emailadres van de contactpersoon die verantwoordelijk is - voor het beheer van de CATALOGUS. - maxLength: 254 - zaaktypen: + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + concept: + type: boolean + readOnly: true + description: Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + resultaattypen: type: array items: type: string format: uri - title: '' + title: Is resultaat van readOnly: true - description: - URL-referenties naar ZAAKTYPEn die in deze CATALOGUS worden - ontsloten. - title: Catalogus + title: Is resultaat van + description: Het BESLUITTYPE van besluiten die gepaard gaan met resultaten + van het RESULTAATTYPE. uniqueItems: true - besluittypen: + resultaattypenOmschrijving: type: array items: type: string - format: uri title: '' readOnly: true - description: - URL-referenties naar BESLUITTYPEn die in deze CATALOGUS worden - ontsloten. - title: catalogus + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: is resultaat van uniqueItems: true - informatieobjecttypen: + vastgelegdIn: type: array items: type: string - format: uri title: '' readOnly: true - description: - URL-referenties naar INFORMATIEOBJECTTYPEn die in deze CATALOGUS - worden ontsloten. - title: Catalogus + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen uniqueItems: true - naam: - type: string - nullable: true - description: De benaming die is gegeven aan de zaaktypecatalogus. - title: naam - maxLength: 200 - versie: - type: string - nullable: true - description: Versie-aanduiding van de van toepassing zijnde zaaktypecatalogus. - title: versie - maxLength: 20 - begindatumVersie: - type: string - format: date - nullable: true - description: - Datum waarop de versie van de zaaktypecatalogus van toepassing - is geworden. - title: begindatum versie - required: - - besluittypen - - contactpersoonBeheerNaam - - domein - - informatieobjecttypen - - rsin - - url - - zaaktypen - CheckListItem: - type: object - properties: - itemnaam: - type: string - description: De betekenisvolle benaming van het checklistitem - title: itemnaam - maxLength: 30 - toelichting: - type: string - nullable: true - description: - Beschrijving van de overwegingen bij het controleren van het - aandachtspunt - title: toelichting - maxLength: 1000 - vraagstelling: - type: string - description: - Een betekenisvolle vraag waaruit blijkt waarop het aandachtspunt - gecontroleerd moet worden. - title: vraagstelling - maxLength: 255 - verplicht: - type: boolean - description: - Het al dan niet verplicht zijn van controle van het aandachtspunt - voorafgaand aan het bereiken van de status van het gerelateerde STATUSTYPE. - title: verplicht required: - - itemnaam - - vraagstelling - Eigenschap: + - beginGeldigheid + - catalogus + - concept + - informatieobjecttypen + - publicatieIndicatie + - resultaattypen + - resultaattypenOmschrijving + - url + - vastgelegdIn + - zaaktypen + BesluitTypeUpdate: type: object properties: url: @@ -11209,266 +10345,79 @@ components: format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 - naam: - type: string - description: De naam van de EIGENSCHAP - title: eigenschapnaam - maxLength: 20 catalogus: type: string format: uri - readOnly: true + description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. title: catalogus - definitie: + zaaktypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE + title: zaaktypen + uniqueItems: true + omschrijving: type: string - description: De beschrijving van de betekenis van deze EIGENSCHAP - title: definitie - maxLength: 255 - specificatie: - allOf: - - $ref: '#/components/schemas/EigenschapSpecificatie' - title: specificatie van eigenschap - toelichting: + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: type: string - description: - Een toelichting op deze EIGENSCHAP en het belang hiervan voor - zaken van dit ZAAKTYPE. - title: toelichting - maxLength: 1000 - zaaktype: + description: Algemeen gehanteerde omschrijving van de aard van BESLUITen + van het BESLUITTYPE + title: omschrijving generiek + maxLength: 80 + besluitcategorie: type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze - EIGENSCHAP van belang is. - title: Zaaktype - zaaktypeIdentificatie: + description: Typering van de aard van BESLUITen van het BESLUITTYPE. + title: besluitcategorie + maxLength: 40 + reactietermijn: type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype - statustype: - type: string - format: uri - nullable: true - title: Status type - description: - Status type moet (onder andere) deze EIGENSCHAP hebben, voordat - een STATUS van het STATUSTYPE kan worden gezet. - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de EIGENSCHAP is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date nullable: true - description: De datum waarop de EIGENSCHAP is opgeheven. - title: datum einde geldigheid - beginObject: + description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype + mogelijk is. + title: reactietermijn + format: duration + publicatieIndicatie: + type: boolean + description: Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten + worden. + title: publicatie indicatie + publicatietekst: type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: + description: De generieke tekst van de publicatie van BESLUITen van dit + BESLUITTYPE + title: publicatietekst + publicatietermijn: type: string - format: date nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - required: - - catalogus - - definitie - - naam - - specificatie - - url - - zaaktype - - zaaktypeIdentificatie - EigenschapSpecificatie: - type: object - properties: - groep: - type: string - description: - Benaming van het object of groepattribuut waarvan de EIGENSCHAP - een inhoudelijk gegeven specificeert. - title: groep - maxLength: 32 - formaat: - allOf: - - $ref: '#/components/schemas/FormaatEnum' - description: - 'Het soort tekens waarmee waarden van de EIGENSCHAP kunnen - worden vastgelegd. - - - Uitleg bij mogelijke waarden: - - - * `tekst` - Tekst - - * `getal` - Getal - - * `datum` - Datum - - * `datum_tijd` - Datum/tijd' - title: formaat - lengte: - type: string - description: - Het aantal karakters (lengte) waarmee waarden van de EIGENSCHAP - worden vastgelegd. - title: lengte - maxLength: 14 - kardinaliteit: + description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten + blijven. + title: publicatietermijn + format: duration + toelichting: type: string - description: - Het aantal mogelijke voorkomens van waarden van deze EIGENSCHAP - bij een zaak van het ZAAKTYPE. - title: kardinaliteit - maxLength: 3 - waardenverzameling: + description: Een eventuele toelichting op dit BESLUITTYPE. + title: toelichting + informatieobjecttypen: type: array items: type: string - maxLength: 100 - description: Waarden die deze EIGENSCHAP kan hebben. - title: waardenverzameling - required: - - formaat - - kardinaliteit - - lengte - FieldValidationError: - type: object - description: Formaat van validatiefouten. - properties: - name: - type: string - description: Naam van het veld met ongeldige gegevens - title: name - code: - type: string - description: Systeemcode die het type fout aangeeft - title: code - reason: - type: string - description: Uitleg wat er precies fout is met de gegevens - title: reason - required: - - code - - name - - reason - FormaatEnum: - enum: - - tekst - - getal - - datum - - datum_tijd - type: string - Fout: - type: object - description: Formaat van HTTP 4xx en 5xx fouten. - properties: - type: - type: string - description: URI referentie naar het type fout, bedoeld voor developers - title: type - code: - type: string - description: Systeemcode die het type fout aangeeft - title: code - title: - type: string - description: Generieke titel voor het type fout - title: title - status: - type: integer - description: De HTTP status code - title: status - detail: - type: string - description: Extra informatie bij de fout, indien beschikbaar - title: detail - instance: - type: string - description: - URI met referentie naar dit specifiek voorkomen van de fout. - Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. - title: instance - required: - - code - - detail - - instance - - status - - title - IndicatieInternOfExternEnum: - enum: - - intern - - extern - type: string - InformatieObjectType: - type: object - description: Serializer based on ``IOT-basis`` specified in XSD ``ztc0310_ent_basis.xsd``. - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - catalogus: - type: string - format: uri - description: - URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE - behoort. - title: Catalogus - omschrijving: - type: string - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: omschrijving - maxLength: 80 - vertrouwelijkheidaanduiding: - allOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - description: - 'Aanduiding van de mate waarin informatieobjecten van dit INFORMATIEOBJECTTYPE - voor de openbaarheid bestemd zijn. - - - Uitleg bij mogelijke waarden: - - - * `openbaar` - Openbaar - - * `beperkt_openbaar` - Beperkt openbaar - - * `intern` - Intern - - * `zaakvertrouwelijk` - Zaakvertrouwelijk - - * `vertrouwelijk` - Vertrouwelijk - - * `confidentieel` - Confidentieel - - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' - title: vertrouwelijkheidaanduiding + title: '' + description: '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten + waarin besluiten van dit BESLUITTYPE worden vastgelegd.' + title: informatieobjecttypen beginGeldigheid: type: string format: date @@ -11495,444 +10444,2279 @@ components: concept: type: boolean readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn + description: Geeft aan of het object een concept betreft. Concepten zijn niet-definitieve versies en zouden niet gebruikt moeten worden buiten deze API. title: concept - zaaktypen: + resultaattypen: type: array items: type: string format: uri - title: '' + title: Is resultaat van readOnly: true - description: - URL-referenties naar De INFORMATIEOBJECTTYPEn die relevant - kunnen zijn voor ZAAKen van dit ZAAKTYPE. - title: zaaktypen + title: Is resultaat van + description: Het BESLUITTYPE van besluiten die gepaard gaan met resultaten + van het RESULTAATTYPE. uniqueItems: true - besluittypen: + resultaattypenOmschrijving: type: array items: type: string - format: uri title: '' readOnly: true - description: - URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten - waarin besluiten van dit BESLUITTYPE worden vastgelegd. - title: informatieobjecttypen + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: is resultaat van uniqueItems: true - informatieobjectcategorie: - type: string - title: Categorie - description: Typering van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - maxLength: 80 - trefwoord: + vastgelegdIn: type: array items: type: string - maxLength: 30 - description: - Trefwoord(en) waarmee informatieobjecten van het INFORMATIEOBJECTTYPE - kunnen worden gekarakteriseerd. (Gebruik een komma om waarden van elkaar - te onderscheiden.) - title: trefwoord - omschrijvingGeneriek: - allOf: - - $ref: '#/components/schemas/InformatieObjectTypeOmschrijvingGeneriek' - title: omschrijving generiek + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true required: - - beginGeldigheid - - besluittypen - - catalogus - - concept - - informatieobjectcategorie - - omschrijving - - url - - vertrouwelijkheidaanduiding - - zaaktypen - InformatieObjectTypeOmschrijvingGeneriek: + - beginGeldigheid + - catalogus + - concept + - informatieobjecttypen + - publicatieIndicatie + - resultaattypen + - resultaattypenOmschrijving + - url + - vastgelegdIn + - zaaktypen + BlankEnum: + enum: + - '' + BronCatalogus: type: object + description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. properties: - informatieobjecttypeOmschrijvingGeneriek: + url: type: string - description: Algemeen gehanteerde omschrijving van het type informatieobject. - title: informatieobjecttype omschrijving generiek - maxLength: 80 - definitieInformatieobjecttypeOmschrijvingGeneriek: + format: uri + title: URL-referentie broncatalogus + maxLength: 200 + domein: type: string - title: Definitie - description: Nauwkeurige beschrijving van het generieke type informatieobject - maxLength: 255 - herkomstInformatieobjecttypeOmschrijvingGeneriek: + description: Het domein van de CATALOGUS waaraan het ZAAKTYPE is ontleend. + title: broncatalogus domein + maxLength: 5 + rsin: type: string - title: Herkomst - description: - De naam van de waardenverzameling, of van de beherende organisatie - daarvan, waaruit de waarde is overgenomen. - maxLength: 12 - hierarchieInformatieobjecttypeOmschrijvingGeneriek: + description: Het RSIN van de INGESCHREVEN NIET-NATUURLIJK PERSOON die beheerder + is van de CATALOGUS waaraan het ZAAKTYPE is ontleend. + title: broncatalogus rsin + maxLength: 9 + required: + - domein + - rsin + - url + BronZaaktype: + type: object + description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. + properties: + url: type: string - title: Hierarchie - description: De plaats in de rangorde van het informatieobjecttype. + format: uri + title: URL-referentie bronzaaktype + maxLength: 200 + identificatie: + type: string + description: De Zaaktype-identificatie van het bronzaaktype binnen de CATALOGUS. + title: bronzaaktype identificatie + maxLength: 50 + omschrijving: + type: string + description: De Zaaktype-omschrijving van het bronzaaktype, zoals gehanteerd + in de Broncatalogus. + title: bronzaaktype omschrijving maxLength: 80 - opmerkingInformatieobjecttypeOmschrijvingGeneriek: + required: + - identificatie + - omschrijving + - url + BrondatumArchiefprocedure: + type: object + description: Specificatie voor het bepalen van de brondatum voor de start van + de Archiefactietermijn (=brondatum) van het zaakdossier. + properties: + afleidingswijze: + allOf: + - $ref: '#/components/schemas/AfleidingswijzeEnum' + title: Afleidingswijze brondatum + description: "Wijze van bepalen van de brondatum.\n\nUitleg bij mogelijke\ + \ waarden:\n\n* `afgehandeld` - (Afgehandeld) De termijn start op de datum\ + \ waarop de zaak is afgehandeld (ZAAK.Einddatum in het RGBZ).\n* `ander_datumkenmerk`\ + \ - (Ander datumkenmerk) De termijn start op de datum die is vastgelegd\ + \ in een ander datumveld dan de datumvelden waarop de overige waarden\ + \ (van deze attribuutsoort) betrekking hebben. `Objecttype`, `Registratie`\ + \ en `Datumkenmerk` zijn niet leeg.\n* `eigenschap` - (Eigenschap) De\ + \ termijn start op de datum die vermeld is in een zaaktype-specifieke\ + \ eigenschap (zijnde een `datumveld`). `ResultaatType.ZaakType` heeft\ + \ een `Eigenschap`; `Objecttype`, en `Datumkenmerk` zijn niet leeg.\n\ + * `gerelateerde_zaak` - (Gerelateerde zaak) De termijn start op de datum\ + \ waarop de gerelateerde zaak is afgehandeld (`ZAAK.Einddatum` of `ZAAK.Gerelateerde_zaak.Einddatum`\ + \ in het RGBZ). `ResultaatType.ZaakType` heeft gerelateerd `ZaakType`\n\ + * `hoofdzaak` - (Hoofdzaak) De termijn start op de datum waarop de gerelateerde\ + \ zaak is afgehandeld, waarvan de zaak een deelzaak is (`ZAAK.Einddatum`\ + \ van de hoofdzaak in het RGBZ). ResultaatType.ZaakType is deelzaaktype\ + \ van ZaakType.\n* `ingangsdatum_besluit` - (Ingangsdatum besluit) De\ + \ termijn start op de datum waarop het besluit van kracht wordt (`BESLUIT.Ingangsdatum`\ + \ in het RGBZ).\tResultaatType.ZaakType heeft relevant BesluitType\n*\ + \ `termijn` - (Termijn) De termijn start een vast aantal jaren na de datum\ + \ waarop de zaak is afgehandeld (`ZAAK.Einddatum` in het RGBZ).\n* `vervaldatum_besluit`\ + \ - (Vervaldatum besluit) De termijn start op de dag na de datum waarop\ + \ het besluit vervalt (`BESLUIT.Vervaldatum` in het RGBZ). ResultaatType.ZaakType\ + \ heeft relevant BesluitType\n* `zaakobject` - (Zaakobject) De termijn\ + \ start op de einddatum geldigheid van het zaakobject waarop de zaak betrekking\ + \ heeft (bijvoorbeeld de overlijdendatum van een Persoon). M.b.v. de attribuutsoort\ + \ `Objecttype` wordt vastgelegd om welke zaakobjecttype het gaat; m.b.v.\ + \ de attribuutsoort `Datumkenmerk` wordt vastgelegd welke datum-attribuutsoort\ + \ van het zaakobjecttype het betreft." + datumkenmerk: + type: string + description: Naam van de attribuutsoort van het procesobject dat bepalend + is voor het einde van de procestermijn. + title: datumkenmerk + maxLength: 80 + einddatumBekend: + type: boolean + description: Indicatie dat de einddatum van het procesobject gedurende de + uitvoering van de zaak bekend moet worden. Indien deze nog niet bekend + is en deze waarde staat op `true`, dan kan de zaak (nog) niet afgesloten + worden. + title: einddatum bekend + objecttype: + description: |- + Het soort object in de registratie dat het procesobject representeert. + + Uitleg bij mogelijke waarden: + + * `adres` - Adres + * `besluit` - Besluit + * `buurt` - Buurt + * `enkelvoudig_document` - Enkelvoudig document + * `gemeente` - Gemeente + * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte + * `huishouden` - Huishouden + * `inrichtingselement` - Inrichtingselement + * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak + * `kunstwerkdeel` - Kunstwerkdeel + * `maatschappelijke_activiteit` - Maatschappelijke activiteit + * `medewerker` - Medewerker + * `natuurlijk_persoon` - Natuurlijk persoon + * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon + * `openbare_ruimte` - Openbare ruimte + * `organisatorische_eenheid` - Organisatorische eenheid + * `pand` - Pand + * `spoorbaandeel` - Spoorbaandeel + * `status` - Status + * `terreindeel` - Terreindeel + * `terrein_gebouwd_object` - Terrein gebouwd object + * `vestiging` - Vestiging + * `waterdeel` - Waterdeel + * `wegdeel` - Wegdeel + * `wijk` - Wijk + * `woonplaats` - Woonplaats + * `woz_deelobject` - Woz deel object + * `woz_object` - Woz object + * `woz_waarde` - Woz waarde + * `zakelijk_recht` - Zakelijk recht + * `overige` - Overige + title: objecttype + oneOf: + - $ref: '#/components/schemas/ObjecttypeEnum' + - $ref: '#/components/schemas/BlankEnum' + registratie: + type: string + description: De naam van de registratie waarvan het procesobject deel uit + maakt. + title: registratie + maxLength: 80 + procestermijn: type: string nullable: true - title: Opmerking - description: Zinvolle toelichting bij het informatieobjecttype - maxLength: 255 + title: Brondatum procestermijn + description: De periode dat het zaakdossier na afronding van de zaak actief + gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening + van de organisatie. Enkel relevant indien de afleidingswijze 'termijn' + is. + format: duration required: - - definitieInformatieobjecttypeOmschrijvingGeneriek - - herkomstInformatieobjecttypeOmschrijvingGeneriek - - hierarchieInformatieobjecttypeOmschrijvingGeneriek - - informatieobjecttypeOmschrijvingGeneriek - ObjecttypeEnum: - enum: - - adres - - besluit - - buurt - - enkelvoudig_document - - gemeente - - gemeentelijke_openbare_ruimte - - huishouden - - inrichtingselement - - kadastrale_onroerende_zaak - - kunstwerkdeel - - maatschappelijke_activiteit - - medewerker - - natuurlijk_persoon - - niet_natuurlijk_persoon - - openbare_ruimte - - organisatorische_eenheid - - pand - - spoorbaandeel - - status - - terreindeel - - terrein_gebouwd_object - - vestiging - - waterdeel - - wegdeel - - wijk - - woonplaats - - woz_deelobject - - woz_object - - woz_waarde - - zakelijk_recht - - overige - type: string - OmschrijvingGeneriekEnum: - enum: - - adviseur - - behandelaar - - belanghebbende - - beslisser - - initiator - - klantcontacter - - zaakcoordinator - - mede_initiator - type: string - PaginatedBesluitTypeList: + - afleidingswijze + nullable: true + Catalogus: type: object properties: - count: - type: integer - example: 123 - next: + url: type: string - nullable: true format: uri - example: http://api.example.org/accounts/?page=4 - previous: + readOnly: true + title: url + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + domein: type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: + description: Een afkorting waarmee wordt aangegeven voor welk domein in + een CATALOGUS ZAAKTYPEn zijn uitgewerkt. + title: domein + maxLength: 5 + rsin: + type: string + description: Het door een kamer toegekend uniek nummer voor de INGESCHREVEN + NIET-NATUURLIJK PERSOON die de eigenaar is van een CATALOGUS. + title: rsin + maxLength: 9 + contactpersoonBeheerNaam: + type: string + title: Naam contactpersoon + description: De naam van de contactpersoon die verantwoordelijk is voor + het beheer van de CATALOGUS. + maxLength: 40 + contactpersoonBeheerTelefoonnummer: + type: string + title: Telefoonnummer + description: Het telefoonnummer van de contactpersoon die verantwoordelijk + is voor het beheer van de CATALOGUS. + maxLength: 20 + contactpersoonBeheerEmailadres: + type: string + format: email + title: Emailadres + description: Het emailadres van de contactpersoon die verantwoordelijk is + voor het beheer van de CATALOGUS. + maxLength: 254 + zaaktypen: type: array items: - $ref: '#/components/schemas/BesluitType' - PaginatedCatalogusList: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar ZAAKTYPEn die in deze CATALOGUS worden + ontsloten. + title: Catalogus + uniqueItems: true + besluittypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar BESLUITTYPEn die in deze CATALOGUS worden + ontsloten. + title: catalogus + uniqueItems: true + informatieobjecttypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar INFORMATIEOBJECTTYPEn die in deze CATALOGUS + worden ontsloten. + title: Catalogus + uniqueItems: true + naam: + type: string + nullable: true + description: De benaming die is gegeven aan de zaaktypecatalogus. + title: naam + maxLength: 200 + versie: + type: string + nullable: true + description: Versie-aanduiding van de van toepassing zijnde zaaktypecatalogus. + title: versie + maxLength: 20 + begindatumVersie: + type: string + format: date + nullable: true + description: Datum waarop de versie van de zaaktypecatalogus van toepassing + is geworden. + title: begindatum versie + required: + - besluittypen + - contactpersoonBeheerNaam + - domein + - informatieobjecttypen + - rsin + - url + - zaaktypen + CheckListItem: type: object properties: - count: - type: integer - example: 123 - next: + itemnaam: + type: string + description: De betekenisvolle benaming van het checklistitem + title: itemnaam + maxLength: 30 + toelichting: type: string nullable: true + description: Beschrijving van de overwegingen bij het controleren van het + aandachtspunt + title: toelichting + maxLength: 1000 + vraagstelling: + type: string + description: Een betekenisvolle vraag waaruit blijkt waarop het aandachtspunt + gecontroleerd moet worden. + title: vraagstelling + maxLength: 255 + verplicht: + type: boolean + description: Het al dan niet verplicht zijn van controle van het aandachtspunt + voorafgaand aan het bereiken van de status van het gerelateerde STATUSTYPE. + title: verplicht + required: + - itemnaam + - vraagstelling + Eigenschap: + type: object + properties: + url: + type: string format: uri - example: http://api.example.org/accounts/?page=4 - previous: + readOnly: true + title: url + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + naam: + type: string + description: De naam van de EIGENSCHAP + title: eigenschapnaam + maxLength: 20 + catalogus: type: string - nullable: true format: uri - example: http://api.example.org/accounts/?page=2 - results: + readOnly: true + title: catalogus + definitie: + type: string + description: De beschrijving van de betekenis van deze EIGENSCHAP + title: definitie + maxLength: 255 + specificatie: + allOf: + - $ref: '#/components/schemas/EigenschapSpecificatie' + title: specificatie van eigenschap + toelichting: + type: string + description: Een toelichting op deze EIGENSCHAP en het belang hiervan voor + zaken van dit ZAAKTYPE. + title: toelichting + maxLength: 1000 + zaaktype: + type: string + format: uri + description: URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze + EIGENSCHAP van belang is. + title: Zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + statustype: + type: string + format: uri + nullable: true + title: Status type + description: Status type moet (onder andere) deze EIGENSCHAP hebben, voordat + een STATUS van het STATUSTYPE kan worden gezet. + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de EIGENSCHAP is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de EIGENSCHAP is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + required: + - catalogus + - definitie + - naam + - specificatie + - url + - zaaktype + - zaaktypeIdentificatie + EigenschapSpecificatie: + type: object + properties: + groep: + type: string + description: Benaming van het object of groepattribuut waarvan de EIGENSCHAP + een inhoudelijk gegeven specificeert. + title: groep + maxLength: 32 + formaat: + allOf: + - $ref: '#/components/schemas/FormaatEnum' + description: |- + Het soort tekens waarmee waarden van de EIGENSCHAP kunnen worden vastgelegd. + + Uitleg bij mogelijke waarden: + + * `tekst` - Tekst + * `getal` - Getal + * `datum` - Datum + * `datum_tijd` - Datum/tijd + title: formaat + lengte: + type: string + description: Het aantal karakters (lengte) waarmee waarden van de EIGENSCHAP + worden vastgelegd. + title: lengte + maxLength: 14 + kardinaliteit: + type: string + description: Het aantal mogelijke voorkomens van waarden van deze EIGENSCHAP + bij een zaak van het ZAAKTYPE. + title: kardinaliteit + maxLength: 3 + waardenverzameling: + type: array + items: + type: string + maxLength: 100 + description: Waarden die deze EIGENSCHAP kan hebben. + title: waardenverzameling + required: + - formaat + - kardinaliteit + - lengte + FieldValidationError: + type: object + description: Formaat van validatiefouten. + properties: + name: + type: string + description: Naam van het veld met ongeldige gegevens + title: name + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + reason: + type: string + description: Uitleg wat er precies fout is met de gegevens + title: reason + required: + - code + - name + - reason + FormaatEnum: + enum: + - tekst + - getal + - datum + - datum_tijd + type: string + Fout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: URI met referentie naar dit specifiek voorkomen van de fout. + Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + required: + - code + - detail + - instance + - status + - title + IndicatieInternOfExternEnum: + enum: + - intern + - extern + type: string + InformatieObjectType: + type: object + description: Serializer based on ``IOT-basis`` specified in XSD ``ztc0310_ent_basis.xsd``. + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + catalogus: + type: string + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE + behoort. + title: Catalogus + omschrijving: + type: string + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: omschrijving + maxLength: 80 + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + description: |- + Aanduiding van de mate waarin informatieobjecten van dit INFORMATIEOBJECTTYPE voor de openbaarheid bestemd zijn. + + Uitleg bij mogelijke waarden: + + * `openbaar` - Openbaar + * `beperkt_openbaar` - Beperkt openbaar + * `intern` - Intern + * `zaakvertrouwelijk` - Zaakvertrouwelijk + * `vertrouwelijk` - Vertrouwelijk + * `confidentieel` - Confidentieel + * `geheim` - Geheim + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + concept: + type: boolean + readOnly: true + description: Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + zaaktypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar De INFORMATIEOBJECTTYPEn die relevant + kunnen zijn voor ZAAKen van dit ZAAKTYPE. + title: zaaktypen + uniqueItems: true + besluittypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten + waarin besluiten van dit BESLUITTYPE worden vastgelegd. + title: informatieobjecttypen + uniqueItems: true + informatieobjectcategorie: + type: string + title: Categorie + description: Typering van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + maxLength: 80 + trefwoord: + type: array + items: + type: string + maxLength: 30 + description: Trefwoord(en) waarmee informatieobjecten van het INFORMATIEOBJECTTYPE + kunnen worden gekarakteriseerd. (Gebruik een komma om waarden van elkaar + te onderscheiden.) + title: trefwoord + omschrijvingGeneriek: + allOf: + - $ref: '#/components/schemas/InformatieObjectTypeOmschrijvingGeneriek' + title: omschrijving generiek + required: + - beginGeldigheid + - besluittypen + - catalogus + - concept + - informatieobjectcategorie + - omschrijving + - url + - vertrouwelijkheidaanduiding + - zaaktypen + InformatieObjectTypeOmschrijvingGeneriek: + type: object + properties: + informatieobjecttypeOmschrijvingGeneriek: + type: string + description: Algemeen gehanteerde omschrijving van het type informatieobject. + title: informatieobjecttype omschrijving generiek + maxLength: 80 + definitieInformatieobjecttypeOmschrijvingGeneriek: + type: string + title: Definitie + description: Nauwkeurige beschrijving van het generieke type informatieobject + maxLength: 255 + herkomstInformatieobjecttypeOmschrijvingGeneriek: + type: string + title: Herkomst + description: De naam van de waardenverzameling, of van de beherende organisatie + daarvan, waaruit de waarde is overgenomen. + maxLength: 12 + hierarchieInformatieobjecttypeOmschrijvingGeneriek: + type: string + title: Hierarchie + description: De plaats in de rangorde van het informatieobjecttype. + maxLength: 80 + opmerkingInformatieobjecttypeOmschrijvingGeneriek: + type: string + nullable: true + title: Opmerking + description: Zinvolle toelichting bij het informatieobjecttype + maxLength: 255 + required: + - definitieInformatieobjecttypeOmschrijvingGeneriek + - herkomstInformatieobjecttypeOmschrijvingGeneriek + - hierarchieInformatieobjecttypeOmschrijvingGeneriek + - informatieobjecttypeOmschrijvingGeneriek + ObjecttypeEnum: + enum: + - adres + - besluit + - buurt + - enkelvoudig_document + - gemeente + - gemeentelijke_openbare_ruimte + - huishouden + - inrichtingselement + - kadastrale_onroerende_zaak + - kunstwerkdeel + - maatschappelijke_activiteit + - medewerker + - natuurlijk_persoon + - niet_natuurlijk_persoon + - openbare_ruimte + - organisatorische_eenheid + - pand + - spoorbaandeel + - status + - terreindeel + - terrein_gebouwd_object + - vestiging + - waterdeel + - wegdeel + - wijk + - woonplaats + - woz_deelobject + - woz_object + - woz_waarde + - zakelijk_recht + - overige + type: string + OmschrijvingGeneriekEnum: + enum: + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator + type: string + PaginatedBesluitTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/BesluitType' + PaginatedCatalogusList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Catalogus' + PaginatedEigenschapList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/Eigenschap' + PaginatedInformatieObjectTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/InformatieObjectType' + PaginatedResultaatTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ResultaatType' + PaginatedRolTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/RolType' + PaginatedStatusTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/StatusType' + PaginatedZaakObjectTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ZaakObjectType' + PaginatedZaakTypeInformatieObjectTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ZaakTypeInformatieObjectType' + PaginatedZaakTypeList: + type: object + properties: + count: + type: integer + example: 123 + next: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=4 + previous: + type: string + nullable: true + format: uri + example: http://api.example.org/accounts/?page=2 + results: + type: array + items: + $ref: '#/components/schemas/ZaakType' + PatchedBesluitType: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + catalogus: + type: string + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. + title: catalogus + zaaktypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE + title: zaaktypen + uniqueItems: true + omschrijving: + type: string + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: Algemeen gehanteerde omschrijving van de aard van BESLUITen + van het BESLUITTYPE + title: omschrijving generiek + maxLength: 80 + besluitcategorie: + type: string + description: Typering van de aard van BESLUITen van het BESLUITTYPE. + title: besluitcategorie + maxLength: 40 + reactietermijn: + type: string + nullable: true + description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype + mogelijk is. + title: reactietermijn + format: duration + publicatieIndicatie: + type: boolean + description: Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten + worden. + title: publicatie indicatie + publicatietekst: + type: string + description: De generieke tekst van de publicatie van BESLUITen van dit + BESLUITTYPE + title: publicatietekst + publicatietermijn: + type: string + nullable: true + description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- + of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten + blijven. + title: publicatietermijn + format: duration + toelichting: + type: string + description: Een eventuele toelichting op dit BESLUITTYPE. + title: toelichting + informatieobjecttypen: + type: array + items: + type: string + format: uri + title: '' + description: URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten + waarin besluiten van dit BESLUITTYPE worden vastgelegd. + title: informatieobjecttypen + uniqueItems: true + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + concept: + type: boolean + readOnly: true + description: Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + resultaattypen: + type: array + items: + type: string + format: uri + title: Is resultaat van + readOnly: true + title: Is resultaat van + description: Het BESLUITTYPE van besluiten die gepaard gaan met resultaten + van het RESULTAATTYPE. + uniqueItems: true + resultaattypenOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: is resultaat van + uniqueItems: true + vastgelegdIn: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true + PatchedEigenschap: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + naam: + type: string + description: De naam van de EIGENSCHAP + title: eigenschapnaam + maxLength: 20 + catalogus: + type: string + format: uri + readOnly: true + title: catalogus + definitie: + type: string + description: De beschrijving van de betekenis van deze EIGENSCHAP + title: definitie + maxLength: 255 + specificatie: + allOf: + - $ref: '#/components/schemas/EigenschapSpecificatie' + title: specificatie van eigenschap + toelichting: + type: string + description: Een toelichting op deze EIGENSCHAP en het belang hiervan voor + zaken van dit ZAAKTYPE. + title: toelichting + maxLength: 1000 + zaaktype: + type: string + format: uri + description: URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze + EIGENSCHAP van belang is. + title: Zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + statustype: + type: string + format: uri + nullable: true + title: Status type + description: Status type moet (onder andere) deze EIGENSCHAP hebben, voordat + een STATUS van het STATUSTYPE kan worden gezet. + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de EIGENSCHAP is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de EIGENSCHAP is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + PatchedInformatieObjectType: + type: object + description: Serializer based on ``IOT-basis`` specified in XSD ``ztc0310_ent_basis.xsd``. + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + catalogus: + type: string + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE + behoort. + title: Catalogus + omschrijving: + type: string + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: omschrijving + maxLength: 80 + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + description: |- + Aanduiding van de mate waarin informatieobjecten van dit INFORMATIEOBJECTTYPE voor de openbaarheid bestemd zijn. + + Uitleg bij mogelijke waarden: + + * `openbaar` - Openbaar + * `beperkt_openbaar` - Beperkt openbaar + * `intern` - Intern + * `zaakvertrouwelijk` - Zaakvertrouwelijk + * `vertrouwelijk` - Vertrouwelijk + * `confidentieel` - Confidentieel + * `geheim` - Geheim + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + concept: + type: boolean + readOnly: true + description: Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + zaaktypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar De INFORMATIEOBJECTTYPEn die relevant + kunnen zijn voor ZAAKen van dit ZAAKTYPE. + title: zaaktypen + uniqueItems: true + besluittypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten + waarin besluiten van dit BESLUITTYPE worden vastgelegd. + title: informatieobjecttypen + uniqueItems: true + informatieobjectcategorie: + type: string + title: Categorie + description: Typering van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + maxLength: 80 + trefwoord: + type: array + items: + type: string + maxLength: 30 + description: Trefwoord(en) waarmee informatieobjecten van het INFORMATIEOBJECTTYPE + kunnen worden gekarakteriseerd. (Gebruik een komma om waarden van elkaar + te onderscheiden.) + title: trefwoord + omschrijvingGeneriek: + allOf: + - $ref: '#/components/schemas/InformatieObjectTypeOmschrijvingGeneriek' + title: omschrijving generiek + PatchedResultaatType: + type: object + description: |- + Set gegevensgroepdata from validated nested data. + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen. + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + title: is van + description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten + van dit RESULTAATTYPE bereikt kunnen worden. + zaaktypeIdentificatie: + type: string + readOnly: true + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: is relevant voor + omschrijving: + type: string + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: omschrijving + maxLength: 30 + resultaattypeomschrijving: + type: string + format: uri + description: Algemeen gehanteerde omschrijving van de aard van resultaten + van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst + van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving + generiek' + title: resultaattypeomschrijving + maxLength: 1000 + omschrijvingGeneriek: + type: string + readOnly: true + description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) + title: omschrijving generiek + selectielijstklasse: + type: string + format: uri + description: URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE + relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT + in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. + title: selectielijstklasse + maxLength: 1000 + toelichting: + type: string + description: Een toelichting op dit RESULTAATTYPE en het belang hiervan + voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. + title: toelichting + archiefnominatie: + description: |- + Aanduiding die aangeeft of ZAAKen met een resultaat van dit RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de selectielijst. + + Uitleg bij mogelijke waarden: + + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum overgedragen worden naar een archiefbewaarplaats. + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd worden. + title: archiefnominatie + oneOf: + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' + archiefactietermijn: + type: string + nullable: true + description: De termijn, na het vervallen van het bedrjfsvoeringsbelang, + waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) + van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht + (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers + betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend + te bewaren zaakdossiers betreft het de termijn vanaf afronding van de + zaak tot overbrenging (de procestermijn is dan nihil). + title: archiefactietermijn + format: duration + brondatumArchiefprocedure: + allOf: + - $ref: '#/components/schemas/BrondatumArchiefprocedure' + nullable: true + description: Specificatie voor het bepalen van de brondatum voor de start + van de Archiefactietermijn (=brondatum) van het zaakdossier. + title: brondatumArchiefprocedure + procesobjectaard: + type: string + nullable: true + description: Omschrijving van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking + heeft. + title: procesobjectaard + maxLength: 200 + catalogus: + type: string + format: uri + nullable: true + description: URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE + behoort. + title: catalogus + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop de RESULTAATTYPE is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + indicatieSpecifiek: + type: boolean + nullable: true + description: Aanduiding of het, vanuit archiveringsoptiek, een resultaattype + betreft dat specifiek is voor een bepaalde procesobjectaard. + title: indicatie specifiek + procestermijn: + type: string + nullable: true + description: De periode dat het zaakdossier na afronding van de zaak actief + gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening + van de organisatie. + title: procestermijn + format: duration + besluittypen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + title: is resultaat van + uniqueItems: true + besluittypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: is resultaat van + uniqueItems: true + informatieobjecttypen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + description: De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn + in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van + dit RESULTAATTYPE kan worden gezet. + title: informatieobjecttypen + uniqueItems: true + informatieobjecttypeOmschrijving: + type: array + items: + type: string + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true + PatchedRolType: + type: object + description: Adds nested create feature + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: + type: string + format: uri + description: URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken + kunnen zijn. + title: Zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + omschrijving: + type: string + description: Omschrijving van de aard van de ROL. + title: omschrijving + maxLength: 100 + omschrijvingGeneriek: + allOf: + - $ref: '#/components/schemas/OmschrijvingGeneriekEnum' + description: |- + Algemeen gehanteerde omschrijving van de aard van de ROL. + + 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 + title: omschrijving generiek + catalogus: + type: string + format: uri + nullable: true + description: URL-referentie naar de CATALOGUS waartoe dit ROLTYPE behoort. + title: catalogus + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + PatchedStatusType: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + omschrijving: + type: string + description: Een korte, voor de initiator van de zaak relevante, omschrijving + van de aard van de STATUS van zaken van een ZAAKTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: Algemeen gehanteerde omschrijving van de aard van STATUSsen + van het STATUSTYPE + title: omschrijving generiek + maxLength: 80 + statustekst: + type: string + description: De tekst die wordt gebruikt om de Initiator te informeren over + het bereiken van een STATUS van dit STATUSTYPE bij het desbetreffende + ZAAKTYPE. + title: statustekst + maxLength: 1000 + zaaktype: + type: string + format: uri + description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen + van dit STATUSTYPE bereikt kunnen worden. + title: Zaaktype + catalogus: + type: string + format: uri + readOnly: true + title: catalogus + zaaktypeIdentificatie: + type: string + readOnly: true + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + volgnummer: + type: integer + maximum: 9999 + minimum: 1 + description: Een volgnummer voor statussen van het STATUSTYPE binnen een + zaak. + title: statustypevolgnummer + isEindstatus: + type: boolean + readOnly: true + description: Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven + is afgeleid uit alle STATUSTYPEn van dit ZAAKTYPE met het hoogste volgnummer. + title: isEindstatus + informeren: + type: boolean + description: Aanduiding die aangeeft of na het zetten van een STATUS van + dit STATUSTYPE de Initiator moet worden geïnformeerd over de statusovergang. + title: informeren + doorlooptijd: + type: string + nullable: true + description: De door de zaakbehandelende organisatie(s) gestelde norm voor + de doorlooptijd voor het bereiken van STATUSsen van dit STATUSTYPE bij + het desbetreffende ZAAKTYPE. + title: doorlooptijd status + format: duration + toelichting: + type: string + nullable: true + description: Een eventuele toelichting op dit STATUSTYPE. + title: toelichting + maxLength: 1000 + checklistitemStatustype: + type: array + items: + $ref: '#/components/schemas/CheckListItem' + title: checklistitem + eigenschappen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + description: de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen, + voordat een STATUS van dit STATUSTYPE kan worden gezet. + title: eigenschappen + uniqueItems: true + beginGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + PatchedZaakObjectType: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + anderObjecttype: + type: boolean + description: Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een + ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. + title: Ander objecttype + beginGeldigheid: + type: string + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: + type: string + format: date + nullable: true + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: + type: string + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: + type: string + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + objecttype: + type: string + format: uri + description: URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE + behoort. + title: Objecttype + maxLength: 200 + relatieOmschrijving: + type: string + description: Omschrijving van de betrekking van het Objecttype op zaken + van het gerelateerde ZAAKTYPE. + title: Relatie omschrijving + maxLength: 80 + zaaktype: + type: string + format: uri + description: URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE + behoort. + title: Zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: Zaaktype + resultaattypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar de RESULTAATTYPEN. + title: Zaakobjecttypen + uniqueItems: true + statustypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar de STATUSTYPEN. + title: Zaakobjecttypen + uniqueItems: true + catalogus: + type: string + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE + behoort. + title: Catalogus + PatchedZaakType: + type: object + description: |- + Set gegevensgroepdata from validated nested data. + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen. + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: identificatie + maxLength: 50 + omschrijving: + type: string + description: Omschrijving van de aard van ZAAKen van het ZAAKTYPE. + title: omschrijving + maxLength: 80 + omschrijvingGeneriek: + type: string + description: Algemeen gehanteerde omschrijving van de aard van ZAAKen van + het ZAAKTYPE + title: omschrijving generiek + maxLength: 80 + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + description: |- + Aanduiding van de mate waarin zaakdossiers van ZAAKen van dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde gezet. + + Uitleg bij mogelijke waarden: + + * `openbaar` - Openbaar + * `beperkt_openbaar` - Beperkt openbaar + * `intern` - Intern + * `zaakvertrouwelijk` - Zaakvertrouwelijk + * `vertrouwelijk` - Vertrouwelijk + * `confidentieel` - Confidentieel + * `geheim` - Geheim + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + doel: + type: string + description: Een omschrijving van hetgeen beoogd is te bereiken met een + zaak van dit zaaktype. + title: doel + aanleiding: + type: string + description: Een omschrijving van de gebeurtenis die leidt tot het starten + van een ZAAK van dit ZAAKTYPE. + title: aanleiding + toelichting: + type: string + description: Een eventuele toelichting op dit zaaktype, zoals een beschrijving + van het procesverloop op de hoofdlijnen. + title: toelichting + indicatieInternOfExtern: + allOf: + - $ref: '#/components/schemas/IndicatieInternOfExternEnum' + description: |- + Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn die Intern respectievelijk Extern geïnitieerd worden. Indien van beide sprake kan zijn, dan prevaleert de externe initiatie. + + Uitleg bij mogelijke waarden: + + * `inkomend` - Inkomend + * `intern` - Intern + * `uitgaand` - Uitgaand + title: indicatie intern of extern + handelingInitiator: + type: string + description: Werkwoord dat hoort bij de handeling die de initiator verricht + bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook + het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator + title: handeling initiator + maxLength: 20 + onderwerp: + type: string + description: 'Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen + nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus + (PDC). Bijvoorbeeld: ''Evenementenvergunning'', ''Geboorte'', ''Klacht''. + Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp' + title: onderwerp + maxLength: 80 + handelingBehandelaar: + type: string + description: Werkwoord dat hoort bij de handeling die de behandelaar verricht + bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', + 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar + title: handeling behandelaar + maxLength: 20 + doorlooptijd: + type: string + description: De periode waarbinnen volgens wet- en regelgeving een ZAAK + van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. + title: doorlooptijd behandeling + format: duration + servicenorm: + type: string + nullable: true + description: De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE + afgerond wordt conform de geldende servicenormen van de zaakbehandelende + organisatie(s). + title: servicenorm behandeling + format: duration + opschortingEnAanhoudingMogelijk: + type: boolean + title: Opschorting/aanhouding mogelijk + description: Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE + kunnen worden opgeschort en/of aangehouden. + verlengingMogelijk: + type: boolean + description: Aanduiding die aangeeft of de Doorlooptijd behandeling van + ZAAKen van dit ZAAKTYPE kan worden verlengd. + title: verlenging mogelijk + verlengingstermijn: + type: string + nullable: true + description: Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling + van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde + bevatten als verlenging mogelijk is. + title: verlengingstermijn + format: duration + trefwoorden: + type: array + items: + type: string + title: Trefwoord + maxLength: 30 + description: Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden + gekarakteriseerd. + title: trefwoorden + publicatieIndicatie: + type: boolean + description: Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd + moet worden. + title: publicatie indicatie + publicatietekst: + type: string + description: De generieke tekst van de publicatie van ZAAKen van dit ZAAKTYPE. + title: publicatietekst + verantwoordingsrelatie: + type: array + items: + type: string + maxLength: 40 + description: De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige + en/of financiële verantwoording. + title: verantwoordingsrelatie + productenOfDiensten: + type: array + items: + type: string + format: uri + title: URL naar product/dienst + maxLength: 1000 + description: Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt + voortgebracht. + title: producten of diensten + selectielijstProcestype: + type: string + format: uri + description: URL-referentie naar een vanuit archiveringsoptiek onderkende + groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst + API). + title: selectielijst procestype + maxLength: 200 + referentieproces: + allOf: + - $ref: '#/components/schemas/ReferentieProces' + description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. + title: referentieproces + verantwoordelijke: + type: string + description: De (soort) organisatorische eenheid of (functie van) medewerker + die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. + title: verantwoordelijke + maxLength: 50 + zaakobjecttypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: Zaaktype + uniqueItems: true + broncatalogus: + allOf: + - $ref: '#/components/schemas/BronCatalogus' + description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. + title: broncatalogus + bronzaaktype: + allOf: + - $ref: '#/components/schemas/BronZaaktype' + description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. + title: bronzaaktype + catalogus: + type: string + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. + title: Catalogus + statustypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + title: Zaaktype + uniqueItems: true + resultaattypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + title: is relevant voor + uniqueItems: true + eigenschappen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn + in ZAKEN van dit ZAAKTYPE. + title: Zaaktype + uniqueItems: true + informatieobjecttypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar de INFORMATIEOBJECTTYPEN die mogelijk + zijn binnen dit ZAAKTYPE. + title: zaaktypen + uniqueItems: true + roltypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + description: URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit + ZAAKTYPE. + title: Zaaktype + uniqueItems: true + besluittypen: type: array items: - $ref: '#/components/schemas/Catalogus' - PaginatedEigenschapList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: + type: string + format: uri + title: heeft relevante besluittypen + title: heeft relevante besluittypen + description: URL-referenties naar de BESLUITTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + uniqueItems: true + deelzaaktypen: type: array items: - $ref: '#/components/schemas/Eigenschap' - PaginatedInformatieObjectTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: + type: string + format: uri + nullable: true + title: '' + description: De ZAAKTYPE(n) waaronder ZAAKen als deelzaak kunnen voorkomen + bij ZAAKen van dit ZAAKTYPE. + title: deelzaaktypen + uniqueItems: true + gerelateerdeZaaktypen: type: array items: - $ref: '#/components/schemas/InformatieObjectType' - PaginatedResultaatTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: + $ref: '#/components/schemas/ZaakTypenRelatie' + description: De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit + ZAAKTYPE. + title: zaaktype van + beginGeldigheid: type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: type: string + format: date nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/ResultaatType' - PaginatedRolTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: type: string + format: date nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: type: string + format: date nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/RolType' - PaginatedStatusTypeList: + description: De datum van de aller laatste versie van het object. + title: datum einde object + versiedatum: + type: string + format: date + description: De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE + geldig zijn geworden + title: versiedatum + concept: + type: boolean + readOnly: true + description: Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept + PatchedZaakTypeInformatieObjectType: type: object + description: |- + Represent a ZaakTypeInformatieObjectType. + + Relatie met informatieobjecttype dat relevant is voor zaaktype. properties: - count: - type: integer - example: 123 - next: + url: type: string - nullable: true format: uri - example: http://api.example.org/accounts/?page=4 - previous: + readOnly: true + title: url + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + zaaktype: type: string - nullable: true format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/StatusType' - PaginatedZaakObjectTypeList: - type: object - properties: - count: - type: integer - example: 123 - next: + description: URL-referentie naar het ZAAKTYPE. + title: zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: zaaktype + catalogus: type: string - nullable: true format: uri - example: http://api.example.org/accounts/?page=4 - previous: + readOnly: true + title: catalogus + informatieobjecttype: type: string - nullable: true format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/ZaakObjectType' - PaginatedZaakTypeInformatieObjectTypeList: - type: object - properties: - count: + title: Informatie object type + description: URL-referentie naar het INFORMATIEOBJECTTYPE. + informatieobjecttypeOmschrijving: + type: string + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatie object type + volgnummer: type: integer - example: 123 - next: + maximum: 999 + minimum: 1 + description: Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het + ZAAKTYPE. + title: volgnummer + richting: + allOf: + - $ref: '#/components/schemas/RichtingEnum' + description: |- + Aanduiding van de richting van informatieobjecten van het gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. + + Uitleg bij mogelijke waarden: + + * `inkomend` - Inkomend + * `intern` - Intern + * `uitgaand` - Uitgaand + title: richting + statustype: type: string - nullable: true format: uri - example: http://api.example.org/accounts/?page=4 - previous: - type: string nullable: true - format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' - PaginatedZaakTypeList: + title: Status type + description: URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn + verplicht aanwezig moeten zijn. + ReferentieProces: type: object + description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. properties: - count: - type: integer - example: 123 - next: + naam: type: string - nullable: true - format: uri - example: http://api.example.org/accounts/?page=4 - previous: + title: Referentieprocesnaam + description: De naam van het Referentieproces. + maxLength: 80 + link: type: string - nullable: true format: uri - example: http://api.example.org/accounts/?page=2 - results: - type: array - items: - $ref: '#/components/schemas/ZaakType' - PatchedBesluitType: + title: Referentieproceslink + description: De URL naar de beschrijving van het Referentieproces + maxLength: 200 + required: + - naam + ResultaatType: type: object + description: |- + Set gegevensgroepdata from validated nested data. + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen. properties: url: type: string format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 - catalogus: + zaaktype: type: string format: uri - description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. - title: catalogus - zaaktypen: - type: array - items: - type: string - format: uri - title: '' - description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE - title: zaaktypen - uniqueItems: true + title: is van + description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten + van dit RESULTAATTYPE bereikt kunnen worden. + zaaktypeIdentificatie: + type: string + readOnly: true + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: is relevant voor omschrijving: type: string - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. title: omschrijving - maxLength: 80 + maxLength: 30 + resultaattypeomschrijving: + type: string + format: uri + description: Algemeen gehanteerde omschrijving van de aard van resultaten + van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst + van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving + generiek' + title: resultaattypeomschrijving + maxLength: 1000 omschrijvingGeneriek: type: string - description: - Algemeen gehanteerde omschrijving van de aard van BESLUITen - van het BESLUITTYPE + readOnly: true + description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) title: omschrijving generiek - maxLength: 80 - besluitcategorie: + selectielijstklasse: type: string - description: Typering van de aard van BESLUITen van het BESLUITTYPE. - title: besluitcategorie - maxLength: 40 - reactietermijn: + format: uri + description: URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE + relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT + in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. + title: selectielijstklasse + maxLength: 1000 + toelichting: + type: string + description: Een toelichting op dit RESULTAATTYPE en het belang hiervan + voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. + title: toelichting + archiefnominatie: + description: |- + Aanduiding die aangeeft of ZAAKen met een resultaat van dit RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de selectielijst. + + Uitleg bij mogelijke waarden: + + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum overgedragen worden naar een archiefbewaarplaats. + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd worden. + title: archiefnominatie + oneOf: + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' + archiefactietermijn: type: string nullable: true - description: - Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- - of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype - mogelijk is. - title: reactietermijn + description: De termijn, na het vervallen van het bedrjfsvoeringsbelang, + waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) + van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht + (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers + betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend + te bewaren zaakdossiers betreft het de termijn vanaf afronding van de + zaak tot overbrenging (de procestermijn is dan nihil). + title: archiefactietermijn format: duration - publicatieIndicatie: - type: boolean - description: - Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten - worden. - title: publicatie indicatie - publicatietekst: - type: string - description: - De generieke tekst van de publicatie van BESLUITen van dit - BESLUITTYPE - title: publicatietekst - publicatietermijn: + brondatumArchiefprocedure: + allOf: + - $ref: '#/components/schemas/BrondatumArchiefprocedure' + nullable: true + description: Specificatie voor het bepalen van de brondatum voor de start + van de Archiefactietermijn (=brondatum) van het zaakdossier. + title: brondatumArchiefprocedure + procesobjectaard: type: string nullable: true - description: - Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- - of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten - blijven. - title: publicatietermijn - format: duration - toelichting: + description: Omschrijving van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking + heeft. + title: procesobjectaard + maxLength: 200 + catalogus: type: string - description: Een eventuele toelichting op dit BESLUITTYPE. - title: toelichting - informatieobjecttypen: - type: array - items: - type: string - format: uri - title: '' - description: - URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten - waarin besluiten van dit BESLUITTYPE worden vastgelegd. - title: informatieobjecttypen - uniqueItems: true + format: uri + nullable: true + description: URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE + behoort. + title: catalogus beginGeldigheid: type: string format: date - description: De datum waarop het is ontstaan. + nullable: true + description: De datum waarop de RESULTAATTYPE is ontstaan. title: datum begin geldigheid eindeGeldigheid: type: string format: date nullable: true - description: De datum waarop het is opgeheven. + description: De datum waarop de RESULTAATTYPE is opgeheven. title: datum einde geldigheid beginObject: type: string @@ -11946,36 +12730,51 @@ components: nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object - concept: + indicatieSpecifiek: type: boolean - readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn - niet-definitieve versies en zouden niet gebruikt moeten worden buiten - deze API. - title: concept - resultaattypen: + nullable: true + description: Aanduiding of het, vanuit archiveringsoptiek, een resultaattype + betreft dat specifiek is voor een bepaalde procesobjectaard. + title: indicatie specifiek + procestermijn: + type: string + nullable: true + description: De periode dat het zaakdossier na afronding van de zaak actief + gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening + van de organisatie. + title: procestermijn + format: duration + besluittypen: type: array items: type: string format: uri - title: Is resultaat van - readOnly: true - title: Is resultaat van - description: - Het BESLUITTYPE van besluiten die gepaard gaan met resultaten - van het RESULTAATTYPE. + nullable: true + title: '' + title: is resultaat van uniqueItems: true - resultaattypenOmschrijving: + besluittypeOmschrijving: type: array items: type: string title: '' readOnly: true - description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. title: is resultaat van uniqueItems: true - vastgelegdIn: + informatieobjecttypen: + type: array + items: + type: string + format: uri + nullable: true + title: '' + description: De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn + in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van + dit RESULTAATTYPE kan worden gezet. + title: informatieobjecttypen + uniqueItems: true + informatieobjecttypeOmschrijving: type: array items: type: string @@ -11984,154 +12783,133 @@ components: description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. title: informatieobjecttypen uniqueItems: true - PatchedEigenschap: + required: + - besluittypeOmschrijving + - informatieobjecttypeOmschrijving + - omschrijving + - omschrijvingGeneriek + - resultaattypeomschrijving + - selectielijstklasse + - url + - zaaktype + - zaaktypeIdentificatie + ResultaatTypeCreate: type: object + description: |- + Set gegevensgroepdata from validated nested data. + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen. properties: url: type: string format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 - naam: - type: string - description: De naam van de EIGENSCHAP - title: eigenschapnaam - maxLength: 20 - catalogus: - type: string - format: uri - readOnly: true - title: catalogus - definitie: - type: string - description: De beschrijving van de betekenis van deze EIGENSCHAP - title: definitie - maxLength: 255 - specificatie: - allOf: - - $ref: '#/components/schemas/EigenschapSpecificatie' - title: specificatie van eigenschap - toelichting: - type: string - description: - Een toelichting op deze EIGENSCHAP en het belang hiervan voor - zaken van dit ZAAKTYPE. - title: toelichting - maxLength: 1000 zaaktype: type: string format: uri - description: - URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze - EIGENSCHAP van belang is. - title: Zaaktype + title: is van + description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten + van dit RESULTAATTYPE bereikt kunnen worden. zaaktypeIdentificatie: type: string readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. - title: Zaaktype - statustype: - type: string - format: uri - nullable: true - title: Status type - description: - Status type moet (onder andere) deze EIGENSCHAP hebben, voordat - een STATUS van het STATUSTYPE kan worden gezet. - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de EIGENSCHAP is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop de EIGENSCHAP is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: + title: is relevant voor + omschrijving: type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - PatchedInformatieObjectType: - type: object - description: Serializer based on ``IOT-basis`` specified in XSD ``ztc0310_ent_basis.xsd``. - properties: - url: + description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + title: omschrijving + maxLength: 30 + resultaattypeomschrijving: type: string format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 + description: Algemeen gehanteerde omschrijving van de aard van resultaten + van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst + van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving + generiek' + title: resultaattypeomschrijving maxLength: 1000 - catalogus: + omschrijvingGeneriek: + type: string + readOnly: true + description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) + title: omschrijving generiek + selectielijstklasse: type: string format: uri - description: - URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE - behoort. - title: Catalogus - omschrijving: + description: URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE + relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT + in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. + title: selectielijstklasse + maxLength: 1000 + toelichting: type: string - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: omschrijving - maxLength: 80 - vertrouwelijkheidaanduiding: - allOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - description: - 'Aanduiding van de mate waarin informatieobjecten van dit INFORMATIEOBJECTTYPE - voor de openbaarheid bestemd zijn. - + description: Een toelichting op dit RESULTAATTYPE en het belang hiervan + voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. + title: toelichting + archiefnominatie: + description: |- + Aanduiding die aangeeft of ZAAKen met een resultaat van dit RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de selectielijst. Uitleg bij mogelijke waarden: - - * `openbaar` - Openbaar - - * `beperkt_openbaar` - Beperkt openbaar - - * `intern` - Intern - - * `zaakvertrouwelijk` - Zaakvertrouwelijk - - * `vertrouwelijk` - Vertrouwelijk - - * `confidentieel` - Confidentieel - - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' - title: vertrouwelijkheidaanduiding + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum overgedragen worden naar een archiefbewaarplaats. + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd worden. + title: archiefnominatie + oneOf: + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' + archiefactietermijn: + type: string + nullable: true + description: De termijn, na het vervallen van het bedrjfsvoeringsbelang, + waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) + van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht + (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers + betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend + te bewaren zaakdossiers betreft het de termijn vanaf afronding van de + zaak tot overbrenging (de procestermijn is dan nihil). + title: archiefactietermijn + format: duration + brondatumArchiefprocedure: + allOf: + - $ref: '#/components/schemas/BrondatumArchiefprocedure' + nullable: true + description: Specificatie voor het bepalen van de brondatum voor de start + van de Archiefactietermijn (=brondatum) van het zaakdossier. + title: brondatumArchiefprocedure + procesobjectaard: + type: string + nullable: true + description: Omschrijving van het object, subject of gebeurtenis waarop, + vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking + heeft. + title: procesobjectaard + maxLength: 200 + catalogus: + type: string + format: uri + nullable: true + description: URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE + behoort. + title: catalogus beginGeldigheid: type: string format: date - description: De datum waarop het is ontstaan. + nullable: true + description: De datum waarop de RESULTAATTYPE is ontstaan. title: datum begin geldigheid eindeGeldigheid: type: string format: date nullable: true - description: De datum waarop het is opgeheven. + description: De datum waarop de RESULTAATTYPE is opgeheven. title: datum einde geldigheid beginObject: type: string @@ -12145,71 +12923,80 @@ components: nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object - concept: + indicatieSpecifiek: type: boolean - readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn - niet-definitieve versies en zouden niet gebruikt moeten worden buiten - deze API. - title: concept - zaaktypen: + nullable: true + description: Aanduiding of het, vanuit archiveringsoptiek, een resultaattype + betreft dat specifiek is voor een bepaalde procesobjectaard. + title: indicatie specifiek + procestermijn: + type: string + nullable: true + description: De periode dat het zaakdossier na afronding van de zaak actief + gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening + van de organisatie. + title: procestermijn + format: duration + besluittypen: + type: array + items: + type: string + title: '' + title: besluittypen + besluittypeOmschrijving: type: array items: type: string - format: uri title: '' readOnly: true - description: - URL-referenties naar De INFORMATIEOBJECTTYPEn die relevant - kunnen zijn voor ZAAKen van dit ZAAKTYPE. - title: zaaktypen + description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. + title: is resultaat van uniqueItems: true - besluittypen: + informatieobjecttypen: type: array items: type: string format: uri + nullable: true title: '' - readOnly: true - description: - URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten - waarin besluiten van dit BESLUITTYPE worden vastgelegd. + description: De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn + in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van + dit RESULTAATTYPE kan worden gezet. title: informatieobjecttypen uniqueItems: true - informatieobjectcategorie: - type: string - title: Categorie - description: Typering van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - maxLength: 80 - trefwoord: + informatieobjecttypeOmschrijving: type: array items: type: string - maxLength: 30 - description: - Trefwoord(en) waarmee informatieobjecten van het INFORMATIEOBJECTTYPE - kunnen worden gekarakteriseerd. (Gebruik een komma om waarden van elkaar - te onderscheiden.) - title: trefwoord - omschrijvingGeneriek: - allOf: - - $ref: '#/components/schemas/InformatieObjectTypeOmschrijvingGeneriek' - title: omschrijving generiek - PatchedResultaatType: + title: '' + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatieobjecttypen + uniqueItems: true + required: + - besluittypeOmschrijving + - besluittypen + - informatieobjecttypeOmschrijving + - omschrijving + - omschrijvingGeneriek + - resultaattypeomschrijving + - selectielijstklasse + - url + - zaaktype + - zaaktypeIdentificatie + ResultaatTypeUpdate: type: object - description: 'Set gegevensgroepdata from validated nested data. - + description: |- + Set gegevensgroepdata from validated nested data. - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + Usage: include the mixin on the ModelSerializer that has gegevensgroepen. properties: url: type: string format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 @@ -12217,14 +13004,12 @@ components: type: string format: uri title: is van - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten + description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten van dit RESULTAATTYPE bereikt kunnen worden. zaaktypeIdentificatie: type: string readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: is relevant voor omschrijving: @@ -12235,8 +13020,7 @@ components: resultaattypeomschrijving: type: string format: uri - description: - Algemeen gehanteerde omschrijving van de aard van resultaten + description: Algemeen gehanteerde omschrijving van de aard van resultaten van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving generiek' @@ -12250,43 +13034,32 @@ components: selectielijstklasse: type: string format: uri - description: - URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE + description: URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. title: selectielijstklasse maxLength: 1000 toelichting: type: string - description: - Een toelichting op dit RESULTAATTYPE en het belang hiervan + description: Een toelichting op dit RESULTAATTYPE en het belang hiervan voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. title: toelichting archiefnominatie: - description: - 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit - RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden - vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de - selectielijst. - + description: |- + Aanduiding die aangeeft of ZAAKen met een resultaat van dit RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de selectielijst. Uitleg bij mogelijke waarden: - - * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum - overgedragen worden naar een archiefbewaarplaats. - - * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd - worden.' + * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum overgedragen worden naar een archiefbewaarplaats. + * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd worden. title: archiefnominatie oneOf: - - $ref: '#/components/schemas/ArchiefnominatieEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/ArchiefnominatieEnum' + - $ref: '#/components/schemas/BlankEnum' archiefactietermijn: type: string nullable: true - description: - De termijn, na het vervallen van het bedrjfsvoeringsbelang, + description: De termijn, na het vervallen van het bedrjfsvoeringsbelang, waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers @@ -12297,17 +13070,15 @@ components: format: duration brondatumArchiefprocedure: allOf: - - $ref: '#/components/schemas/BrondatumArchiefprocedure' + - $ref: '#/components/schemas/BrondatumArchiefprocedure' nullable: true - description: - Specificatie voor het bepalen van de brondatum voor de start + description: Specificatie voor het bepalen van de brondatum voor de start van de Archiefactietermijn (=brondatum) van het zaakdossier. title: brondatumArchiefprocedure procesobjectaard: type: string nullable: true - description: - Omschrijving van het object, subject of gebeurtenis waarop, + description: Omschrijving van het object, subject of gebeurtenis waarop, vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking heeft. title: procesobjectaard @@ -12316,8 +13087,7 @@ components: type: string format: uri nullable: true - description: - URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE + description: URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE behoort. title: catalogus beginGeldigheid: @@ -12347,15 +13117,13 @@ components: indicatieSpecifiek: type: boolean nullable: true - description: - Aanduiding of het, vanuit archiveringsoptiek, een resultaattype + description: Aanduiding of het, vanuit archiveringsoptiek, een resultaattype betreft dat specifiek is voor een bepaalde procesobjectaard. title: indicatie specifiek procestermijn: type: string nullable: true - description: - De periode dat het zaakdossier na afronding van de zaak actief + description: De periode dat het zaakdossier na afronding van de zaak actief gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening van de organisatie. title: procestermijn @@ -12364,11 +13132,8 @@ components: type: array items: type: string - format: uri - nullable: true title: '' - title: is resultaat van - uniqueItems: true + title: besluittypen besluittypeOmschrijving: type: array items: @@ -12385,8 +13150,7 @@ components: format: uri nullable: true title: '' - description: - De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn + description: De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van dit RESULTAATTYPE kan worden gezet. title: informatieobjecttypen @@ -12400,7 +13164,24 @@ components: description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. title: informatieobjecttypen uniqueItems: true - PatchedRolType: + required: + - besluittypeOmschrijving + - besluittypen + - informatieobjecttypeOmschrijving + - omschrijving + - omschrijvingGeneriek + - resultaattypeomschrijving + - selectielijstklasse + - url + - zaaktype + - zaaktypeIdentificatie + RichtingEnum: + enum: + - inkomend + - intern + - uitgaand + type: string + RolType: type: object description: Adds nested create feature properties: @@ -12409,23 +13190,20 @@ components: format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 zaaktype: type: string format: uri - description: - URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken + description: URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken kunnen zijn. title: Zaaktype zaaktypeIdentificatie: type: string readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: Zaaktype omschrijving: @@ -12435,21 +13213,20 @@ components: maxLength: 100 omschrijvingGeneriek: allOf: - - $ref: '#/components/schemas/OmschrijvingGeneriekEnum' - description: - "Algemeen gehanteerde omschrijving van de aard van de ROL.\n\ - \nUitleg bij mogelijke waarden:\n\n* `adviseur` - (Adviseur) Kennis in\ - \ dienst stellen van de behandeling van (een deel van) een zaak.\n* `behandelaar`\ - \ - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van)\ - \ een zaak.\n* `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief\ - \ belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst\ - \ van een zaak.\n* `beslisser` - (Beslisser) Nemen van besluiten die voor\ - \ de uitkomst van een zaak noodzakelijk zijn.\n* `initiator` - (Initiator)\ - \ Aanleiding geven tot de start van een zaak ..\n* `klantcontacter` -\ - \ (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers\ - \ en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6rdinator) Er voor\ - \ zorg dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt\ - \ conform de daarover gemaakte afspraken.\n* `mede_initiator` - Mede-initiator" + - $ref: '#/components/schemas/OmschrijvingGeneriekEnum' + description: |- + Algemeen gehanteerde omschrijving van de aard van de ROL. + + 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 title: omschrijving generiek catalogus: type: string @@ -12481,7 +13258,13 @@ components: nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object - PatchedStatusType: + required: + - omschrijving + - omschrijvingGeneriek + - url + - zaaktype + - zaaktypeIdentificatie + StatusType: type: object properties: url: @@ -12489,29 +13272,25 @@ components: format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 omschrijving: type: string - description: - Een korte, voor de initiator van de zaak relevante, omschrijving + description: Een korte, voor de initiator van de zaak relevante, omschrijving van de aard van de STATUS van zaken van een ZAAKTYPE. title: omschrijving maxLength: 80 omschrijvingGeneriek: type: string - description: - Algemeen gehanteerde omschrijving van de aard van STATUSsen + description: Algemeen gehanteerde omschrijving van de aard van STATUSsen van het STATUSTYPE title: omschrijving generiek maxLength: 80 statustekst: type: string - description: - De tekst die wordt gebruikt om de Initiator te informeren over + description: De tekst die wordt gebruikt om de Initiator te informeren over het bereiken van een STATUS van dit STATUSTYPE bij het desbetreffende ZAAKTYPE. title: statustekst @@ -12519,8 +13298,7 @@ components: zaaktype: type: string format: uri - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen + description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen van dit STATUSTYPE bereikt kunnen worden. title: Zaaktype catalogus: @@ -12531,36 +13309,31 @@ components: zaaktypeIdentificatie: type: string readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: Zaaktype volgnummer: type: integer maximum: 9999 minimum: 1 - description: - Een volgnummer voor statussen van het STATUSTYPE binnen een + description: Een volgnummer voor statussen van het STATUSTYPE binnen een zaak. title: statustypevolgnummer isEindstatus: type: boolean readOnly: true - description: - Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven + description: Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven is afgeleid uit alle STATUSTYPEn van dit ZAAKTYPE met het hoogste volgnummer. title: isEindstatus informeren: type: boolean - description: - "Aanduiding die aangeeft of na het zetten van een STATUS van\ - \ dit STATUSTYPE de Initiator moet worden ge\xEFnformeerd over de statusovergang." + description: Aanduiding die aangeeft of na het zetten van een STATUS van + dit STATUSTYPE de Initiator moet worden geïnformeerd over de statusovergang. title: informeren doorlooptijd: type: string nullable: true - description: - De door de zaakbehandelende organisatie(s) gestelde norm voor + description: De door de zaakbehandelende organisatie(s) gestelde norm voor de doorlooptijd voor het bereiken van STATUSsen van dit STATUSTYPE bij het desbetreffende ZAAKTYPE. title: doorlooptijd status @@ -12583,8 +13356,7 @@ components: format: uri nullable: true title: '' - description: - de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen, + description: de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen, voordat een STATUS van dit STATUSTYPE kan worden gezet. title: eigenschappen uniqueItems: true @@ -12612,7 +13384,67 @@ components: nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object - PatchedZaakObjectType: + required: + - catalogus + - isEindstatus + - omschrijving + - url + - volgnummer + - zaaktype + - zaaktypeIdentificatie + ValidatieFout: + type: object + description: Formaat van HTTP 4xx en 5xx fouten. + properties: + type: + type: string + description: URI referentie naar het type fout, bedoeld voor developers + title: type + code: + type: string + description: Systeemcode die het type fout aangeeft + title: code + title: + type: string + description: Generieke titel voor het type fout + title: title + status: + type: integer + description: De HTTP status code + title: status + detail: + type: string + description: Extra informatie bij de fout, indien beschikbaar + title: detail + instance: + type: string + description: URI met referentie naar dit specifiek voorkomen van de fout. + Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + title: instance + invalidParams: + type: array + items: + $ref: '#/components/schemas/FieldValidationError' + title: invalidParams + required: + - code + - detail + - instance + - invalidParams + - status + - title + VertrouwelijkheidaanduidingEnum: + enum: + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim + type: string + ZaakObjectType: type: object properties: url: @@ -12620,15 +13452,13 @@ components: format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 anderObjecttype: type: boolean - description: - Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een + description: Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. title: Ander objecttype beginGeldigheid: @@ -12657,30 +13487,26 @@ components: objecttype: type: string format: uri - description: - URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE + description: URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE behoort. title: Objecttype maxLength: 200 relatieOmschrijving: type: string - description: - Omschrijving van de betrekking van het Objecttype op zaken + description: Omschrijving van de betrekking van het Objecttype op zaken van het gerelateerde ZAAKTYPE. title: Relatie omschrijving maxLength: 80 zaaktype: type: string format: uri - description: - URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE + description: URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE behoort. title: Zaaktype zaaktypeIdentificatie: type: string readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: Zaaktype resultaattypen: @@ -12706,31 +13532,39 @@ components: catalogus: type: string format: uri - description: - URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE + description: URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE behoort. title: Catalogus - PatchedZaakType: + required: + - anderObjecttype + - beginGeldigheid + - catalogus + - objecttype + - relatieOmschrijving + - resultaattypen + - statustypen + - url + - zaaktype + - zaaktypeIdentificatie + ZaakType: type: object - description: 'Set gegevensgroepdata from validated nested data. + description: |- + Set gegevensgroepdata from validated nested data. - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + Usage: include the mixin on the ModelSerializer that has gegevensgroepen. properties: url: type: string format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 identificatie: type: string - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: identificatie maxLength: 50 @@ -12741,105 +13575,86 @@ components: maxLength: 80 omschrijvingGeneriek: type: string - description: - Algemeen gehanteerde omschrijving van de aard van ZAAKen van + description: Algemeen gehanteerde omschrijving van de aard van ZAAKen van het ZAAKTYPE title: omschrijving generiek maxLength: 80 vertrouwelijkheidaanduiding: allOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - description: - 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van - dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het - aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde - gezet. - + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + description: |- + Aanduiding van de mate waarin zaakdossiers van ZAAKen van dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde gezet. Uitleg bij mogelijke waarden: - * `openbaar` - Openbaar - * `beperkt_openbaar` - Beperkt openbaar - * `intern` - Intern - * `zaakvertrouwelijk` - Zaakvertrouwelijk - * `vertrouwelijk` - Vertrouwelijk - * `confidentieel` - Confidentieel - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' + * `zeer_geheim` - Zeer geheim title: vertrouwelijkheidaanduiding doel: type: string - description: - Een omschrijving van hetgeen beoogd is te bereiken met een + description: Een omschrijving van hetgeen beoogd is te bereiken met een zaak van dit zaaktype. title: doel aanleiding: type: string - description: - Een omschrijving van de gebeurtenis die leidt tot het starten + description: Een omschrijving van de gebeurtenis die leidt tot het starten van een ZAAK van dit ZAAKTYPE. title: aanleiding toelichting: type: string - description: - Een eventuele toelichting op dit zaaktype, zoals een beschrijving + description: Een eventuele toelichting op dit zaaktype, zoals een beschrijving van het procesverloop op de hoofdlijnen. title: toelichting indicatieInternOfExtern: allOf: - - $ref: '#/components/schemas/IndicatieInternOfExternEnum' - description: - "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\ - \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\ - \ beide sprake kan zijn, dan prevaleert de externe initiatie.\n\nUitleg\ - \ bij mogelijke waarden:\n\n* `inkomend` - Inkomend\n* `intern` - Intern\n\ - * `uitgaand` - Uitgaand" + - $ref: '#/components/schemas/IndicatieInternOfExternEnum' + description: |- + Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn die Intern respectievelijk Extern geïnitieerd worden. Indien van beide sprake kan zijn, dan prevaleert de externe initiatie. + + Uitleg bij mogelijke waarden: + + * `inkomend` - Inkomend + * `intern` - Intern + * `uitgaand` - Uitgaand title: indicatie intern of extern handelingInitiator: type: string - description: - Werkwoord dat hoort bij de handeling die de initiator verricht + description: Werkwoord dat hoort bij de handeling die de initiator verricht bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator title: handeling initiator maxLength: 20 onderwerp: type: string - description: - "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen + description: 'Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus - (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'. - Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp" + (PDC). Bijvoorbeeld: ''Evenementenvergunning'', ''Geboorte'', ''Klacht''. + Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp' title: onderwerp maxLength: 80 handelingBehandelaar: type: string - description: - Werkwoord dat hoort bij de handeling die de behandelaar verricht + description: Werkwoord dat hoort bij de handeling die de behandelaar verricht bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar title: handeling behandelaar maxLength: 20 doorlooptijd: type: string - description: - De periode waarbinnen volgens wet- en regelgeving een ZAAK + description: De periode waarbinnen volgens wet- en regelgeving een ZAAK van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. title: doorlooptijd behandeling format: duration servicenorm: type: string nullable: true - description: - De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE + description: De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE afgerond wordt conform de geldende servicenormen van de zaakbehandelende organisatie(s). title: servicenorm behandeling @@ -12847,20 +13662,17 @@ components: opschortingEnAanhoudingMogelijk: type: boolean title: Opschorting/aanhouding mogelijk - description: - Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE + description: Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE kunnen worden opgeschort en/of aangehouden. verlengingMogelijk: type: boolean - description: - Aanduiding die aangeeft of de Doorlooptijd behandeling van + description: Aanduiding die aangeeft of de Doorlooptijd behandeling van ZAAKen van dit ZAAKTYPE kan worden verlengd. title: verlenging mogelijk verlengingstermijn: type: string nullable: true - description: - Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling + description: Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde bevatten als verlenging mogelijk is. title: verlengingstermijn @@ -12871,14 +13683,12 @@ components: type: string title: Trefwoord maxLength: 30 - description: - Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden + description: Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden gekarakteriseerd. title: trefwoorden publicatieIndicatie: type: boolean - description: - Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd + description: Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd moet worden. title: publicatie indicatie publicatietekst: @@ -12890,9 +13700,8 @@ components: items: type: string maxLength: 40 - description: - "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ - \ en/of financi\xEBle verantwoording." + description: De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige + en/of financiële verantwoording. title: verantwoordingsrelatie productenOfDiensten: type: array @@ -12901,28 +13710,25 @@ components: format: uri title: URL naar product/dienst maxLength: 1000 - description: - Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt + description: Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt voortgebracht. title: producten of diensten selectielijstProcestype: type: string format: uri - description: - URL-referentie naar een vanuit archiveringsoptiek onderkende + description: URL-referentie naar een vanuit archiveringsoptiek onderkende groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst API). title: selectielijst procestype maxLength: 200 referentieproces: allOf: - - $ref: '#/components/schemas/ReferentieProces' + - $ref: '#/components/schemas/ReferentieProces' description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. title: referentieproces verantwoordelijke: type: string - description: - De (soort) organisatorische eenheid of (functie van) medewerker + description: De (soort) organisatorische eenheid of (functie van) medewerker die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. title: verantwoordelijke maxLength: 50 @@ -12937,12 +13743,12 @@ components: uniqueItems: true broncatalogus: allOf: - - $ref: '#/components/schemas/BronCatalogus' + - $ref: '#/components/schemas/BronCatalogus' description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. title: broncatalogus bronzaaktype: allOf: - - $ref: '#/components/schemas/BronZaaktype' + - $ref: '#/components/schemas/BronZaaktype' description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. title: bronzaaktype catalogus: @@ -12957,8 +13763,7 @@ components: format: uri title: '' readOnly: true - description: - URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen + description: URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen dit ZAAKTYPE. title: Zaaktype uniqueItems: true @@ -12969,8 +13774,7 @@ components: format: uri title: '' readOnly: true - description: - URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen + description: URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen dit ZAAKTYPE. title: is relevant voor uniqueItems: true @@ -12981,8 +13785,7 @@ components: format: uri title: '' readOnly: true - description: - URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn + description: URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn in ZAKEN van dit ZAAKTYPE. title: Zaaktype uniqueItems: true @@ -12993,8 +13796,7 @@ components: format: uri title: '' readOnly: true - description: - URL-referenties naar de INFORMATIEOBJECTTYPEN die mogelijk + description: URL-referenties naar de INFORMATIEOBJECTTYPEN die mogelijk zijn binnen dit ZAAKTYPE. title: zaaktypen uniqueItems: true @@ -13005,8 +13807,7 @@ components: format: uri title: '' readOnly: true - description: - URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit + description: URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit ZAAKTYPE. title: Zaaktype uniqueItems: true @@ -13017,8 +13818,7 @@ components: format: uri title: heeft relevante besluittypen title: heeft relevante besluittypen - description: - URL-referenties naar de BESLUITTYPEN die mogelijk zijn binnen + description: URL-referenties naar de BESLUITTYPEN die mogelijk zijn binnen dit ZAAKTYPE. uniqueItems: true deelzaaktypen: @@ -13028,8 +13828,7 @@ components: format: uri nullable: true title: '' - description: - De ZAAKTYPE(n) waaronder ZAAKen als deelzaak kunnen voorkomen + description: De ZAAKTYPE(n) waaronder ZAAKen als deelzaak kunnen voorkomen bij ZAAKen van dit ZAAKTYPE. title: deelzaaktypen uniqueItems: true @@ -13037,423 +13836,366 @@ components: type: array items: $ref: '#/components/schemas/ZaakTypenRelatie' - description: - De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit + description: De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit ZAAKTYPE. title: zaaktype van beginGeldigheid: type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - versiedatum: - type: string - format: date - description: - De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE - geldig zijn geworden - title: versiedatum - concept: - type: boolean - readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn - niet-definitieve versies en zouden niet gebruikt moeten worden buiten - deze API. - title: concept - PatchedZaakTypeInformatieObjectType: - type: object - description: 'Represent a ZaakTypeInformatieObjectType. - - - Relatie met informatieobjecttype dat relevant is voor zaaktype.' - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - description: URL-referentie naar het ZAAKTYPE. - title: zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: zaaktype - catalogus: - type: string - format: uri - readOnly: true - title: catalogus - informatieobjecttype: - type: string - format: uri - title: Informatie object type - description: URL-referentie naar het INFORMATIEOBJECTTYPE. - informatieobjecttypeOmschrijving: - type: string - readOnly: true - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: informatie object type - volgnummer: - type: integer - maximum: 999 - minimum: 1 - description: - Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het - ZAAKTYPE. - title: volgnummer - richting: - allOf: - - $ref: '#/components/schemas/RichtingEnum' - description: - 'Aanduiding van de richting van informatieobjecten van het - gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. - - - Uitleg bij mogelijke waarden: - - - * `inkomend` - Inkomend - - * `intern` - Intern - - * `uitgaand` - Uitgaand' - title: richting - statustype: + format: date + description: De datum waarop het is ontstaan. + title: datum begin geldigheid + eindeGeldigheid: type: string - format: uri + format: date nullable: true - title: Status type - description: - URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn - verplicht aanwezig moeten zijn. - ReferentieProces: - type: object - description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. - properties: - naam: + description: De datum waarop het is opgeheven. + title: datum einde geldigheid + beginObject: type: string - title: Referentieprocesnaam - description: De naam van het Referentieproces. - maxLength: 80 - link: + format: date + nullable: true + description: De datum waarop de eerst versie van het object ontstaan is. + title: datum begin object + eindeObject: type: string - format: uri - title: Referentieproceslink - description: De URL naar de beschrijving van het Referentieproces - maxLength: 200 + format: date + nullable: true + description: De datum van de aller laatste versie van het object. + title: datum einde object + versiedatum: + type: string + format: date + description: De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE + geldig zijn geworden + title: versiedatum + concept: + type: boolean + readOnly: true + description: Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept required: - - naam - ResultaatType: + - aanleiding + - beginGeldigheid + - besluittypen + - catalogus + - concept + - doel + - doorlooptijd + - eigenschappen + - gerelateerdeZaaktypen + - handelingBehandelaar + - handelingInitiator + - identificatie + - indicatieInternOfExtern + - informatieobjecttypen + - omschrijving + - onderwerp + - opschortingEnAanhoudingMogelijk + - productenOfDiensten + - publicatieIndicatie + - referentieproces + - resultaattypen + - roltypen + - statustypen + - url + - verantwoordelijke + - verlengingMogelijk + - versiedatum + - vertrouwelijkheidaanduiding + - zaakobjecttypen + ZaakTypeCreate: type: object - description: 'Set gegevensgroepdata from validated nested data. - + description: |- + Set gegevensgroepdata from validated nested data. - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + Usage: include the mixin on the ModelSerializer that has gegevensgroepen. properties: url: type: string format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 - zaaktype: - type: string - format: uri - title: is van - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten - van dit RESULTAATTYPE bereikt kunnen worden. - zaaktypeIdentificatie: + identificatie: type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. - title: is relevant voor + title: identificatie + maxLength: 50 omschrijving: type: string - description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. + description: Omschrijving van de aard van ZAAKen van het ZAAKTYPE. title: omschrijving - maxLength: 30 - resultaattypeomschrijving: - type: string - format: uri - description: - Algemeen gehanteerde omschrijving van de aard van resultaten - van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst - van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving - generiek' - title: resultaattypeomschrijving - maxLength: 1000 + maxLength: 80 omschrijvingGeneriek: type: string - readOnly: true - description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) + description: Algemeen gehanteerde omschrijving van de aard van ZAAKen van + het ZAAKTYPE title: omschrijving generiek - selectielijstklasse: + maxLength: 80 + vertrouwelijkheidaanduiding: + allOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + description: |- + Aanduiding van de mate waarin zaakdossiers van ZAAKen van dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde gezet. + + Uitleg bij mogelijke waarden: + + * `openbaar` - Openbaar + * `beperkt_openbaar` - Beperkt openbaar + * `intern` - Intern + * `zaakvertrouwelijk` - Zaakvertrouwelijk + * `vertrouwelijk` - Vertrouwelijk + * `confidentieel` - Confidentieel + * `geheim` - Geheim + * `zeer_geheim` - Zeer geheim + title: vertrouwelijkheidaanduiding + doel: type: string - format: uri - description: - URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE - relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT - in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. - title: selectielijstklasse - maxLength: 1000 + description: Een omschrijving van hetgeen beoogd is te bereiken met een + zaak van dit zaaktype. + title: doel + aanleiding: + type: string + description: Een omschrijving van de gebeurtenis die leidt tot het starten + van een ZAAK van dit ZAAKTYPE. + title: aanleiding toelichting: type: string - description: - Een toelichting op dit RESULTAATTYPE en het belang hiervan - voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. + description: Een eventuele toelichting op dit zaaktype, zoals een beschrijving + van het procesverloop op de hoofdlijnen. title: toelichting - archiefnominatie: - description: - 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit - RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden - vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de - selectielijst. - + indicatieInternOfExtern: + allOf: + - $ref: '#/components/schemas/IndicatieInternOfExternEnum' + description: |- + Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn die Intern respectievelijk Extern geïnitieerd worden. Indien van beide sprake kan zijn, dan prevaleert de externe initiatie. Uitleg bij mogelijke waarden: - - * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum - overgedragen worden naar een archiefbewaarplaats. - - * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd - worden.' - title: archiefnominatie - oneOf: - - $ref: '#/components/schemas/ArchiefnominatieEnum' - - $ref: '#/components/schemas/BlankEnum' - archiefactietermijn: - type: string - nullable: true - description: - De termijn, na het vervallen van het bedrjfsvoeringsbelang, - waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) - van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht - (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers - betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend - te bewaren zaakdossiers betreft het de termijn vanaf afronding van de - zaak tot overbrenging (de procestermijn is dan nihil). - title: archiefactietermijn - format: duration - brondatumArchiefprocedure: - allOf: - - $ref: '#/components/schemas/BrondatumArchiefprocedure' - nullable: true - description: - Specificatie voor het bepalen van de brondatum voor de start - van de Archiefactietermijn (=brondatum) van het zaakdossier. - title: brondatumArchiefprocedure - procesobjectaard: + * `inkomend` - Inkomend + * `intern` - Intern + * `uitgaand` - Uitgaand + title: indicatie intern of extern + handelingInitiator: type: string - nullable: true - description: - Omschrijving van het object, subject of gebeurtenis waarop, - vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking - heeft. - title: procesobjectaard - maxLength: 200 - catalogus: + description: Werkwoord dat hoort bij de handeling die de initiator verricht + bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook + het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator + title: handeling initiator + maxLength: 20 + onderwerp: type: string - format: uri - nullable: true - description: - URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE - behoort. - title: catalogus - beginGeldigheid: + description: 'Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen + nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus + (PDC). Bijvoorbeeld: ''Evenementenvergunning'', ''Geboorte'', ''Klacht''. + Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp' + title: onderwerp + maxLength: 80 + handelingBehandelaar: type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: + description: Werkwoord dat hoort bij de handeling die de behandelaar verricht + bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', + 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar + title: handeling behandelaar + maxLength: 20 + doorlooptijd: type: string - format: date - nullable: true - description: De datum waarop de RESULTAATTYPE is opgeheven. - title: datum einde geldigheid - beginObject: + description: De periode waarbinnen volgens wet- en regelgeving een ZAAK + van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. + title: doorlooptijd behandeling + format: duration + servicenorm: type: string - format: date nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: + description: De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE + afgerond wordt conform de geldende servicenormen van de zaakbehandelende + organisatie(s). + title: servicenorm behandeling + format: duration + opschortingEnAanhoudingMogelijk: + type: boolean + title: Opschorting/aanhouding mogelijk + description: Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE + kunnen worden opgeschort en/of aangehouden. + verlengingMogelijk: + type: boolean + description: Aanduiding die aangeeft of de Doorlooptijd behandeling van + ZAAKen van dit ZAAKTYPE kan worden verlengd. + title: verlenging mogelijk + verlengingstermijn: type: string - format: date nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - indicatieSpecifiek: + description: Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling + van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde + bevatten als verlenging mogelijk is. + title: verlengingstermijn + format: duration + trefwoorden: + type: array + items: + type: string + title: Trefwoord + maxLength: 30 + description: Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden + gekarakteriseerd. + title: trefwoorden + publicatieIndicatie: type: boolean - nullable: true - description: - Aanduiding of het, vanuit archiveringsoptiek, een resultaattype - betreft dat specifiek is voor een bepaalde procesobjectaard. - title: indicatie specifiek - procestermijn: + description: Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd + moet worden. + title: publicatie indicatie + publicatietekst: + type: string + description: De generieke tekst van de publicatie van ZAAKen van dit ZAAKTYPE. + title: publicatietekst + verantwoordingsrelatie: + type: array + items: + type: string + maxLength: 40 + description: De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige + en/of financiële verantwoording. + title: verantwoordingsrelatie + productenOfDiensten: + type: array + items: + type: string + format: uri + title: URL naar product/dienst + maxLength: 1000 + description: Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt + voortgebracht. + title: producten of diensten + selectielijstProcestype: + type: string + format: uri + description: URL-referentie naar een vanuit archiveringsoptiek onderkende + groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst + API). + title: selectielijst procestype + maxLength: 200 + referentieproces: + allOf: + - $ref: '#/components/schemas/ReferentieProces' + description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. + title: referentieproces + verantwoordelijke: + type: string + description: De (soort) organisatorische eenheid of (functie van) medewerker + die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. + title: verantwoordelijke + maxLength: 50 + zaakobjecttypen: + type: array + items: + type: string + format: uri + title: '' + readOnly: true + title: Zaaktype + uniqueItems: true + broncatalogus: + allOf: + - $ref: '#/components/schemas/BronCatalogus' + description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. + title: broncatalogus + bronzaaktype: + allOf: + - $ref: '#/components/schemas/BronZaaktype' + description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. + title: bronzaaktype + catalogus: type: string - nullable: true - description: - De periode dat het zaakdossier na afronding van de zaak actief - gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening - van de organisatie. - title: procestermijn - format: duration - besluittypen: + format: uri + description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. + title: Catalogus + statustypen: type: array items: type: string format: uri - nullable: true title: '' - title: is resultaat van + readOnly: true + description: URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + title: Zaaktype uniqueItems: true - besluittypeOmschrijving: + resultaattypen: type: array items: type: string + format: uri title: '' readOnly: true - description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. - title: is resultaat van + description: URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen + dit ZAAKTYPE. + title: is relevant voor uniqueItems: true - informatieobjecttypen: + eigenschappen: type: array items: type: string format: uri - nullable: true title: '' - description: - De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn - in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van - dit RESULTAATTYPE kan worden gezet. - title: informatieobjecttypen + readOnly: true + description: URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn + in ZAKEN van dit ZAAKTYPE. + title: Zaaktype uniqueItems: true - informatieobjecttypeOmschrijving: + informatieobjecttypen: type: array items: type: string + format: uri title: '' readOnly: true - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: informatieobjecttypen + description: URL-referenties naar de INFORMATIEOBJECTTYPEN die mogelijk + zijn binnen dit ZAAKTYPE. + title: zaaktypen uniqueItems: true - required: - - besluittypeOmschrijving - - informatieobjecttypeOmschrijving - - omschrijving - - omschrijvingGeneriek - - resultaattypeomschrijving - - selectielijstklasse - - url - - zaaktype - - zaaktypeIdentificatie - RichtingEnum: - enum: - - inkomend - - intern - - uitgaand - type: string - RolType: - type: object - description: Adds nested create feature - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - zaaktype: - type: string - format: uri - description: - URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken - kunnen zijn. - title: Zaaktype - zaaktypeIdentificatie: - type: string + roltypen: + type: array + items: + type: string + format: uri + title: '' readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. + description: URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit + ZAAKTYPE. title: Zaaktype - omschrijving: - type: string - description: Omschrijving van de aard van de ROL. - title: omschrijving - maxLength: 100 - omschrijvingGeneriek: - allOf: - - $ref: '#/components/schemas/OmschrijvingGeneriekEnum' - description: - "Algemeen gehanteerde omschrijving van de aard van de ROL.\n\ - \nUitleg bij mogelijke waarden:\n\n* `adviseur` - (Adviseur) Kennis in\ - \ dienst stellen van de behandeling van (een deel van) een zaak.\n* `behandelaar`\ - \ - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van)\ - \ een zaak.\n* `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief\ - \ belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst\ - \ van een zaak.\n* `beslisser` - (Beslisser) Nemen van besluiten die voor\ - \ de uitkomst van een zaak noodzakelijk zijn.\n* `initiator` - (Initiator)\ - \ Aanleiding geven tot de start van een zaak ..\n* `klantcontacter` -\ - \ (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers\ - \ en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6rdinator) Er voor\ - \ zorg dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt\ - \ conform de daarover gemaakte afspraken.\n* `mede_initiator` - Mede-initiator" - title: omschrijving generiek - catalogus: - type: string - format: uri - nullable: true - description: URL-referentie naar de CATALOGUS waartoe dit ROLTYPE behoort. - title: catalogus + uniqueItems: true + besluittypen: + type: array + items: + type: string + title: '' + description: '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen + dit ZAAKTYPE.' + title: zaaktypen + deelzaaktypen: + type: array + items: + type: string + title: '' + description: De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak + kunnen voorkomen bij ZAAKen van dit ZAAKTYPE. + title: deelzaaktypen + gerelateerdeZaaktypen: + type: array + items: + $ref: '#/components/schemas/ZaakTypenRelatieCreate' + description: De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit + ZAAKTYPE. + title: zaaktype van beginGeldigheid: type: string format: date - nullable: true description: De datum waarop het is ontstaan. title: datum begin geldigheid eindeGeldigheid: @@ -13474,334 +14216,300 @@ components: nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object + versiedatum: + type: string + format: date + description: De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE + geldig zijn geworden + title: versiedatum + concept: + type: boolean + readOnly: true + description: Geeft aan of het object een concept betreft. Concepten zijn + niet-definitieve versies en zouden niet gebruikt moeten worden buiten + deze API. + title: concept required: - - omschrijving - - omschrijvingGeneriek - - url - - zaaktype - - zaaktypeIdentificatie - StatusType: + - aanleiding + - beginGeldigheid + - besluittypen + - catalogus + - concept + - deelzaaktypen + - doel + - doorlooptijd + - eigenschappen + - gerelateerdeZaaktypen + - handelingBehandelaar + - handelingInitiator + - identificatie + - indicatieInternOfExtern + - informatieobjecttypen + - omschrijving + - onderwerp + - opschortingEnAanhoudingMogelijk + - productenOfDiensten + - publicatieIndicatie + - referentieproces + - resultaattypen + - roltypen + - statustypen + - url + - verantwoordelijke + - verlengingMogelijk + - versiedatum + - vertrouwelijkheidaanduiding + - zaakobjecttypen + ZaakTypeInformatieObjectType: type: object + description: |- + Represent a ZaakTypeInformatieObjectType. + + Relatie met informatieobjecttype dat relevant is voor zaaktype. properties: url: type: string format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 - omschrijving: - type: string - description: - Een korte, voor de initiator van de zaak relevante, omschrijving - van de aard van de STATUS van zaken van een ZAAKTYPE. - title: omschrijving - maxLength: 80 - omschrijvingGeneriek: - type: string - description: - Algemeen gehanteerde omschrijving van de aard van STATUSsen - van het STATUSTYPE - title: omschrijving generiek - maxLength: 80 - statustekst: - type: string - description: - De tekst die wordt gebruikt om de Initiator te informeren over - het bereiken van een STATUS van dit STATUSTYPE bij het desbetreffende - ZAAKTYPE. - title: statustekst - maxLength: 1000 zaaktype: type: string format: uri - description: - URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen - van dit STATUSTYPE bereikt kunnen worden. - title: Zaaktype + description: URL-referentie naar het ZAAKTYPE. + title: zaaktype + zaaktypeIdentificatie: + type: string + readOnly: true + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: zaaktype catalogus: type: string format: uri readOnly: true title: catalogus - zaaktypeIdentificatie: + informatieobjecttype: + type: string + format: uri + title: Informatie object type + description: URL-referentie naar het INFORMATIEOBJECTTYPE. + informatieobjecttypeOmschrijving: type: string readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: Zaaktype + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatie object type volgnummer: type: integer - maximum: 9999 + maximum: 999 minimum: 1 - description: - Een volgnummer voor statussen van het STATUSTYPE binnen een - zaak. - title: statustypevolgnummer - isEindstatus: - type: boolean - readOnly: true - description: - Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven - is afgeleid uit alle STATUSTYPEn van dit ZAAKTYPE met het hoogste volgnummer. - title: isEindstatus - informeren: - type: boolean - description: - "Aanduiding die aangeeft of na het zetten van een STATUS van\ - \ dit STATUSTYPE de Initiator moet worden ge\xEFnformeerd over de statusovergang." - title: informeren - doorlooptijd: - type: string - nullable: true - description: - De door de zaakbehandelende organisatie(s) gestelde norm voor - de doorlooptijd voor het bereiken van STATUSsen van dit STATUSTYPE bij - het desbetreffende ZAAKTYPE. - title: doorlooptijd status - format: duration - toelichting: - type: string - nullable: true - description: Een eventuele toelichting op dit STATUSTYPE. - title: toelichting - maxLength: 1000 - checklistitemStatustype: - type: array - items: - $ref: '#/components/schemas/CheckListItem' - title: checklistitem - eigenschappen: - type: array - items: - type: string - format: uri - nullable: true - title: '' - description: - de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen, - voordat een STATUS van dit STATUSTYPE kan worden gezet. - title: eigenschappen - uniqueItems: true - beginGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: - type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: - type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: - type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - required: - - catalogus - - isEindstatus - - omschrijving - - url - - volgnummer - - zaaktype - - zaaktypeIdentificatie - ValidatieFout: - type: object - description: Formaat van HTTP 4xx en 5xx fouten. - properties: - type: - type: string - description: URI referentie naar het type fout, bedoeld voor developers - title: type - code: - type: string - description: Systeemcode die het type fout aangeeft - title: code - title: - type: string - description: Generieke titel voor het type fout - title: title - status: - type: integer - description: De HTTP status code - title: status - detail: - type: string - description: Extra informatie bij de fout, indien beschikbaar - title: detail - instance: + description: Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het + ZAAKTYPE. + title: volgnummer + richting: + allOf: + - $ref: '#/components/schemas/RichtingEnum' + description: |- + Aanduiding van de richting van informatieobjecten van het gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. + + Uitleg bij mogelijke waarden: + + * `inkomend` - Inkomend + * `intern` - Intern + * `uitgaand` - Uitgaand + title: richting + statustype: type: string - description: - URI met referentie naar dit specifiek voorkomen van de fout. - Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. - title: instance - invalidParams: - type: array - items: - $ref: '#/components/schemas/FieldValidationError' - title: invalidParams + format: uri + nullable: true + title: Status type + description: URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn + verplicht aanwezig moeten zijn. required: - - code - - detail - - instance - - invalidParams - - status - - title - VertrouwelijkheidaanduidingEnum: - enum: - - openbaar - - beperkt_openbaar - - intern - - zaakvertrouwelijk - - vertrouwelijk - - confidentieel - - geheim - - zeer_geheim - type: string - ZaakObjectType: + - catalogus + - informatieobjecttype + - informatieobjecttypeOmschrijving + - richting + - url + - volgnummer + - zaaktype + - zaaktypeIdentificatie + ZaakTypeInformatieObjectTypeCreate: type: object + description: |- + Represent a ZaakTypeInformatieObjectType. + + Relatie met informatieobjecttype dat relevant is voor zaaktype. properties: url: type: string format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 - anderObjecttype: - type: boolean - description: - Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een - ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. - title: Ander objecttype - beginGeldigheid: + zaaktype: type: string - format: date - description: De datum waarop het is ontstaan. - title: datum begin geldigheid - eindeGeldigheid: + format: uri + description: URL-referentie naar het ZAAKTYPE. + title: zaaktype + zaaktypeIdentificatie: type: string - format: date - nullable: true - description: De datum waarop het is opgeheven. - title: datum einde geldigheid - beginObject: + readOnly: true + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + het ZAAKTYPE voorkomt. + title: zaaktype + catalogus: type: string - format: date - nullable: true - description: De datum waarop de eerst versie van het object ontstaan is. - title: datum begin object - eindeObject: + format: uri + readOnly: true + title: catalogus + informatieobjecttype: type: string - format: date - nullable: true - description: De datum van de aller laatste versie van het object. - title: datum einde object - objecttype: + description: '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten + waarin besluiten van dit BESLUITTYPE worden vastgelegd.' + title: informatie object type + informatieobjecttypeOmschrijving: + type: string + readOnly: true + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatie object type + volgnummer: + type: integer + maximum: 999 + minimum: 1 + description: Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het + ZAAKTYPE. + title: volgnummer + richting: + allOf: + - $ref: '#/components/schemas/RichtingEnum' + description: |- + Aanduiding van de richting van informatieobjecten van het gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. + + Uitleg bij mogelijke waarden: + + * `inkomend` - Inkomend + * `intern` - Intern + * `uitgaand` - Uitgaand + title: richting + statustype: type: string format: uri - description: - URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE - behoort. - title: Objecttype - maxLength: 200 - relatieOmschrijving: + nullable: true + title: Status type + description: URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn + verplicht aanwezig moeten zijn. + required: + - catalogus + - informatieobjecttype + - informatieobjecttypeOmschrijving + - richting + - url + - volgnummer + - zaaktype + - zaaktypeIdentificatie + ZaakTypeInformatieObjectTypeUpdate: + type: object + description: |- + Represent a ZaakTypeInformatieObjectType. + + Relatie met informatieobjecttype dat relevant is voor zaaktype. + properties: + url: type: string - description: - Omschrijving van de betrekking van het Objecttype op zaken - van het gerelateerde ZAAKTYPE. - title: Relatie omschrijving - maxLength: 80 + format: uri + readOnly: true + title: url + description: URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 zaaktype: type: string format: uri - description: - URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE - behoort. - title: Zaaktype + description: URL-referentie naar het ZAAKTYPE. + title: zaaktype zaaktypeIdentificatie: type: string readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. - title: Zaaktype - resultaattypen: - type: array - items: - type: string - format: uri - title: '' + title: zaaktype + catalogus: + type: string + format: uri readOnly: true - description: URL-referenties naar de RESULTAATTYPEN. - title: Zaakobjecttypen - uniqueItems: true - statustypen: - type: array - items: - type: string - format: uri - title: '' + title: catalogus + informatieobjecttype: + type: string + description: '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten + waarin besluiten van dit BESLUITTYPE worden vastgelegd.' + title: informatie object type + informatieobjecttypeOmschrijving: + type: string readOnly: true - description: URL-referenties naar de STATUSTYPEN. - title: Zaakobjecttypen - uniqueItems: true - catalogus: + description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. + title: informatie object type + volgnummer: + type: integer + maximum: 999 + minimum: 1 + description: Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het + ZAAKTYPE. + title: volgnummer + richting: + allOf: + - $ref: '#/components/schemas/RichtingEnum' + description: |- + Aanduiding van de richting van informatieobjecten van het gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. + + Uitleg bij mogelijke waarden: + + * `inkomend` - Inkomend + * `intern` - Intern + * `uitgaand` - Uitgaand + title: richting + statustype: type: string format: uri - description: - URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE - behoort. - title: Catalogus + nullable: true + title: Status type + description: URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn + verplicht aanwezig moeten zijn. required: - - anderObjecttype - - beginGeldigheid - - catalogus - - objecttype - - relatieOmschrijving - - resultaattypen - - statustypen - - url - - zaaktype - - zaaktypeIdentificatie - ZaakType: + - catalogus + - informatieobjecttype + - informatieobjecttypeOmschrijving + - richting + - url + - volgnummer + - zaaktype + - zaaktypeIdentificatie + ZaakTypeUpdate: type: object - description: 'Set gegevensgroepdata from validated nested data. - + description: |- + Set gegevensgroepdata from validated nested data. - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + Usage: include the mixin on the ModelSerializer that has gegevensgroepen. properties: url: type: string format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 identificatie: type: string - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin + description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: identificatie maxLength: 50 @@ -13812,105 +14520,86 @@ components: maxLength: 80 omschrijvingGeneriek: type: string - description: - Algemeen gehanteerde omschrijving van de aard van ZAAKen van + description: Algemeen gehanteerde omschrijving van de aard van ZAAKen van het ZAAKTYPE title: omschrijving generiek maxLength: 80 vertrouwelijkheidaanduiding: allOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - description: - 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van - dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het - aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde - gezet. - + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + description: |- + Aanduiding van de mate waarin zaakdossiers van ZAAKen van dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde gezet. Uitleg bij mogelijke waarden: - * `openbaar` - Openbaar - * `beperkt_openbaar` - Beperkt openbaar - * `intern` - Intern - * `zaakvertrouwelijk` - Zaakvertrouwelijk - * `vertrouwelijk` - Vertrouwelijk - * `confidentieel` - Confidentieel - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' + * `zeer_geheim` - Zeer geheim title: vertrouwelijkheidaanduiding doel: type: string - description: - Een omschrijving van hetgeen beoogd is te bereiken met een + description: Een omschrijving van hetgeen beoogd is te bereiken met een zaak van dit zaaktype. title: doel aanleiding: type: string - description: - Een omschrijving van de gebeurtenis die leidt tot het starten + description: Een omschrijving van de gebeurtenis die leidt tot het starten van een ZAAK van dit ZAAKTYPE. title: aanleiding toelichting: type: string - description: - Een eventuele toelichting op dit zaaktype, zoals een beschrijving + description: Een eventuele toelichting op dit zaaktype, zoals een beschrijving van het procesverloop op de hoofdlijnen. title: toelichting indicatieInternOfExtern: allOf: - - $ref: '#/components/schemas/IndicatieInternOfExternEnum' - description: - "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\ - \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\ - \ beide sprake kan zijn, dan prevaleert de externe initiatie.\n\nUitleg\ - \ bij mogelijke waarden:\n\n* `inkomend` - Inkomend\n* `intern` - Intern\n\ - * `uitgaand` - Uitgaand" + - $ref: '#/components/schemas/IndicatieInternOfExternEnum' + description: |- + Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn die Intern respectievelijk Extern geïnitieerd worden. Indien van beide sprake kan zijn, dan prevaleert de externe initiatie. + + Uitleg bij mogelijke waarden: + + * `inkomend` - Inkomend + * `intern` - Intern + * `uitgaand` - Uitgaand title: indicatie intern of extern handelingInitiator: type: string - description: - Werkwoord dat hoort bij de handeling die de initiator verricht + description: Werkwoord dat hoort bij de handeling die de initiator verricht bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator title: handeling initiator maxLength: 20 onderwerp: type: string - description: - "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen + description: 'Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus - (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'. - Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp" + (PDC). Bijvoorbeeld: ''Evenementenvergunning'', ''Geboorte'', ''Klacht''. + Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp' title: onderwerp maxLength: 80 handelingBehandelaar: type: string - description: - Werkwoord dat hoort bij de handeling die de behandelaar verricht + description: Werkwoord dat hoort bij de handeling die de behandelaar verricht bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar title: handeling behandelaar maxLength: 20 doorlooptijd: type: string - description: - De periode waarbinnen volgens wet- en regelgeving een ZAAK + description: De periode waarbinnen volgens wet- en regelgeving een ZAAK van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. title: doorlooptijd behandeling format: duration servicenorm: type: string nullable: true - description: - De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE + description: De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE afgerond wordt conform de geldende servicenormen van de zaakbehandelende organisatie(s). title: servicenorm behandeling @@ -13918,20 +14607,17 @@ components: opschortingEnAanhoudingMogelijk: type: boolean title: Opschorting/aanhouding mogelijk - description: - Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE + description: Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE kunnen worden opgeschort en/of aangehouden. verlengingMogelijk: type: boolean - description: - Aanduiding die aangeeft of de Doorlooptijd behandeling van + description: Aanduiding die aangeeft of de Doorlooptijd behandeling van ZAAKen van dit ZAAKTYPE kan worden verlengd. title: verlenging mogelijk verlengingstermijn: type: string nullable: true - description: - Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling + description: Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde bevatten als verlenging mogelijk is. title: verlengingstermijn @@ -13942,14 +14628,12 @@ components: type: string title: Trefwoord maxLength: 30 - description: - Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden + description: Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden gekarakteriseerd. title: trefwoorden publicatieIndicatie: type: boolean - description: - Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd + description: Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd moet worden. title: publicatie indicatie publicatietekst: @@ -13961,9 +14645,8 @@ components: items: type: string maxLength: 40 - description: - "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ - \ en/of financi\xEBle verantwoording." + description: De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige + en/of financiële verantwoording. title: verantwoordingsrelatie productenOfDiensten: type: array @@ -13972,28 +14655,25 @@ components: format: uri title: URL naar product/dienst maxLength: 1000 - description: - Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt + description: Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt voortgebracht. title: producten of diensten selectielijstProcestype: type: string format: uri - description: - URL-referentie naar een vanuit archiveringsoptiek onderkende + description: URL-referentie naar een vanuit archiveringsoptiek onderkende groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst API). title: selectielijst procestype maxLength: 200 referentieproces: allOf: - - $ref: '#/components/schemas/ReferentieProces' + - $ref: '#/components/schemas/ReferentieProces' description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. title: referentieproces verantwoordelijke: type: string - description: - De (soort) organisatorische eenheid of (functie van) medewerker + description: De (soort) organisatorische eenheid of (functie van) medewerker die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. title: verantwoordelijke maxLength: 50 @@ -14008,12 +14688,12 @@ components: uniqueItems: true broncatalogus: allOf: - - $ref: '#/components/schemas/BronCatalogus' + - $ref: '#/components/schemas/BronCatalogus' description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. title: broncatalogus bronzaaktype: allOf: - - $ref: '#/components/schemas/BronZaaktype' + - $ref: '#/components/schemas/BronZaaktype' description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. title: bronzaaktype catalogus: @@ -14028,8 +14708,7 @@ components: format: uri title: '' readOnly: true - description: - URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen + description: URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen dit ZAAKTYPE. title: Zaaktype uniqueItems: true @@ -14040,8 +14719,7 @@ components: format: uri title: '' readOnly: true - description: - URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen + description: URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen dit ZAAKTYPE. title: is relevant voor uniqueItems: true @@ -14052,8 +14730,7 @@ components: format: uri title: '' readOnly: true - description: - URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn + description: URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn in ZAKEN van dit ZAAKTYPE. title: Zaaktype uniqueItems: true @@ -14064,8 +14741,7 @@ components: format: uri title: '' readOnly: true - description: - URL-referenties naar de INFORMATIEOBJECTTYPEN die mogelijk + description: URL-referenties naar de INFORMATIEOBJECTTYPEN die mogelijk zijn binnen dit ZAAKTYPE. title: zaaktypen uniqueItems: true @@ -14076,8 +14752,7 @@ components: format: uri title: '' readOnly: true - description: - URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit + description: URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit ZAAKTYPE. title: Zaaktype uniqueItems: true @@ -14085,31 +14760,23 @@ components: type: array items: type: string - format: uri - title: heeft relevante besluittypen - title: heeft relevante besluittypen - description: - URL-referenties naar de BESLUITTYPEN die mogelijk zijn binnen - dit ZAAKTYPE. - uniqueItems: true + title: '' + description: '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen + dit ZAAKTYPE.' + title: zaaktypen deelzaaktypen: type: array items: type: string - format: uri - nullable: true title: '' - description: - De ZAAKTYPE(n) waaronder ZAAKen als deelzaak kunnen voorkomen - bij ZAAKen van dit ZAAKTYPE. + description: De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak + kunnen voorkomen bij ZAAKen van dit ZAAKTYPE. title: deelzaaktypen - uniqueItems: true gerelateerdeZaaktypen: type: array items: - $ref: '#/components/schemas/ZaakTypenRelatie' - description: - De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit + $ref: '#/components/schemas/ZaakTypenRelatieCreate' + description: De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit ZAAKTYPE. title: zaaktype van beginGeldigheid: @@ -14138,161 +14805,95 @@ components: versiedatum: type: string format: date - description: - De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE + description: De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE geldig zijn geworden title: versiedatum concept: type: boolean readOnly: true - description: - Geeft aan of het object een concept betreft. Concepten zijn + description: Geeft aan of het object een concept betreft. Concepten zijn niet-definitieve versies en zouden niet gebruikt moeten worden buiten deze API. title: concept required: - - aanleiding - - beginGeldigheid - - besluittypen - - catalogus - - concept - - doel - - doorlooptijd - - eigenschappen - - gerelateerdeZaaktypen - - handelingBehandelaar - - handelingInitiator - - identificatie - - indicatieInternOfExtern - - informatieobjecttypen - - omschrijving - - onderwerp - - opschortingEnAanhoudingMogelijk - - productenOfDiensten - - publicatieIndicatie - - referentieproces - - resultaattypen - - roltypen - - statustypen - - url - - verantwoordelijke - - verlengingMogelijk - - versiedatum - - vertrouwelijkheidaanduiding - - zaakobjecttypen - ZaakTypeInformatieObjectType: + - aanleiding + - beginGeldigheid + - besluittypen + - catalogus + - concept + - deelzaaktypen + - doel + - doorlooptijd + - eigenschappen + - gerelateerdeZaaktypen + - handelingBehandelaar + - handelingInitiator + - identificatie + - indicatieInternOfExtern + - informatieobjecttypen + - omschrijving + - onderwerp + - opschortingEnAanhoudingMogelijk + - productenOfDiensten + - publicatieIndicatie + - referentieproces + - resultaattypen + - roltypen + - statustypen + - url + - verantwoordelijke + - verlengingMogelijk + - versiedatum + - vertrouwelijkheidaanduiding + - zaakobjecttypen + ZaakTypenRelatie: type: object - description: 'Represent a ZaakTypeInformatieObjectType. - - - Relatie met informatieobjecttype dat relevant is voor zaaktype.' properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 zaaktype: type: string format: uri - description: URL-referentie naar het ZAAKTYPE. - title: zaaktype - zaaktypeIdentificatie: - type: string - readOnly: true - description: - Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin - het ZAAKTYPE voorkomt. - title: zaaktype - catalogus: - type: string - format: uri - readOnly: true - title: catalogus - informatieobjecttype: - type: string - format: uri - title: Informatie object type - description: URL-referentie naar het INFORMATIEOBJECTTYPE. - informatieobjecttypeOmschrijving: - type: string - readOnly: true - description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. - title: informatie object type - volgnummer: - type: integer - maximum: 999 - minimum: 1 - description: - Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het - ZAAKTYPE. - title: volgnummer - richting: + description: URL referentie naar het gerelateerde zaaktype, mogelijks in + een extern ZTC. + title: gerelateerd zaaktype + maxLength: 200 + aardRelatie: allOf: - - $ref: '#/components/schemas/RichtingEnum' - description: - 'Aanduiding van de richting van informatieobjecten van het - gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. - + - $ref: '#/components/schemas/AardRelatieEnum' + description: |- + Omschrijving van de aard van de relatie van zaken van het ZAAKTYPE tot zaken van het andere ZAAKTYPE Uitleg bij mogelijke waarden: - - * `inkomend` - Inkomend - - * `intern` - Intern - - * `uitgaand` - Uitgaand' - title: richting - statustype: + * `vervolg` - Vervolg + * `bijdrage` - Bijdrage + * `onderwerp` - Onderwerp + title: aard relatie + toelichting: type: string - format: uri - nullable: true - title: Status type - description: - URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn - verplicht aanwezig moeten zijn. + description: Een toelichting op de aard van de relatie tussen beide ZAAKTYPEN. + title: toelichting + maxLength: 255 required: - - catalogus - - informatieobjecttype - - informatieobjecttypeOmschrijving - - richting - - url - - volgnummer - - zaaktype - - zaaktypeIdentificatie - ZaakTypenRelatie: + - aardRelatie + - zaaktype + ZaakTypenRelatieCreate: type: object properties: zaaktype: type: string - format: uri - description: - URL referentie naar het gerelateerde zaaktype, mogelijks in - een extern ZTC. - title: gerelateerd zaaktype - maxLength: 200 + description: '`zaaktype.identificatie` naar het ZAAKTYPE.' + title: zaaktype van aardRelatie: allOf: - - $ref: '#/components/schemas/AardRelatieEnum' - description: - 'Omschrijving van de aard van de relatie van zaken van het - ZAAKTYPE tot zaken van het andere ZAAKTYPE - + - $ref: '#/components/schemas/AardRelatieEnum' + description: |- + Omschrijving van de aard van de relatie van zaken van het ZAAKTYPE tot zaken van het andere ZAAKTYPE Uitleg bij mogelijke waarden: - * `vervolg` - Vervolg - * `bijdrage` - Bijdrage - - * `onderwerp` - Onderwerp' + * `onderwerp` - Onderwerp title: aard relatie toelichting: type: string @@ -14300,61 +14901,52 @@ components: title: toelichting maxLength: 255 required: - - aardRelatie - - zaaktype + - aardRelatie + - zaaktype securitySchemes: JWT-Claims: type: http bearerFormat: JWT scheme: bearer servers: - - url: https://catalogi-api.vng.cloud/api/v1 - description: Productie Omgeving +- url: https://catalogi-api.vng.cloud/api/v1 + description: Productie Omgeving tags: - - name: besluittypen - description: - Opvragen en bewerken van BESLUITTYPEn nodig voor BESLUITEN in de Besluiten - API. Alle BESLUITTYPEn van de besluiten die het resultaat kunnen zijn van het - zaakgericht werken van de behandelende organisatie(s). - - name: catalogussen - description: - "Opvragen en bewerken van CATALOGUSsen. De verzameling van ZAAKTYPEn,\ - \ INFORMATIEOBJECTTYPEn en BESLUITTYPEn voor een domein die als \xE9\xE9n geheel\ - \ beheerd wordt." - - name: eigenschappen - description: - Opvragen en bewerken van EIGENSCHAPpen van een ZAAKTYPE. Een relevant - inhoudelijk gegeven dat bij ZAAKen van dit ZAAKTYPE geregistreerd moet kunnen - worden en geen standaard kenmerk is van een zaak. - - name: informatieobjecttypen - description: - Opvragen en bewerken van INFORMATIEOBJECTTYPEn nodig voor INFORMATIEOBJECTen - in de Documenten API. Een INFORMATIEOBJECTTYPE beschijft de karakteristieken van - een document of ander object dat informatie bevat. - - name: resultaattypen - description: - Opvragen en bewerken van RESULTAATTYPEn van een ZAAKTYPE. Het betreft - de indeling of groepering van resultaten van zaken van hetzelfde ZAAKTYPE naar - hun aard, zoals 'verleend', 'geweigerd', 'verwerkt', etc. - - name: roltypen - description: - Opvragen en bewerken van ROLTYPEn van een ZAAKTYPE. Generieke aanduiding - van de aard van een ROL die een BETROKKENE kan uitoefenen in ZAAKen van een ZAAKTYPE. - - name: statustypen - description: - Opvragen en bewerken van STATUSTYPEn van een ZAAKTYPE. Generieke aanduiding - van de aard van een status. - - name: zaakobjecttypen - description: - "Opvragen en bewerken van ZAAKOBJECTTYPEn. Er wordt gevalideerd op:\n\ - \ - `zaaktype` behoort tot dezelfde `catalogus`" - - name: zaaktype-informatieobjecttypen - description: - Opvragen en bewerken van ZAAKTYPE-INFORMATIEOBJECTTYPE relaties. Geeft - aan welke INFORMATIEOBJECTTYPEn binnen een ZAAKTYPE mogelijk zijn en hoe de richting - is. - - name: zaaktypen - description: - Opvragen en bewerken van ZAAKTYPEn nodig voor ZAKEN in de Zaken API.Een - ZAAKTYPE beschrijft het geheel van karakteristieke eigenschappen van zaken van - eenzelfde soort. +- name: besluittypen + description: Opvragen en bewerken van BESLUITTYPEn nodig voor BESLUITEN in de Besluiten + API. Alle BESLUITTYPEn van de besluiten die het resultaat kunnen zijn van het + zaakgericht werken van de behandelende organisatie(s). +- name: catalogussen + description: Opvragen en bewerken van CATALOGUSsen. De verzameling van ZAAKTYPEn, + INFORMATIEOBJECTTYPEn en BESLUITTYPEn voor een domein die als één geheel beheerd + wordt. +- name: eigenschappen + description: Opvragen en bewerken van EIGENSCHAPpen van een ZAAKTYPE. Een relevant + inhoudelijk gegeven dat bij ZAAKen van dit ZAAKTYPE geregistreerd moet kunnen + worden en geen standaard kenmerk is van een zaak. +- name: informatieobjecttypen + description: Opvragen en bewerken van INFORMATIEOBJECTTYPEn nodig voor INFORMATIEOBJECTen + in de Documenten API. Een INFORMATIEOBJECTTYPE beschijft de karakteristieken van + een document of ander object dat informatie bevat. +- name: resultaattypen + description: Opvragen en bewerken van RESULTAATTYPEn van een ZAAKTYPE. Het betreft + de indeling of groepering van resultaten van zaken van hetzelfde ZAAKTYPE naar + hun aard, zoals 'verleend', 'geweigerd', 'verwerkt', etc. +- name: roltypen + description: Opvragen en bewerken van ROLTYPEn van een ZAAKTYPE. Generieke aanduiding + van de aard van een ROL die een BETROKKENE kan uitoefenen in ZAAKen van een ZAAKTYPE. +- name: statustypen + description: Opvragen en bewerken van STATUSTYPEn van een ZAAKTYPE. Generieke aanduiding + van de aard van een status. +- name: zaakobjecttypen + description: |- + Opvragen en bewerken van ZAAKOBJECTTYPEn. Er wordt gevalideerd op: + - `zaaktype` behoort tot dezelfde `catalogus` +- name: zaaktype-informatieobjecttypen + description: Opvragen en bewerken van ZAAKTYPE-INFORMATIEOBJECTTYPE relaties. Geeft + aan welke INFORMATIEOBJECTTYPEn binnen een ZAAKTYPE mogelijk zijn en hoe de richting + is. +- name: zaaktypen + description: Opvragen en bewerken van ZAAKTYPEn nodig voor ZAKEN in de Zaken API.Een + ZAAKTYPE beschrijft het geheel van karakteristieke eigenschappen van zaken van + eenzelfde soort. diff --git a/src/ztc/__init__.py b/src/ztc/__init__.py index 224c37ae..84bce98b 100644 --- a/src/ztc/__init__.py +++ b/src/ztc/__init__.py @@ -6,7 +6,7 @@ import re from collections import namedtuple -__version__ = "1.2.1" +__version__ = "1.3.0-rc1" __author__ = "Maykin Media B.V., VNG Realisatie" __homepage__ = "https://github.com/VNG-Realisatie/zaaktypecataloguscomponent/" __docformat__ = "restructuredtext" diff --git a/src/ztc/api/serializers/besluittype.py b/src/ztc/api/serializers/besluittype.py index 7546b947..3a3712ad 100644 --- a/src/ztc/api/serializers/besluittype.py +++ b/src/ztc/api/serializers/besluittype.py @@ -1,15 +1,10 @@ from django.utils.translation import gettext as _ from rest_framework import serializers -from rest_framework.validators import UniqueTogetherValidator from ...datamodel.models import BesluitType from ..utils.validators import RelationCatalogValidator -from ..validators import ( - ConceptUpdateValidator, - M2MConceptCreateValidator, - M2MConceptUpdateValidator, -) +from ..validators import ConceptUpdateValidator class BesluitTypeSerializer(serializers.HyperlinkedModelSerializer): @@ -45,7 +40,11 @@ class Meta: "required": True, "allow_empty": True, }, - "zaaktypen": {"lookup_field": "uuid", "allow_empty": True}, + "zaaktypen": { + "lookup_field": "uuid", + "allow_empty": True, + "read_only": True, + }, "resultaattypen": { "lookup_field": "uuid", "read_only": True, @@ -78,12 +77,18 @@ class Meta: "vastgelegd_in", ) validators = [ - UniqueTogetherValidator( - queryset=BesluitType.objects.all(), fields=["catalogus", "omschrijving"] - ), RelationCatalogValidator("informatieobjecttypen"), RelationCatalogValidator("zaaktypen"), ConceptUpdateValidator(), - M2MConceptCreateValidator(["zaaktypen", "informatieobjecttypen"]), - M2MConceptUpdateValidator(["zaaktypen", "informatieobjecttypen"]), ] + + +class BesluitTypeCreateSerializer(BesluitTypeSerializer): + informatieobjecttypen = serializers.ListSerializer( + child=serializers.CharField(), + help_text="`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten van dit BESLUITTYPE worden vastgelegd.", + ) + + +class BesluitTypeUpdateSerializer(BesluitTypeCreateSerializer): + pass diff --git a/src/ztc/api/serializers/informatieobjecttype.py b/src/ztc/api/serializers/informatieobjecttype.py index 5df62ab8..09f08edb 100644 --- a/src/ztc/api/serializers/informatieobjecttype.py +++ b/src/ztc/api/serializers/informatieobjecttype.py @@ -1,7 +1,6 @@ from django.utils.translation import gettext as _ from rest_framework import serializers -from rest_framework.validators import UniqueTogetherValidator from vng_api_common.constants import VertrouwelijkheidsAanduiding from vng_api_common.serializers import add_choice_values_help_text @@ -9,11 +8,7 @@ InformatieObjectType, InformatieObjectTypeOmschrijvingGeneriek, ) -from ..validators import ( - ConceptUpdateValidator, - M2MConceptCreateValidator, - M2MConceptUpdateValidator, -) +from ..validators import ConceptUpdateValidator class InformatieObjectTypeOmschrijvingGeneriekSerializer(serializers.ModelSerializer): @@ -82,12 +77,6 @@ class Meta: ) validators = [ ConceptUpdateValidator(), - M2MConceptCreateValidator(["besluittypen", "zaaktypen"]), - M2MConceptUpdateValidator(["besluittypen", "zaaktypen"]), - UniqueTogetherValidator( - queryset=InformatieObjectType.objects.all(), - fields=["catalogus", "omschrijving"], - ), ] def __init__(self, *args, **kwargs): diff --git a/src/ztc/api/serializers/relatieklassen.py b/src/ztc/api/serializers/relatieklassen.py index d65a5d1e..7a406584 100644 --- a/src/ztc/api/serializers/relatieklassen.py +++ b/src/ztc/api/serializers/relatieklassen.py @@ -1,7 +1,6 @@ from django.utils.translation import ugettext_lazy as _ from rest_framework import serializers -from rest_framework.validators import UniqueTogetherValidator from vng_api_common.serializers import add_choice_values_help_text from ...datamodel.choices import RichtingChoices @@ -62,10 +61,6 @@ class Meta: } validators = [ ZaakInformatieObjectTypeCatalogusValidator(), - UniqueTogetherValidator( - queryset=ZaakInformatieobjectType.objects.all(), - fields=["zaaktype", "volgnummer"], - ), ] def __init__(self, *args, **kwargs): @@ -107,45 +102,15 @@ def validate(self, attrs): return validated_data -# class ZaakInformatieobjectTypeArchiefregimeSerializer(FlexFieldsSerializerMixin, SourceMappingSerializerMixin, -# NestedHyperlinkedModelSerializer): -# """ -# RSTIOTARC-basis -# -# Afwijkende archiveringskenmerken van informatieobjecten van een INFORMATIEOBJECTTYPE bij zaken van een ZAAKTYPE op -# grond van resultaten van een RESULTAATTYPE bij dat ZAAKTYPE. -# """ -# parent_lookup_kwargs = { -# 'catalogus_pk': 'zaak_informatieobject_type__zaaktype__catalogus__pk', -# 'zaaktype_pk': 'zaak_informatieobject_type__zaaktype__pk', -# } -# -# gerelateerde = NestedHyperlinkedRelatedField( -# read_only=True, -# source='zaak_informatieobject_type', -# view_name='api:informatieobjecttype-detail', -# parent_lookup_kwargs={ -# 'catalogus_pk': 'informatieobjecttype__catalogus__pk', -# 'pk': 'informatieobjecttype__pk' -# }, -# ) -# -# class Meta: -# model = ZaakInformatieobjectTypeArchiefregime -# ref_name = model.__name__ -# source_mapping = { -# 'rstzdt.selectielijstklasse': 'selectielijstklasse', -# 'rstzdt.archiefnominatie': 'archiefnominatie', -# 'rstzdt.archiefactietermijn': 'archiefactietermijn', -# } -# -# fields = ( -# 'url', -# 'gerelateerde', -# 'rstzdt.selectielijstklasse', -# 'rstzdt.archiefnominatie', -# 'rstzdt.archiefactietermijn', -# ) -# extra_kwargs = { -# 'url': {'view_name': 'api:rstiotarc-detail'}, -# } +class ZaakTypeInformatieObjectTypeCreateSerializer( + ZaakTypeInformatieObjectTypeSerializer +): + informatieobjecttype = serializers.CharField( + help_text="`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten van dit BESLUITTYPE worden vastgelegd." + ) + + +class ZaakTypeInformatieObjectTypeUpdateSerializer( + ZaakTypeInformatieObjectTypeCreateSerializer +): + pass diff --git a/src/ztc/api/serializers/resultaattype.py b/src/ztc/api/serializers/resultaattype.py index 54654c18..23605af1 100644 --- a/src/ztc/api/serializers/resultaattype.py +++ b/src/ztc/api/serializers/resultaattype.py @@ -167,3 +167,13 @@ def __init__(self, *args, **kwargs): self.fields["archiefnominatie"].help_text += "\n\n{}".format( value_display_mapping ) + + +class ResultaatTypeCreateSerializer(ResultaatTypeSerializer): + besluittypen = serializers.ListSerializer( + child=serializers.CharField(), help_text="" + ) + + +class ResultaatTypeUpdateSerializer(ResultaatTypeCreateSerializer): + pass diff --git a/src/ztc/api/serializers/zaken.py b/src/ztc/api/serializers/zaken.py index 6fec7ae3..c8782193 100644 --- a/src/ztc/api/serializers/zaken.py +++ b/src/ztc/api/serializers/zaken.py @@ -55,6 +55,12 @@ def __init__(self, *args, **kwargs): self.fields["aard_relatie"].help_text += f"\n\n{value_display_mapping}" +class ZaakTypenRelatieCreateSerializer(ZaakTypenRelatieSerializer): + zaaktype = serializers.CharField( + help_text=_("`zaaktype.identificatie` naar het ZAAKTYPE.") + ) + + class ZaakTypeSerializer( NestedGegevensGroepMixin, NestedCreateMixin, @@ -204,8 +210,6 @@ class Meta: ZaaktypeGeldigheidValidator(), RelationCatalogValidator("besluittypen"), ConceptUpdateValidator(), - M2MConceptCreateValidator(["besluittypen", "informatieobjecttypen"]), - M2MConceptUpdateValidator(["besluittypen", "informatieobjecttypen"]), DeelzaaktypeCatalogusValidator(), ] @@ -234,3 +238,23 @@ def validate(self, attrs): validated_data = super(ZaakTypeSerializer, self).validate(attrs) return validated_data + + +class ZaakTypeCreateSerializer(ZaakTypeSerializer): + besluittypen = serializers.ListSerializer( + child=serializers.CharField(), + help_text="`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen dit ZAAKTYPE.", + ) + deelzaaktypen = serializers.ListSerializer( + child=serializers.CharField(), + help_text="De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak kunnen voorkomen bij ZAAKen van dit ZAAKTYPE.", + ) + gerelateerde_zaaktypen = ZaakTypenRelatieCreateSerializer( + many=True, + source="zaaktypenrelaties", + help_text="De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit ZAAKTYPE.", + ) + + +class ZaakTypeUpdateSerializer(ZaakTypeCreateSerializer): + pass diff --git a/src/ztc/api/tests/test_api_strategy.py b/src/ztc/api/tests/test_api_strategy.py index daac0f20..defd7043 100644 --- a/src/ztc/api/tests/test_api_strategy.py +++ b/src/ztc/api/tests/test_api_strategy.py @@ -292,6 +292,7 @@ class UseJSONTests(APITestCase): def test_accept_and_return_json(self): """DSO: API-26 (accept and return JSON)""" response = self.client.get(self.catalogus_list_url) + self.assertEqual(response.status_code, 200) self.assertEqual(response["content-type"], "application/json") diff --git a/src/ztc/api/tests/test_besluittype.py b/src/ztc/api/tests/test_besluittype.py index af33e55f..c0acb58a 100644 --- a/src/ztc/api/tests/test_besluittype.py +++ b/src/ztc/api/tests/test_besluittype.py @@ -1,4 +1,4 @@ -from datetime import date, timedelta +from datetime import date from rest_framework import status from vng_api_common.tests import ( @@ -53,7 +53,9 @@ def test_get_list_default_definitief(self): def test_get_detail(self): """Retrieve the details of a single `BesluitType` object.""" - zaaktype = ZaakTypeFactory(catalogus=self.catalogus) + zaaktype = ZaakTypeFactory( + catalogus=self.catalogus, datum_begin_geldigheid="2018-01-01" + ) resultaattype = ResultaatTypeFactory(zaaktype=zaaktype) @@ -151,15 +153,15 @@ def test_create_besluittype(self): zaaktype = ZaakTypeFactory.create(catalogus=self.catalogus) zaaktype_url = reverse("zaaktype-detail", kwargs={"uuid": zaaktype.uuid}) informatieobjecttype = InformatieObjectTypeFactory.create( - catalogus=self.catalogus + catalogus=self.catalogus, omschrijving="test" ) informatieobjecttype_url = reverse( "informatieobjecttype-detail", kwargs={"uuid": informatieobjecttype.uuid} ) besluittype_list_url = reverse("besluittype-list") + data = { "catalogus": f"http://testserver{self.catalogus_detail_url}", - "zaaktypen": [f"http://testserver{zaaktype_url}"], "omschrijving": "test", "omschrijvingGeneriek": "", "besluitcategorie": "", @@ -168,7 +170,7 @@ def test_create_besluittype(self): "publicatietekst": "", "publicatietermijn": None, "toelichting": "", - "informatieobjecttypen": [f"http://testserver{informatieobjecttype_url}"], + "informatieobjecttypen": ["test"], "beginGeldigheid": "2019-01-01", } @@ -180,119 +182,17 @@ def test_create_besluittype(self): self.assertEqual(besluittype.omschrijving, "test") self.assertEqual(besluittype.catalogus, self.catalogus) - self.assertEqual(besluittype.zaaktypen.get(), zaaktype) self.assertEqual(besluittype.informatieobjecttypen.get(), informatieobjecttype) self.assertEqual(besluittype.concept, True) - def test_create_besluittype_fail_non_concept_zaaktypen(self): - zaaktype = ZaakTypeFactory.create(concept=False, catalogus=self.catalogus) - zaaktype_url = reverse("zaaktype-detail", kwargs={"uuid": zaaktype.uuid}) - informatieobjecttype = InformatieObjectTypeFactory.create( - catalogus=self.catalogus - ) - informatieobjecttype_url = reverse( - "informatieobjecttype-detail", kwargs={"uuid": informatieobjecttype.uuid} - ) - besluittype_list_url = reverse("besluittype-list") - data = { - "catalogus": f"http://testserver{self.catalogus_detail_url}", - "zaaktypen": [f"http://testserver{zaaktype_url}"], - "omschrijving": "test", - "omschrijvingGeneriek": "", - "besluitcategorie": "", - "reactietermijn": "P14D", - "publicatieIndicatie": True, - "publicatietekst": "", - "publicatietermijn": None, - "toelichting": "", - "informatieobjecttypen": [f"http://testserver{informatieobjecttype_url}"], - "beginGeldigheid": "2019-01-01", - } - - response = self.client.post(besluittype_list_url, data) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], M2MConceptCreateValidator.code) - - def test_create_besluittype_fail_non_concept_informatieobjecttypen(self): - zaaktype = ZaakTypeFactory.create(catalogus=self.catalogus) - zaaktype_url = reverse("zaaktype-detail", kwargs={"uuid": zaaktype.uuid}) - informatieobjecttype = InformatieObjectTypeFactory.create( - concept=False, catalogus=self.catalogus - ) - informatieobjecttype_url = reverse( - "informatieobjecttype-detail", kwargs={"uuid": informatieobjecttype.uuid} - ) - besluittype_list_url = reverse("besluittype-list") - data = { - "catalogus": f"http://testserver{self.catalogus_detail_url}", - "zaaktypen": [f"http://testserver{zaaktype_url}"], - "omschrijving": "test", - "omschrijvingGeneriek": "", - "besluitcategorie": "", - "reactietermijn": "P14D", - "publicatieIndicatie": True, - "publicatietekst": "", - "publicatietermijn": None, - "toelichting": "", - "informatieobjecttypen": [f"http://testserver{informatieobjecttype_url}"], - "beginGeldigheid": "2019-01-01", - } - - response = self.client.post(besluittype_list_url, data) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], M2MConceptCreateValidator.code) - - def test_create_besluittype_fail_different_catalogus_for_zaaktypen(self): - zaaktype = ZaakTypeFactory.create() - zaaktype_url = reverse("zaaktype-detail", kwargs={"uuid": zaaktype.uuid}) - informatieobjecttype = InformatieObjectTypeFactory.create( - catalogus=self.catalogus - ) - informatieobjecttype_url = reverse( - "informatieobjecttype-detail", kwargs={"uuid": informatieobjecttype.uuid} - ) - besluittype_list_url = reverse("besluittype-list") - data = { - "catalogus": f"http://testserver{self.catalogus_detail_url}", - "zaaktypen": [f"http://testserver{zaaktype_url}"], - "omschrijving": "test", - "omschrijvingGeneriek": "", - "besluitcategorie": "", - "reactietermijn": "P14D", - "publicatieIndicatie": True, - "publicatietekst": "", - "publicatietermijn": None, - "toelichting": "", - "informatieobjecttypen": [f"http://testserver{informatieobjecttype_url}"], - "beginGeldigheid": "2019-01-01", - } - - response = self.client.post(besluittype_list_url, data) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], "relations-incorrect-catalogus") - def test_create_besluittype_fail_different_catalogus_for_informatieobjecttypen( self, ): - zaaktype = ZaakTypeFactory.create(catalogus=self.catalogus) - zaaktype_url = reverse("zaaktype-detail", kwargs={"uuid": zaaktype.uuid}) informatieobjecttype = InformatieObjectTypeFactory.create() - informatieobjecttype_url = reverse( - "informatieobjecttype-detail", kwargs={"uuid": informatieobjecttype.uuid} - ) + besluittype_list_url = reverse("besluittype-list") data = { "catalogus": f"http://testserver{self.catalogus_detail_url}", - "zaaktypen": [f"http://testserver{zaaktype_url}"], "omschrijving": "test", "omschrijvingGeneriek": "", "besluitcategorie": "", @@ -301,7 +201,7 @@ def test_create_besluittype_fail_different_catalogus_for_informatieobjecttypen( "publicatietekst": "", "publicatietermijn": None, "toelichting": "", - "informatieobjecttypen": [f"http://testserver{informatieobjecttype_url}"], + "informatieobjecttypen": [informatieobjecttype.omschrijving], "beginGeldigheid": "2019-01-01", } @@ -506,84 +406,6 @@ def test_update_besluittype_not_related_to_non_concept_resource(self): self.assertEqual(response.data["toelichting"], "aangepast") besluittype.delete() - def test_update_besluittype_related_to_non_concept_resource_fails(self): - catalogus = CatalogusFactory.create() - zaaktype = ZaakTypeFactory.create(catalogus=catalogus, concept=False) - informatieobjecttype = InformatieObjectTypeFactory.create( - catalogus=catalogus, concept=False - ) - - for resource in ["zaaktypen", "informatieobjecttypen"]: - with self.subTest(resource=resource): - related = zaaktype if resource == "zaaktypen" else informatieobjecttype - besluittype = BesluitTypeFactory.create(**{resource: [related]}) - besluittype_url = reverse( - "besluittype-detail", kwargs={"uuid": besluittype.uuid} - ) - - data = { - "catalogus": reverse(catalogus), - "zaaktypen": [], - "omschrijving": "test", - "omschrijvingGeneriek": "", - "besluitcategorie": "", - "reactietermijn": "P14D", - "publicatieIndicatie": True, - "publicatietekst": "", - "publicatietermijn": None, - "toelichting": "aangepast", - "informatieobjecttypen": [], - "beginGeldigheid": "2019-01-01", - } - data[resource] = [reverse(related)] - - response = self.client.put(besluittype_url, data) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], M2MConceptUpdateValidator.code) - besluittype.delete() - - def test_update_besluittype_add_relation_to_non_concept_resource_fails(self): - catalogus = CatalogusFactory.create() - zaaktype = ZaakTypeFactory.create(catalogus=catalogus, concept=False) - informatieobjecttype = InformatieObjectTypeFactory.create( - catalogus=catalogus, concept=False - ) - - for resource in ["zaaktypen", "informatieobjecttypen"]: - with self.subTest(resource=resource): - related = zaaktype if resource == "zaaktypen" else informatieobjecttype - besluittype = BesluitTypeFactory.create() - besluittype_url = reverse( - "besluittype-detail", kwargs={"uuid": besluittype.uuid} - ) - - data = { - "catalogus": reverse(catalogus), - "zaaktypen": [], - "omschrijving": "test", - "omschrijvingGeneriek": "", - "besluitcategorie": "", - "reactietermijn": "P14D", - "publicatieIndicatie": True, - "publicatietekst": "", - "publicatietermijn": None, - "toelichting": "aangepast", - "informatieobjecttypen": [], - "beginGeldigheid": "2019-01-01", - } - data[resource] = [reverse(related)] - - response = self.client.put(besluittype_url, data) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], M2MConceptUpdateValidator.code) - besluittype.delete() - def test_partial_update_besluittype_not_related_to_non_concept_resource(self): catalogus = CatalogusFactory.create() zaaktype = ZaakTypeFactory.create(catalogus=catalogus) @@ -607,60 +429,6 @@ def test_partial_update_besluittype_not_related_to_non_concept_resource(self): self.assertEqual(response.data["toelichting"], "aangepast") besluittype.delete() - def test_partial_update_besluittype_related_to_non_concept_resource_fails(self): - catalogus = CatalogusFactory.create() - zaaktype = ZaakTypeFactory.create(catalogus=catalogus, concept=False) - informatieobjecttype = InformatieObjectTypeFactory.create( - catalogus=catalogus, concept=False - ) - - for resource in ["zaaktypen", "informatieobjecttypen"]: - with self.subTest(resource=resource): - related = zaaktype if resource == "zaaktypen" else informatieobjecttype - besluittype = BesluitTypeFactory.create( - catalogus=catalogus, **{resource: [related]} - ) - besluittype_url = reverse( - "besluittype-detail", kwargs={"uuid": besluittype.uuid} - ) - - response = self.client.patch( - besluittype_url, {"toelichting": "aangepast"} - ) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], M2MConceptUpdateValidator.code) - besluittype.delete() - - def test_partial_update_besluittype_add_relation_to_non_concept_resource_fails( - self, - ): - catalogus = CatalogusFactory.create() - zaaktype = ZaakTypeFactory.create(catalogus=catalogus, concept=False) - informatieobjecttype = InformatieObjectTypeFactory.create( - catalogus=catalogus, concept=False - ) - - for resource in ["zaaktypen", "informatieobjecttypen"]: - with self.subTest(resource=resource): - related = zaaktype if resource == "zaaktypen" else informatieobjecttype - besluittype = BesluitTypeFactory.create(catalogus=catalogus) - besluittype_url = reverse( - "besluittype-detail", kwargs={"uuid": besluittype.uuid} - ) - - response = self.client.patch( - besluittype_url, {resource: [reverse(related)]} - ) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], M2MConceptUpdateValidator.code) - besluittype.delete() - def test_partial_update_non_concept_besluittype_einde_geldigheid(self): besluittype = BesluitTypeFactory.create() besluittype_url = reverse(besluittype) @@ -890,41 +658,11 @@ def test_pagination_page_param(self): self.assertIsNone(response_data["next"]) -class BesluitTypeValidationTests(APITestCase): - maxDiff = None - - def test_besluittype_unique_catalogus_omschrijving_combination(self): - besluittype1 = BesluitTypeFactory(catalogus=self.catalogus, omschrijving="test") - besluittype_list_url = reverse("besluittype-list") - data = { - "catalogus": f"http://testserver{self.catalogus_detail_url}", - "zaaktypen": [], - "omschrijving": "test", - "omschrijvingGeneriek": "", - "besluitcategorie": "", - "reactietermijn": "P14D", - "publicatieIndicatie": True, - "publicatietekst": "", - "publicatietermijn": None, - "toelichting": "", - "informatieobjecttypen": [], - "beginGeldigheid": "2019-01-01", - } - - response = self.client.post(besluittype_list_url, data) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], "unique") - - class BesluitTypeScopeTests(APITestCase, JWTAuthMixin): heeft_alle_autorisaties = False scopes = [SCOPE_CATALOGI_FORCED_WRITE] def test_update_besluittype_not_concept_with_forced_scope(self): - besluittype = BesluitTypeFactory.create(concept=False) besluittype_url = reverse( "besluittype-detail", kwargs={"uuid": besluittype.uuid} diff --git a/src/ztc/api/tests/test_informatieobjecttype.py b/src/ztc/api/tests/test_informatieobjecttype.py index a6d20f02..76d89e28 100644 --- a/src/ztc/api/tests/test_informatieobjecttype.py +++ b/src/ztc/api/tests/test_informatieobjecttype.py @@ -1,4 +1,3 @@ -from datetime import date, datetime, timedelta from unittest import skip from django.urls import reverse @@ -164,24 +163,6 @@ def test_create_informatieobjecttype(self): self.assertEqual(informatieobjecttype.catalogus, self.catalogus) self.assertEqual(informatieobjecttype.concept, True) - def test_create_informatieobjecttype_fail_not_unique(self): - informatieobjecttype = InformatieObjectTypeFactory.create() - list_url = get_operation_url("informatieobjecttype_list") - data = { - "catalogus": f"http://testserver{reverse(informatieobjecttype.catalogus)}", - "omschrijving": informatieobjecttype.omschrijving, - "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar, - "beginGeldigheid": "2019-01-01", - "informatieobjectcategorie": "test", - } - - response = self.client.post(list_url, data) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], "unique") - def test_publish_informatieobjecttype(self): informatieobjecttype = InformatieObjectTypeFactory.create() informatieobjecttypee_url = get_operation_url( @@ -394,61 +375,6 @@ def test_update_informatieobjecttype_not_related_to_non_concept_besluittype(self self.assertEqual(response.data["omschrijving"], "test") informatieobjecttype.delete() - def test_update_informatieobjecttype_related_to_non_concept_zaaktype_fails(self): - catalogus = CatalogusFactory.create() - informatieobjecttype = InformatieObjectTypeFactory.create(catalogus=catalogus) - - zaaktype = ZaakTypeFactory.create(concept=False, catalogus=catalogus) - ZaakInformatieobjectTypeFactory( - zaaktype=zaaktype, informatieobjecttype=informatieobjecttype - ) - - informatieobjecttype_url = reverse(informatieobjecttype) - - data = { - "catalogus": f"http://testserver{self.catalogus_detail_url}", - "omschrijving": "test", - "vertrouwelijkheidaanduiding": "openbaar", - "beginGeldigheid": "2019-01-01", - "informatieobjectcategorie": "test", - } - - response = self.client.put(informatieobjecttype_url, data) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], M2MConceptUpdateValidator.code) - informatieobjecttype.delete() - - def test_update_informatieobjecttype_related_to_non_concept_besluittype_fails(self): - catalogus = CatalogusFactory.create() - informatieobjecttype = InformatieObjectTypeFactory.create(catalogus=catalogus) - - besluittype = BesluitTypeFactory.create( - informatieobjecttypen=[informatieobjecttype], - concept=False, - catalogus=catalogus, - ) - - informatieobjecttype_url = reverse(informatieobjecttype) - - data = { - "catalogus": f"http://testserver{self.catalogus_detail_url}", - "omschrijving": "test", - "vertrouwelijkheidaanduiding": "openbaar", - "beginGeldigheid": "2019-01-01", - "informatieobjectcategorie": "test", - } - - response = self.client.put(informatieobjecttype_url, data) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], M2MConceptUpdateValidator.code) - informatieobjecttype.delete() - def test_partial_update_informatieobjecttype_not_related_to_non_concept_zaaktype( self, ): @@ -486,51 +412,6 @@ def test_partial_update_informatieobjecttype_not_related_to_non_concept_besluitt self.assertEqual(response.data["omschrijving"], "test") informatieobjecttype.delete() - def test_partial_update_informatieobjecttype_related_to_non_concept_zaaktype_fails( - self, - ): - catalogus = CatalogusFactory.create() - informatieobjecttype = InformatieObjectTypeFactory.create(catalogus=catalogus) - zaaktype = ZaakTypeFactory.create(catalogus=catalogus, concept=False) - ZaakInformatieobjectTypeFactory( - zaaktype=zaaktype, informatieobjecttype=informatieobjecttype - ) - - informatieobjecttype_url = reverse(informatieobjecttype) - - response = self.client.patch( - informatieobjecttype_url, {"omschrijving": "aangepast"} - ) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], M2MConceptUpdateValidator.code) - informatieobjecttype.delete() - - def test_partial_update_informatieobjecttype_related_to_non_concept_besluittype_fails( - self, - ): - catalogus = CatalogusFactory.create() - informatieobjecttype = InformatieObjectTypeFactory.create(catalogus=catalogus) - besluittype = BesluitTypeFactory.create( - informatieobjecttypen=[informatieobjecttype], - catalogus=catalogus, - concept=False, - ) - - informatieobjecttype_url = reverse(informatieobjecttype) - - response = self.client.patch( - informatieobjecttype_url, {"omschrijving": "aangepast"} - ) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], M2MConceptUpdateValidator.code) - informatieobjecttype.delete() - def test_partial_update_non_concept_informatieobjecttype_einde_geldigheid(self): informatieobjecttype = InformatieObjectTypeFactory.create() informatieobjecttype_url = reverse(informatieobjecttype) diff --git a/src/ztc/api/tests/test_relatieklassen.py b/src/ztc/api/tests/test_relatieklassen.py index e277bc78..43f73411 100644 --- a/src/ztc/api/tests/test_relatieklassen.py +++ b/src/ztc/api/tests/test_relatieklassen.py @@ -82,12 +82,15 @@ def test_create_ziot(self): zaaktype = ZaakTypeFactory.create() zaaktype_url = reverse(zaaktype) informatieobjecttype = InformatieObjectTypeFactory.create( - catalogus=zaaktype.catalogus + catalogus=zaaktype.catalogus, omschrijving="test" + ) + informatieobjecttype2 = InformatieObjectTypeFactory.create( + catalogus=zaaktype.catalogus, omschrijving="test" ) informatieobjecttype_url = reverse(informatieobjecttype) data = { "zaaktype": f"http://testserver{zaaktype_url}", - "informatieobjecttype": f"http://testserver{informatieobjecttype_url}", + "informatieobjecttype": "test", "volgnummer": 13, "richting": RichtingChoices.inkomend, } @@ -96,7 +99,7 @@ def test_create_ziot(self): self.assertEqual(response.status_code, status.HTTP_201_CREATED) - ziot = ZaakInformatieobjectType.objects.get(volgnummer=13) + ziot = ZaakInformatieobjectType.objects.filter(volgnummer=13)[0] self.assertEqual(ziot.zaaktype, zaaktype) self.assertEqual(ziot.informatieobjecttype, informatieobjecttype) @@ -105,12 +108,12 @@ def test_create_ziot_not_concept_zaaktype(self): zaaktype = ZaakTypeFactory.create(concept=False) zaaktype_url = reverse(zaaktype) informatieobjecttype = InformatieObjectTypeFactory.create( - catalogus=zaaktype.catalogus + catalogus=zaaktype.catalogus, omschrijving="test" ) informatieobjecttype_url = reverse(informatieobjecttype) data = { "zaaktype": f"http://testserver{zaaktype_url}", - "informatieobjecttype": f"http://testserver{informatieobjecttype_url}", + "informatieobjecttype": "test", "volgnummer": 13, "richting": RichtingChoices.inkomend, } @@ -123,12 +126,12 @@ def test_create_ziot_not_concept_informatieobjecttype(self): zaaktype = ZaakTypeFactory.create() zaaktype_url = reverse(zaaktype) informatieobjecttype = InformatieObjectTypeFactory.create( - concept=False, catalogus=zaaktype.catalogus + concept=False, catalogus=zaaktype.catalogus, omschrijving="test" ) informatieobjecttype_url = reverse(informatieobjecttype) data = { "zaaktype": f"http://testserver{zaaktype_url}", - "informatieobjecttype": f"http://testserver{informatieobjecttype_url}", + "informatieobjecttype": "test", "volgnummer": 13, "richting": RichtingChoices.inkomend, } @@ -141,12 +144,12 @@ def test_create_ziot_fail_not_concept_zaaktype_and_informatieobjecttype(self): zaaktype = ZaakTypeFactory.create(concept=False) zaaktype_url = reverse(zaaktype) informatieobjecttype = InformatieObjectTypeFactory.create( - concept=False, catalogus=zaaktype.catalogus + concept=False, catalogus=zaaktype.catalogus, omschrijving="test" ) informatieobjecttype_url = reverse(informatieobjecttype) data = { "zaaktype": f"http://testserver{zaaktype_url}", - "informatieobjecttype": f"http://testserver{informatieobjecttype_url}", + "informatieobjecttype": "test", "volgnummer": 13, "richting": RichtingChoices.inkomend, } @@ -161,11 +164,13 @@ def test_create_ziot_fail_not_concept_zaaktype_and_informatieobjecttype(self): def test_create_ziot_fail_catalogus_mismatch(self): zaaktype = ZaakTypeFactory.create() zaaktype_url = reverse(zaaktype) - informatieobjecttype = InformatieObjectTypeFactory.create(concept=False) + informatieobjecttype = InformatieObjectTypeFactory.create( + concept=False, omschrijving="test" + ) # todo make ticket omschrijving/identficatie verplicht veld informatieobjecttype_url = reverse(informatieobjecttype) data = { "zaaktype": f"http://testserver{zaaktype_url}", - "informatieobjecttype": f"http://testserver{informatieobjecttype_url}", + "informatieobjecttype": "test", "volgnummer": 13, "richting": RichtingChoices.inkomend, } @@ -177,25 +182,6 @@ def test_create_ziot_fail_catalogus_mismatch(self): error = get_validation_errors(response, "nonFieldErrors") self.assertEqual(error["code"], "relations-incorrect-catalogus") - def test_create_ziot_fail_not_unique(self): - ziot = ZaakInformatieobjectTypeFactory(volgnummer=1) - informatieobjecttype = InformatieObjectTypeFactory.create( - catalogus=ziot.zaaktype.catalogus - ) - data = { - "zaaktype": f"http://testserver.com{reverse(ziot.zaaktype)}", - "informatieobjecttype": f"http://testserver.com{reverse(informatieobjecttype)}", - "volgnummer": ziot.volgnummer, - "richting": RichtingChoices.inkomend, - } - - response = self.client.post(self.list_url, data) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], "unique") - def test_delete_ziot(self): ziot = ZaakInformatieobjectTypeFactory.create() ziot_url = reverse(ziot) @@ -242,46 +228,73 @@ def test_update_ziot(self): zaaktype = ZaakTypeFactory.create() zaaktype_url = reverse(zaaktype) informatieobjecttype = InformatieObjectTypeFactory.create( - catalogus=zaaktype.catalogus + catalogus=zaaktype.catalogus, omschrijving="test" + ) + informatieobjecttype2 = InformatieObjectTypeFactory.create( + catalogus=zaaktype.catalogus, omschrijving="test" ) - informatieobjecttype_url = reverse(informatieobjecttype) ziot = ZaakInformatieobjectTypeFactory.create( zaaktype=zaaktype, informatieobjecttype=informatieobjecttype ) + ziot2 = ZaakInformatieobjectTypeFactory.create( + zaaktype=zaaktype, informatieobjecttype=informatieobjecttype2 + ) ziot_url = reverse(ziot) data = { "zaaktype": f"http://testserver{zaaktype_url}", - "informatieobjecttype": f"http://testserver{informatieobjecttype_url}", + "informatieobjecttype": f"test", "volgnummer": 13, "richting": RichtingChoices.inkomend, } + self.assertNotEqual(ziot.volgnummer, 13) + self.assertNotEqual(ziot2.volgnummer, 13) + response = self.client.put(ziot_url, data) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual(response.data["volgnummer"], 13) ziot.refresh_from_db() + ziot2.refresh_from_db() + self.assertEqual(ziot.volgnummer, 13) + self.assertEqual(ziot2.volgnummer, 13) def test_partial_update_ziot(self): zaaktype = ZaakTypeFactory.create() informatieobjecttype = InformatieObjectTypeFactory.create( - catalogus=zaaktype.catalogus + catalogus=zaaktype.catalogus, omschrijving="test" + ) + + informatieobjecttype2 = InformatieObjectTypeFactory.create( + catalogus=zaaktype.catalogus, omschrijving="test" ) + for item in ZaakInformatieobjectType.objects.all(): + item.delete() + ziot = ZaakInformatieobjectTypeFactory.create( zaaktype=zaaktype, informatieobjecttype=informatieobjecttype ) + ziot2 = ZaakInformatieobjectTypeFactory.create( + zaaktype=zaaktype, informatieobjecttype=informatieobjecttype2 + ) ziot_url = reverse(ziot) + self.assertNotEqual(ziot.volgnummer, 12) + self.assertNotEqual(ziot2.volgnummer, 12) + response = self.client.patch(ziot_url, {"volgnummer": 12}) self.assertEqual(response.status_code, status.HTTP_200_OK) self.assertEqual(response.data["volgnummer"], 12) ziot.refresh_from_db() + ziot2.refresh_from_db() + self.assertEqual(ziot.volgnummer, 12) + self.assertEqual(ziot2.volgnummer, 12) def test_partial_update_ziot_informatieobjecttype(self): zaaktype = ZaakTypeFactory.create() @@ -403,12 +416,13 @@ def test_partial_update_ziot_not_concept_informatieobjecttype(self): zaaktype = ZaakTypeFactory.create() zaaktype_url = reverse(zaaktype) informatieobjecttype = InformatieObjectTypeFactory.create( - catalogus=zaaktype.catalogus, concept=False + catalogus=zaaktype.catalogus, concept=False, omschrijving="test" ) informatieobjecttype_url = reverse(informatieobjecttype) ziot = ZaakInformatieobjectTypeFactory.create( zaaktype=zaaktype, informatieobjecttype=informatieobjecttype ) + ziot_url = reverse(ziot) response = self.client.patch(ziot_url, {"volgnummer": 12}) @@ -729,12 +743,12 @@ def test_create_ziot_not_concept_zaaktype_and_informatieobjecttype(self): zaaktype = ZaakTypeFactory.create(concept=False) zaaktype_url = reverse(zaaktype) informatieobjecttype = InformatieObjectTypeFactory.create( - catalogus=zaaktype.catalogus, concept=False + catalogus=zaaktype.catalogus, concept=False, omschrijving="test" ) informatieobjecttype_url = reverse(informatieobjecttype) data = { "zaaktype": f"http://testserver{zaaktype_url}", - "informatieobjecttype": f"http://testserver{informatieobjecttype_url}", + "informatieobjecttype": "test", "volgnummer": 13, "richting": RichtingChoices.inkomend, } diff --git a/src/ztc/api/tests/test_resultaattype.py b/src/ztc/api/tests/test_resultaattype.py index eadcdbe0..a34fcf0c 100644 --- a/src/ztc/api/tests/test_resultaattype.py +++ b/src/ztc/api/tests/test_resultaattype.py @@ -227,6 +227,13 @@ def test_create_resultaattype(self, mock_shape, mock_fetch): zaaktype = ZaakTypeFactory.create(selectielijst_procestype=PROCESTYPE_URL) zaaktype_url = reverse("zaaktype-detail", kwargs={"uuid": zaaktype.uuid}) resultaattypeomschrijving_url = "http://example.com/omschrijving/1" + besluittype = BesluitTypeFactory( + catalogus=self.catalogus, + omschrijving="foobarios", + datum_begin_geldigheid="2021-10-30", + datum_einde_geldigheid="2022-10-31", + ) + data = { "zaaktype": f"http://testserver{zaaktype_url}", "omschrijving": "illum", @@ -234,6 +241,8 @@ def test_create_resultaattype(self, mock_shape, mock_fetch): "selectielijstklasse": SELECTIELIJSTKLASSE_URL, "archiefnominatie": "blijvend_bewaren", "archiefactietermijn": "P10Y", + "beginGeldigheid": "2021-10-30", + "eindeGeldigheid": "2021-10-31", "brondatumArchiefprocedure": { "afleidingswijze": Afleidingswijze.afgehandeld, "einddatumBekend": False, @@ -242,7 +251,7 @@ def test_create_resultaattype(self, mock_shape, mock_fetch): "objecttype": "", "registratie": "", }, - "besluittype_omschrijving": ["foobar", "foobar2"], + "besluittypen": [f"{besluittype.omschrijving}"], } responses = { @@ -258,15 +267,20 @@ def test_create_resultaattype(self, mock_shape, mock_fetch): m.register_uri( "GET", resultaattypeomschrijving_url, json={"omschrijving": "test"} ) - response = self.client.post(self.list_url, data) + response = self.client.post( + self.list_url, data, SERVER_NAME="testserver.com" + ) self.assertEqual(response.status_code, status.HTTP_201_CREATED) - resultaattype = ResultaatType.objects.get() - self.assertEqual(resultaattype.omschrijving_generiek, "test") - self.assertEqual(resultaattype.zaaktype, zaaktype) + resultaattype = response.json() + + self.assertEqual(resultaattype["omschrijvingGeneriek"], "test") self.assertEqual( - resultaattype.brondatum_archiefprocedure_afleidingswijze, + resultaattype["zaaktype"], f"http://testserver.com{zaaktype_url}" + ) + self.assertEqual( + resultaattype["brondatumArchiefprocedure"]["afleidingswijze"], Afleidingswijze.afgehandeld, ) diff --git a/src/ztc/api/tests/test_zaken.py b/src/ztc/api/tests/test_zaken.py index 8094e0be..a94ce84c 100644 --- a/src/ztc/api/tests/test_zaken.py +++ b/src/ztc/api/tests/test_zaken.py @@ -1,5 +1,5 @@ import uuid -from datetime import date, datetime, timedelta +from datetime import date from django.test import override_settings from django.urls import reverse as django_reverse @@ -24,17 +24,13 @@ from ztc.datamodel.tests.factories import ( BesluitTypeFactory, CatalogusFactory, - EigenschapFactory, InformatieObjectTypeFactory, - ResultaatTypeFactory, - StatusTypeFactory, ZaakInformatieobjectTypeFactory, ZaakTypeFactory, ZaakTypenRelatieFactory, ) from ztc.datamodel.tests.factories.zaakobjecttype import ZaakObjectTypeFactory -from ...datamodel.tests.factories import RolTypeFactory from ..scopes import ( SCOPE_CATALOGI_FORCED_WRITE, SCOPE_CATALOGI_READ, @@ -53,8 +49,8 @@ def test_get_list_default_definitief(self): zaaktype2 = ZaakTypeFactory.create(concept=False) zaaktypen_list_url = get_operation_url("zaaktype_list") zaaktype2_url = get_operation_url("zaaktype_retrieve", uuid=zaaktype2.uuid) - response = self.client.get(zaaktypen_list_url) + self.assertEqual(response.status_code, 200) data = response.json()["results"] @@ -168,13 +164,35 @@ def test_get_detail_404(self): ) def test_create_zaaktype(self): - besluittype = BesluitTypeFactory.create(catalogus=self.catalogus) + besluittype = BesluitTypeFactory.create( + catalogus=self.catalogus, + omschrijving="test", + datum_begin_geldigheid="2018-01-01", + datum_einde_geldigheid="2018-01-02", + ) + besluittype2 = BesluitTypeFactory.create( + catalogus=self.catalogus, + omschrijving="test", + datum_begin_geldigheid="2018-01-03", + datum_einde_geldigheid=None, + ) + besluittype_url = get_operation_url( "besluittype_retrieve", uuid=besluittype.uuid ) - deelzaaktype1 = ZaakTypeFactory.create(catalogus=self.catalogus, concept=False) - deelzaaktype2 = ZaakTypeFactory.create(catalogus=self.catalogus, concept=True) + besluittype.zaaktypen.through.objects.all()[0].delete() + besluittype.zaaktypen.through.objects.all()[0].delete() + + deelzaaktype1 = ZaakTypeFactory.create( + catalogus=self.catalogus, concept=False, identificatie="test1" + ) + deelzaaktype2 = ZaakTypeFactory.create( + catalogus=self.catalogus, concept=True, identificatie="test1" + ) + deelzaaktype3 = ZaakTypeFactory.create( + catalogus=self.catalogus, concept=False, identificatie="test2" + ) zaaktype_list_url = get_operation_url("zaaktype_list") data = { @@ -195,41 +213,56 @@ def test_create_zaaktype(self): "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar, "omschrijving": "some test", "deelzaaktypen": [ - f"http://testserver{reverse(deelzaaktype1)}", - f"http://testserver{reverse(deelzaaktype2)}", + "test1", + "test2", ], "gerelateerdeZaaktypen": [ { - "zaaktype": "http://example.com/zaaktype/1", + "zaaktype": "test1", "aard_relatie": AardRelatieChoices.bijdrage, "toelichting": "test relations", } ], "referentieproces": {"naam": "ReferentieProces 0", "link": ""}, "catalogus": f"http://testserver{self.catalogus_detail_url}", - "besluittypen": [f"http://testserver{besluittype_url}"], + "besluittypen": ["test", "test2"], "beginGeldigheid": "2018-01-01", "versiedatum": "2018-01-01", "verantwoordelijke": "Organisatie eenheid X", } - response = self.client.post(zaaktype_list_url, data) + response = self.client.post( + zaaktype_list_url, data, SERVER_NAME="testserver.com" + ) self.assertEqual(response.status_code, status.HTTP_201_CREATED) zaaktype = ZaakType.objects.get(zaaktype_omschrijving="some test") self.assertEqual(zaaktype.catalogus, self.catalogus) - self.assertEqual(zaaktype.besluittypen.get(), besluittype) self.assertEqual(zaaktype.referentieproces_naam, "ReferentieProces 0") + + self.assertEqual(len(zaaktype.zaaktypenrelaties.all()), 2) + self.assertEqual( - zaaktype.zaaktypenrelaties.get().gerelateerd_zaaktype, - "http://example.com/zaaktype/1", + sorted( + [ + zaaktype.zaaktypenrelaties.all()[0].gerelateerd_zaaktype, + zaaktype.zaaktypenrelaties.all()[1].gerelateerd_zaaktype, + ] + ), + sorted( + [ + f"http://testserver.com{reverse(deelzaaktype1)}", + f"http://testserver.com{reverse(deelzaaktype2)}", + ] + ), ) + self.assertEqual(zaaktype.concept, True) self.assertQuerysetEqual( zaaktype.deelzaaktypen.all(), - {deelzaaktype1.pk, deelzaaktype2.pk}, + {deelzaaktype1.pk, deelzaaktype2.pk, deelzaaktype3.pk}, transform=lambda x: x.pk, ordered=False, ) @@ -282,52 +315,6 @@ def test_create_zaaktype_fails_no_identificatie(self): self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) self.assertEqual(response.json()["invalidParams"][0]["code"], "required") - def test_create_zaaktype_fail_besluittype_non_concept(self): - besluittype = BesluitTypeFactory.create(concept=False, catalogus=self.catalogus) - besluittype_url = get_operation_url( - "besluittype_retrieve", uuid=besluittype.uuid - ) - - zaaktype_list_url = get_operation_url("zaaktype_list") - data = { - "identificatie": 0, - "doel": "some test", - "aanleiding": "some test", - "indicatieInternOfExtern": InternExtern.extern, - "handelingInitiator": "indienen", - "onderwerp": "Klacht", - "handelingBehandelaar": "uitvoeren", - "doorlooptijd": "P30D", - "opschortingEnAanhoudingMogelijk": False, - "verlengingMogelijk": True, - "verlengingstermijn": "P30D", - "publicatieIndicatie": True, - "verantwoordingsrelatie": [], - "productenOfDiensten": ["https://example.com/product/123"], - "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar, - "omschrijving": "some test", - "gerelateerdeZaaktypen": [ - { - "zaaktype": "http://example.com/zaaktype/1", - "aard_relatie": AardRelatieChoices.bijdrage, - "toelichting": "test relations", - } - ], - "referentieproces": {"naam": "ReferentieProces 0", "link": ""}, - "catalogus": f"http://testserver{self.catalogus_detail_url}", - "besluittypen": [f"http://testserver{besluittype_url}"], - "beginGeldigheid": "2018-01-01", - "versiedatum": "2018-01-01", - "verantwoordelijke": "Organisatie eenheid X", - } - - response = self.client.post(zaaktype_list_url, data) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], M2MConceptCreateValidator.code) - def test_create_zaaktype_fail_different_catalogus_zaaktypes(self): besluittype = BesluitTypeFactory.create() besluittype_url = get_operation_url( @@ -361,7 +348,7 @@ def test_create_zaaktype_fail_different_catalogus_zaaktypes(self): ], "referentieproces": {"naam": "ReferentieProces 0", "link": ""}, "catalogus": f"http://testserver{self.catalogus_detail_url}", - "besluittypen": [f"http://testserver{besluittype_url}"], + "besluittypen": [besluittype.omschrijving], "beginGeldigheid": "2018-01-01", "versiedatum": "2018-01-01", "verantwoordelijke": "Organisatie eenheid X", @@ -561,21 +548,6 @@ def test_partial_update_zaaktype_fail_not_concept(self): error = get_validation_errors(response, "nonFieldErrors") self.assertEqual(error["code"], ConceptUpdateValidator.code) - def test_delete_zaaktype_not_related_to_non_concept_besluittypen(self): - catalogus = CatalogusFactory.create() - - zaaktype = ZaakTypeFactory.create(catalogus=catalogus) - zaaktype_url = reverse(zaaktype) - - besluittype = BesluitTypeFactory.create( - catalogus=catalogus, zaaktypen=[zaaktype] - ) - - response = self.client.delete(zaaktype_url) - - self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT) - self.assertFalse(ZaakType.objects.filter(id=zaaktype.id).exists()) - def test_delete_zaaktype_not_related_to_non_concept_informatieobjecttypen(self): catalogus = CatalogusFactory.create() @@ -791,158 +763,6 @@ def test_update_zaaktype_not_related_to_non_concept_zaaktypes(self): self.assertEqual(response.data["aanleiding"], "aangepast") zaaktype.delete() - def test_update_zaaktype_related_to_non_concept_besluittype_fails(self): - catalogus = CatalogusFactory.create() - - zaaktype = ZaakTypeFactory.create(catalogus=catalogus) - zaaktype_url = reverse(zaaktype) - - besluittype = BesluitTypeFactory.create( - catalogus=catalogus, zaaktypen=[zaaktype], concept=False - ) - - data = { - "identificatie": 0, - "doel": "some test", - "aanleiding": "aangepast", - "indicatieInternOfExtern": InternExtern.extern, - "handelingInitiator": "indienen", - "onderwerp": "Klacht", - "handelingBehandelaar": "uitvoeren", - "doorlooptijd": "P30D", - "opschortingEnAanhoudingMogelijk": False, - "verlengingMogelijk": True, - "verlengingstermijn": "P30D", - "publicatieIndicatie": True, - "verantwoordingsrelatie": [], - "productenOfDiensten": ["https://example.com/product/123"], - "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar, - "omschrijving": "some test", - "gerelateerdeZaaktypen": [ - { - "zaaktype": "http://example.com/zaaktype/1", - "aard_relatie": AardRelatieChoices.bijdrage, - "toelichting": "test relations", - } - ], - "referentieproces": {"naam": "ReferentieProces 0", "link": ""}, - "catalogus": reverse(catalogus), - "besluittypen": [], - "beginGeldigheid": "2018-01-01", - "versiedatum": "2018-01-01", - "verantwoordelijke": "Organisatie eenheid X", - } - - response = self.client.put(zaaktype_url, data) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], M2MConceptUpdateValidator.code) - zaaktype.delete() - - def test_update_zaaktype_related_to_non_concept_informatieobjecttype_fails(self): - catalogus = CatalogusFactory.create() - - zaaktype = ZaakTypeFactory.create(catalogus=catalogus) - zaaktype_url = reverse(zaaktype) - - informatieobjecttype = InformatieObjectTypeFactory.create( - catalogus=catalogus, concept=False - ) - ZaakInformatieobjectTypeFactory.create( - zaaktype=zaaktype, informatieobjecttype=informatieobjecttype - ) - - data = { - "identificatie": 0, - "doel": "some test", - "aanleiding": "aangepast", - "indicatieInternOfExtern": InternExtern.extern, - "handelingInitiator": "indienen", - "onderwerp": "Klacht", - "handelingBehandelaar": "uitvoeren", - "doorlooptijd": "P30D", - "opschortingEnAanhoudingMogelijk": False, - "verlengingMogelijk": True, - "verlengingstermijn": "P30D", - "publicatieIndicatie": True, - "verantwoordingsrelatie": [], - "productenOfDiensten": ["https://example.com/product/123"], - "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar, - "omschrijving": "some test", - "gerelateerdeZaaktypen": [ - { - "zaaktype": "http://example.com/zaaktype/1", - "aard_relatie": AardRelatieChoices.bijdrage, - "toelichting": "test relations", - } - ], - "referentieproces": {"naam": "ReferentieProces 0", "link": ""}, - "catalogus": reverse(catalogus), - "besluittypen": [], - "beginGeldigheid": "2018-01-01", - "versiedatum": "2018-01-01", - "verantwoordelijke": "Organisatie eenheid X", - } - - response = self.client.put(zaaktype_url, data) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], M2MConceptUpdateValidator.code) - zaaktype.delete() - - def test_update_zaaktype_add_relation_to_non_concept_besluittype_fails(self): - catalogus = CatalogusFactory.create() - - zaaktype = ZaakTypeFactory.create(catalogus=catalogus) - zaaktype_url = reverse(zaaktype) - - data = { - "identificatie": 0, - "doel": "some test", - "aanleiding": "aangepast", - "indicatieInternOfExtern": InternExtern.extern, - "handelingInitiator": "indienen", - "onderwerp": "Klacht", - "handelingBehandelaar": "uitvoeren", - "doorlooptijd": "P30D", - "opschortingEnAanhoudingMogelijk": False, - "verlengingMogelijk": True, - "verlengingstermijn": "P30D", - "publicatieIndicatie": True, - "verantwoordingsrelatie": [], - "productenOfDiensten": ["https://example.com/product/123"], - "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar, - "omschrijving": "some test", - "gerelateerdeZaaktypen": [ - { - "zaaktype": "http://example.com/zaaktype/1", - "aard_relatie": AardRelatieChoices.bijdrage, - "toelichting": "test relations", - } - ], - "referentieproces": {"naam": "ReferentieProces 0", "link": ""}, - "catalogus": reverse(catalogus), - "besluittypen": [], - "beginGeldigheid": "2018-01-01", - "versiedatum": "2018-01-01", - "verantwoordelijke": "Organisatie eenheid X", - } - - besluittype = BesluitTypeFactory.create(catalogus=catalogus, concept=False) - data["besluittypen"] = [reverse(besluittype)] - - response = self.client.put(zaaktype_url, data) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], M2MConceptUpdateValidator.code) - zaaktype.delete() - def test_partial_update_zaaktype_not_related_to_non_concept_besluittype(self): catalogus = CatalogusFactory.create() @@ -1003,77 +823,6 @@ def test_partial_update_zaaktype_not_related_to_non_concept_zaaktype(self): self.assertEqual(response.data["aanleiding"], "aangepast") zaaktype.delete() - def test_partial_update_zaaktype_related_to_non_concept_besluittype_fails(self): - catalogus = CatalogusFactory.create() - - zaaktype = ZaakTypeFactory.create(catalogus=catalogus) - zaaktype_url = reverse(zaaktype) - - besluittype = BesluitTypeFactory.create( - catalogus=catalogus, zaaktypen=[zaaktype], concept=False - ) - - response = self.client.patch(zaaktype_url, {"aanleiding": "aangepast"}) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], M2MConceptUpdateValidator.code) - zaaktype.delete() - - def test_partial_update_zaaktype_related_to_non_concept_informatieobjecttype_fails( - self, - ): - catalogus = CatalogusFactory.create() - - zaaktype = ZaakTypeFactory.create(catalogus=catalogus) - zaaktype_url = reverse(zaaktype) - - informatieobjecttype = InformatieObjectTypeFactory.create( - catalogus=catalogus, concept=False - ) - ZaakInformatieobjectTypeFactory.create( - zaaktype=zaaktype, informatieobjecttype=informatieobjecttype - ) - - response = self.client.patch(zaaktype_url, {"aanleiding": "aangepast"}) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], M2MConceptUpdateValidator.code) - zaaktype.delete() - - def test_partial_update_zaaktype_add_relation_to_non_concept_besluittype_fails( - self, - ): - catalogus = CatalogusFactory.create() - - zaaktype = ZaakTypeFactory.create( - catalogus=catalogus, - datum_begin_geldigheid="2018-03-01", - datum_einde_geldigheid="2019-01-01", - ) - zaaktype_url = reverse(zaaktype) - - zaaktype_for_besluittype = ZaakTypeFactory.create( - catalogus=catalogus, - datum_begin_geldigheid="2015-01-01", - datum_einde_geldigheid="2016-01-01", - ) - besluittype = BesluitTypeFactory.create( - catalogus=catalogus, concept=False, zaaktypen=[zaaktype_for_besluittype] - ) - data = {"besluittypen": [reverse(besluittype)]} - - response = self.client.patch(zaaktype_url, data) - - self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) - - error = get_validation_errors(response, "nonFieldErrors") - self.assertEqual(error["code"], M2MConceptUpdateValidator.code) - zaaktype.delete() - def test_partial_update_non_concept_zaaktype_einde_geldigheid(self): zaaktype = ZaakTypeFactory.create() zaaktype_url = reverse(zaaktype) @@ -1771,7 +1520,7 @@ def test_deelzaaktype_different_catalogue(self): response = self.client.patch( reverse(zaaktype2), - {"deelzaaktypen": [f"http://testserver{reverse(zaaktype1)}"]}, + {"deelzaaktypen": [zaaktype1.identificatie]}, ) self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST) diff --git a/src/ztc/api/utils/viewsets.py b/src/ztc/api/utils/viewsets.py index 6dbd3519..034970d7 100644 --- a/src/ztc/api/utils/viewsets.py +++ b/src/ztc/api/utils/viewsets.py @@ -1,3 +1,28 @@ +import datetime +import uuid +from urllib.parse import urlparse + +from django.db.models import Q + +from ztc.datamodel.models import ( + BesluitType, + InformatieObjectType, + ResultaatType, + ZaakType, +) + + +def is_url(pattern: str): + is_url = urlparse(pattern) + return all([is_url.scheme, is_url.netloc]) + + +def build_absolute_url(action, request): + if action in ["update", "partial_update"]: + return request.build_absolute_uri().rsplit("/", 2)[0] + return request.build_absolute_uri().rsplit("/", 1)[0] + + class FilterSearchOrderingViewSetMixin(object): """ Consult the model options to set filter-, ordering- and search fields. @@ -46,3 +71,86 @@ def get_search_fields(self): This function can be overriden to return custom fields. """ return self.get_model_option("search_fields") + + +MAPPING_FIELD_TO_MODEL = { + "zaaktypen": ZaakType, + "deelzaaktypen": ZaakType, + "gerelateerde_zaaktypen": ZaakType, + "besluittypen": BesluitType, + "informatieobjecttypen": InformatieObjectType, + "resultaattypen": ResultaatType, +} + + +def m2m_array_of_str_to_url(request, m2m_fields: list, action: str): + """ + The m2m array 'm2m_field' (like 'besluittypen') is transformed to an array of urls, which are required for the + m2m relationship. + """ + + for m2m_field in m2m_fields: + m2m_data = request.data.get(m2m_field, []).copy() + if m2m_data: + request.data[m2m_field].clear() + + for m2m_str in m2m_data: + search_parameter = ( + Q(omschrijving=m2m_str) + if MAPPING_FIELD_TO_MODEL[m2m_field] + in [BesluitType, InformatieObjectType] + else Q( + identificatie=m2m_str + if m2m_field != "gerelateerde_zaaktypen" + else m2m_str["zaaktype"] + ) + ) + + m2m_objects = MAPPING_FIELD_TO_MODEL[m2m_field].objects.filter( + search_parameter + ) + for m2m_object in m2m_objects: + build_url = f"{build_absolute_url(action, request)}/{MAPPING_FIELD_TO_MODEL[m2m_field]._meta.verbose_name_plural.title().lower()}/{str(m2m_object.uuid)}" + if m2m_field == "gerelateerde_zaaktypen": + new_m2m_str = m2m_str.copy() + new_m2m_str.update({"zaaktype": build_url}) + request.data[m2m_field].extend([new_m2m_str]) + else: + request.data[m2m_field].extend([build_url]) + + return request + + +def extract_relevant_m2m(serializer, m2m_fields: list, action: str, date=None): + """ "filters down the m2m model fields array to show objects related to submitted `date` or datetime.now()""" + for m2m_field in m2m_fields: + data = serializer.data if action == "list" else [serializer.data] + for query_object in data: + valid_urls = [] + for m2m_url in query_object[m2m_field]: + uuid_from_url = uuid.UUID(m2m_url.rsplit("/", 1)[1]).hex + + valid_m2m = get_valid_m2m_objects(m2m_field, uuid_from_url, date) + + if valid_m2m: + valid_urls.append(m2m_url) + + query_object[m2m_field].clear() + query_object[m2m_field].extend(valid_urls) + + return serializer + + +def get_valid_m2m_objects(m2m_field: str, uuid_from_url, date=None): + relevant_date = date if date else datetime.datetime.now() + search_parameter = Q( + uuid=uuid_from_url, + datum_begin_geldigheid__lte=relevant_date, + datum_einde_geldigheid__gte=relevant_date, + ) + + qs_old_version = MAPPING_FIELD_TO_MODEL[m2m_field].objects.filter(search_parameter) + if not qs_old_version: + search_parameter = Q(datum_einde_geldigheid=None, uuid=uuid_from_url) + return MAPPING_FIELD_TO_MODEL[m2m_field].objects.filter(search_parameter) + return qs_old_version diff --git a/src/ztc/api/validators.py b/src/ztc/api/validators.py index dbc38215..e204dd97 100644 --- a/src/ztc/api/validators.py +++ b/src/ztc/api/validators.py @@ -45,7 +45,6 @@ def __call__(self, attrs): datum_einde_geldigheid, instance, ) - if query.exists(): # are we patching eindeGeldigheid? changing_published_geldigheid = self.serializer.partial and list(attrs) == [ diff --git a/src/ztc/api/views/besluittype.py b/src/ztc/api/views/besluittype.py index b3c823a5..91c297c2 100644 --- a/src/ztc/api/views/besluittype.py +++ b/src/ztc/api/views/besluittype.py @@ -3,10 +3,11 @@ from drf_spectacular.utils import extend_schema, extend_schema_view from notifications_api_common.viewsets import NotificationViewSetMixin from rest_framework import viewsets +from rest_framework.response import Response from vng_api_common.caching import conditional_retrieve from vng_api_common.viewsets import CheckQueryParamsMixin -from ...datamodel.models import BesluitType +from ...datamodel.models import BesluitType, ZaakType from ..filters import BesluitTypeFilter from ..kanalen import KANAAL_BESLUITTYPEN from ..scopes import ( @@ -15,7 +16,12 @@ SCOPE_CATALOGI_READ, SCOPE_CATALOGI_WRITE, ) -from ..serializers import BesluitTypeSerializer +from ..serializers import ( + BesluitTypeCreateSerializer, + BesluitTypeSerializer, + BesluitTypeUpdateSerializer, +) +from ..utils.viewsets import extract_relevant_m2m, m2m_array_of_str_to_url from .mixins import ( ConceptMixin, ForcedCreateUpdateMixin, @@ -69,11 +75,9 @@ class BesluitTypeViewSet( CheckQueryParamsMixin, ConceptMixin, M2MConceptDestroyMixin, - NotificationViewSetMixin, ForcedCreateUpdateMixin, viewsets.ModelViewSet, ): - global_description = _( "Opvragen en bewerken van BESLUITTYPEn nodig voor BESLUITEN in de Besluiten API. " "Alle BESLUITTYPEn van de besluiten die het resultaat kunnen zijn van het zaakgericht werken " @@ -97,5 +101,64 @@ class BesluitTypeViewSet( concept_related_fields = ["informatieobjecttypen", "zaaktypen"] notifications_kanaal = KANAAL_BESLUITTYPEN + @extend_schema( + request=BesluitTypeCreateSerializer, + responses={201: BesluitTypeSerializer}, + ) + def create(self, request, *args, **kwargs): + request = m2m_array_of_str_to_url( + request, ["informatieobjecttypen"], self.action + ) + return super(viewsets.ModelViewSet, self).create(request, *args, **kwargs) + + @extend_schema( + request=BesluitTypeUpdateSerializer, + responses={200: BesluitTypeSerializer}, + ) + def update(self, request, *args, **kwargs): + request = m2m_array_of_str_to_url( + request, ["informatieobjecttypen"], self.action + ) + return super(viewsets.ModelViewSet, self).update(request, *args, **kwargs) + + def retrieve(self, request, *args, **kwargs): + instance = self.get_object() + serializer = extract_relevant_m2m( + self.get_serializer(instance), + ["zaaktypen", "informatieobjecttypen", "resultaattypen"], + self.action, + ) + return Response(serializer.data) + + def list(self, request, *args, **kwargs): + self._check_query_params(request) + queryset = self.filter_queryset(self.get_queryset()) + filters = ( + self.filter_backends[0]() + .get_filterset_kwargs(self.request, queryset, self) + .get("data", {}) + ) + + page = self.paginate_queryset(queryset) + if page is not None: + serializer = self.get_serializer(page, many=True) + serializer = extract_relevant_m2m( + serializer, + ["zaaktypen", "informatieobjecttypen", "resultaattypen"], + self.action, + filters.get("datum_geldigheid", None), + ) + return self.get_paginated_response(serializer.data) + + serializer = self.get_serializer(queryset, many=True) + serializer = extract_relevant_m2m( + serializer, + ["zaaktypen", "informatieobjecttypen", "resultaattypen"], + self.action, + filters.get("datum_geldigheid", None), + ) + + return Response(serializer.data) + BesluitTypeViewSet.publish = swagger_publish_schema(BesluitTypeViewSet) diff --git a/src/ztc/api/views/informatieobjecttype.py b/src/ztc/api/views/informatieobjecttype.py index 7d85f538..779b3c52 100644 --- a/src/ztc/api/views/informatieobjecttype.py +++ b/src/ztc/api/views/informatieobjecttype.py @@ -1,8 +1,8 @@ from django.utils.translation import gettext as _ from drf_spectacular.utils import extend_schema, extend_schema_view -from notifications_api_common.viewsets import NotificationViewSetMixin from rest_framework import viewsets +from rest_framework.response import Response from vng_api_common.caching import conditional_retrieve from vng_api_common.viewsets import CheckQueryParamsMixin @@ -16,6 +16,7 @@ SCOPE_CATALOGI_WRITE, ) from ..serializers import InformatieObjectTypeSerializer +from ..utils.viewsets import extract_relevant_m2m from .mixins import ( ConceptMixin, ForcedCreateUpdateMixin, @@ -69,7 +70,6 @@ class InformatieObjectTypeViewSet( CheckQueryParamsMixin, ConceptMixin, M2MConceptDestroyMixin, - NotificationViewSetMixin, ForcedCreateUpdateMixin, viewsets.ModelViewSet, ): @@ -95,6 +95,42 @@ class InformatieObjectTypeViewSet( concept_related_fields = ["besluittypen", "zaaktypen"] notifications_kanaal = KANAAL_INFORMATIEOBJECTTYPEN + def retrieve(self, request, *args, **kwargs): + instance = self.get_object() + serializer = extract_relevant_m2m( + self.get_serializer(instance), ["besluittypen", "zaaktypen"], self.action + ) + return Response(serializer.data) + + def list(self, request, *args, **kwargs): + self._check_query_params(request) + queryset = self.filter_queryset(self.get_queryset()) + filters = ( + self.filter_backends[0]() + .get_filterset_kwargs(self.request, queryset, self) + .get("data", {}) + ) + page = self.paginate_queryset(queryset) + if page is not None: + serializer = self.get_serializer(page, many=True) + serializer = extract_relevant_m2m( + serializer, + ["besluittypen", "zaaktypen"], + self.action, + filters.get("datum_geldigheid", None), + ) + return self.get_paginated_response(serializer.data) + + serializer = self.get_serializer(queryset, many=True) + serializer = extract_relevant_m2m( + serializer, + ["besluittypen", "zaaktypen"], + self.action, + filters.get("datum_geldigheid", None), + ) + + return Response(serializer.data) + InformatieObjectTypeViewSet.publish = swagger_publish_schema( InformatieObjectTypeViewSet diff --git a/src/ztc/api/views/relatieklassen.py b/src/ztc/api/views/relatieklassen.py index 0bd7b98e..f402cca9 100644 --- a/src/ztc/api/views/relatieklassen.py +++ b/src/ztc/api/views/relatieklassen.py @@ -2,12 +2,13 @@ from django.utils.translation import gettext as _ from drf_spectacular.utils import extend_schema, extend_schema_view -from rest_framework import viewsets +from rest_framework import status, viewsets +from rest_framework.response import Response from rest_framework.serializers import ValidationError from vng_api_common.caching import conditional_retrieve from vng_api_common.viewsets import CheckQueryParamsMixin -from ...datamodel.models import ZaakInformatieobjectType +from ...datamodel.models import InformatieObjectType, ZaakInformatieobjectType from ..filters import ZaakInformatieobjectTypeFilter from ..scopes import ( SCOPE_CATALOGI_FORCED_DELETE, @@ -15,7 +16,12 @@ SCOPE_CATALOGI_READ, SCOPE_CATALOGI_WRITE, ) -from ..serializers import ZaakTypeInformatieObjectTypeSerializer +from ..serializers import ( + ZaakTypeInformatieObjectTypeCreateSerializer, + ZaakTypeInformatieObjectTypeSerializer, + ZaakTypeInformatieObjectTypeUpdateSerializer, +) +from ..utils.viewsets import build_absolute_url from .mixins import ConceptFilterMixin, ForcedCreateUpdateMixin @@ -113,3 +119,53 @@ def perform_destroy(self, instance): ) super().perform_destroy(instance) + + @extend_schema( + request=ZaakTypeInformatieObjectTypeCreateSerializer, + responses={201: ZaakTypeInformatieObjectTypeSerializer}, + ) + def create(self, request, *args, **kwargs): + search_parameter = Q(omschrijving=request.data["informatieobjecttype"]) + iots = InformatieObjectType.objects.filter(search_parameter) + for iot in iots: + data = request.data.copy() + data[ + "informatieobjecttype" + ] = f"{build_absolute_url(self.action, request)}/informatieobjecttypen/{str(iot.uuid)}" + serializer = self.get_serializer(data=data) + serializer.is_valid(raise_exception=True) + self.perform_create(serializer) + headers = self.get_success_headers(serializer.data) + return Response( + serializer.data, status=status.HTTP_201_CREATED, headers=headers + ) + + @extend_schema( + request=ZaakTypeInformatieObjectTypeUpdateSerializer, + responses={200: ZaakTypeInformatieObjectTypeSerializer}, + ) + def update(self, request, *args, **kwargs): + """ + Update multiple ZIOT instances with `informatieobjecttype__omschrijving` as input. Update all correlated ZIOTs + """ + partial = kwargs.pop("partial", False) + instance = self.get_object() + + search_parameter = Q( + informatieobjecttype__omschrijving=instance.informatieobjecttype.omschrijving, + informatieobjecttype__catalogus=instance.informatieobjecttype.catalogus, + zaaktype__catalogus=instance.zaaktype.catalogus, + ) + ziots = ZaakInformatieobjectType.objects.filter(search_parameter) + + for ziot in ziots: + data = request.data.copy() + data[ + "informatieobjecttype" + ] = f"{build_absolute_url(self.action, request)}/informatieobjecttypen/{str(ziot.informatieobjecttype.uuid)}" + + serializer = self.get_serializer(ziot, data=data, partial=partial) + serializer.is_valid(raise_exception=True) + self.perform_update(serializer) + + return Response(serializer.data) diff --git a/src/ztc/api/views/resultaattype.py b/src/ztc/api/views/resultaattype.py index d7fe6576..62d32567 100644 --- a/src/ztc/api/views/resultaattype.py +++ b/src/ztc/api/views/resultaattype.py @@ -2,6 +2,7 @@ from drf_spectacular.utils import extend_schema, extend_schema_view from rest_framework import viewsets +from rest_framework.response import Response from vng_api_common.caching import conditional_retrieve from vng_api_common.viewsets import CheckQueryParamsMixin @@ -13,7 +14,12 @@ SCOPE_CATALOGI_READ, SCOPE_CATALOGI_WRITE, ) -from ..serializers import ResultaatTypeSerializer +from ..serializers import ( + ResultaatTypeCreateSerializer, + ResultaatTypeSerializer, + ResultaatTypeUpdateSerializer, +) +from ..utils.viewsets import extract_relevant_m2m, m2m_array_of_str_to_url from .mixins import ForcedCreateUpdateMixin, ZaakTypeConceptMixin @@ -76,3 +82,56 @@ class ResultaatTypeViewSet( "partial_update": SCOPE_CATALOGI_WRITE | SCOPE_CATALOGI_FORCED_WRITE, "destroy": SCOPE_CATALOGI_WRITE | SCOPE_CATALOGI_FORCED_DELETE, } + + @extend_schema( + request=ResultaatTypeCreateSerializer, + responses={201: ResultaatTypeSerializer}, + ) + def create(self, request, *args, **kwargs): + request = m2m_array_of_str_to_url(request, ["besluittypen"], self.action) + return super(viewsets.ModelViewSet, self).create(request, *args, **kwargs) + + def retrieve(self, request, *args, **kwargs): + instance = self.get_object() + serializer = extract_relevant_m2m( + self.get_serializer(instance), ["besluittypen"], self.action + ) + return Response(serializer.data) + + @extend_schema( + request=ResultaatTypeCreateSerializer, + responses={200: ResultaatTypeUpdateSerializer}, + ) + def update(self, request, *args, **kwargs): + request = m2m_array_of_str_to_url(request, ["besluittypen"], self.action) + return super(viewsets.ModelViewSet, self).update(request, *args, **kwargs) + + def list(self, request, *args, **kwargs): + self._check_query_params(request) + queryset = self.filter_queryset(self.get_queryset()) + filters = ( + self.filter_backends[0]() + .get_filterset_kwargs(self.request, queryset, self) + .get("data", {}) + ) + + page = self.paginate_queryset(queryset) + if page is not None: + serializer = self.get_serializer(page, many=True) + serializer = extract_relevant_m2m( + serializer, + ["besluittypen"], + self.action, + filters.get("datum_geldigheid", None), + ) + return self.get_paginated_response(serializer.data) + + serializer = self.get_serializer(queryset, many=True) + serializer = extract_relevant_m2m( + serializer, + ["besluittypen"], + self.action, + filters.get("datum_geldigheid", None), + ) + + return Response(serializer.data) diff --git a/src/ztc/api/views/zaken.py b/src/ztc/api/views/zaken.py index fa26caa7..cd24066d 100644 --- a/src/ztc/api/views/zaken.py +++ b/src/ztc/api/views/zaken.py @@ -12,7 +12,7 @@ from vng_api_common.serializers import FoutSerializer, ValidatieFoutSerializer from vng_api_common.viewsets import CheckQueryParamsMixin -from ...datamodel.models import ZaakType +from ...datamodel.models import BesluitType, ZaakType from ..filters import ZaakTypeFilter from ..kanalen import KANAAL_ZAAKTYPEN from ..scopes import ( @@ -21,7 +21,12 @@ SCOPE_CATALOGI_READ, SCOPE_CATALOGI_WRITE, ) -from ..serializers import ZaakTypeSerializer +from ..serializers import ( + ZaakTypeCreateSerializer, + ZaakTypeSerializer, + ZaakTypeUpdateSerializer, +) +from ..utils.viewsets import extract_relevant_m2m, m2m_array_of_str_to_url from .mixins import ConceptMixin, ForcedCreateUpdateMixin, M2MConceptDestroyMixin @@ -83,7 +88,6 @@ class ZaakTypeViewSet( CheckQueryParamsMixin, ConceptMixin, M2MConceptDestroyMixin, - NotificationViewSetMixin, ForcedCreateUpdateMixin, viewsets.ModelViewSet, ): @@ -148,3 +152,83 @@ def publish(self, request, *args, **kwargs): serializer = self.get_serializer(instance) return Response(serializer.data) + + @extend_schema( + request=ZaakTypeCreateSerializer, + responses={201: ZaakTypeSerializer}, + ) + def create(self, request, *args, **kwargs): + + request = m2m_array_of_str_to_url( + request, + ["besluittypen", "deelzaaktypen", "gerelateerde_zaaktypen"], + self.action, + ) + + return super(viewsets.ModelViewSet, self).create(request, *args, **kwargs) + + def retrieve(self, request, *args, **kwargs): + instance = self.get_object() + serializer = extract_relevant_m2m( + self.get_serializer(instance), + [ + "besluittypen", + "informatieobjecttypen", + "deelzaaktypen", + "gerelateerde_zaaktypen", + ], + self.action, + ) + return Response(serializer.data) + + @extend_schema( + request=ZaakTypeUpdateSerializer, + responses={200: ZaakTypeSerializer}, + ) + def update(self, request, *args, **kwargs): + request = m2m_array_of_str_to_url( + request, + ["besluittypen", "deelzaaktypen", "gerelateerde_zaaktypen"], + self.action, + ) + return super(viewsets.ModelViewSet, self).update(request, *args, **kwargs) + + def list(self, request, *args, **kwargs): + self._check_query_params(request) + queryset = self.filter_queryset(self.get_queryset()) + filters = ( + self.filter_backends[0]() + .get_filterset_kwargs(self.request, queryset, self) + .get("data", {}) + ) + + page = self.paginate_queryset(queryset) + if page is not None: + serializer = self.get_serializer(page, many=True) + serializer = extract_relevant_m2m( + serializer, + [ + "besluittypen", + "informatieobjecttypen", + "deelzaaktypen", + "gerelateerde_zaaktypen", + ], + self.action, + filters.get("datum_geldigheid", None), + ) + return self.get_paginated_response(serializer.data) + + serializer = self.get_serializer(queryset, many=True) + serializer = extract_relevant_m2m( + serializer, + [ + "besluittypen", + "informatieobjecttypen", + "deelzaaktypen", + "gerelateerde_zaaktypen", + ], + self.action, + filters.get("datum_geldigheid", None), + ) + + return Response(serializer.data) diff --git a/src/ztc/conf/api.py b/src/ztc/conf/api.py index 5d437052..7aef4563 100644 --- a/src/ztc/conf/api.py +++ b/src/ztc/conf/api.py @@ -2,7 +2,7 @@ from vng_api_common.conf.api import * # noqa - imports white-listed -API_VERSION = "1.2.1" +API_VERSION = "1.3.0-rc1" REST_FRAMEWORK = BASE_REST_FRAMEWORK.copy() REST_FRAMEWORK["DEFAULT_PERMISSION_CLASSES"] = ( diff --git a/src/ztc/datamodel/migrations/0136_auto_20230309_1412.py b/src/ztc/datamodel/migrations/0136_auto_20230309_1412.py new file mode 100644 index 00000000..5263dcbf --- /dev/null +++ b/src/ztc/datamodel/migrations/0136_auto_20230309_1412.py @@ -0,0 +1,21 @@ +# Generated by Django 3.2.14 on 2023-03-09 14:12 + +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ("datamodel", "0135_merge_0134_auto_20220707_1447_0134_auto_20220711_0841"), + ] + + operations = [ + migrations.AlterUniqueTogether( + name="besluittype", + unique_together=set(), + ), + migrations.AlterUniqueTogether( + name="informatieobjecttype", + unique_together=set(), + ), + ] diff --git a/src/ztc/datamodel/migrations/0137_auto_20230309_1415.py b/src/ztc/datamodel/migrations/0137_auto_20230309_1415.py new file mode 100644 index 00000000..5b8f406b --- /dev/null +++ b/src/ztc/datamodel/migrations/0137_auto_20230309_1415.py @@ -0,0 +1,24 @@ +# Generated by Django 3.2.14 on 2023-03-09 14:15 + +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ("datamodel", "0136_auto_20230309_1412"), + ] + + operations = [ + migrations.AlterModelOptions( + name="zaakinformatieobjecttype", + options={ + "verbose_name": "Zaak-Informatieobject-Type", + "verbose_name_plural": "Zaak-Informatieobject-Typen", + }, + ), + migrations.AlterUniqueTogether( + name="zaakinformatieobjecttype", + unique_together=set(), + ), + ] diff --git a/src/ztc/datamodel/migrations/0138_alter_zaaktypenrelatie_unique_together.py b/src/ztc/datamodel/migrations/0138_alter_zaaktypenrelatie_unique_together.py new file mode 100644 index 00000000..a5ce1313 --- /dev/null +++ b/src/ztc/datamodel/migrations/0138_alter_zaaktypenrelatie_unique_together.py @@ -0,0 +1,17 @@ +# Generated by Django 3.2.14 on 2023-03-13 13:29 + +from django.db import migrations + + +class Migration(migrations.Migration): + + dependencies = [ + ("datamodel", "0137_auto_20230309_1415"), + ] + + operations = [ + migrations.AlterUniqueTogether( + name="zaaktypenrelatie", + unique_together=set(), + ), + ] diff --git a/src/ztc/datamodel/models/besluittype.py b/src/ztc/datamodel/models/besluittype.py index ec40a212..e8ef7152 100644 --- a/src/ztc/datamodel/models/besluittype.py +++ b/src/ztc/datamodel/models/besluittype.py @@ -138,7 +138,7 @@ class BesluitType( class Meta: verbose_name = _("besluittype") verbose_name_plural = _("besluittypen") - unique_together = ("catalogus", "omschrijving") + # unique_together = ("catalogus", "omschrijving") def __str__(self): """ diff --git a/src/ztc/datamodel/models/informatieobjecttype.py b/src/ztc/datamodel/models/informatieobjecttype.py index 7169b060..9caabceb 100644 --- a/src/ztc/datamodel/models/informatieobjecttype.py +++ b/src/ztc/datamodel/models/informatieobjecttype.py @@ -164,7 +164,7 @@ class InformatieObjectType( ) class Meta: - unique_together = ("catalogus", "omschrijving") + # unique_together = ("catalogus", "omschrijving") verbose_name = _("Informatieobjecttype") verbose_name_plural = _("Informatieobjecttypen") diff --git a/src/ztc/datamodel/models/relatieklassen.py b/src/ztc/datamodel/models/relatieklassen.py index 9a851dd7..79ee0c36 100644 --- a/src/ztc/datamodel/models/relatieklassen.py +++ b/src/ztc/datamodel/models/relatieklassen.py @@ -71,10 +71,10 @@ class ZaakInformatieobjectType(ETagMixin, models.Model): class Meta: # NOTE: The uniqueness is implied in the specification. - unique_together = ("zaaktype", "volgnummer") + # unique_together = ("zaaktype", "volgnummer") verbose_name = _("Zaak-Informatieobject-Type") verbose_name_plural = _("Zaak-Informatieobject-Typen") - ordering = unique_together + # ordering = unique_together filter_fields = ("zaaktype", "informatieobjecttype", "richting") ordering_fields = filter_fields @@ -197,7 +197,7 @@ class ZaakTypenRelatie(models.Model): class Meta: # NOTE: The uniqueness is not explicitly defined in specification: - unique_together = ("zaaktype", "gerelateerd_zaaktype") + # unique_together = ("zaaktype", "gerelateerd_zaaktype") verbose_name = _("Zaaktypenrelatie") verbose_name_plural = _("Zaaktypenrelaties") ordering = ("pk",) diff --git a/src/ztc/tests/test_userstory_history_model.py b/src/ztc/tests/test_userstory_history_model.py new file mode 100644 index 00000000..cae539ff --- /dev/null +++ b/src/ztc/tests/test_userstory_history_model.py @@ -0,0 +1,546 @@ +from rest_framework import status +from vng_api_common.constants import VertrouwelijkheidsAanduiding +from vng_api_common.tests import get_operation_url, reverse, reverse_lazy + +from ztc.api.scopes import ( + SCOPE_CATALOGI_FORCED_DELETE, + SCOPE_CATALOGI_READ, + SCOPE_CATALOGI_WRITE, +) +from ztc.api.tests.base import APITestCase +from ztc.datamodel.choices import AardRelatieChoices, InternExtern, RichtingChoices +from ztc.datamodel.models import ( + BesluitType, + InformatieObjectType, + ZaakInformatieobjectType, + ZaakType, +) + + +class HistoryModelUserStoryTests(APITestCase): + maxDiff = None + heeft_alle_autorisaties = False + scopes = [SCOPE_CATALOGI_READ, SCOPE_CATALOGI_WRITE, SCOPE_CATALOGI_FORCED_DELETE] + + def test_user_story_new_version_model(self): + """ + In this userstory the following aspects of the new version model are tested: + 1. POST zaaktype with a besluittypen array consisted of besluittypen_omschrijvingen (which is conventially an array of URI's) + 2. POST besluittypen with a zaaktypen array consisted of zaaktypen_identificatie (which is conventially an array of URI's) + 3. GET a specific zaaktype which contains a list of associated besluittypen. Only the most recent and concept = False besluittypen should be shown. + """ + + self.post_informatieobjecttype() + self.post_besluittype_1() + self.post_zaaktype_1() + self.post_ziot() + + self.publish_besluittype_1() + self.publish_informatieobject_1() + self.publish_zaaktype_1() + + self.post_besluittype_2() + + self.publish_besluittype_2() + + self.post_zaaktype_2() + self.post_ziot_2() + + self.update_zaaktype_2() + + self.publish_zaaktype_2() + + self.delete_besluittype_3() + + self.post_besluittype_3() + + self.get_zaaktype_2() + + self.get_zaaktype_list() + + self.get_besluittype_list() + + self.get_informatieobjecttype() + + def get_zaaktype_list(self): + zaaktype_list_url = get_operation_url("zaaktype_list") + response = self.client.get(zaaktype_list_url) + besluittype = BesluitType.objects.filter( + datum_begin_geldigheid="2000-01-01", omschrijving="foo" + )[0] + besluittype_2 = BesluitType.objects.filter( + datum_begin_geldigheid="2000-01-01", omschrijving="foo2" + )[0] + besluittype_3 = BesluitType.objects.filter( + datum_begin_geldigheid="2016-01-01", omschrijving="foo" + )[0] + besluittype_4 = BesluitType.objects.filter( + datum_begin_geldigheid="2016-01-01", omschrijving="foo2" + )[0] + data_zaaktype_2 = response.json()["results"] + + self.assertEqual( + sorted(data_zaaktype_2[0]["besluittypen"]), + sorted( + [ + f"http://testserver{get_operation_url('besluittype_retrieve', uuid=besluittype_3.uuid)}", + f"http://testserver{get_operation_url('besluittype_retrieve', uuid=besluittype_4.uuid)}", + ] + ), + ) + + def get_besluittype_list(self): + besluittype_list_url = get_operation_url("besluittype_list") + response = self.client.get(besluittype_list_url) + + zaaktype_2 = ZaakType.objects.filter( + datum_begin_geldigheid="2016-01-01", identificatie="ID" + )[0] + data_besluittype = response.json()["results"] + + self.assertEqual( + sorted(data_besluittype[0]["zaaktypen"]), + sorted( + [ + f"http://testserver{get_operation_url('zaaktype_retrieve', uuid=zaaktype_2.uuid)}" + ] + ), + ) + + def post_informatieobjecttype(self): + data = { + "catalogus": f"http://testserver{self.catalogus_detail_url}", + "omschrijving": "test", + "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar, + "beginGeldigheid": "2017-01-01", + "informatieobjectcategorie": "test", + } + informatieobjecttypen_list_url = get_operation_url("informatieobjecttype_list") + + response = self.client.post(informatieobjecttypen_list_url, data) + + self.assertEqual(response.status_code, status.HTTP_201_CREATED) + + def post_besluittype_1(self): + informatieobjecttype = InformatieObjectType.objects.get() + informatieobjecttype_detail_url = get_operation_url( + "informatieobjecttype_retrieve", uuid=informatieobjecttype.uuid + ) + besluittype_list_url = reverse("besluittype-list") + data = { + "catalogus": f"http://testserver{self.catalogus_detail_url}", + "omschrijving": "foo", + "zaaktypen": ["ID"], + "omschrijvingGeneriek": "", + "besluitcategorie": "", + "reactietermijn": "P14D", + "publicatieIndicatie": True, + "publicatietekst": "", + "publicatietermijn": None, + "toelichting": "", + "informatieobjecttypen": [f"{informatieobjecttype.omschrijving}"], + "beginGeldigheid": "2000-01-01", + "eindeGeldigheid": "2000-01-02", + "concept": True, + } + + response_besluit_1 = self.client.post(besluittype_list_url, data) + self.assertEqual(response_besluit_1.status_code, 201) + + data2 = { + "catalogus": f"http://testserver{self.catalogus_detail_url}", + "omschrijving": "foo2", + "zaaktypen": ["ID"], + "omschrijvingGeneriek": "", + "besluitcategorie": "", + "reactietermijn": "P14D", + "publicatieIndicatie": True, + "publicatietekst": "", + "publicatietermijn": None, + "toelichting": "", + "informatieobjecttypen": [f"{informatieobjecttype.omschrijving}"], + "beginGeldigheid": "2000-01-01", + "eindeGeldigheid": "2000-01-02", + "concept": True, + } + + response_besluit_2 = self.client.post(besluittype_list_url, data2) + self.assertEqual(response_besluit_2.status_code, 201) + + data3 = { + "catalogus": f"http://testserver{self.catalogus_detail_url}", + "omschrijving": "foo3", + "zaaktypen": ["ID"], + "omschrijvingGeneriek": "", + "besluitcategorie": "", + "reactietermijn": "P14D", + "publicatieIndicatie": True, + "publicatietekst": "", + "publicatietermijn": None, + "toelichting": "", + "informatieobjecttypen": [f"{informatieobjecttype.omschrijving}"], + "beginGeldigheid": "2000-01-01", + "eindeGeldigheid": None, + "concept": True, + } + + response_besluit_3 = self.client.post(besluittype_list_url, data3) + self.assertEqual(response_besluit_3.status_code, 201) + + def post_zaaktype_1(self): + """ + test if we can post with ' "besluittypen": ["foo"] '. Where "foo" is converted into a URL in the View. + """ + zaaktype_list_url = get_operation_url("zaaktype_list") + data = { + "identificatie": "ID", + "doel": "some test", + "aanleiding": "some test", + "indicatieInternOfExtern": InternExtern.extern, + "handelingInitiator": "indienen", + "onderwerp": "Klacht", + "handelingBehandelaar": "uitvoeren", + "doorlooptijd": "P30D", + "opschortingEnAanhoudingMogelijk": False, + "verlengingMogelijk": True, + "verlengingstermijn": "P30D", + "publicatieIndicatie": True, + "verantwoordingsrelatie": [], + "productenOfDiensten": ["https://example.com/product/123"], + "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar, + "omschrijving": "some test", + "gerelateerdeZaaktypen": [], + "referentieproces": {"naam": "ReferentieProces 0", "link": ""}, + "catalogus": f"http://testserver{self.catalogus_detail_url}", + "besluittypen": ["foo", "foo2"], + "beginGeldigheid": "2000-01-01", + "eindeGeldigheid": "2000-01-02", + # todo normaal staat deze op None, waar word deze gezet bij nieuwe versie van een zaaktype? + "versiedatum": "2000-01-01", + "verantwoordelijke": "Organisatie eenheid X", + "concept": True, + } + + response_zaaktype_1 = self.client.post(zaaktype_list_url, data) + + self.assertEqual(response_zaaktype_1.status_code, 201) + + def post_ziot(self): + list_url = reverse_lazy(ZaakInformatieobjectType) + zaaktype = ZaakType.objects.get() + zaaktype_detail_url = get_operation_url("zaaktype_retrieve", uuid=zaaktype.uuid) + + data = { + "zaaktype": f"http://testserver{zaaktype_detail_url}", + "informatieobjecttype": "test", + "volgnummer": 13, + "richting": RichtingChoices.inkomend, + } + + response = self.client.post(list_url, data) + self.assertEqual(response.status_code, 201) + + def post_ziot_2(self): + list_url = reverse_lazy(ZaakInformatieobjectType) + zaaktype_2 = ZaakType.objects.filter(datum_begin_geldigheid="2011-01-01")[0] + zaaktype_detail_url = get_operation_url( + "zaaktype_retrieve", uuid=zaaktype_2.uuid + ) + data = { + "zaaktype": f"http://testserver{zaaktype_detail_url}", + "informatieobjecttype": "test", + "volgnummer": 13, + "richting": RichtingChoices.inkomend, + } + + response = self.client.post(list_url, data) + self.assertEqual(response.status_code, 201) + + def publish_besluittype_1(self): + self.besluittype_1 = BesluitType.objects.all()[0] + self.besluittype_2 = BesluitType.objects.all()[1] + self.besluittype_3 = BesluitType.objects.all()[2] + + besluittype_url_publish = reverse( + "besluittype-publish", kwargs={"uuid": self.besluittype_1.uuid} + ) + response_besluittype_publish = self.client.post(besluittype_url_publish) + self.assertEqual(response_besluittype_publish.status_code, 200) + + besluittype2_url_publish = reverse( + "besluittype-publish", kwargs={"uuid": self.besluittype_2.uuid} + ) + response_besluittype2_publish = self.client.post(besluittype2_url_publish) + self.assertEqual(response_besluittype2_publish.status_code, 200) + + besluittype3_url_publish = reverse( + "besluittype-publish", kwargs={"uuid": self.besluittype_3.uuid} + ) + response_besluittype3_publish = self.client.post(besluittype3_url_publish) + self.assertEqual(response_besluittype3_publish.status_code, 200) + + def publish_besluittype_2(self): + besluittype = BesluitType.objects.filter(datum_begin_geldigheid="2016-01-01")[0] + + besluittype_2 = BesluitType.objects.filter(datum_begin_geldigheid="2016-01-01")[ + 1 + ] + + besluittype_url_publish_2 = reverse( + "besluittype-publish", kwargs={"uuid": besluittype_2.uuid} + ) + response_besluittype_publish_2 = self.client.post(besluittype_url_publish_2) + self.assertEqual(response_besluittype_publish_2.status_code, 200) + + besluittype_url_publish = reverse( + "besluittype-publish", kwargs={"uuid": besluittype.uuid} + ) + response_besluittype_publish = self.client.post(besluittype_url_publish) + self.assertEqual(response_besluittype_publish.status_code, 200) + + def publish_informatieobject_1(self): + informatieobjecttype = InformatieObjectType.objects.get() + + informatieobjecttypee_url = get_operation_url( + "informatieobjecttype_publish", uuid=informatieobjecttype.uuid + ) + + response_informatieobjecttypee_url = self.client.post(informatieobjecttypee_url) + + self.assertEqual( + response_informatieobjecttypee_url.status_code, status.HTTP_200_OK + ) + + def publish_zaaktype_1(self): + zaaktype_1 = ZaakType.objects.all().first() + zaaktype_1_publish = get_operation_url("zaaktype_publish", uuid=zaaktype_1.uuid) + response_1_publish = self.client.post(zaaktype_1_publish) + self.assertEqual(response_1_publish.status_code, status.HTTP_200_OK) + + def post_zaaktype_2(self): + zaaktype_list_url = get_operation_url("zaaktype_list") + + data_2 = { + "identificatie": "ID", + "doel": "some test", + "aanleiding": "some test", + "indicatieInternOfExtern": InternExtern.extern, + "handelingInitiator": "indienen", + "onderwerp": "Klacht", + "handelingBehandelaar": "uitvoeren", + "doorlooptijd": "P30D", + "opschortingEnAanhoudingMogelijk": False, + "verlengingMogelijk": True, + "verlengingstermijn": "P30D", + "publicatieIndicatie": True, + "verantwoordingsrelatie": [], + "productenOfDiensten": ["https://example.com/product/123"], + "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar, + "omschrijving": "some test", + "gerelateerdeZaaktypen": [ + { + "zaaktype": "ID", + "aard_relatie": AardRelatieChoices.bijdrage, + "toelichting": "test relations", + } + ], + "referentieproces": {"naam": "ReferentieProces 0", "link": ""}, + "catalogus": f"http://testserver{self.catalogus_detail_url}", + "besluittypen": [f"foo"], + "beginGeldigheid": "2011-01-01", + "versiedatum": "2011-01-01", + "verantwoordelijke": "Organisatie eenheid X", + "concept": True, + } + + response_zaaktype_2 = self.client.post( + zaaktype_list_url, data_2, SERVER_NAME="testserver.com" + ) + self.assertEqual(response_zaaktype_2.status_code, 201) + + def publish_zaaktype_2(self): + self.zaaktype_2 = ZaakType.objects.filter(datum_begin_geldigheid="2016-01-01")[ + 0 + ] + zaaktype_2_publish = get_operation_url( + "zaaktype_publish", uuid=self.zaaktype_2.uuid + ) + response_2_publish = self.client.post(zaaktype_2_publish) + self.assertEqual(response_2_publish.status_code, status.HTTP_200_OK) + + def post_besluittype_2(self): + """ + test if we can post with ' "zaaktypen": ["ID"], '. Where "ID" is converted into a URL in the View. + """ + + informatieobjecttype = InformatieObjectType.objects.get() + informatieobjecttype_detail_url = get_operation_url( + "informatieobjecttype_retrieve", uuid=informatieobjecttype.uuid + ) + besluittype_list_url = reverse("besluittype-list") + data = { + "catalogus": f"http://testserver{self.catalogus_detail_url}", + "zaaktypen": ["ID"], + "omschrijving": "foo", + "omschrijvingGeneriek": "", + "besluitcategorie": "", + "reactietermijn": "P14D", + "publicatieIndicatie": True, + "publicatietekst": "", + "publicatietermijn": None, + "toelichting": "", + "informatieobjecttypen": [f"{informatieobjecttype.omschrijving}"], + "beginGeldigheid": "2016-01-01", + "concept": True, + } + + response_besluit_1 = self.client.post(besluittype_list_url, data) + self.assertEqual(response_besluit_1.status_code, 201) + + data2 = { + "catalogus": f"http://testserver{self.catalogus_detail_url}", + "zaaktypen": ["ID"], + "omschrijving": "foo2", + "omschrijvingGeneriek": "", + "besluitcategorie": "", + "reactietermijn": "P14D", + "publicatieIndicatie": True, + "publicatietekst": "", + "publicatietermijn": None, + "toelichting": "", + "informatieobjecttypen": [f"{informatieobjecttype.omschrijving}"], + "beginGeldigheid": "2016-01-01", + "concept": True, + } + + response_besluit_2 = self.client.post(besluittype_list_url, data2) + self.assertEqual(response_besluit_2.status_code, 201) + + def post_besluittype_3(self): + informatieobjecttype = InformatieObjectType.objects.get() + informatieobjecttype_detail_url = get_operation_url( + "informatieobjecttype_retrieve", uuid=informatieobjecttype.uuid + ) + besluittype_list_url = reverse("besluittype-list") + data = { + "catalogus": f"http://testserver{self.catalogus_detail_url}", + "zaaktypen": [f"ID"], + "omschrijving": "foo", + "omschrijvingGeneriek": "", + "besluitcategorie": "", + "reactietermijn": "P14D", + "publicatieIndicatie": True, + "publicatietekst": "", + "publicatietermijn": None, + "toelichting": "", + "informatieobjecttypen": [f"{informatieobjecttype.omschrijving}"], + "beginGeldigheid": "2030-01-01", + "concept": True, + } + + response_besluit_1 = self.client.post(besluittype_list_url, data) + self.assertEqual(response_besluit_1.status_code, 201) + + def get_besluittype_2(self): + """test that a GET request only returns the most recent associated besluittypen with concept=False""" + + besluittype_2 = BesluitType.objects.filter(datum_begin_geldigheid="2016-01-01")[ + 0 + ] + besluittype_detail_url = get_operation_url( + "besluittype_retrieve", uuid=besluittype_2.uuid + ) + + response = self.client.get(besluittype_detail_url) + zaaktype_2 = ZaakType.objects.filter(datum_begin_geldigheid="2016-01-01")[0] + + self.assertEqual(response.status_code, 200) + self.assertEqual(len(response.json()["zaaktypen"]), 1) + self.assertEqual( + response.json()["zaaktypen"][0], + f"http://testserver{get_operation_url('zaaktype_retrieve', uuid=zaaktype_2.uuid)}", + ) + + def get_zaaktype_2(self): + """test that a GET request only returns the most recent associated besluittypen with concept=False""" + + zaaktype_2 = ZaakType.objects.filter(datum_begin_geldigheid="2016-01-01")[0] + zaaktype_detail_url = get_operation_url( + "zaaktype_retrieve", uuid=zaaktype_2.uuid + ) + + response = self.client.get(zaaktype_detail_url) + besluittype = BesluitType.objects.filter(datum_begin_geldigheid="2016-01-01")[0] + besluittype_2 = BesluitType.objects.filter(datum_begin_geldigheid="2016-01-01")[ + 1 + ] + self.assertEqual(response.status_code, 200) + + self.assertEqual(len(response.json()["besluittypen"]), 2) + + self.assertEqual( + sorted(response.json()["besluittypen"]), + sorted( + [ + f"http://testserver{get_operation_url('besluittype_retrieve', uuid=besluittype.uuid)}", + f"http://testserver{get_operation_url('besluittype_retrieve', uuid=besluittype_2.uuid)}", + ] + ), + ) + + def get_informatieobjecttype(self): + informatieobjecttype = InformatieObjectType.objects.get() + informatieobjecttype_detail_url = get_operation_url( + "informatieobjecttype_retrieve", uuid=informatieobjecttype.uuid + ) + + response = self.client.get(informatieobjecttype_detail_url) + + def update_zaaktype_2(self): + zaaktype_2 = ZaakType.objects.filter(datum_begin_geldigheid="2011-01-01")[0] + zaaktype_url = reverse(zaaktype_2) + + data = { + "identificatie": "ID", + "doel": "some test", + "aanleiding": "aangepast", + "indicatieInternOfExtern": InternExtern.extern, + "handelingInitiator": "indienen", + "onderwerp": "Klacht", + "handelingBehandelaar": "uitvoeren", + "doorlooptijd": "P30D", + "opschortingEnAanhoudingMogelijk": False, + "verlengingMogelijk": True, + "verlengingstermijn": "P30D", + "publicatieIndicatie": True, + "verantwoordingsrelatie": [], + "productenOfDiensten": ["https://example.com/product/123"], + "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar, + "omschrijving": "some test", + "gerelateerdeZaaktypen": [ + { + "zaaktype": "http://example.com/zaaktype/2", + "aard_relatie": AardRelatieChoices.bijdrage, + "toelichting": "test relations", + } + ], + "referentieproces": {"naam": "ReferentieProces 0", "link": ""}, + "catalogus": f"http://testserver{self.catalogus_detail_url}", + "besluittypen": ["foo", "foo2", "foo3"], + "beginGeldigheid": "2016-01-01", + "versiedatum": "2016-01-01", + "verantwoordelijke": "Organisatie eenheid X", + } + + response = self.client.put(zaaktype_url, data) + + self.assertEqual(response.status_code, status.HTTP_200_OK) + self.assertEqual(response.data["aanleiding"], "aangepast") + + def delete_besluittype_3(self): + besluittype = BesluitType.objects.filter(omschrijving="foo3")[0] + besluittype_url = reverse(besluittype) + + response_besluit_1 = self.client.delete(besluittype_url) + + self.assertEqual(response_besluit_1.status_code, 204)