From aa0a6ba4ab7e6db6298cd2d5ced5d6482065afc3 Mon Sep 17 00:00:00 2001 From: joerivrij Date: Tue, 22 Aug 2023 13:21:39 +0200 Subject: [PATCH] Production release to version v1.3.0 (#184) * feat: Add 'documenten.lezen' and 'zaken.lezen' scopes (#179) * feat: Add 'documenten.lezen' and 'zaken.lezen' scopes This commit introduces two new scopes, 'documenten.lezen' and 'zaken.lezen', to the catalogi-api. These scopes inherit the same permissions as the existing 'catalogi.lezen' scope. The addition of these scopes is necessary to accommodate the new expand model, which involves requesting information from the catalogi-api through the documenten-api and zaken-api. Issue #2262 * Issue/history model userstory michiel (#176) Implemented and Refactored Features, Bug Fixes, and Formatting Changes: Added feature in perform_create to automatically add zaaktype relations Added feature in perform_create to besluittype to add zaaktype relations Added query parameter "datumGeldigheid" to the GET (retrieve) request Changed: Moved geldigheid datum validation into the PUBLISH operation from the POST operation Changed: Updated perform_create for gerelateerde_zaken to create correct relations Changed: Refactored views and updated openapi documentation Changed: ZIOT relatie class now uses a char model instead of a foreignfield model for informatieobjecttype Changed: informatieobjecttype correlates its zaaktype now through a custom serializer Changed: zaaktype now correlates its informatieobjecttype through a custom serializer Changed: zaaktype serializer outputs informatieobject URL instead of omschrijvingen Changed: Disabled notification in base Changed: post to block creation of two concepts for one zaaktype Changed: Zaken publish restrictions adapted to the new history model Fixed: Query parameter in retrieve /zaaktypen gave incorrect dates Fixed: Unit test using incorrect ZIOT information Fixed: URL creation in viewsets Removed: NotificationViewSetMixin from imports Removed hard-coded strings in extract_relevant_m2m Updated favicon to VNG logo -------- * bump version to 1.3.0 (#180) --------- Co-authored-by: MatthijsBekendam <47739550+MatthijsBekendam@users.noreply.github.com> --- src/openapi.yaml | 8481 ++++++++++++++++++++++++++-------------------- 1 file changed, 4772 insertions(+), 3709 deletions(-) diff --git a/src/openapi.yaml b/src/openapi.yaml index 6f0a0924..9f59a366 100644 --- a/src/openapi.yaml +++ b/src/openapi.yaml @@ -1,116 +1,42 @@ openapi: 3.0.3 info: title: Catalogi API - version: 1.3.0-rc3 - 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) + version: 1.3.0 + description: + "Een API om een zaaktypecatalogus (ZTC) te benaderen.\n\nDe zaaktypecatalogus\ + \ helpt gemeenten om het proces vanuit de 'vraag van een\nklant' (productaanvraag,\ + \ melding, aangifte, informatieverzoek e.d.) tot en met\nhet leveren van een passend\ + \ antwoord daarop in te richten, inclusief de\nbijbehorende informatievoorziening.\n\ + \nEen CATALOGUS bestaat uit ZAAKTYPEn, INFORMATIEOBJECTTYPEn en BESLUITTYPEn en\n\ + wordt typisch gebruikt om een ZAAK (in de Zaken API), INFORMATIEOBJECT (in de\n\ + Documenten API) en BESLUIT (in de Besluiten API) te voorzien van type,\nstandaardwaarden\ + \ en processtructuur.\n\n**Afhankelijkheden**\n\nDeze API is afhankelijk van:\n\ + \n* Gemeentelijke Selectielijst API\n* Autorisaties API *(optioneel)*\n\n\n**Autorisatie**\n\ + \nDeze API vereist autorisatie. Je kan de\n[token-tool](https://zaken-auth.vng.cloud/)\ + \ gebruiken om een token te\ngenereren.\n\n_Zelf een token genereren_\n\nDe tokens\ + \ die gebruikt worden voor autorisatie zijn [jwt.io][JWT's] (JSON web\ntoken).\ + \ In de API calls moeten deze gebruikt worden in de `Authorization`\nheader:\n\ + \n```\nAuthorization: Bearer \n```\n\nOm een JWT te genereren heb je een\ + \ `client ID` en een `secret` nodig. Het JWT\nmoet gebouwd worden volgens het\ + \ `HS256` algoritme. De vereiste payload is:\n\n```json\n{\n \"iss\": \"\",\n \"iat\": 1572863906,\n \"client_id\": \"\",\n \"\ + user_id\": \"\",\n \"user_representation\": \"\"\ + \n}\n```\n\nAls `issuer` gebruik je dus je eigen client ID. De `iat` timestamp\ + \ is een\nUNIX-timestamp die aangeeft op welk moment het token gegenereerd is.\n\ + \n`user_id` en `user_representation` zijn nodig voor de audit trails. Het zijn\n\ + vrije velden met als enige beperking dat de lengte maximaal de lengte van\nde\ + \ overeenkomstige velden in de audit trail resources is (zie rest API spec).\n\ + \n\n### Notificaties\n\nDeze API publiceert notificaties op het kanaal `zaaktypen`.\n\ + \n**Main resource**\n\n`zaaktype`\n\n\n\n**Kenmerken**\n\n* `catalogus`: URL-referentie\ + \ naar de CATALOGUS waartoe dit ZAAKTYPE behoort.\n\n**Resources en acties**\n\ + \n\nDeze API publiceert notificaties op het kanaal `besluittypen`.\n\n**Main resource**\n\ + \n`besluittype`\n\n\n\n**Kenmerken**\n\n* `catalogus`: URL-referentie naar de\ + \ CATALOGUS waartoe dit BESLUITTYPE behoort.\n\n**Resources en acties**\n\n\n\ + Deze API publiceert notificaties op het kanaal `informatieobjecttypen`.\n\n**Main\ + \ resource**\n\n`informatieobjecttype`\n\n\n\n**Kenmerken**\n\n* `catalogus`:\ + \ URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE behoort.\n\ + \n**Resources en acties**\n\n\n**Handige links**\n\n* [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard)\n\ + * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken)\n" contact: email: standaarden.ondersteuning@vng.nl url: https://vng-realisatie.github.io/gemma-zaken @@ -124,66 +50,72 @@ 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: @@ -215,10 +147,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -227,10 +160,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -239,10 +173,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -251,10 +186,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -263,10 +199,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -275,10 +212,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -287,10 +225,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -299,10 +238,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -311,10 +251,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -323,16 +264,16 @@ 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: @@ -340,8 +281,8 @@ paths: $ref: '#/components/schemas/BesluitTypeCreate' required: true security: - - JWT-Claims: - - catalogi.schrijven + - JWT-Claims: + - catalogi.schrijven responses: '201': headers: @@ -353,7 +294,8 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: @@ -365,10 +307,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -377,10 +320,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -389,10 +333,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -401,10 +346,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -413,10 +359,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -425,10 +372,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -437,10 +385,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -449,10 +398,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -461,10 +411,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -474,48 +425,52 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - besluittypen + - 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: @@ -529,10 +484,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -541,10 +497,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -553,10 +510,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -565,10 +523,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -577,10 +536,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -589,10 +549,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -601,10 +562,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -613,10 +575,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -625,37 +588,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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: besluittype_update - description: Werk een BESLUITTYPE in zijn geheel bij. Dit kan alleen als het + 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: @@ -663,15 +628,16 @@ paths: $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: @@ -683,10 +649,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -695,10 +662,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -707,10 +675,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -719,10 +688,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -731,10 +701,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -743,10 +714,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -755,10 +727,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -767,10 +740,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -779,10 +753,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -791,37 +766,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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: besluittype_partial_update - description: Werk een BESLUITTYPE deels bij. Dit kan alleen als het een concept + 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: @@ -830,15 +807,16 @@ paths: additionalProperties: {} description: Unspecified request body 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: @@ -852,10 +830,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -864,10 +843,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -876,10 +856,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -888,10 +869,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -900,10 +882,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -912,10 +895,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -924,10 +908,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -936,10 +921,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -948,10 +934,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -960,10 +947,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -972,26 +960,27 @@ 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: '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: @@ -1005,10 +994,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -1017,10 +1007,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -1029,10 +1020,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -1041,10 +1033,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1053,10 +1046,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1065,10 +1059,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1077,10 +1072,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1089,10 +1085,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1101,10 +1098,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -1113,45 +1111,49 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - besluittypen + - 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: @@ -1161,40 +1163,42 @@ 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: @@ -1203,61 +1207,61 @@ paths: description: OK '400': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '404': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '401': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -1267,48 +1271,49 @@ 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: @@ -1320,10 +1325,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -1332,10 +1338,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -1344,10 +1351,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -1356,10 +1364,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1368,10 +1377,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1380,10 +1390,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1392,10 +1403,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1404,10 +1416,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1416,10 +1429,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -1428,16 +1442,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: @@ -1445,8 +1459,8 @@ paths: $ref: '#/components/schemas/Catalogus' required: true security: - - JWT-Claims: - - catalogi.schrijven + - JWT-Claims: + - catalogi.schrijven responses: '201': headers: @@ -1458,7 +1472,8 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: @@ -1470,10 +1485,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -1482,10 +1498,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -1494,10 +1511,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -1506,10 +1524,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1518,10 +1537,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1530,10 +1550,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1542,10 +1563,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1554,10 +1576,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1566,10 +1589,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -1579,48 +1603,52 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - catalogussen + - 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: @@ -1632,10 +1660,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -1644,10 +1673,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -1656,10 +1686,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -1668,10 +1699,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1680,10 +1712,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1692,10 +1725,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1704,10 +1738,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1716,10 +1751,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1728,10 +1764,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -1740,45 +1777,49 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - catalogussen + - 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: @@ -1791,54 +1832,60 @@ 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: @@ -1850,10 +1897,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -1862,10 +1910,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -1874,10 +1923,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -1886,10 +1936,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1898,10 +1949,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1910,10 +1962,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1922,10 +1975,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1934,10 +1988,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1946,29 +2001,31 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: eigenschap_create - description: Maak een EIGENSCHAP aan. Dit kan alleen als het bijbehorende ZAAKTYPE + 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: @@ -1976,8 +2033,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: @@ -1989,7 +2046,8 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: @@ -2001,10 +2059,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -2013,10 +2072,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2025,10 +2085,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2037,10 +2098,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2049,10 +2111,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2061,10 +2124,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2073,10 +2137,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2085,10 +2150,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2097,10 +2163,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -2110,48 +2177,52 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - eigenschappen + - 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: @@ -2163,10 +2234,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2175,10 +2247,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2187,10 +2260,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -2199,10 +2273,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2211,10 +2286,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2223,10 +2299,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2235,10 +2312,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2247,10 +2325,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2259,37 +2338,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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: eigenschap_update - description: Werk een EIGENSCHAP in zijn geheel bij. Dit kan alleen als het + 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: @@ -2297,15 +2378,16 @@ 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: @@ -2317,10 +2399,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -2329,10 +2412,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2341,10 +2425,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2353,10 +2438,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -2365,10 +2451,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2377,10 +2464,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2389,10 +2477,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2401,10 +2490,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2413,10 +2503,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2425,52 +2516,55 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: eigenschap_partial_update - description: Werk een EIGENSCHAP deels bij. Dit kan alleen als het bijbehorende + 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: @@ -2482,10 +2576,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -2494,10 +2589,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2506,10 +2602,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2518,10 +2615,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -2530,10 +2628,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2542,10 +2641,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2554,10 +2654,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2566,10 +2667,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2578,10 +2680,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2590,32 +2693,34 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: eigenschap_destroy - description: Verwijder een EIGENSCHAP. Dit kan alleen als het bijbehorende ZAAKTYPE + 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 @@ -2624,10 +2729,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2636,10 +2742,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2648,10 +2755,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -2660,10 +2768,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2672,10 +2781,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2684,10 +2794,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2696,10 +2807,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2708,10 +2820,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2720,10 +2833,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -2732,45 +2846,49 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - eigenschappen + - 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: @@ -2783,54 +2901,60 @@ 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: @@ -2862,10 +2986,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -2874,10 +2999,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2886,10 +3012,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2898,10 +3025,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2910,10 +3038,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2922,10 +3051,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2934,10 +3064,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2946,10 +3077,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2958,10 +3090,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -2970,16 +3103,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: @@ -2988,15 +3121,16 @@ paths: additionalProperties: {} description: Unspecified request body 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: @@ -3010,10 +3144,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -3022,10 +3157,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3034,10 +3170,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3046,10 +3183,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3058,10 +3196,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3070,10 +3209,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3082,10 +3222,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3094,10 +3235,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3106,10 +3248,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -3119,48 +3262,52 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - informatieobjecttypen + - 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: @@ -3174,10 +3321,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3186,10 +3334,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3198,10 +3347,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -3210,10 +3360,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3222,10 +3373,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3234,10 +3386,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3246,10 +3399,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3258,10 +3412,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3270,37 +3425,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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: informatieobjecttype_update - description: Werk een INFORMATIEOBJECTTYPE in zijn geheel bij. Dit kan alleen + 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: @@ -3309,15 +3466,16 @@ paths: additionalProperties: {} description: Unspecified request body 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: @@ -3331,10 +3489,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -3343,10 +3502,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3355,10 +3515,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3367,10 +3528,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -3379,10 +3541,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3391,10 +3554,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3403,10 +3567,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3415,10 +3580,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3427,10 +3593,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3439,37 +3606,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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: informatieobjecttype_partial_update - description: Werk een INFORMATIEOBJECTTYPE deels bij. Dit kan alleen als het + 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: @@ -3478,15 +3647,16 @@ paths: additionalProperties: {} description: Unspecified request body 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: @@ -3500,10 +3670,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -3512,10 +3683,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3524,10 +3696,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3536,10 +3709,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -3548,10 +3722,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3560,10 +3735,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3572,10 +3748,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3584,10 +3761,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3596,10 +3774,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3608,39 +3787,42 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: informatieobjecttype_destroy - description: Verwijder een INFORMATIEOBJECTTYPE. Dit kan alleen als het een + 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: '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: @@ -3654,10 +3836,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3666,10 +3849,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3678,10 +3862,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -3690,10 +3875,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3702,10 +3888,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3714,10 +3901,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3726,10 +3914,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3738,10 +3927,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3750,10 +3940,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -3762,45 +3953,49 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - informatieobjecttypen + - 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: @@ -3810,40 +4005,42 @@ 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: @@ -3852,61 +4049,61 @@ paths: description: OK '400': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '404': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '401': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -3916,48 +4113,49 @@ 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: @@ -3969,10 +4167,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -3981,10 +4180,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3993,10 +4193,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4005,10 +4206,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4017,10 +4219,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4029,10 +4232,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4041,10 +4245,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4053,10 +4258,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4065,29 +4271,31 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: resultaattype_create - description: Maak een RESULTAATTYPE aan. Dit kan alleen als het bijbehorende + 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: @@ -4095,8 +4303,8 @@ paths: $ref: '#/components/schemas/ResultaatTypeCreate' required: true security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '201': headers: @@ -4108,7 +4316,8 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: @@ -4120,10 +4329,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -4132,10 +4342,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4144,10 +4355,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4156,10 +4368,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4168,10 +4381,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4180,10 +4394,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4192,10 +4407,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4204,10 +4420,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4216,10 +4433,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -4229,48 +4447,52 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - resultaattypen + - 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: @@ -4282,10 +4504,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4294,10 +4517,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4306,10 +4530,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -4318,10 +4543,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4330,10 +4556,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4342,10 +4569,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4354,10 +4582,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4366,10 +4595,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4378,37 +4608,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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: resultaattype_update - description: Werk een RESULTAATTYPE in zijn geheel bij. Dit kan alleen als het + 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: @@ -4416,15 +4648,16 @@ paths: $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: @@ -4436,10 +4669,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -4448,10 +4682,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4460,10 +4695,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4472,10 +4708,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -4484,10 +4721,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4496,10 +4734,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4508,10 +4747,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4520,10 +4760,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4532,10 +4773,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4544,52 +4786,55 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: resultaattype_partial_update - description: Werk een RESULTAATTYPE deels bij. Dit kan alleen als het bijbehorende + 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: @@ -4601,10 +4846,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -4613,10 +4859,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4625,10 +4872,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4637,10 +4885,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -4649,10 +4898,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4661,10 +4911,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4673,10 +4924,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4685,10 +4937,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4697,10 +4950,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4709,32 +4963,34 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: resultaattype_destroy - description: Verwijder een RESULTAATTYPE. Dit kan alleen als het bijbehorende + 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 @@ -4743,10 +4999,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4755,10 +5012,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4767,10 +5025,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -4779,10 +5038,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4791,10 +5051,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4803,10 +5064,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4815,10 +5077,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4827,10 +5090,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4839,10 +5103,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -4851,45 +5116,49 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - resultaattypen + - 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: @@ -4902,69 +5171,75 @@ 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: @@ -4976,10 +5251,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -4988,10 +5264,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -5000,10 +5277,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -5012,10 +5290,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -5024,10 +5303,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -5036,10 +5316,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -5048,10 +5329,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -5060,10 +5342,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -5072,29 +5355,31 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: roltype_create - description: Maak een ROLTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE + 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: @@ -5102,8 +5387,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: @@ -5115,7 +5400,8 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: @@ -5127,10 +5413,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -5139,10 +5426,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -5151,10 +5439,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -5163,10 +5452,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -5175,10 +5465,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -5187,10 +5478,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -5199,10 +5491,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -5211,10 +5504,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -5223,10 +5517,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -5236,47 +5531,51 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - roltypen + - 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: @@ -5288,10 +5587,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -5300,10 +5600,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -5312,10 +5613,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -5324,10 +5626,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -5336,10 +5639,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -5348,10 +5652,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -5360,10 +5665,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -5372,10 +5678,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -5384,36 +5691,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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: roltype_update - description: Werk een ROLTYPE in zijn geheel bij. Dit kan alleen als het een + 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: @@ -5421,15 +5730,16 @@ 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: @@ -5441,10 +5751,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -5453,10 +5764,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -5465,10 +5777,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -5477,10 +5790,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -5489,10 +5803,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -5501,10 +5816,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -5513,10 +5829,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -5525,10 +5842,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -5537,10 +5855,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -5549,51 +5868,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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: roltype_partial_update - description: Werk een ROLTYPE deels bij. Dit kan alleen als het een concept + 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: @@ -5605,10 +5927,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -5617,10 +5940,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -5629,10 +5953,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -5641,10 +5966,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -5653,10 +5979,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -5665,10 +5992,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -5677,10 +6005,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -5689,10 +6018,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -5701,10 +6031,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -5713,10 +6044,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -5725,18 +6057,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 @@ -5745,10 +6077,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -5757,10 +6090,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -5769,10 +6103,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -5781,10 +6116,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -5793,10 +6129,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -5805,10 +6142,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -5817,10 +6155,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -5829,10 +6168,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -5841,10 +6181,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -5853,44 +6194,48 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - roltypen + - 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: @@ -5903,54 +6248,60 @@ 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: @@ -5962,10 +6313,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -5974,10 +6326,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -5986,10 +6339,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -5998,10 +6352,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -6010,10 +6365,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -6022,10 +6378,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -6034,10 +6391,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -6046,10 +6404,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -6058,29 +6417,31 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: statustype_create - description: Maak een STATUSTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE + 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: @@ -6088,8 +6449,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: @@ -6101,7 +6462,8 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: @@ -6113,10 +6475,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -6125,10 +6488,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -6137,10 +6501,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -6149,10 +6514,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -6161,10 +6527,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -6173,10 +6540,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -6185,10 +6553,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -6197,10 +6566,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -6209,10 +6579,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -6222,48 +6593,52 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - statustypen + - 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: @@ -6275,10 +6650,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -6287,10 +6663,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -6299,10 +6676,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -6311,10 +6689,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -6323,10 +6702,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -6335,10 +6715,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -6347,10 +6728,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -6359,10 +6741,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -6371,37 +6754,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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: statustype_update - description: Werk een STATUSTYPE in zijn geheel bij. Dit kan alleen als het + 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: @@ -6409,15 +6794,16 @@ 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: @@ -6429,10 +6815,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -6441,10 +6828,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -6453,10 +6841,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -6465,10 +6854,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -6477,10 +6867,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -6489,10 +6880,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -6501,10 +6893,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -6513,10 +6906,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -6525,10 +6919,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -6537,52 +6932,55 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: statustype_partial_update - description: Werk een STATUSTYPE deels bij. Dit kan alleen als het bijbehorende + 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: @@ -6594,10 +6992,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -6606,10 +7005,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -6618,10 +7018,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -6630,10 +7031,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -6642,10 +7044,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -6654,10 +7057,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -6666,10 +7070,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -6678,10 +7083,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -6690,10 +7096,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -6702,32 +7109,34 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: statustype_destroy - description: Verwijder een STATUSTYPE. Dit kan alleen als het bijbehorende ZAAKTYPE + 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 @@ -6736,10 +7145,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -6748,10 +7158,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -6760,10 +7171,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -6772,10 +7184,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -6784,10 +7197,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -6796,10 +7210,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -6808,10 +7223,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -6820,10 +7236,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -6832,10 +7249,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -6844,45 +7262,49 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - statustypen + - 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: @@ -6895,84 +7317,88 @@ 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: @@ -6984,10 +7410,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -6996,10 +7423,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -7008,10 +7436,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -7020,10 +7449,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -7032,10 +7462,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -7044,10 +7475,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -7056,10 +7488,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -7068,10 +7501,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -7080,10 +7514,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -7092,16 +7527,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: @@ -7109,8 +7544,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: @@ -7122,7 +7557,8 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: @@ -7134,10 +7570,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -7146,10 +7583,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -7158,10 +7596,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -7170,10 +7609,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -7182,10 +7622,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -7194,10 +7635,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -7206,10 +7648,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -7218,10 +7661,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -7230,10 +7674,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -7243,48 +7688,52 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - zaakobjecttypen + - 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: @@ -7296,10 +7745,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -7308,10 +7758,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -7320,10 +7771,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -7332,10 +7784,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -7344,10 +7797,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -7356,10 +7810,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -7368,10 +7823,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -7380,10 +7836,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -7392,10 +7849,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -7404,24 +7862,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: @@ -7429,15 +7887,16 @@ 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: @@ -7449,10 +7908,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -7461,10 +7921,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -7473,10 +7934,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -7485,10 +7947,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -7497,10 +7960,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -7509,10 +7973,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -7521,10 +7986,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -7533,10 +7999,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -7545,10 +8012,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -7557,10 +8025,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -7569,39 +8038,40 @@ 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: @@ -7613,10 +8083,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -7625,10 +8096,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -7637,10 +8109,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -7649,10 +8122,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -7661,10 +8135,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -7673,10 +8148,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -7685,10 +8161,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -7697,10 +8174,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -7709,10 +8187,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -7721,10 +8200,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -7733,19 +8213,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 @@ -7754,10 +8234,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -7766,10 +8247,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -7778,10 +8260,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -7790,10 +8273,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -7802,10 +8286,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -7814,10 +8299,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -7826,10 +8312,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -7838,10 +8325,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -7850,10 +8338,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -7862,45 +8351,49 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - zaakobjecttypen + - 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: @@ -7913,58 +8406,64 @@ 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: informatieobjecttype - schema: - type: string - - name: richting - required: false - in: query - description: Aanduiding van de richting van informatieobjecten van het gerelateerde - INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. - schema: - type: string - enum: - - inkomend - - intern - - uitgaand - - name: status - required: false - in: query - description: | - filter objects depending on their concept status: - * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. - * `concept`: Toon objecten waarvan het attribuut `concept` true is. - * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer + - name: zaaktype + required: false + in: query + description: URL-referentie naar het ZAAKTYPE. + schema: + type: string + format: uri + - name: informatieobjecttype + required: false + in: query + description: informatieobjecttype + schema: + type: string + - name: richting + required: false + in: query + description: + Aanduiding van de richting van informatieobjecten van het gerelateerde + INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. + schema: + type: string + enum: + - inkomend + - intern + - uitgaand + - name: status + required: false + in: query + description: 'filter objects depending on their concept status: + + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + + ' + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer tags: - - zaaktype-informatieobjecttypen + - 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: @@ -7976,10 +8475,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -7988,10 +8488,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -8000,10 +8501,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -8012,10 +8514,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -8024,10 +8527,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -8036,10 +8540,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -8048,10 +8553,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -8060,10 +8566,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -8072,30 +8579,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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: zaakinformatieobjecttype_create - description: |- - Maak een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie aan. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op: - - `zaaktype` en `informatieobjecttype` behoren tot dezelfde `catalogus` + 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: @@ -8103,8 +8613,8 @@ paths: $ref: '#/components/schemas/ZaakTypeInformatieObjectType' required: true security: - - JWT-Claims: - - (catalogi.schrijven | catalogi.geforceerd-schrijven) + - JWT-Claims: + - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '201': headers: @@ -8116,7 +8626,8 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: @@ -8128,10 +8639,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -8140,10 +8652,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -8152,10 +8665,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -8164,10 +8678,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -8176,10 +8691,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -8188,10 +8704,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -8200,10 +8717,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -8212,10 +8730,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -8224,10 +8743,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -8237,48 +8757,52 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - zaaktype-informatieobjecttypen + - 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: @@ -8290,10 +8814,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -8302,10 +8827,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -8314,10 +8840,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -8326,10 +8853,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -8338,10 +8866,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -8350,10 +8879,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -8362,10 +8892,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -8374,10 +8905,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -8386,38 +8918,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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: zaakinformatieobjecttype_update - description: |- - Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op: - - `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:\n - `zaaktype` en `informatieobjecttype` behoren tot\ + \ dezelfde `catalogus`" summary: Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - 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: @@ -8425,15 +8960,16 @@ paths: $ref: '#/components/schemas/ZaakTypeInformatieObjectType' 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: @@ -8445,10 +8981,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -8457,10 +8994,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -8469,10 +9007,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -8481,10 +9020,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -8493,10 +9033,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -8505,10 +9046,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -8517,10 +9059,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -8529,10 +9072,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -8541,10 +9085,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -8553,53 +9098,57 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: zaakinformatieobjecttype_partial_update - description: |- - Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op: - - `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:\n - `zaaktype` en `informatieobjecttype` behoren tot dezelfde\ + \ `catalogus`" summary: Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - 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: @@ -8611,10 +9160,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -8623,10 +9173,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -8635,10 +9186,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -8647,10 +9199,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -8659,10 +9212,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -8671,10 +9225,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -8683,10 +9238,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -8695,10 +9251,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -8707,10 +9264,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -8719,33 +9277,35 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: zaakinformatieobjecttype_destroy - description: |- - Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op: - - `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:\n - `zaaktype` of `informatieobjecttype` is nog niet gepubliceerd" summary: Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true + - 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 @@ -8754,10 +9314,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -8766,10 +9327,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -8778,10 +9340,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -8790,10 +9353,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -8802,10 +9366,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -8814,10 +9379,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -8826,10 +9392,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -8838,10 +9405,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -8850,10 +9418,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -8862,45 +9431,49 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - zaaktype-informatieobjecttypen + - 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: @@ -8913,64 +9486,70 @@ 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: + - 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 - 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 + - name: trefwoorden + required: false + in: query + description: Multiple values may be separated by commas. + schema: + type: array + items: + type: string + style: form + explode: false + - name: status + required: false + in: query + description: 'filter objects depending on their concept status: + + * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. + + * `concept`: Toon objecten waarvan het attribuut `concept` true is. + + * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). + + ' + schema: + type: string + - name: datumGeldigheid + required: false + in: query + description: filter objecten op hun geldigheids datum. + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer tags: - - zaaktypen + - zaaktypen security: - - JWT-Claims: - - (catalogi.lezen | documenten.lezen | zaken.lezen) + - JWT-Claims: + - (catalogi.lezen | documenten.lezen | zaken.lezen) responses: '200': headers: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -9002,10 +9581,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -9014,10 +9594,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -9026,10 +9607,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -9038,10 +9620,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -9050,10 +9633,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -9062,10 +9646,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -9074,10 +9659,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -9086,10 +9672,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -9098,32 +9685,34 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: zaaktype_create - 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. + 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." 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: @@ -9131,8 +9720,8 @@ paths: $ref: '#/components/schemas/ZaakTypeCreate' required: true security: - - JWT-Claims: - - catalogi.schrijven + - JWT-Claims: + - catalogi.schrijven responses: '201': headers: @@ -9144,7 +9733,8 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: @@ -9156,10 +9746,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -9168,10 +9759,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -9180,10 +9772,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -9192,10 +9785,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -9204,10 +9798,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -9216,10 +9811,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -9228,10 +9824,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -9240,10 +9837,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -9252,10 +9850,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -9265,54 +9864,59 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: query - name: datumGeldigheid - schema: - type: string - description: filter op datumGeldigheid voor het zelf en alle onderliggende - objecten + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: query + name: datumGeldigheid + schema: + type: string + description: + filter op datumGeldigheid voor het zelf en alle onderliggende + objecten tags: - - zaaktypen + - zaaktypen security: - - JWT-Claims: - - (catalogi.lezen | documenten.lezen | zaken.lezen) + - JWT-Claims: + - (catalogi.lezen | documenten.lezen | zaken.lezen) responses: '200': headers: ETag: schema: type: string - description: De ETag berekend op de response body JSON. Indien twee + 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: @@ -9326,10 +9930,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -9338,10 +9943,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -9350,10 +9956,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -9362,10 +9969,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -9374,10 +9982,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -9386,10 +9995,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -9398,10 +10008,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -9410,10 +10021,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -9422,38 +10034,40 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: zaaktype_update - description: |- - Werk een ZAAKTYPE in zijn geheel bij. Dit kan alleen als het een concept betreft. Er wordt gevalideerd op: - - `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:\n - `deelzaaktypen` moeten tot\ + \ dezelfde catalogus behoren als het ZAAKTYPE." summary: Werk een ZAAKTYPE in zijn geheel bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - 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: @@ -9461,15 +10075,16 @@ paths: $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: @@ -9481,10 +10096,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -9493,10 +10109,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -9505,10 +10122,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -9517,10 +10135,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -9529,10 +10148,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -9541,10 +10161,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -9553,10 +10174,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -9565,10 +10187,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -9577,10 +10200,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -9589,38 +10213,40 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: zaaktype_partial_update - description: |- - Werk een ZAAKTYPE deels bij. Dit kan alleen als het een concept betreft. Er wordt gevalideerd op: - - `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:\n - `deelzaaktypen` moeten tot dezelfde\ + \ catalogus behoren als het ZAAKTYPE." summary: Werk een ZAAKTYPE deels bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - 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: @@ -9629,15 +10255,16 @@ paths: additionalProperties: {} description: Unspecified request body 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: @@ -9651,10 +10278,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -9663,10 +10291,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -9675,10 +10304,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -9687,10 +10317,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -9699,10 +10330,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -9711,10 +10343,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -9723,10 +10356,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -9735,10 +10369,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -9747,10 +10382,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -9759,10 +10395,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -9771,26 +10408,27 @@ 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: '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: @@ -9804,10 +10442,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -9816,10 +10455,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -9828,10 +10468,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -9840,10 +10481,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -9852,10 +10494,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -9864,10 +10507,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -9876,10 +10520,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -9888,10 +10533,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -9900,10 +10546,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan 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: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -9912,45 +10559,49 @@ 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 één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - zaaktypen + - 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: @@ -9960,31 +10611,32 @@ 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: @@ -9993,15 +10645,16 @@ paths: additionalProperties: {} description: Unspecified request body 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: @@ -10010,61 +10663,61 @@ paths: description: OK '400': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '404': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '401': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -10075,10 +10728,11 @@ 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/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -10087,10 +10741,11 @@ 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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -10099,10 +10754,11 @@ 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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -10111,10 +10767,11 @@ 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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -10123,10 +10780,11 @@ 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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -10135,10 +10793,11 @@ 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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -10147,10 +10806,11 @@ 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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -10159,10 +10819,11 @@ 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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -10171,10 +10832,11 @@ 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/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -10183,36 +10845,37 @@ 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/json: + application/problem+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 @@ -10222,7 +10885,8 @@ 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 @@ -10248,7 +10912,8 @@ 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 @@ -10260,25 +10925,29 @@ 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 @@ -10293,7 +10962,8 @@ 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 @@ -10323,7 +10993,8 @@ 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 @@ -10335,7 +11006,8 @@ 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: @@ -10357,16 +11029,16 @@ components: title: informatieobjecttypen uniqueItems: true required: - - beginGeldigheid - - catalogus - - concept - - informatieobjecttypen - - publicatieIndicatie - - resultaattypen - - resultaattypenOmschrijving - - url - - vastgelegdIn - - zaaktypen + - beginGeldigheid + - catalogus + - concept + - informatieobjecttypen + - publicatieIndicatie + - resultaattypen + - resultaattypenOmschrijving + - url + - vastgelegdIn + - zaaktypen BesluitTypeCreate: type: object properties: @@ -10375,7 +11047,8 @@ 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 @@ -10401,7 +11074,8 @@ 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 @@ -10413,25 +11087,29 @@ 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 @@ -10445,7 +11123,8 @@ components: items: type: string title: '' - description: '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten + description: + '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten van dit BESLUITTYPE worden vastgelegd.' title: informatieobjecttypen beginGeldigheid: @@ -10474,7 +11153,8 @@ 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 @@ -10486,7 +11166,8 @@ 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: @@ -10508,16 +11189,16 @@ components: title: informatieobjecttypen uniqueItems: true required: - - beginGeldigheid - - catalogus - - concept - - informatieobjecttypen - - publicatieIndicatie - - resultaattypen - - resultaattypenOmschrijving - - url - - vastgelegdIn - - zaaktypen + - beginGeldigheid + - catalogus + - concept + - informatieobjecttypen + - publicatieIndicatie + - resultaattypen + - resultaattypenOmschrijving + - url + - vastgelegdIn + - zaaktypen BesluitTypeUpdate: type: object properties: @@ -10526,7 +11207,8 @@ 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 @@ -10552,7 +11234,8 @@ 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 @@ -10564,25 +11247,29 @@ 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 @@ -10596,7 +11283,8 @@ components: items: type: string title: '' - description: '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten + description: + '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten van dit BESLUITTYPE worden vastgelegd.' title: informatieobjecttypen beginGeldigheid: @@ -10625,7 +11313,8 @@ 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 @@ -10637,7 +11326,8 @@ 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: @@ -10659,19 +11349,19 @@ components: title: informatieobjecttypen uniqueItems: true required: - - beginGeldigheid - - catalogus - - concept - - informatieobjecttypen - - publicatieIndicatie - - resultaattypen - - resultaattypenOmschrijving - - url - - vastgelegdIn - - zaaktypen + - beginGeldigheid + - catalogus + - concept + - informatieobjecttypen + - publicatieIndicatie + - resultaattypen + - resultaattypenOmschrijving + - url + - vastgelegdIn + - zaaktypen BlankEnum: enum: - - '' + - '' BronCatalogus: type: object description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. @@ -10688,14 +11378,15 @@ components: maxLength: 5 rsin: type: string - description: Het RSIN van de INGESCHREVEN NIET-NATUURLIJK PERSOON die beheerder + 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 + - domein + - rsin + - url BronZaaktype: type: object description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. @@ -10712,24 +11403,27 @@ components: maxLength: 50 omschrijving: type: string - description: De Zaaktype-omschrijving van het bronzaaktype, zoals gehanteerd + description: + De Zaaktype-omschrijving van het bronzaaktype, zoals gehanteerd in de Broncatalogus. title: bronzaaktype omschrijving maxLength: 80 required: - - identificatie - - omschrijving - - url + - identificatie + - omschrijving + - url BrondatumArchiefprocedure: type: object - description: Specificatie voor het bepalen van de brondatum voor de start van + 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' + - $ref: '#/components/schemas/AfleidingswijzeEnum' title: Afleidingswijze brondatum - description: "Wijze van bepalen van de brondatum.\n\nUitleg bij mogelijke\ + 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\ @@ -10760,61 +11454,96 @@ components: \ van het zaakobjecttype het betreft." datumkenmerk: type: string - description: Naam van de attribuutsoort van het procesobject dat bepalend + 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 + 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. + 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 + + * `overige` - Overige' title: objecttype oneOf: - - $ref: '#/components/schemas/ObjecttypeEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/ObjecttypeEnum' + - $ref: '#/components/schemas/BlankEnum' registratie: type: string - description: De naam van de registratie waarvan het procesobject deel uit + description: + De naam van de registratie waarvan het procesobject deel uit maakt. title: registratie maxLength: 80 @@ -10822,13 +11551,14 @@ components: type: string nullable: true title: Brondatum procestermijn - 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. Enkel relevant indien de afleidingswijze 'termijn' is. format: duration required: - - afleidingswijze + - afleidingswijze nullable: true Catalogus: type: object @@ -10838,39 +11568,45 @@ 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 domein: type: string - description: Een afkorting waarmee wordt aangegeven voor welk domein in + 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 + 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 + 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 + 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 + description: + Het emailadres van de contactpersoon die verantwoordelijk is voor het beheer van de CATALOGUS. maxLength: 254 zaaktypen: @@ -10880,7 +11616,8 @@ components: format: uri title: '' readOnly: true - description: URL-referenties naar ZAAKTYPEn die in deze CATALOGUS worden + description: + URL-referenties naar ZAAKTYPEn die in deze CATALOGUS worden ontsloten. title: Catalogus uniqueItems: true @@ -10891,7 +11628,8 @@ components: format: uri title: '' readOnly: true - description: URL-referenties naar BESLUITTYPEn die in deze CATALOGUS worden + description: + URL-referenties naar BESLUITTYPEn die in deze CATALOGUS worden ontsloten. title: catalogus uniqueItems: true @@ -10902,7 +11640,8 @@ components: format: uri title: '' readOnly: true - description: URL-referenties naar INFORMATIEOBJECTTYPEn die in deze CATALOGUS + description: + URL-referenties naar INFORMATIEOBJECTTYPEn die in deze CATALOGUS worden ontsloten. title: Catalogus uniqueItems: true @@ -10922,17 +11661,18 @@ components: type: string format: date nullable: true - description: Datum waarop de versie van de zaaktypecatalogus van toepassing + description: + Datum waarop de versie van de zaaktypecatalogus van toepassing is geworden. title: begindatum versie required: - - besluittypen - - contactpersoonBeheerNaam - - domein - - informatieobjecttypen - - rsin - - url - - zaaktypen + - besluittypen + - contactpersoonBeheerNaam + - domein + - informatieobjecttypen + - rsin + - url + - zaaktypen CheckListItem: type: object properties: @@ -10944,24 +11684,27 @@ components: toelichting: type: string nullable: true - description: Beschrijving van de overwegingen bij het controleren van het + 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 + 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 + 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 + - itemnaam + - vraagstelling Eigenschap: type: object properties: @@ -10970,7 +11713,8 @@ 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 @@ -10991,24 +11735,27 @@ components: maxLength: 255 specificatie: allOf: - - $ref: '#/components/schemas/EigenschapSpecificatie' + - $ref: '#/components/schemas/EigenschapSpecificatie' title: specificatie van eigenschap toelichting: type: string - description: Een toelichting op deze EIGENSCHAP en het belang hiervan voor + 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 + 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 + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: Zaaktype statustype: @@ -11016,7 +11763,8 @@ components: format: uri nullable: true title: Status type - description: Status type moet (onder andere) deze EIGENSCHAP hebben, voordat + description: + Status type moet (onder andere) deze EIGENSCHAP hebben, voordat een STATUS van het STATUSTYPE kan worden gezet. beginGeldigheid: type: string @@ -11043,44 +11791,53 @@ components: description: De datum van de aller laatste versie van het object. title: datum einde object required: - - catalogus - - definitie - - naam - - specificatie - - url - - zaaktype - - zaaktypeIdentificatie + - catalogus + - definitie + - naam + - specificatie + - url + - zaaktype + - zaaktypeIdentificatie EigenschapSpecificatie: type: object properties: groep: type: string - description: Benaming van het object of groepattribuut waarvan de EIGENSCHAP + 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. + - $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 + + * `datum_tijd` - Datum/tijd' title: formaat lengte: type: string - description: Het aantal karakters (lengte) waarmee waarden van de EIGENSCHAP + 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 + description: + Het aantal mogelijke voorkomens van waarden van deze EIGENSCHAP bij een zaak van het ZAAKTYPE. title: kardinaliteit maxLength: 3 @@ -11092,9 +11849,9 @@ components: description: Waarden die deze EIGENSCHAP kan hebben. title: waardenverzameling required: - - formaat - - kardinaliteit - - lengte + - formaat + - kardinaliteit + - lengte FieldValidationError: type: object description: Formaat van validatiefouten. @@ -11112,15 +11869,15 @@ components: description: Uitleg wat er precies fout is met de gegevens title: reason required: - - code - - name - - reason + - code + - name + - reason FormaatEnum: enum: - - tekst - - getal - - datum - - datum_tijd + - tekst + - getal + - datum + - datum_tijd type: string Fout: type: object @@ -11148,19 +11905,20 @@ components: title: detail instance: type: string - description: URI met referentie naar dit specifiek voorkomen van de fout. + 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 + - code + - detail + - instance + - status + - title IndicatieInternOfExternEnum: enum: - - intern - - extern + - intern + - extern type: string InformatieObjectType: type: object @@ -11171,14 +11929,16 @@ 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 catalogus: type: string format: uri - description: URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE + description: + URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE behoort. title: Catalogus omschrijving: @@ -11188,20 +11948,30 @@ components: maxLength: 80 vertrouwelijkheidaanduiding: allOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - description: |- - Aanduiding van de mate waarin informatieobjecten van dit INFORMATIEOBJECTTYPE voor de openbaarheid bestemd zijn. + - $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 + + * `zeer_geheim` - Zeer geheim' title: vertrouwelijkheidaanduiding beginGeldigheid: type: string @@ -11229,7 +11999,8 @@ 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 @@ -11244,7 +12015,8 @@ components: format: uri title: '' readOnly: true - 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 @@ -11258,24 +12030,25 @@ components: items: type: string maxLength: 30 - description: Trefwoord(en) waarmee informatieobjecten van het INFORMATIEOBJECTTYPE + 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' + - $ref: '#/components/schemas/InformatieObjectTypeOmschrijvingGeneriek' title: omschrijving generiek required: - - beginGeldigheid - - besluittypen - - catalogus - - concept - - informatieobjectcategorie - - omschrijving - - url - - vertrouwelijkheidaanduiding - - zaaktypen + - beginGeldigheid + - besluittypen + - catalogus + - concept + - informatieobjectcategorie + - omschrijving + - url + - vertrouwelijkheidaanduiding + - zaaktypen InformatieObjectTypeOmschrijvingGeneriek: type: object properties: @@ -11292,7 +12065,8 @@ components: herkomstInformatieobjecttypeOmschrijvingGeneriek: type: string title: Herkomst - description: De naam van de waardenverzameling, of van de beherende organisatie + description: + De naam van de waardenverzameling, of van de beherende organisatie daarvan, waaruit de waarde is overgenomen. maxLength: 12 hierarchieInformatieobjecttypeOmschrijvingGeneriek: @@ -11307,54 +12081,54 @@ components: description: Zinvolle toelichting bij het informatieobjecttype maxLength: 255 required: - - definitieInformatieobjecttypeOmschrijvingGeneriek - - herkomstInformatieobjecttypeOmschrijvingGeneriek - - hierarchieInformatieobjecttypeOmschrijvingGeneriek - - informatieobjecttypeOmschrijvingGeneriek + - 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 + - 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 + - adviseur + - behandelaar + - belanghebbende + - beslisser + - initiator + - klantcontacter + - zaakcoordinator + - mede_initiator type: string PaginatedCatalogusList: type: object @@ -11504,7 +12278,8 @@ 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 @@ -11525,24 +12300,27 @@ components: maxLength: 255 specificatie: allOf: - - $ref: '#/components/schemas/EigenschapSpecificatie' + - $ref: '#/components/schemas/EigenschapSpecificatie' title: specificatie van eigenschap toelichting: type: string - description: Een toelichting op deze EIGENSCHAP en het belang hiervan voor + 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 + 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 + description: + Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: Zaaktype statustype: @@ -11550,7 +12328,8 @@ components: format: uri nullable: true title: Status type - description: Status type moet (onder andere) deze EIGENSCHAP hebben, voordat + description: + Status type moet (onder andere) deze EIGENSCHAP hebben, voordat een STATUS van het STATUSTYPE kan worden gezet. beginGeldigheid: type: string @@ -11578,17 +12357,18 @@ components: title: datum einde object PatchedResultaatType: 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 @@ -11596,12 +12376,14 @@ 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: @@ -11612,7 +12394,8 @@ 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' @@ -11626,32 +12409,43 @@ 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 @@ -11662,15 +12456,17 @@ 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 @@ -11679,7 +12475,8 @@ 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: @@ -11709,13 +12506,15 @@ 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 @@ -11745,7 +12544,8 @@ 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 @@ -11768,20 +12568,23 @@ 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: @@ -11791,20 +12594,21 @@ components: 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 + - $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 @@ -11844,25 +12648,29 @@ 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 @@ -11870,7 +12678,8 @@ 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: @@ -11881,31 +12690,36 @@ 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ïnformeerd over de statusovergang. + 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 + 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 @@ -11928,7 +12742,8 @@ 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 @@ -11964,13 +12779,15 @@ 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: @@ -11999,26 +12816,30 @@ 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: @@ -12044,22 +12865,24 @@ 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 PatchedZaakTypeInformatieObjectType: type: object - description: |- - Represent a ZaakTypeInformatieObjectType. + description: 'Represent a ZaakTypeInformatieObjectType. - Relatie met informatieobjecttype dat relevant is voor zaaktype. + + 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 @@ -12071,7 +12894,8 @@ 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 catalogus: @@ -12087,27 +12911,34 @@ components: type: integer maximum: 999 minimum: 1 - description: Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het + 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. + - $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 + + * `uitgaand` - Uitgaand' title: richting statustype: type: string format: uri nullable: true title: Status type - description: URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn + description: + URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn verplicht aanwezig moeten zijn. ReferentieProces: type: object @@ -12125,20 +12956,21 @@ components: description: De URL naar de beschrijving van het Referentieproces maxLength: 200 required: - - naam + - naam ResultaatType: 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 @@ -12146,12 +12978,14 @@ 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: @@ -12162,7 +12996,8 @@ 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' @@ -12176,32 +13011,43 @@ 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 @@ -12212,15 +13058,17 @@ 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 @@ -12229,7 +13077,8 @@ 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: @@ -12259,13 +13108,15 @@ 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 @@ -12295,7 +13146,8 @@ 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 @@ -12310,28 +13162,29 @@ components: title: informatieobjecttypen uniqueItems: true required: - - besluittypeOmschrijving - - informatieobjecttypeOmschrijving - - omschrijving - - omschrijvingGeneriek - - resultaattypeomschrijving - - selectielijstklasse - - url - - zaaktype - - zaaktypeIdentificatie + - besluittypeOmschrijving + - informatieobjecttypeOmschrijving + - omschrijving + - omschrijvingGeneriek + - resultaattypeomschrijving + - selectielijstklasse + - url + - zaaktype + - zaaktypeIdentificatie ResultaatTypeCreate: 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 @@ -12339,12 +13192,14 @@ 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: @@ -12355,7 +13210,8 @@ 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' @@ -12369,32 +13225,43 @@ 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 @@ -12405,15 +13272,17 @@ 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 @@ -12422,7 +13291,8 @@ 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: @@ -12452,13 +13322,15 @@ 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 @@ -12485,7 +13357,8 @@ 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 @@ -12500,29 +13373,30 @@ components: title: informatieobjecttypen uniqueItems: true required: - - besluittypeOmschrijving - - besluittypen - - informatieobjecttypeOmschrijving - - omschrijving - - omschrijvingGeneriek - - resultaattypeomschrijving - - selectielijstklasse - - url - - zaaktype - - zaaktypeIdentificatie + - 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 @@ -12530,12 +13404,14 @@ 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: @@ -12546,7 +13422,8 @@ 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' @@ -12560,32 +13437,43 @@ 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 @@ -12596,15 +13484,17 @@ 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 @@ -12613,7 +13503,8 @@ 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: @@ -12643,13 +13534,15 @@ 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 @@ -12676,7 +13569,8 @@ 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 @@ -12691,21 +13585,21 @@ components: title: informatieobjecttypen uniqueItems: true required: - - besluittypeOmschrijving - - besluittypen - - informatieobjecttypeOmschrijving - - omschrijving - - omschrijvingGeneriek - - resultaattypeomschrijving - - selectielijstklasse - - url - - zaaktype - - zaaktypeIdentificatie + - besluittypeOmschrijving + - besluittypen + - informatieobjecttypeOmschrijving + - omschrijving + - omschrijvingGeneriek + - resultaattypeomschrijving + - selectielijstklasse + - url + - zaaktype + - zaaktypeIdentificatie RichtingEnum: enum: - - inkomend - - intern - - uitgaand + - inkomend + - intern + - uitgaand type: string RolType: type: object @@ -12716,20 +13610,23 @@ 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: @@ -12739,20 +13636,21 @@ components: 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 + - $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 @@ -12785,11 +13683,11 @@ components: description: De datum van de aller laatste versie van het object. title: datum einde object required: - - omschrijving - - omschrijvingGeneriek - - url - - zaaktype - - zaaktypeIdentificatie + - omschrijving + - omschrijvingGeneriek + - url + - zaaktype + - zaaktypeIdentificatie StatusType: type: object properties: @@ -12798,25 +13696,29 @@ 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 @@ -12824,7 +13726,8 @@ 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: @@ -12835,31 +13738,36 @@ 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ïnformeerd over de statusovergang. + 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 + 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 @@ -12882,7 +13790,8 @@ 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 @@ -12911,13 +13820,13 @@ components: description: De datum van de aller laatste versie van het object. title: datum einde object required: - - catalogus - - isEindstatus - - omschrijving - - url - - volgnummer - - zaaktype - - zaaktypeIdentificatie + - catalogus + - isEindstatus + - omschrijving + - url + - volgnummer + - zaaktype + - zaaktypeIdentificatie ValidatieFout: type: object description: Formaat van HTTP 4xx en 5xx fouten. @@ -12944,7 +13853,8 @@ components: title: detail instance: type: string - description: URI met referentie naar dit specifiek voorkomen van de fout. + description: + URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. title: instance invalidParams: @@ -12953,22 +13863,22 @@ components: $ref: '#/components/schemas/FieldValidationError' title: invalidParams required: - - code - - detail - - instance - - invalidParams - - status - - title + - code + - detail + - instance + - invalidParams + - status + - title VertrouwelijkheidaanduidingEnum: enum: - - openbaar - - beperkt_openbaar - - intern - - zaakvertrouwelijk - - vertrouwelijk - - confidentieel - - geheim - - zeer_geheim + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim type: string ZaakObjectType: type: object @@ -12978,13 +13888,15 @@ 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: @@ -13013,26 +13925,30 @@ 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: @@ -13058,39 +13974,42 @@ 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 required: - - anderObjecttype - - beginGeldigheid - - catalogus - - objecttype - - relatieOmschrijving - - resultaattypen - - statustypen - - url - - zaaktype - - zaaktypeIdentificatie + - 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 @@ -13101,86 +14020,105 @@ 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ïnitieerd worden. Indien van beide sprake kan zijn, dan prevaleert de externe initiatie. - - Uitleg bij mogelijke waarden: - - * `inkomend` - Inkomend - * `intern` - Intern - * `uitgaand` - Uitgaand + - $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" 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 @@ -13188,17 +14126,20 @@ 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 @@ -13209,12 +14150,14 @@ 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: @@ -13226,8 +14169,9 @@ components: items: type: string maxLength: 40 - description: De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige - en/of financiële verantwoording. + description: + "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ + \ en/of financi\xEBle verantwoording." title: verantwoordingsrelatie productenOfDiensten: type: array @@ -13236,25 +14180,28 @@ 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 @@ -13269,12 +14216,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: @@ -13289,7 +14236,8 @@ 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 @@ -13300,7 +14248,8 @@ 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 @@ -13311,7 +14260,8 @@ 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 @@ -13326,7 +14276,8 @@ 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 @@ -13337,7 +14288,8 @@ 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: @@ -13347,7 +14299,8 @@ 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 @@ -13355,7 +14308,8 @@ 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: @@ -13384,65 +14338,69 @@ 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 + - 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 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 @@ -13453,86 +14411,105 @@ 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ïnitieerd worden. Indien van beide sprake kan zijn, dan prevaleert de externe initiatie. - - Uitleg bij mogelijke waarden: - - * `inkomend` - Inkomend - * `intern` - Intern - * `uitgaand` - Uitgaand + - $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" 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 @@ -13540,17 +14517,20 @@ 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 @@ -13561,12 +14541,14 @@ 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: @@ -13578,8 +14560,9 @@ components: items: type: string maxLength: 40 - description: De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige - en/of financiële verantwoording. + description: + "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ + \ en/of financi\xEBle verantwoording." title: verantwoordingsrelatie productenOfDiensten: type: array @@ -13588,25 +14571,28 @@ 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 @@ -13621,12 +14607,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: @@ -13641,7 +14627,8 @@ 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 @@ -13652,7 +14639,8 @@ 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 @@ -13663,7 +14651,8 @@ 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 @@ -13678,7 +14667,8 @@ 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 @@ -13687,7 +14677,8 @@ components: items: type: string title: '' - description: '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen + description: + '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen dit ZAAKTYPE.' title: zaaktypen deelzaaktypen: @@ -13695,14 +14686,16 @@ components: items: type: string title: '' - description: De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak + 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 + description: + De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit ZAAKTYPE. title: zaaktype van beginGeldigheid: @@ -13731,60 +14724,63 @@ 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 - - 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 + - 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. + description: 'Represent a ZaakTypeInformatieObjectType. - Relatie met informatieobjecttype dat relevant is voor zaaktype. + + 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 @@ -13796,7 +14792,8 @@ 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 catalogus: @@ -13812,55 +14809,64 @@ components: type: integer maximum: 999 minimum: 1 - description: Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het + 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. + - $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 + + * `uitgaand` - Uitgaand' title: richting statustype: type: string format: uri nullable: true title: Status type - description: URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn + description: + URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn verplicht aanwezig moeten zijn. required: - - catalogus - - informatieobjecttype - - richting - - url - - volgnummer - - zaaktype - - zaaktypeIdentificatie + - catalogus + - informatieobjecttype + - 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 @@ -13871,86 +14877,105 @@ 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ïnitieerd worden. Indien van beide sprake kan zijn, dan prevaleert de externe initiatie. - - Uitleg bij mogelijke waarden: - - * `inkomend` - Inkomend - * `intern` - Intern - * `uitgaand` - Uitgaand + - $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" 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 @@ -13958,17 +14983,20 @@ 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 @@ -13979,12 +15007,14 @@ 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: @@ -13996,8 +15026,9 @@ components: items: type: string maxLength: 40 - description: De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige - en/of financiële verantwoording. + description: + "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ + \ en/of financi\xEBle verantwoording." title: verantwoordingsrelatie productenOfDiensten: type: array @@ -14006,25 +15037,28 @@ 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 @@ -14039,12 +15073,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: @@ -14059,7 +15093,8 @@ 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 @@ -14070,7 +15105,8 @@ 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 @@ -14081,7 +15117,8 @@ 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 @@ -14096,7 +15133,8 @@ 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 @@ -14105,7 +15143,8 @@ components: items: type: string title: '' - description: '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen + description: + '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen dit ZAAKTYPE.' title: zaaktypen deelzaaktypen: @@ -14113,14 +15152,16 @@ components: items: type: string title: '' - description: De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak + 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 + description: + De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit ZAAKTYPE. title: zaaktype van beginGeldigheid: @@ -14149,68 +15190,76 @@ 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 - - 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 + - aanleiding + - beginGeldigheid + - besluittypen + - catalogus + - concept + - deelzaaktypen + - doel + - doorlooptijd + - eigenschappen + - gerelateerdeZaaktypen + - handelingBehandelaar + - handelingInitiator + - identificatie + - indicatieInternOfExtern + - informatieobjecttypen + - omschrijving + - onderwerp + - opschortingEnAanhoudingMogelijk + - productenOfDiensten + - publicatieIndicatie + - referentieproces + - resultaattypen + - roltypen + - statustypen + - url + - verantwoordelijke + - verlengingMogelijk + - versiedatum + - vertrouwelijkheidaanduiding + - zaakobjecttypen ZaakTypenRelatie: type: object properties: zaaktype: type: string format: uri - description: URL referentie naar het gerelateerde zaaktype, mogelijks in + description: + URL referentie naar het gerelateerde zaaktype, mogelijks in een extern ZTC. title: gerelateerd zaaktype maxLength: 200 aardRelatie: allOf: - - $ref: '#/components/schemas/AardRelatieEnum' - description: |- - Omschrijving van de aard van de relatie van zaken van het ZAAKTYPE tot zaken van het andere ZAAKTYPE + - $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 @@ -14218,8 +15267,8 @@ components: title: toelichting maxLength: 255 required: - - aardRelatie - - zaaktype + - aardRelatie + - zaaktype ZaakTypenRelatieCreate: type: object properties: @@ -14229,15 +15278,20 @@ components: 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 @@ -14245,52 +15299,61 @@ 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 éé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. + - 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.