openapi: 3.0.3 info: title: Catalogi API version: 1.3.4 description: "Een API om een zaaktypecatalogus (ZTC) te benaderen.\n\nDe zaaktypecatalogus\ \ helpt gemeenten om het proces vanuit de 'vraag van een\nklant' (productaanvraag,\ \ melding, aangifte, informatieverzoek e.d.) tot en met\nhet leveren van een passend\ \ antwoord daarop in te richten, inclusief de\nbijbehorende informatievoorziening.\n\ \nEen CATALOGUS bestaat uit ZAAKTYPEn, INFORMATIEOBJECTTYPEn en BESLUITTYPEn en\n\ wordt typisch gebruikt om een ZAAK (in de Zaken API), INFORMATIEOBJECT (in de\n\ Documenten API) en BESLUIT (in de Besluiten API) te voorzien van type,\nstandaardwaarden\ \ en processtructuur.\n\n**Afhankelijkheden**\n\nDeze API is afhankelijk van:\n\ \n* Gemeentelijke Selectielijst API\n* Autorisaties API *(optioneel)*\n\n\n**Autorisatie**\n\ \nDeze API vereist autorisatie. Je kan de\n[token-tool](https://zaken-auth.vng.cloud/)\ \ gebruiken om een token te\ngenereren.\n\n_Zelf een token genereren_\n\nDe tokens\ \ die gebruikt worden voor autorisatie zijn [jwt.io][JWT's] (JSON web\ntoken).\ \ In de API calls moeten deze gebruikt worden in de `Authorization`\nheader:\n\ \n```\nAuthorization: Bearer \n```\n\nOm een JWT te genereren heb je een\ \ `client ID` en een `secret` nodig. Het JWT\nmoet gebouwd worden volgens het\ \ `HS256` algoritme. De vereiste payload is:\n\n```json\n{\n \"iss\": \"\",\n \"iat\": 1572863906,\n \"client_id\": \"\",\n \"\ user_id\": \"\",\n \"user_representation\": \"\"\ \n}\n```\n\nAls `issuer` gebruik je dus je eigen client ID. De `iat` timestamp\ \ is een\nUNIX-timestamp die aangeeft op welk moment het token gegenereerd is.\n\ \n`user_id` en `user_representation` zijn nodig voor de audit trails. Het zijn\n\ vrije velden met als enige beperking dat de lengte maximaal de lengte van\nde\ \ overeenkomstige velden in de audit trail resources is (zie rest API spec).\n\ \n\n### Notificaties\n\nDeze API publiceert notificaties op het kanaal `zaaktypen`.\n\ \n**Main resource**\n\n`zaaktype`\n\n\n\n**Kenmerken**\n\n* `catalogus`: URL-referentie\ \ naar de CATALOGUS waartoe dit ZAAKTYPE behoort.\n\n**Resources en acties**\n\ \n\nDeze API publiceert notificaties op het kanaal `besluittypen`.\n\n**Main resource**\n\ \n`besluittype`\n\n\n\n**Kenmerken**\n\n* `catalogus`: URL-referentie naar de\ \ CATALOGUS waartoe dit BESLUITTYPE behoort.\n\n**Resources en acties**\n\n\n\ Deze API publiceert notificaties op het kanaal `informatieobjecttypen`.\n\n**Main\ \ resource**\n\n`informatieobjecttype`\n\n\n\n**Kenmerken**\n\n* `catalogus`:\ \ URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE behoort.\n\ \n**Resources en acties**\n\n\n**Handige links**\n\n* [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard)\n\ * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken)\n" contact: email: standaarden.ondersteuning@vng.nl url: https://vng-realisatie.github.io/gemma-zaken license: name: EUPL 1.2 url: https://opensource.org/licenses/EUPL-1.2 paths: /besluittypen: get: operationId: besluittype_list description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle BESLUITTYPEn opvragen. parameters: - name: catalogus required: false in: query description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. schema: type: string format: uri - name: zaaktypen required: false in: query description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE schema: type: string - name: informatieobjecttypen required: false in: query description: Het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten van dit BESLUITTYPE worden vastgelegd. schema: type: string - name: status required: false in: query description: 'filter objects depending on their concept status: * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. * `concept`: Toon objecten waarvan het attribuut `concept` true is. * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). ' schema: type: string - name: omschrijving required: false in: query description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. schema: type: string - name: datumGeldigheid required: false in: query description: filter objecten op hun geldigheids datum. schema: type: string - name: page required: false in: query description: Een pagina binnen de gepagineerde set resultaten. schema: type: integer - $ref: '#/components/parameters/expand' tags: - besluittypen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/PaginatedBesluitTypeList' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: besluittype_create description: Maak een BESLUITTYPE aan. summary: Maak een BESLUITTYPE aan. parameters: - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - besluittypen requestBody: content: application/json: schema: $ref: '#/components/schemas/BesluitTypeCreate' required: true security: - JWT-Claims: - catalogi.schrijven responses: '201': headers: Location: schema: type: string format: uri description: URL waar de resource leeft. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/BesluitTypePostResponse' description: Created '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /besluittypen/{uuid}: get: operationId: besluittype_retrieve description: Een specifieke BESLUITTYPE opvragen. summary: Een specifieke BESLUITTYPE opvragen. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes - $ref: '#/components/parameters/expand' tags: - besluittypen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/BesluitTypeExpanded' description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: besluittype_update description: Werk een BESLUITTYPE in zijn geheel bij. Dit kan alleen als het een concept betreft. summary: Werk een BESLUITTYPE in zijn geheel bij. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - besluittypen requestBody: content: application/json: schema: $ref: '#/components/schemas/BesluitTypeUpdate' required: true security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/BesluitType' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: besluittype_partial_update description: Werk een BESLUITTYPE deels bij. Dit kan alleen als het een concept betreft. summary: Werk een BESLUITTYPE deels bij. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - besluittypen requestBody: content: application/json: schema: type: object additionalProperties: {} description: Unspecified request body security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: type: object additionalProperties: {} description: Unspecified response body description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: besluittype_destroy description: Verwijder een BESLUITTYPE. Dit kan alleen als het een concept betreft. summary: Verwijder een BESLUITTYPE. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true tags: - besluittypen security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: type: object additionalProperties: {} description: Unspecified response body description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error head: operationId: besluittype_headers description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) BESLUITTYPE opvragen ' parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes tags: - besluittypen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' description: OK /besluittypen/{uuid}/publish: post: operationId: besluittype_publish description: Publiceren van het besluittype zorgt ervoor dat dit in een Besluiten API kan gebruikt worden. Na het publiceren van een besluittype zijn geen inhoudelijke wijzigingen meer mogelijk. Indien er na het publiceren nog wat gewijzigd moet worden, dan moet je een nieuwe versie aanmaken. summary: Publiceer het concept BESLUITTYPE. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - besluittypen security: - JWT-Claims: - catalogi.schrijven responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/BesluitType' description: OK '400': content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '404': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '401': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /catalogussen: get: operationId: catalogus_list description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle CATALOGUSsen opvragen. parameters: - name: domein required: false in: query description: domein schema: type: string - name: domein__in required: false in: query description: domein__in schema: type: string - name: rsin required: false in: query description: rsin schema: type: string - name: rsin__in required: false in: query description: rsin__in schema: type: string - name: page required: false in: query description: Een pagina binnen de gepagineerde set resultaten. schema: type: integer - $ref: '#/components/parameters/expand' tags: - catalogussen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/PaginatedCatalogusList' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: catalogus_create description: Maak een CATALOGUS aan. summary: Maak een CATALOGUS aan. parameters: - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - catalogussen requestBody: content: application/json: schema: $ref: '#/components/schemas/Catalogus' required: true security: - JWT-Claims: - catalogi.schrijven responses: '201': headers: Location: schema: type: string format: uri description: URL waar de resource leeft. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Catalogus' description: Created '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /catalogussen/{uuid}: get: operationId: catalogus_retrieve description: Een specifieke CATALOGUS opvragen. summary: Een specifieke CATALOGUS opvragen. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes - $ref: '#/components/parameters/expand' tags: - catalogussen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/CatalogusExpanded' description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error head: operationId: catalogus_headers description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) CATALOGUS opvragen ' parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes tags: - catalogussen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' description: OK /eigenschappen: get: operationId: eigenschap_list description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle EIGENSCHAPpen opvragen. parameters: - name: zaaktype required: false in: query description: URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze EIGENSCHAP van belang is. schema: type: string format: uri - name: zaaktypeIdentificatie required: false in: query description: zaaktype_identificatie schema: type: string - name: status required: false in: query description: 'filter de resultaten op basis van de waarde van het boolean attribuut `concept` van het gerelateerde zaaktype: * `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 - $ref: '#/components/parameters/expand' tags: - eigenschappen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/PaginatedEigenschapList' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: eigenschap_create description: Maak een EIGENSCHAP aan. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Maak een EIGENSCHAP aan. parameters: - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - eigenschappen requestBody: content: application/json: schema: $ref: '#/components/schemas/Eigenschap' required: true security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '201': headers: Location: schema: type: string format: uri description: URL waar de resource leeft. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Eigenschap' description: Created '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /eigenschappen/{uuid}: get: operationId: eigenschap_retrieve description: Een specifieke EIGENSCHAP opvragen. summary: Een specifieke EIGENSCHAP opvragen. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes - $ref: '#/components/parameters/expand' tags: - eigenschappen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/EigenschapExpanded' description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: eigenschap_update description: Werk een EIGENSCHAP in zijn geheel bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Werk een EIGENSCHAP in zijn geheel bij. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - eigenschappen requestBody: content: application/json: schema: $ref: '#/components/schemas/Eigenschap' required: true security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Eigenschap' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: eigenschap_partial_update description: Werk een EIGENSCHAP deels bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Werk een EIGENSCHAP deels bij. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - eigenschappen requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedEigenschap' security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Eigenschap' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: eigenschap_destroy description: Verwijder een EIGENSCHAP. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Verwijder een EIGENSCHAP. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true tags: - eigenschappen security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '204': description: No content '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error head: operationId: eigenschap_headers description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) EIGENSCHAP opvragen ' parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes tags: - eigenschappen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' description: OK /informatieobjecttypen: get: operationId: informatieobjecttype_list description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle INFORMATIEOBJECTTYPEn opvragen. parameters: - name: catalogus required: false in: query description: URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE behoort. schema: type: string format: uri - name: status required: false in: query description: 'filter objects depending on their concept status: * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. * `concept`: Toon objecten waarvan het attribuut `concept` true is. * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). ' schema: type: string - name: datumGeldigheid required: false in: query description: filter objecten op hun geldigheids datum. schema: type: string - name: omschrijving required: false in: query description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. schema: type: string - name: page required: false in: query description: Een pagina binnen de gepagineerde set resultaten. schema: type: integer - $ref: '#/components/parameters/expand' tags: - informatieobjecttypen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/PaginatedInformatieObjectTypeList' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: informatieobjecttype_create description: Maak een INFORMATIEOBJECTTYPE aan. summary: Maak een INFORMATIEOBJECTTYPE aan. parameters: - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - informatieobjecttypen requestBody: content: application/json: schema: $ref: '#/components/schemas/InformatieObjectType' required: true security: - JWT-Claims: - catalogi.schrijven responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/InformatieObjectType' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /informatieobjecttypen/{uuid}: get: operationId: informatieobjecttype_retrieve description: Een specifieke INFORMATIEOBJECTTYPE opvragen. summary: Een specifieke INFORMATIEOBJECTTYPE opvragen. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes - $ref: '#/components/parameters/expand' tags: - informatieobjecttypen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/InformatieObjectTypeExpanded' description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: informatieobjecttype_update description: Werk een INFORMATIEOBJECTTYPE in zijn geheel bij. Dit kan alleen als het een concept betreft. summary: Werk een INFORMATIEOBJECTTYPE in zijn geheel bij. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - informatieobjecttypen requestBody: content: application/json: schema: type: object additionalProperties: {} description: Unspecified request body security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: type: object additionalProperties: {} description: Unspecified response body description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: informatieobjecttype_partial_update description: Werk een INFORMATIEOBJECTTYPE deels bij. Dit kan alleen als het een concept betreft. summary: ' Werk een INFORMATIEOBJECTTYPE deels bij.' parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - informatieobjecttypen requestBody: content: application/json: schema: type: object additionalProperties: {} description: Unspecified request body security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: type: object additionalProperties: {} description: Unspecified response body description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: informatieobjecttype_destroy description: Verwijder een INFORMATIEOBJECTTYPE. Dit kan alleen als het een concept betreft. summary: Verwijder een INFORMATIEOBJECTTYPE. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true tags: - informatieobjecttypen security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: type: object additionalProperties: {} description: Unspecified response body description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error head: operationId: informatieobjecttype_headers description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) INFORMATIEOBJECTTYPE opvragen ' parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes tags: - informatieobjecttypen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' description: OK /informatieobjecttypen/{uuid}/publish: post: operationId: informatieobjecttype_publish description: Publiceren van het informatieobjecttype zorgt ervoor dat dit in een Documenten API kan gebruikt worden. Na het publiceren van een informatieobjecttype zijn geen inhoudelijke wijzigingen meer mogelijk. Indien er na het publiceren nog wat gewijzigd moet worden, dan moet je een nieuwe versie aanmaken. summary: Publiceer het concept INFORMATIEOBJECTTYPE. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - informatieobjecttypen security: - JWT-Claims: - catalogi.schrijven responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/InformatieObjectType' description: OK '400': content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '404': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '401': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /resultaattypen: get: operationId: resultaattype_list description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle RESULTAATTYPEn opvragen. parameters: - name: zaaktype required: false in: query description: zaaktype schema: type: string - name: zaaktype_identificatie required: false in: query description: zaaktype_identificatie schema: type: string deprecated: true - name: zaaktypeIdentificatie required: false in: query description: zaaktype_identificatie schema: type: string - name: status required: false in: query schema: type: string description: 'filter de resultaten op basis van de waarde van het boolean attribuut `concept` van het gerelateerde zaaktype: * `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). ' - name: datum_geldigheid required: false in: query description: datum_geldigheid schema: type: string deprecated: true - name: datumGeldigheid 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 - $ref: '#/components/parameters/expand' tags: - resultaattypen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/PaginatedResultaatTypeList' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: resultaattype_create description: Maak een RESULTAATTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Maak een RESULTAATTYPE aan. parameters: - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - resultaattypen requestBody: content: application/json: schema: $ref: '#/components/schemas/ResultaatTypeCreate' required: true security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '201': headers: Location: schema: type: string format: uri description: URL waar de resource leeft. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ResultaatType' description: Created '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /resultaattypen/{uuid}: get: operationId: resultaattype_retrieve description: Een specifieke RESULTAATTYPE opvragen. summary: Een specifieke RESULTAATTYPE opvragen. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes - $ref: '#/components/parameters/expand' tags: - resultaattypen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ResultaatTypeExpanded' description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: resultaattype_update description: Werk een RESULTAATTYPE in zijn geheel bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Werk een RESULTAATTYPE in zijn geheel bij. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - resultaattypen requestBody: content: application/json: schema: $ref: '#/components/schemas/ResultaatTypeCreate' required: true security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ResultaatTypeUpdate' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: resultaattype_partial_update description: Werk een RESULTAATTYPE deels bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Werk een RESULTAATTYPE deels bij. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - resultaattypen requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedResultaatType' security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ResultaatType' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: resultaattype_destroy description: Verwijder een RESULTAATTYPE. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Verwijder een RESULTAATTYPE. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true tags: - resultaattypen security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '204': description: No content '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error head: operationId: resultaattype_headers description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) RESULTAATTYPE opvragen ' parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes tags: - resultaattypen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' description: OK /roltypen: get: operationId: roltype_list description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle ROLTYPEn opvragen. parameters: - name: zaaktype required: false in: query description: URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken kunnen zijn. schema: type: string format: uri - name: zaaktypeIdentificatie required: false in: query description: zaaktype_identificatie schema: type: string - name: omschrijvingGeneriek required: false in: query description: Algemeen gehanteerde omschrijving van de aard van de ROL. schema: type: string enum: - adviseur - behandelaar - belanghebbende - beslisser - initiator - klantcontacter - zaakcoordinator - mede_initiator - name: status required: false in: query description: 'filter de resultaten op basis van de waarde van het boolean attribuut `concept` van het gerelateerde zaaktype: * `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 - $ref: '#/components/parameters/expand' tags: - roltypen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/PaginatedRolTypeList' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: roltype_create description: Maak een ROLTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Maak een ROLTYPE aan. parameters: - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - roltypen requestBody: content: application/json: schema: $ref: '#/components/schemas/RolType' required: true security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '201': headers: Location: schema: type: string format: uri description: URL waar de resource leeft. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/RolType' description: Created '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /roltypen/{uuid}: get: operationId: roltype_retrieve description: Een specifieke ROLTYPE opvragen. summary: Een specifieke ROLTYPE opvragen. parameters: - in: path name: uuid schema: type: string format: uuid title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes - $ref: '#/components/parameters/expand' tags: - roltypen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/RolTypeExpanded' description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: roltype_update description: Werk een ROLTYPE in zijn geheel bij. Dit kan alleen als het een concept betreft. summary: Werk een ROLTYPE in zijn geheel bij. parameters: - in: path name: uuid schema: type: string format: uuid title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - roltypen requestBody: content: application/json: schema: $ref: '#/components/schemas/RolType' required: true security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/RolType' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: roltype_partial_update description: Werk een ROLTYPE deels bij. Dit kan alleen als het een concept betreft. summary: Werk een ROLTYPE deels bij. parameters: - in: path name: uuid schema: type: string format: uuid title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - roltypen requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedRolType' security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/RolType' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: roltype_destroy description: Verwijder een ROLTYPE. Dit kan alleen als het een concept betreft. summary: Verwijder een ROLTYPE. parameters: - in: path name: uuid schema: type: string format: uuid title: uuid required: true tags: - roltypen security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '204': description: No content '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error head: operationId: roltype_headers description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) ROLTYPE opvragen ' parameters: - in: path name: uuid schema: type: string format: uuid title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes tags: - roltypen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' description: OK /statustypen: get: operationId: statustype_list description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle STATUSTYPEn opvragen. parameters: - name: zaaktype required: false in: query description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen van dit STATUSTYPE bereikt kunnen worden. schema: type: string format: uri - name: zaaktypeIdentificatie required: false in: query description: zaaktype_identificatie schema: type: string - name: status required: false in: query description: 'filter de resultaten op basis van de waarde van het boolean attribuut `concept` van het gerelateerde zaaktype: * `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 - $ref: '#/components/parameters/expand' tags: - statustypen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/PaginatedStatusTypeList' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: statustype_create description: Maak een STATUSTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Maak een STATUSTYPE aan. parameters: - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - statustypen requestBody: content: application/json: schema: $ref: '#/components/schemas/StatusType' required: true security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '201': headers: Location: schema: type: string format: uri description: URL waar de resource leeft. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/StatusType' description: Created '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /statustypen/{uuid}: get: operationId: statustype_retrieve description: Een specifieke STATUSTYPE opvragen. summary: Een specifieke STATUSTYPE opvragen. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes - $ref: '#/components/parameters/expand' tags: - statustypen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/StatusTypeExpanded' description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: statustype_update description: Werk een STATUSTYPE in zijn geheel bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Werk een STATUSTYPE in zijn geheel bij. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - statustypen requestBody: content: application/json: schema: $ref: '#/components/schemas/StatusType' required: true security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/StatusType' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: statustype_partial_update description: Werk een STATUSTYPE deels bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Werk een STATUSTYPE deels bij. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - statustypen requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedStatusType' security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/StatusType' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: statustype_destroy description: Verwijder een STATUSTYPE. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. summary: Verwijder een STATUSTYPE. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true tags: - statustypen security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '204': description: No content '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error head: operationId: statustype_headers description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) STATUSTYPE opvragen ' parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes tags: - statustypen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' description: OK /zaakobjecttypen: get: operationId: zaakobjecttype_list description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle ZAAKOBJECTTYPEn opvragen. parameters: - name: anderObjecttype required: false in: query description: Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. schema: type: string - name: catalogus required: false in: query description: URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE behoort. schema: type: string format: uri - name: datumBeginGeldigheid required: false in: query description: De datum waarop het is ontstaan. schema: type: string deprecated: true - name: datumEindeGeldigheid required: false in: query description: De datum waarop het is opgeheven. schema: type: string deprecated: true - 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 - $ref: '#/components/parameters/expand' tags: - zaakobjecttypen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/PaginatedZaakObjectTypeList' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: zaakobjecttype_create description: Maak een ZAAKOBJECTTYPE aan. summary: Maak een ZAAKOBJECTTYPE aan. parameters: - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - zaakobjecttypen requestBody: content: application/json: schema: $ref: '#/components/schemas/ZaakObjectType' required: true security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '201': headers: Location: schema: type: string format: uri description: URL waar de resource leeft. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakObjectType' description: Created '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /zaakobjecttypen/{uuid}: get: operationId: zaakobjecttype_retrieve description: Een specifieke ZAAKOBJECTTYPE opvragen. summary: Een specifieke ZAAKOBJECTTYPE opvragen. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes - $ref: '#/components/parameters/expand' tags: - zaakobjecttypen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakObjectTypeExpanded' description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: zaakobjecttype_update description: Werk een ZAAKOBJECTTYPE in zijn geheel bij. summary: Werk een ZAAKOBJECTTYPE in zijn geheel bij. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - zaakobjecttypen requestBody: content: application/json: schema: $ref: '#/components/schemas/ZaakObjectType' required: true security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakObjectType' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: zaakobjecttype_partial_update description: Werk een ZAAKOBJECTTYPE deels bij. summary: Werk een ZAAKOBJECTTYPE deels bij. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - zaakobjecttypen requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedZaakObjectType' security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakObjectType' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: zaakobjecttype_destroy description: Verwijder een ZAAKOBJECTTYPE. summary: Verwijder een ZAAKOBJECTTYPE. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true tags: - zaakobjecttypen security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '204': description: No content '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error head: operationId: zaakobjecttype_headers description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) ZAAKOBJECTTYPE opvragen ' parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes tags: - zaakobjecttypen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' description: OK /zaaktype-informatieobjecttypen: get: operationId: zaakinformatieobjecttype_list description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle ZAAKTYPE-INFORMATIEOBJECTTYPE relaties opvragen. parameters: - name: zaaktype required: false in: query description: URL-referentie naar het ZAAKTYPE. schema: type: string format: uri - name: informatieobjecttype required: false in: query description: informatieobjecttype schema: type: string - name: richting required: false in: query description: Aanduiding van de richting van informatieobjecten van het gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. schema: type: string enum: - inkomend - intern - uitgaand - name: status required: false in: query description: 'filter de resultaten op basis van de waarde van het boolean attribuut `concept` van het gerelateerde zaaktype: * `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 - $ref: '#/components/parameters/expand' tags: - zaaktype-informatieobjecttypen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/PaginatedZaakTypeInformatieObjectTypeList' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: zaakinformatieobjecttype_create description: 'Maak een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie aan. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op: - `zaaktype` en `informatieobjecttype` behoren tot dezelfde `catalogus`' summary: Maak een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie aan. parameters: - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - zaaktype-informatieobjecttypen requestBody: content: application/json: schema: $ref: '#/components/schemas/ZaakTypeInformatieObjectType' required: true security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '201': headers: Location: schema: type: string format: uri description: URL waar de resource leeft. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakTypeInformatieObjectType' description: Created '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /zaaktype-informatieobjecttypen/{uuid}: get: operationId: zaakinformatieobjecttype_retrieve description: Een specifieke ZAAKTYPE-INFORMATIEOBJECTTYPE relatie opvragen. summary: Een specifieke ZAAKTYPE-INFORMATIEOBJECTTYPE relatie opvragen. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes - $ref: '#/components/parameters/expand' tags: - zaaktype-informatieobjecttypen security: - JWT-Claims: - catalogi.lezen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakTypeInformatieObjectTypeExpanded' description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: zaakinformatieobjecttype_update description: "Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel\ \ bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er\ \ wordt gevalideerd op:\n - `zaaktype` en `informatieobjecttype` behoren tot\ \ dezelfde `catalogus`" summary: Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel bij. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - zaaktype-informatieobjecttypen requestBody: content: application/json: schema: $ref: '#/components/schemas/ZaakTypeInformatieObjectType' required: true security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakTypeInformatieObjectType' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: zaakinformatieobjecttype_partial_update description: "Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij. Dit\ \ kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt\ \ gevalideerd op:\n - `zaaktype` en `informatieobjecttype` behoren tot dezelfde\ \ `catalogus`" summary: Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - zaaktype-informatieobjecttypen requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedZaakTypeInformatieObjectType' security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakTypeInformatieObjectType' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: zaakinformatieobjecttype_destroy description: "Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie. Dit kan alleen\ \ als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd\ \ op:\n - `zaaktype` of `informatieobjecttype` is nog niet gepubliceerd" summary: Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true tags: - zaaktype-informatieobjecttypen security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '204': description: No content '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error head: operationId: zaakinformatieobjecttype_headers description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) ZAAK-INFORMATIEOBJECT-TYPE opvragen ' parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes tags: - zaaktype-informatieobjecttypen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' description: OK /zaaktypen: get: operationId: zaaktype_list description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle ZAAKTYPEn opvragen. parameters: - name: catalogus required: false in: query description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. schema: type: string format: uri - name: identificatie required: false in: query description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. schema: type: string - name: trefwoorden required: false in: query description: Multiple values may be separated by commas. schema: type: array items: type: string style: form explode: false - name: status required: false in: query description: 'filter objects depending on their concept status: * `alles`: Toon objecten waarvan het attribuut `concept` true of false is. * `concept`: Toon objecten waarvan het attribuut `concept` true is. * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard). ' schema: type: string - name: datumGeldigheid required: false in: query description: filter objecten op hun geldigheids datum. schema: type: string - name: page required: false in: query description: Een pagina binnen de gepagineerde set resultaten. XX schema: type: integer - $ref: '#/components/parameters/expand' tags: - zaaktypen security: - JWT-Claims: - (catalogi.lezen | documenten.lezen | zaken.lezen) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/PaginatedZaakTypeList' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: zaaktype_create description: "Er wordt gevalideerd op:\n- geldigheid `catalogus` URL, dit moet\ \ een catalogus binnen dezelfde API zijn\n - Uniciteit `catalogus` en `zaaktypeidentificatie`.\ \ Dezelfde zaaktypeidentificatie mag enkel opnieuw gebruikt worden als het zaaktype\ \ een andere geldigheidsperiode kent dan bestaande zaaktypen.\n - `deelzaaktypen`\ \ moeten tot dezelfde catalogus behoren als het ZAAKTYPE." summary: Maak een ZAAKTYPE aan. parameters: - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - zaaktypen requestBody: content: application/json: schema: $ref: '#/components/schemas/ZaakTypeCreate' required: true security: - JWT-Claims: - catalogi.schrijven responses: '201': headers: Location: schema: type: string format: uri description: URL waar de resource leeft. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakType' description: Created '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /zaaktypen/{uuid}: get: operationId: zaaktype_retrieve description: Een specifieke ZAAKTYPE opvragen. summary: Een specifieke ZAAKTYPE opvragen. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes - in: query name: datumGeldigheid schema: type: string description: filter op datumGeldigheid voor het zelf en alle onderliggende objecten deprecated: true - $ref: '#/components/parameters/expand' tags: - zaaktypen security: - JWT-Claims: - (catalogi.lezen | documenten.lezen | zaken.lezen) responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakTypeExpanded' description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: zaaktype_update description: "Werk een ZAAKTYPE in zijn geheel bij. Dit kan alleen als het een\ \ concept betreft. Er wordt gevalideerd op:\n - `deelzaaktypen` moeten tot\ \ dezelfde catalogus behoren als het ZAAKTYPE." summary: Werk een ZAAKTYPE in zijn geheel bij. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - zaaktypen requestBody: content: application/json: schema: $ref: '#/components/schemas/ZaakTypeUpdate' required: true security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakType' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: zaaktype_partial_update description: "Werk een ZAAKTYPE deels bij. Dit kan alleen als het een concept\ \ betreft. Er wordt gevalideerd op:\n - `deelzaaktypen` moeten tot dezelfde\ \ catalogus behoren als het ZAAKTYPE." summary: Werk een ZAAKTYPE deels bij. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - zaaktypen requestBody: content: application/json: schema: type: object additionalProperties: {} description: Unspecified request body security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-schrijven) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: type: object additionalProperties: {} description: Unspecified response body description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: zaaktype_destroy description: Verwijder een ZAAKTYPE. Dit kan alleen als het een concept betreft. summary: Verwijder een ZAAKTYPE. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true tags: - zaaktypen security: - JWT-Claims: - (catalogi.schrijven | catalogi.geforceerd-verwijderen) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: type: object additionalProperties: {} description: Unspecified response body description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error head: operationId: zaaktype_headers description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) ZAAKTYPE opvragen ' parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ \ voor meer informatie." examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: "E\xE9n ETag-waarde" MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes tags: - zaaktypen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' description: OK /zaaktypen/{uuid}/publish: post: operationId: zaaktype_publish description: Publiceren van het zaaktype zorgt ervoor dat dit in een Zaken API kan gebruiktworden. Na het publiceren van een zaaktype zijn geen inhoudelijke wijzigingenmeer mogelijk - ook niet de statustypen, eigenschappen... etc. Indien er na hetpubliceren nog wat gewijzigd moet worden, dan moet je een nieuwe versieaanmaken. summary: Publiceer het concept ZAAKTYPE. parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true tags: - zaaktypen requestBody: content: application/json: schema: type: object additionalProperties: {} description: Unspecified request body security: - JWT-Claims: - catalogi.schrijven responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakType' description: OK '400': content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '404': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '401': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error components: parameters: expand: name: expand description: Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt. in: query schema: type: string responses: '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error schemas: AardRelatieEnum: enum: - vervolg - bijdrage - onderwerp type: string AfleidingswijzeEnum: enum: - afgehandeld - ander_datumkenmerk - eigenschap - gerelateerde_zaak - hoofdzaak - ingangsdatum_besluit - termijn - vervaldatum_besluit - zaakobject type: string ArchiefnominatieEnum: enum: - blijvend_bewaren - vernietigen type: string BesluitType: type: object properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 catalogus: type: string format: uri description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. title: catalogus zaaktypen: type: array items: type: string format: uri title: '' readOnly: true description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE title: zaaktypen uniqueItems: true omschrijving: type: string description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. title: omschrijving maxLength: 80 omschrijvingGeneriek: type: string description: Algemeen gehanteerde omschrijving van de aard van BESLUITen van het BESLUITTYPE title: omschrijving generiek maxLength: 80 besluitcategorie: type: string description: Typering van de aard van BESLUITen van het BESLUITTYPE. title: besluitcategorie maxLength: 40 reactietermijn: type: string nullable: true description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype mogelijk is. title: reactietermijn format: duration publicatieIndicatie: type: boolean description: Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten worden. title: publicatie indicatie publicatietekst: type: string description: De generieke tekst van de publicatie van BESLUITen van dit BESLUITTYPE title: publicatietekst publicatietermijn: type: string nullable: true description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten blijven. title: publicatietermijn format: duration toelichting: type: string description: Een eventuele toelichting op dit BESLUITTYPE. title: toelichting informatieobjecttypen: type: array items: type: string format: uri title: '' description: URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten van dit BESLUITTYPE worden vastgelegd. title: informatieobjecttypen uniqueItems: true beginGeldigheid: type: string format: date description: De datum waarop het is ontstaan. title: datum begin geldigheid eindeGeldigheid: type: string format: date nullable: true description: De datum waarop het is opgeheven. title: datum einde geldigheid beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true concept: type: boolean readOnly: true description: Geeft aan of het object een concept betreft. Concepten zijn niet-definitieve versies en zouden niet gebruikt moeten worden buiten deze API. title: concept resultaattypen: type: array items: type: string format: uri title: Is resultaat van readOnly: true title: Is resultaat van description: Het BESLUITTYPE van besluiten die gepaard gaan met resultaten van het RESULTAATTYPE. uniqueItems: true resultaattypenOmschrijving: type: array items: type: string title: '' readOnly: true description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. title: is resultaat van uniqueItems: true vastgelegdIn: type: array items: type: string title: '' readOnly: true description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. title: informatieobjecttypen uniqueItems: true required: - beginGeldigheid - catalogus - concept - informatieobjecttypen - publicatieIndicatie - resultaattypen - resultaattypenOmschrijving - url - vastgelegdIn - zaaktypen BesluitTypePostResponse: type: object properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 catalogus: type: string format: uri description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. title: catalogus zaaktypen: type: array items: type: string format: uri title: '' readOnly: true description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE. Let op, dit veld is een bug en zal verwijderd worden in volgende versie. Het kan alleen de waarde [] bevatten. title: zaaktypen uniqueItems: true deprecated: true omschrijving: type: string description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. title: omschrijving maxLength: 80 omschrijvingGeneriek: type: string description: Algemeen gehanteerde omschrijving van de aard van BESLUITen van het BESLUITTYPE title: omschrijving generiek maxLength: 80 besluitcategorie: type: string description: Typering van de aard van BESLUITen van het BESLUITTYPE. title: besluitcategorie maxLength: 40 reactietermijn: type: string nullable: true description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype mogelijk is. title: reactietermijn format: duration publicatieIndicatie: type: boolean description: Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten worden. title: publicatie indicatie publicatietekst: type: string description: De generieke tekst van de publicatie van BESLUITen van dit BESLUITTYPE title: publicatietekst publicatietermijn: type: string nullable: true description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten blijven. title: publicatietermijn format: duration toelichting: type: string description: Een eventuele toelichting op dit BESLUITTYPE. title: toelichting informatieobjecttypen: type: array items: type: string format: uri title: '' description: URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten van dit BESLUITTYPE worden vastgelegd. title: informatieobjecttypen uniqueItems: true beginGeldigheid: type: string format: date description: De datum waarop het is ontstaan. title: datum begin geldigheid eindeGeldigheid: type: string format: date nullable: true description: De datum waarop het is opgeheven. title: datum einde geldigheid beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true concept: type: boolean readOnly: true description: Geeft aan of het object een concept betreft. Concepten zijn niet-definitieve versies en zouden niet gebruikt moeten worden buiten deze API. title: concept resultaattypen: type: array items: type: string format: uri title: Is resultaat van readOnly: true title: Is resultaat van description: Het BESLUITTYPE van besluiten die gepaard gaan met resultaten van het RESULTAATTYPE. uniqueItems: true resultaattypenOmschrijving: type: array items: type: string title: '' readOnly: true description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. title: is resultaat van uniqueItems: true vastgelegdIn: type: array items: type: string title: '' readOnly: true description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. title: informatieobjecttypen uniqueItems: true required: - beginGeldigheid - catalogus - concept - informatieobjecttypen - publicatieIndicatie - resultaattypen - resultaattypenOmschrijving - url - vastgelegdIn BesluitTypeExpanded: allOf: - $ref: '#/components/schemas/BesluitType' - properties: _expand: $ref: '#/components/schemas/BesluitTypeEmbedded' BesluitTypeEmbedded: type: object properties: catalogus: oneOf: - $ref: '#/components/schemas/CatalogusExpanded' - $ref: '#/components/schemas/EmptyObject' zaaktypen: type: array items: $ref: '#/components/schemas/ZaakTypeExpanded' informatieobjecttypen: type: array items: $ref: '#/components/schemas/InformatieObjectTypeExpanded' resultaattypen: type: array items: $ref: '#/components/schemas/ResultaatTypeExpanded' EmptyObject: type: object description: Leeg object. Dit wordt teruggeven indien het te expanderen veld een null waarde heeft. example: {} BesluitTypeCreate: type: object properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 catalogus: type: string format: uri description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. title: catalogus zaaktypen: type: array items: type: string format: uri title: '' readOnly: true description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE title: zaaktypen uniqueItems: true omschrijving: type: string description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. title: omschrijving maxLength: 80 omschrijvingGeneriek: type: string description: Algemeen gehanteerde omschrijving van de aard van BESLUITen van het BESLUITTYPE title: omschrijving generiek maxLength: 80 besluitcategorie: type: string description: Typering van de aard van BESLUITen van het BESLUITTYPE. title: besluitcategorie maxLength: 40 reactietermijn: type: string nullable: true description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype mogelijk is. title: reactietermijn format: duration publicatieIndicatie: type: boolean description: Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten worden. title: publicatie indicatie publicatietekst: type: string description: De generieke tekst van de publicatie van BESLUITen van dit BESLUITTYPE title: publicatietekst publicatietermijn: type: string nullable: true description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten blijven. title: publicatietermijn format: duration toelichting: type: string description: Een eventuele toelichting op dit BESLUITTYPE. title: toelichting informatieobjecttypen: type: array items: type: string title: '' description: '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten van dit BESLUITTYPE worden vastgelegd.' title: informatieobjecttypen beginGeldigheid: type: string format: date description: De datum waarop het is ontstaan. title: datum begin geldigheid eindeGeldigheid: type: string format: date nullable: true description: De datum waarop het is opgeheven. title: datum einde geldigheid beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true concept: type: boolean readOnly: true description: Geeft aan of het object een concept betreft. Concepten zijn niet-definitieve versies en zouden niet gebruikt moeten worden buiten deze API. title: concept resultaattypen: type: array items: type: string format: uri title: Is resultaat van readOnly: true title: Is resultaat van description: Het BESLUITTYPE van besluiten die gepaard gaan met resultaten van het RESULTAATTYPE. uniqueItems: true resultaattypenOmschrijving: type: array items: type: string title: '' readOnly: true description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. title: is resultaat van uniqueItems: true vastgelegdIn: type: array items: type: string title: '' readOnly: true description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. title: informatieobjecttypen uniqueItems: true required: - beginGeldigheid - catalogus - concept - informatieobjecttypen - publicatieIndicatie - resultaattypen - resultaattypenOmschrijving - url - vastgelegdIn - zaaktypen BesluitTypeUpdate: type: object properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 catalogus: type: string format: uri description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. title: catalogus zaaktypen: type: array items: type: string format: uri title: '' readOnly: true description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE title: zaaktypen uniqueItems: true omschrijving: type: string description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. title: omschrijving maxLength: 80 omschrijvingGeneriek: type: string description: Algemeen gehanteerde omschrijving van de aard van BESLUITen van het BESLUITTYPE title: omschrijving generiek maxLength: 80 besluitcategorie: type: string description: Typering van de aard van BESLUITen van het BESLUITTYPE. title: besluitcategorie maxLength: 40 reactietermijn: type: string nullable: true description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype mogelijk is. title: reactietermijn format: duration publicatieIndicatie: type: boolean description: Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten worden. title: publicatie indicatie publicatietekst: type: string description: De generieke tekst van de publicatie van BESLUITen van dit BESLUITTYPE title: publicatietekst publicatietermijn: type: string nullable: true description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend- of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten blijven. title: publicatietermijn format: duration toelichting: type: string description: Een eventuele toelichting op dit BESLUITTYPE. title: toelichting informatieobjecttypen: type: array items: type: string title: '' description: '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten van dit BESLUITTYPE worden vastgelegd.' title: informatieobjecttypen beginGeldigheid: type: string format: date description: De datum waarop het is ontstaan. title: datum begin geldigheid eindeGeldigheid: type: string format: date nullable: true description: De datum waarop het is opgeheven. title: datum einde geldigheid beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true concept: type: boolean readOnly: true description: Geeft aan of het object een concept betreft. Concepten zijn niet-definitieve versies en zouden niet gebruikt moeten worden buiten deze API. title: concept resultaattypen: type: array items: type: string format: uri title: Is resultaat van readOnly: true title: Is resultaat van description: Het BESLUITTYPE van besluiten die gepaard gaan met resultaten van het RESULTAATTYPE. uniqueItems: true resultaattypenOmschrijving: type: array items: type: string title: '' readOnly: true description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. title: is resultaat van uniqueItems: true vastgelegdIn: type: array items: type: string title: '' readOnly: true description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. title: informatieobjecttypen uniqueItems: true required: - beginGeldigheid - catalogus - concept - informatieobjecttypen - publicatieIndicatie - resultaattypen - resultaattypenOmschrijving - url - vastgelegdIn - zaaktypen BlankEnum: enum: - '' BronCatalogus: type: object description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. properties: url: type: string format: uri title: URL-referentie broncatalogus maxLength: 200 domein: type: string description: Het domein van de CATALOGUS waaraan het ZAAKTYPE is ontleend. title: broncatalogus domein maxLength: 5 rsin: type: string description: Het RSIN van de INGESCHREVEN NIET-NATUURLIJK PERSOON die beheerder is van de CATALOGUS waaraan het ZAAKTYPE is ontleend. title: broncatalogus rsin maxLength: 9 required: - domein - rsin - url BronZaaktype: type: object description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. properties: url: type: string format: uri title: URL-referentie bronzaaktype maxLength: 200 identificatie: type: string description: De Zaaktype-identificatie van het bronzaaktype binnen de CATALOGUS. title: bronzaaktype identificatie maxLength: 50 omschrijving: type: string description: De Zaaktype-omschrijving van het bronzaaktype, zoals gehanteerd in de Broncatalogus. title: bronzaaktype omschrijving maxLength: 80 required: - identificatie - omschrijving - url BrondatumArchiefprocedure: type: object description: Specificatie voor het bepalen van de brondatum voor de start van de Archiefactietermijn (=brondatum) van het zaakdossier. properties: afleidingswijze: allOf: - $ref: '#/components/schemas/AfleidingswijzeEnum' title: Afleidingswijze brondatum description: "Wijze van bepalen van de brondatum.\n\nUitleg bij mogelijke\ \ waarden:\n\n* `afgehandeld` - (Afgehandeld) De termijn start op de datum\ \ waarop de zaak is afgehandeld (ZAAK.Einddatum in het RGBZ).\n* `ander_datumkenmerk`\ \ - (Ander datumkenmerk) De termijn start op de datum die is vastgelegd\ \ in een ander datumveld dan de datumvelden waarop de overige waarden\ \ (van deze attribuutsoort) betrekking hebben. `Objecttype`, `Registratie`\ \ en `Datumkenmerk` zijn niet leeg.\n* `eigenschap` - (Eigenschap) De\ \ termijn start op de datum die vermeld is in een zaaktype-specifieke\ \ eigenschap (zijnde een `datumveld`). `ResultaatType.ZaakType` heeft\ \ een `Eigenschap`; `Objecttype`, en `Datumkenmerk` zijn niet leeg.\n\ * `gerelateerde_zaak` - (Gerelateerde zaak) De termijn start op de datum\ \ waarop de gerelateerde zaak is afgehandeld (`ZAAK.Einddatum` of `ZAAK.Gerelateerde_zaak.Einddatum`\ \ in het RGBZ). `ResultaatType.ZaakType` heeft gerelateerd `ZaakType`\n\ * `hoofdzaak` - (Hoofdzaak) De termijn start op de datum waarop de gerelateerde\ \ zaak is afgehandeld, waarvan de zaak een deelzaak is (`ZAAK.Einddatum`\ \ van de hoofdzaak in het RGBZ). ResultaatType.ZaakType is deelzaaktype\ \ van ZaakType.\n* `ingangsdatum_besluit` - (Ingangsdatum besluit) De\ \ termijn start op de datum waarop het besluit van kracht wordt (`BESLUIT.Ingangsdatum`\ \ in het RGBZ).\tResultaatType.ZaakType heeft relevant BesluitType\n*\ \ `termijn` - (Termijn) De termijn start een vast aantal jaren na de datum\ \ waarop de zaak is afgehandeld (`ZAAK.Einddatum` in het RGBZ).\n* `vervaldatum_besluit`\ \ - (Vervaldatum besluit) De termijn start op de dag na de datum waarop\ \ het besluit vervalt (`BESLUIT.Vervaldatum` in het RGBZ). ResultaatType.ZaakType\ \ heeft relevant BesluitType\n* `zaakobject` - (Zaakobject) De termijn\ \ start op de einddatum geldigheid van het zaakobject waarop de zaak betrekking\ \ heeft (bijvoorbeeld de overlijdendatum van een Persoon). M.b.v. de attribuutsoort\ \ `Objecttype` wordt vastgelegd om welke zaakobjecttype het gaat; m.b.v.\ \ de attribuutsoort `Datumkenmerk` wordt vastgelegd welke datum-attribuutsoort\ \ van het zaakobjecttype het betreft." datumkenmerk: type: string description: Naam van de attribuutsoort van het procesobject dat bepalend is voor het einde van de procestermijn. title: datumkenmerk maxLength: 80 einddatumBekend: type: boolean description: Indicatie dat de einddatum van het procesobject gedurende de uitvoering van de zaak bekend moet worden. Indien deze nog niet bekend is en deze waarde staat op `true`, dan kan de zaak (nog) niet afgesloten worden. title: einddatum bekend objecttype: description: 'Het soort object in de registratie dat het procesobject representeert. Uitleg bij mogelijke waarden: * `adres` - Adres * `besluit` - Besluit * `buurt` - Buurt * `enkelvoudig_document` - Enkelvoudig document * `gemeente` - Gemeente * `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte * `huishouden` - Huishouden * `inrichtingselement` - Inrichtingselement * `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak * `kunstwerkdeel` - Kunstwerkdeel * `maatschappelijke_activiteit` - Maatschappelijke activiteit * `medewerker` - Medewerker * `natuurlijk_persoon` - Natuurlijk persoon * `niet_natuurlijk_persoon` - Niet-natuurlijk persoon * `openbare_ruimte` - Openbare ruimte * `organisatorische_eenheid` - Organisatorische eenheid * `pand` - Pand * `spoorbaandeel` - Spoorbaandeel * `status` - Status * `terreindeel` - Terreindeel * `terrein_gebouwd_object` - Terrein gebouwd object * `vestiging` - Vestiging * `waterdeel` - Waterdeel * `wegdeel` - Wegdeel * `wijk` - Wijk * `woonplaats` - Woonplaats * `woz_deelobject` - Woz deel object * `woz_object` - Woz object * `woz_waarde` - Woz waarde * `zakelijk_recht` - Zakelijk recht * `overige` - Overige' title: objecttype oneOf: - $ref: '#/components/schemas/ObjecttypeEnum' - $ref: '#/components/schemas/BlankEnum' registratie: type: string description: De naam van de registratie waarvan het procesobject deel uit maakt. title: registratie maxLength: 80 procestermijn: type: string nullable: true title: Brondatum procestermijn description: De periode dat het zaakdossier na afronding van de zaak actief gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening van de organisatie. Enkel relevant indien de afleidingswijze 'termijn' is. format: duration required: - afleidingswijze nullable: true Catalogus: type: object properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 domein: type: string description: Een afkorting waarmee wordt aangegeven voor welk domein in een CATALOGUS ZAAKTYPEn zijn uitgewerkt. title: domein maxLength: 5 rsin: type: string description: Het door een kamer toegekend uniek nummer voor de INGESCHREVEN NIET-NATUURLIJK PERSOON die de eigenaar is van een CATALOGUS. title: rsin maxLength: 9 contactpersoonBeheerNaam: type: string title: Naam contactpersoon description: De naam van de contactpersoon die verantwoordelijk is voor het beheer van de CATALOGUS. maxLength: 40 contactpersoonBeheerTelefoonnummer: type: string title: Telefoonnummer description: Het telefoonnummer van de contactpersoon die verantwoordelijk is voor het beheer van de CATALOGUS. maxLength: 20 contactpersoonBeheerEmailadres: type: string format: email title: Emailadres description: Het emailadres van de contactpersoon die verantwoordelijk is voor het beheer van de CATALOGUS. maxLength: 254 zaaktypen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar ZAAKTYPEn die in deze CATALOGUS worden ontsloten. title: Catalogus uniqueItems: true besluittypen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar BESLUITTYPEn die in deze CATALOGUS worden ontsloten. title: catalogus uniqueItems: true informatieobjecttypen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar INFORMATIEOBJECTTYPEn die in deze CATALOGUS worden ontsloten. title: Catalogus uniqueItems: true naam: type: string nullable: true description: De benaming die is gegeven aan de zaaktypecatalogus. title: naam maxLength: 200 versie: type: string nullable: true description: Versie-aanduiding van de van toepassing zijnde zaaktypecatalogus. title: versie maxLength: 20 begindatumVersie: type: string format: date nullable: true description: Datum waarop de versie van de zaaktypecatalogus van toepassing is geworden. title: begindatum versie required: - besluittypen - contactpersoonBeheerNaam - domein - informatieobjecttypen - rsin - url - zaaktypen CatalogusExpanded: allOf: - $ref: '#/components/schemas/Catalogus' - properties: _expand: $ref: '#/components/schemas/CatalogusEmbedded' CatalogusEmbedded: type: object properties: zaaktypen: type: array items: $ref: '#/components/schemas/ZaakTypeExpanded' besluittypen: type: array items: $ref: '#/components/schemas/BesluitTypeExpanded' informatieobjecttypen: type: array items: $ref: '#/components/schemas/InformatieObjectTypeExpanded' CheckListItem: type: object properties: itemnaam: type: string description: De betekenisvolle benaming van het checklistitem title: itemnaam maxLength: 30 toelichting: type: string nullable: true description: Beschrijving van de overwegingen bij het controleren van het aandachtspunt title: toelichting maxLength: 1000 vraagstelling: type: string description: Een betekenisvolle vraag waaruit blijkt waarop het aandachtspunt gecontroleerd moet worden. title: vraagstelling maxLength: 255 verplicht: type: boolean description: Het al dan niet verplicht zijn van controle van het aandachtspunt voorafgaand aan het bereiken van de status van het gerelateerde STATUSTYPE. title: verplicht required: - itemnaam - vraagstelling Eigenschap: type: object properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 naam: type: string description: De naam van de EIGENSCHAP title: eigenschapnaam maxLength: 20 catalogus: type: string format: uri readOnly: true title: catalogus definitie: type: string description: De beschrijving van de betekenis van deze EIGENSCHAP title: definitie maxLength: 255 specificatie: allOf: - $ref: '#/components/schemas/EigenschapSpecificatie' title: specificatie van eigenschap toelichting: type: string description: Een toelichting op deze EIGENSCHAP en het belang hiervan voor zaken van dit ZAAKTYPE. title: toelichting maxLength: 1000 zaaktype: type: string format: uri description: URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze EIGENSCHAP van belang is. title: Zaaktype zaaktypeIdentificatie: type: string readOnly: true description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: Zaaktype statustype: type: string format: uri nullable: true title: Status type description: Status type moet (onder andere) deze EIGENSCHAP hebben, voordat een STATUS van het STATUSTYPE kan worden gezet. beginGeldigheid: type: string format: date nullable: true description: De datum waarop de EIGENSCHAP is ontstaan. title: datum begin geldigheid deprecated: true eindeGeldigheid: type: string format: date nullable: true description: De datum waarop de EIGENSCHAP is opgeheven. title: datum einde geldigheid deprecated: true beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true required: - catalogus - definitie - naam - specificatie - url - zaaktype - zaaktypeIdentificatie EigenschapExpanded: allOf: - $ref: '#/components/schemas/Eigenschap' - properties: _expand: $ref: '#/components/schemas/EigenschapEmbedded' EigenschapEmbedded: type: object properties: catalogus: oneOf: - $ref: '#/components/schemas/CatalogusExpanded' - $ref: '#/components/schemas/EmptyObject' zaaktype: oneOf: - $ref: '#/components/schemas/ZaakTypeExpanded' - $ref: '#/components/schemas/EmptyObject' statustype: oneOf: - $ref: '#/components/schemas/StatusTypeExpanded' - $ref: '#/components/schemas/EmptyObject' EigenschapSpecificatie: type: object properties: groep: type: string description: Benaming van het object of groepattribuut waarvan de EIGENSCHAP een inhoudelijk gegeven specificeert. title: groep maxLength: 32 formaat: allOf: - $ref: '#/components/schemas/FormaatEnum' description: 'Het soort tekens waarmee waarden van de EIGENSCHAP kunnen worden vastgelegd. Uitleg bij mogelijke waarden: * `tekst` - Tekst * `getal` - Getal * `datum` - Datum * `datum_tijd` - Datum/tijd' title: formaat lengte: type: string description: Het aantal karakters (lengte) waarmee waarden van de EIGENSCHAP worden vastgelegd. title: lengte maxLength: 14 kardinaliteit: type: string description: Het aantal mogelijke voorkomens van waarden van deze EIGENSCHAP bij een zaak van het ZAAKTYPE. title: kardinaliteit maxLength: 3 waardenverzameling: type: array items: type: string maxLength: 100 description: Waarden die deze EIGENSCHAP kan hebben. title: waardenverzameling required: - formaat - kardinaliteit - lengte FieldValidationError: type: object description: Formaat van validatiefouten. properties: name: type: string description: Naam van het veld met ongeldige gegevens title: name code: type: string description: Systeemcode die het type fout aangeeft title: code reason: type: string description: Uitleg wat er precies fout is met de gegevens title: reason required: - code - name - reason FormaatEnum: enum: - tekst - getal - datum - datum_tijd type: string Fout: type: object description: Formaat van HTTP 4xx en 5xx fouten. properties: type: type: string description: URI referentie naar het type fout, bedoeld voor developers title: type code: type: string description: Systeemcode die het type fout aangeeft title: code title: type: string description: Generieke titel voor het type fout title: title status: type: integer description: De HTTP status code title: status detail: type: string description: Extra informatie bij de fout, indien beschikbaar title: detail instance: type: string description: URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. title: instance required: - code - detail - instance - status - title IndicatieInternOfExternEnum: enum: - intern - extern type: string InformatieObjectType: type: object description: Serializer based on ``IOT-basis`` specified in XSD ``ztc0310_ent_basis.xsd``. properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 catalogus: type: string format: uri description: URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE behoort. title: Catalogus omschrijving: type: string description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. title: omschrijving maxLength: 80 vertrouwelijkheidaanduiding: allOf: - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' description: 'Aanduiding van de mate waarin informatieobjecten van dit INFORMATIEOBJECTTYPE voor de openbaarheid bestemd zijn. Uitleg bij mogelijke waarden: * `openbaar` - Openbaar * `beperkt_openbaar` - Beperkt openbaar * `intern` - Intern * `zaakvertrouwelijk` - Zaakvertrouwelijk * `vertrouwelijk` - Vertrouwelijk * `confidentieel` - Confidentieel * `geheim` - Geheim * `zeer_geheim` - Zeer geheim' title: vertrouwelijkheidaanduiding beginGeldigheid: type: string format: date description: De datum waarop het is ontstaan. title: datum begin geldigheid eindeGeldigheid: type: string format: date nullable: true description: De datum waarop het is opgeheven. title: datum einde geldigheid beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true concept: type: boolean readOnly: true description: Geeft aan of het object een concept betreft. Concepten zijn niet-definitieve versies en zouden niet gebruikt moeten worden buiten deze API. title: concept zaaktypen: type: array items: type: string format: uri readOnly: true title: zaaktypen description: Lijst van URL-referenties naar de zaaktypen die gebruik maken van dit INFORMATIEOBJECTTYPE. uniqueItems: true besluittypen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten van dit BESLUITTYPE worden vastgelegd. title: informatieobjecttypen uniqueItems: true informatieobjectcategorie: type: string title: Categorie description: Typering van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. maxLength: 80 trefwoord: type: array items: type: string maxLength: 30 description: Trefwoord(en) waarmee informatieobjecten van het INFORMATIEOBJECTTYPE kunnen worden gekarakteriseerd. (Gebruik een komma om waarden van elkaar te onderscheiden.) title: trefwoord omschrijvingGeneriek: allOf: - $ref: '#/components/schemas/InformatieObjectTypeOmschrijvingGeneriek' title: omschrijving generiek required: - beginGeldigheid - besluittypen - catalogus - concept - informatieobjectcategorie - omschrijving - url - vertrouwelijkheidaanduiding - zaaktypen InformatieObjectTypeExpanded: allOf: - $ref: '#/components/schemas/InformatieObjectType' - properties: _expand: $ref: '#/components/schemas/InformatieObjectTypeEmbedded' InformatieObjectTypeEmbedded: type: object properties: catalogus: oneOf: - $ref: '#/components/schemas/CatalogusExpanded' - $ref: '#/components/schemas/EmptyObject' zaaktypen: type: array items: $ref: '#/components/schemas/ZaakTypeExpanded' besluittypen: type: array items: $ref: '#/components/schemas/BesluitTypeExpanded' InformatieObjectTypeOmschrijvingGeneriek: type: object properties: informatieobjecttypeOmschrijvingGeneriek: type: string description: Algemeen gehanteerde omschrijving van het type informatieobject. title: informatieobjecttype omschrijving generiek maxLength: 80 definitieInformatieobjecttypeOmschrijvingGeneriek: type: string title: Definitie description: Nauwkeurige beschrijving van het generieke type informatieobject maxLength: 255 herkomstInformatieobjecttypeOmschrijvingGeneriek: type: string title: Herkomst description: De naam van de waardenverzameling, of van de beherende organisatie daarvan, waaruit de waarde is overgenomen. maxLength: 12 hierarchieInformatieobjecttypeOmschrijvingGeneriek: type: string title: Hierarchie description: De plaats in de rangorde van het informatieobjecttype. maxLength: 80 opmerkingInformatieobjecttypeOmschrijvingGeneriek: type: string nullable: true title: Opmerking description: Zinvolle toelichting bij het informatieobjecttype maxLength: 255 required: - definitieInformatieobjecttypeOmschrijvingGeneriek - herkomstInformatieobjecttypeOmschrijvingGeneriek - hierarchieInformatieobjecttypeOmschrijvingGeneriek - informatieobjecttypeOmschrijvingGeneriek ObjecttypeEnum: enum: - adres - besluit - buurt - enkelvoudig_document - gemeente - gemeentelijke_openbare_ruimte - huishouden - inrichtingselement - kadastrale_onroerende_zaak - kunstwerkdeel - maatschappelijke_activiteit - medewerker - natuurlijk_persoon - niet_natuurlijk_persoon - openbare_ruimte - organisatorische_eenheid - pand - spoorbaandeel - status - terreindeel - terrein_gebouwd_object - vestiging - waterdeel - wegdeel - wijk - woonplaats - woz_deelobject - woz_object - woz_waarde - zakelijk_recht - overige type: string OmschrijvingGeneriekEnum: enum: - adviseur - behandelaar - belanghebbende - beslisser - initiator - klantcontacter - zaakcoordinator - mede_initiator type: string PaginatedBesluitTypeList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/BesluitTypeExpanded' PaginatedCatalogusList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/CatalogusExpanded' PaginatedEigenschapList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/EigenschapExpanded' PaginatedResultaatTypeList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/ResultaatTypeExpanded' PaginatedInformatieObjectTypeList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/InformatieObjectTypeExpanded' PaginatedRolTypeList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/RolTypeExpanded' PaginatedStatusTypeList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/StatusTypeExpanded' PaginatedZaakObjectTypeList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/ZaakObjectTypeExpanded' PaginatedZaakTypeInformatieObjectTypeList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/ZaakTypeInformatieObjectTypeExpanded' PaginatedZaakTypeList: type: object properties: count: type: integer example: 123 next: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=4 previous: type: string nullable: true format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/ZaakTypeExpanded' PatchedEigenschap: type: object properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 naam: type: string description: De naam van de EIGENSCHAP title: eigenschapnaam maxLength: 20 catalogus: type: string format: uri readOnly: true title: catalogus definitie: type: string description: De beschrijving van de betekenis van deze EIGENSCHAP title: definitie maxLength: 255 specificatie: allOf: - $ref: '#/components/schemas/EigenschapSpecificatie' title: specificatie van eigenschap toelichting: type: string description: Een toelichting op deze EIGENSCHAP en het belang hiervan voor zaken van dit ZAAKTYPE. title: toelichting maxLength: 1000 zaaktype: type: string format: uri description: URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze EIGENSCHAP van belang is. title: Zaaktype zaaktypeIdentificatie: type: string readOnly: true description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: Zaaktype statustype: type: string format: uri nullable: true title: Status type description: Status type moet (onder andere) deze EIGENSCHAP hebben, voordat een STATUS van het STATUSTYPE kan worden gezet. beginGeldigheid: type: string format: date nullable: true description: De datum waarop de EIGENSCHAP is ontstaan. title: datum begin geldigheid deprecated: true eindeGeldigheid: type: string format: date nullable: true description: De datum waarop de EIGENSCHAP is opgeheven. title: datum einde geldigheid deprecated: true beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true PatchedResultaatType: type: object description: 'Set gegevensgroepdata from validated nested data. Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 zaaktype: type: string format: uri title: is van description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten van dit RESULTAATTYPE bereikt kunnen worden. zaaktypeIdentificatie: type: string readOnly: true description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: is relevant voor omschrijving: type: string description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. title: omschrijving maxLength: 30 resultaattypeomschrijving: type: string format: uri description: Algemeen gehanteerde omschrijving van de aard van resultaten van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving generiek' title: resultaattypeomschrijving maxLength: 1000 omschrijvingGeneriek: type: string readOnly: true description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) title: omschrijving generiek selectielijstklasse: type: string format: uri description: URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. title: selectielijstklasse maxLength: 1000 toelichting: type: string description: Een toelichting op dit RESULTAATTYPE en het belang hiervan voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. title: toelichting archiefnominatie: description: 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de selectielijst. Uitleg bij mogelijke waarden: * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum overgedragen worden naar een archiefbewaarplaats. * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd worden.' title: archiefnominatie oneOf: - $ref: '#/components/schemas/ArchiefnominatieEnum' - $ref: '#/components/schemas/BlankEnum' archiefactietermijn: type: string nullable: true description: De termijn, na het vervallen van het bedrjfsvoeringsbelang, waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend te bewaren zaakdossiers betreft het de termijn vanaf afronding van de zaak tot overbrenging (de procestermijn is dan nihil). title: archiefactietermijn format: duration brondatumArchiefprocedure: allOf: - $ref: '#/components/schemas/BrondatumArchiefprocedure' nullable: true description: Specificatie voor het bepalen van de brondatum voor de start van de Archiefactietermijn (=brondatum) van het zaakdossier. title: brondatumArchiefprocedure procesobjectaard: type: string nullable: true description: Omschrijving van het object, subject of gebeurtenis waarop, vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking heeft. title: procesobjectaard maxLength: 200 catalogus: type: string format: uri nullable: true description: URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE behoort. Let op, dit veld is verouderd, maar als het wordt meegegeven dan moet de url refereren naar dezelfde catalogus als dat van het zaaktype! title: catalogus deprecated: true beginGeldigheid: type: string format: date nullable: true description: De datum waarop de RESULTAATTYPE is ontstaan. title: datum begin geldigheid deprecated: true eindeGeldigheid: type: string format: date nullable: true description: De datum waarop de RESULTAATTYPE is opgeheven. title: datum einde geldigheid deprecated: true beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true indicatieSpecifiek: type: boolean nullable: true description: Aanduiding of het, vanuit archiveringsoptiek, een resultaattype betreft dat specifiek is voor een bepaalde procesobjectaard. title: indicatie specifiek procestermijn: type: string nullable: true description: De periode dat het zaakdossier na afronding van de zaak actief gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening van de organisatie. title: procestermijn format: duration besluittypen: type: array items: type: string format: uri nullable: true title: '' title: is resultaat van uniqueItems: true besluittypeOmschrijving: type: array items: type: string title: '' readOnly: true description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. title: is resultaat van uniqueItems: true informatieobjecttypen: type: array items: type: string format: uri nullable: true title: '' description: De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van dit RESULTAATTYPE kan worden gezet. title: informatieobjecttypen uniqueItems: true informatieobjecttypeOmschrijving: type: array items: type: string title: '' readOnly: true description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. title: informatieobjecttypen uniqueItems: true PatchedRolType: type: object description: Adds nested create feature properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 zaaktype: type: string format: uri description: URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken kunnen zijn. title: Zaaktype zaaktypeIdentificatie: type: string readOnly: true description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: Zaaktype omschrijving: type: string description: Omschrijving van de aard van de ROL. title: omschrijving maxLength: 100 omschrijvingGeneriek: allOf: - $ref: '#/components/schemas/OmschrijvingGeneriekEnum' description: "Algemeen gehanteerde omschrijving van de aard van de ROL.\n\ \nUitleg bij mogelijke waarden:\n\n* `adviseur` - (Adviseur) Kennis in\ \ dienst stellen van de behandeling van (een deel van) een zaak.\n* `behandelaar`\ \ - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van)\ \ een zaak.\n* `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief\ \ belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst\ \ van een zaak.\n* `beslisser` - (Beslisser) Nemen van besluiten die voor\ \ de uitkomst van een zaak noodzakelijk zijn.\n* `initiator` - (Initiator)\ \ Aanleiding geven tot de start van een zaak ..\n* `klantcontacter` -\ \ (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers\ \ en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6rdinator) Er voor\ \ zorg dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt\ \ conform de daarover gemaakte afspraken.\n* `mede_initiator` - Mede-initiator" title: omschrijving generiek catalogus: type: string format: uri nullable: true description: URL-referentie naar de CATALOGUS waartoe dit ROLTYPE behoort. Let op, dit veld is verouderd, maar als het wordt meegegeven dan moet de url refereren naar dezelfde catalogus als dat van het zaaktype! title: catalogus deprecated: true beginGeldigheid: type: string format: date nullable: true description: De datum waarop het is ontstaan. title: datum begin geldigheid deprecated: true eindeGeldigheid: type: string format: date nullable: true description: De datum waarop het is opgeheven. title: datum einde geldigheid deprecated: true beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true PatchedStatusType: type: object properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 omschrijving: type: string description: Een korte, voor de initiator van de zaak relevante, omschrijving van de aard van de STATUS van zaken van een ZAAKTYPE. title: omschrijving maxLength: 80 omschrijvingGeneriek: type: string description: Algemeen gehanteerde omschrijving van de aard van STATUSsen van het STATUSTYPE title: omschrijving generiek maxLength: 80 statustekst: type: string description: De tekst die wordt gebruikt om de Initiator te informeren over het bereiken van een STATUS van dit STATUSTYPE bij het desbetreffende ZAAKTYPE. title: statustekst maxLength: 1000 zaaktype: type: string format: uri description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen van dit STATUSTYPE bereikt kunnen worden. title: Zaaktype catalogus: type: string format: uri readOnly: true title: catalogus zaaktypeIdentificatie: type: string readOnly: true description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: Zaaktype volgnummer: type: integer maximum: 9999 minimum: 1 description: Een volgnummer voor statussen van het STATUSTYPE binnen een zaak. title: statustypevolgnummer isEindstatus: type: boolean readOnly: true description: Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven is afgeleid uit alle STATUSTYPEn van dit ZAAKTYPE met het hoogste volgnummer. title: isEindstatus informeren: type: boolean description: "Aanduiding die aangeeft of na het zetten van een STATUS van\ \ dit STATUSTYPE de Initiator moet worden ge\xEFnformeerd over de statusovergang." title: informeren doorlooptijd: type: string nullable: true description: De door de zaakbehandelende organisatie(s) gestelde norm voor de doorlooptijd voor het bereiken van STATUSsen van dit STATUSTYPE bij het desbetreffende ZAAKTYPE. title: doorlooptijd status format: duration toelichting: type: string nullable: true description: Een eventuele toelichting op dit STATUSTYPE. title: toelichting maxLength: 1000 checklistitemStatustype: type: array items: $ref: '#/components/schemas/CheckListItem' title: checklistitem eigenschappen: type: array items: type: string format: uri nullable: true title: '' description: de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen, voordat een STATUS van dit STATUSTYPE kan worden gezet. title: eigenschappen uniqueItems: true beginGeldigheid: type: string format: date nullable: true description: De datum waarop het is ontstaan. title: datum begin geldigheid deprecated: true eindeGeldigheid: type: string format: date nullable: true description: De datum waarop het is opgeheven. title: datum einde geldigheid deprecated: true beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true PatchedZaakObjectType: type: object properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 anderObjecttype: type: boolean description: Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. title: Ander objecttype beginGeldigheid: type: string format: date description: De datum waarop het is ontstaan. title: datum begin geldigheid deprecated: true eindeGeldigheid: type: string format: date nullable: true description: De datum waarop het is opgeheven. title: datum einde geldigheid deprecated: true beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true objecttype: type: string format: uri description: URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE behoort. title: Objecttype maxLength: 200 relatieOmschrijving: type: string description: Omschrijving van de betrekking van het Objecttype op zaken van het gerelateerde ZAAKTYPE. title: Relatie omschrijving maxLength: 80 zaaktype: type: string format: uri description: URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE behoort. title: Zaaktype zaaktypeIdentificatie: type: string readOnly: true description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: Zaaktype resultaattypen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar de RESULTAATTYPEN. title: Zaakobjecttypen uniqueItems: true statustypen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar de STATUSTYPEN. title: Zaakobjecttypen uniqueItems: true catalogus: type: string format: uri description: URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE behoort. title: Catalogus PatchedZaakTypeInformatieObjectType: type: object description: 'Represent a ZaakTypeInformatieObjectType. Relatie met informatieobjecttype dat relevant is voor zaaktype.' properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 zaaktype: type: string format: uri description: URL-referentie naar het ZAAKTYPE. title: zaaktype zaaktypeIdentificatie: type: string readOnly: true description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: zaaktype catalogus: type: string format: uri readOnly: true title: catalogus informatieobjecttype: type: string title: informatieobjecttype maxLength: 100 volgnummer: type: integer maximum: 999 minimum: 1 description: Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het ZAAKTYPE. title: volgnummer richting: allOf: - $ref: '#/components/schemas/RichtingEnum' description: 'Aanduiding van de richting van informatieobjecten van het gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. Uitleg bij mogelijke waarden: * `inkomend` - Inkomend * `intern` - Intern * `uitgaand` - Uitgaand' title: richting statustype: type: string format: uri nullable: true title: Status type description: URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn verplicht aanwezig moeten zijn. ReferentieProces: type: object description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. properties: naam: type: string title: Referentieprocesnaam description: De naam van het Referentieproces. maxLength: 80 link: type: string format: uri title: Referentieproceslink description: De URL naar de beschrijving van het Referentieproces maxLength: 200 required: - naam ResultaatType: type: object description: 'Set gegevensgroepdata from validated nested data. Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 zaaktype: type: string format: uri title: is van description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten van dit RESULTAATTYPE bereikt kunnen worden. zaaktypeIdentificatie: type: string readOnly: true description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: is relevant voor omschrijving: type: string description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. title: omschrijving maxLength: 30 resultaattypeomschrijving: type: string format: uri description: Algemeen gehanteerde omschrijving van de aard van resultaten van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving generiek' title: resultaattypeomschrijving maxLength: 1000 omschrijvingGeneriek: type: string readOnly: true description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) title: omschrijving generiek selectielijstklasse: type: string format: uri description: URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. title: selectielijstklasse maxLength: 1000 toelichting: type: string description: Een toelichting op dit RESULTAATTYPE en het belang hiervan voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. title: toelichting archiefnominatie: description: 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de selectielijst. Uitleg bij mogelijke waarden: * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum overgedragen worden naar een archiefbewaarplaats. * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd worden.' title: archiefnominatie oneOf: - $ref: '#/components/schemas/ArchiefnominatieEnum' - $ref: '#/components/schemas/BlankEnum' archiefactietermijn: type: string nullable: true description: De termijn, na het vervallen van het bedrjfsvoeringsbelang, waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend te bewaren zaakdossiers betreft het de termijn vanaf afronding van de zaak tot overbrenging (de procestermijn is dan nihil). title: archiefactietermijn format: duration brondatumArchiefprocedure: allOf: - $ref: '#/components/schemas/BrondatumArchiefprocedure' nullable: true description: Specificatie voor het bepalen van de brondatum voor de start van de Archiefactietermijn (=brondatum) van het zaakdossier. title: brondatumArchiefprocedure procesobjectaard: type: string nullable: true description: Omschrijving van het object, subject of gebeurtenis waarop, vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking heeft. title: procesobjectaard maxLength: 200 catalogus: type: string format: uri nullable: true description: URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE behoort. Let op, dit veld is verouderd, maar als je het meegeeft dan moet er naar dezelfde catalogus worden verwezen als die van het zaaktype. title: catalogus deprecated: true beginGeldigheid: type: string format: date nullable: true description: De datum waarop de RESULTAATTYPE is ontstaan. title: datum begin geldigheid deprecated: true eindeGeldigheid: type: string format: date nullable: true description: De datum waarop de RESULTAATTYPE is opgeheven. title: datum einde geldigheid deprecated: true beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true indicatieSpecifiek: type: boolean nullable: true description: Aanduiding of het, vanuit archiveringsoptiek, een resultaattype betreft dat specifiek is voor een bepaalde procesobjectaard. title: indicatie specifiek procestermijn: type: string nullable: true description: De periode dat het zaakdossier na afronding van de zaak actief gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening van de organisatie. title: procestermijn format: duration besluittypen: type: array items: type: string format: uri nullable: true title: '' title: is resultaat van uniqueItems: true besluittypeOmschrijving: type: array items: type: string title: '' readOnly: true description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. title: is resultaat van uniqueItems: true informatieobjecttypen: type: array items: type: string format: uri nullable: true title: '' description: De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van dit RESULTAATTYPE kan worden gezet. title: informatieobjecttypen uniqueItems: true informatieobjecttypeOmschrijving: type: array items: type: string title: '' readOnly: true description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. title: informatieobjecttypen uniqueItems: true required: - besluittypeOmschrijving - informatieobjecttypeOmschrijving - omschrijving - omschrijvingGeneriek - resultaattypeomschrijving - selectielijstklasse - url - zaaktype - zaaktypeIdentificatie ResultaatTypeExpanded: allOf: - $ref: '#/components/schemas/ResultaatType' - properties: _expand: $ref: '#/components/schemas/ResultaatTypeEmbedded' ResultaatTypeEmbedded: type: object properties: catalogus: oneOf: - $ref: '#/components/schemas/CatalogusExpanded' - $ref: '#/components/schemas/EmptyObject' zaaktype: oneOf: - $ref: '#/components/schemas/ZaakTypeExpanded' - $ref: '#/components/schemas/EmptyObject' besluittypen: type: array items: $ref: '#/components/schemas/BesluitTypeExpanded' informatieobjecttypen: type: array items: $ref: '#/components/schemas/InformatieObjectTypeExpanded' ResultaatTypeCreate: type: object description: 'Set gegevensgroepdata from validated nested data. Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 zaaktype: type: string format: uri title: is van description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten van dit RESULTAATTYPE bereikt kunnen worden. zaaktypeIdentificatie: type: string readOnly: true description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: is relevant voor omschrijving: type: string description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. title: omschrijving maxLength: 30 resultaattypeomschrijving: type: string format: uri description: Algemeen gehanteerde omschrijving van de aard van resultaten van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving generiek' title: resultaattypeomschrijving maxLength: 1000 omschrijvingGeneriek: type: string readOnly: true description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) title: omschrijving generiek selectielijstklasse: type: string format: uri description: URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. title: selectielijstklasse maxLength: 1000 toelichting: type: string description: Een toelichting op dit RESULTAATTYPE en het belang hiervan voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. title: toelichting archiefnominatie: description: 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de selectielijst. Uitleg bij mogelijke waarden: * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum overgedragen worden naar een archiefbewaarplaats. * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd worden.' title: archiefnominatie oneOf: - $ref: '#/components/schemas/ArchiefnominatieEnum' - $ref: '#/components/schemas/BlankEnum' archiefactietermijn: type: string nullable: true description: De termijn, na het vervallen van het bedrjfsvoeringsbelang, waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend te bewaren zaakdossiers betreft het de termijn vanaf afronding van de zaak tot overbrenging (de procestermijn is dan nihil). title: archiefactietermijn format: duration brondatumArchiefprocedure: allOf: - $ref: '#/components/schemas/BrondatumArchiefprocedure' nullable: true description: Specificatie voor het bepalen van de brondatum voor de start van de Archiefactietermijn (=brondatum) van het zaakdossier. title: brondatumArchiefprocedure procesobjectaard: type: string nullable: true description: Omschrijving van het object, subject of gebeurtenis waarop, vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking heeft. title: procesobjectaard maxLength: 200 catalogus: type: string format: uri nullable: true description: URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE behoort. Let op, dit veld is verouderd, maar als het wordt meegegeven dan moet de url refereren naar dezelfde catalogus als dat van het zaaktype! title: catalogus deprecated: true beginGeldigheid: type: string format: date nullable: true description: De datum waarop de RESULTAATTYPE is ontstaan. title: datum begin geldigheid deprecated: true eindeGeldigheid: type: string format: date nullable: true description: De datum waarop de RESULTAATTYPE is opgeheven. title: datum einde geldigheid deprecated: true beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true indicatieSpecifiek: type: boolean nullable: true description: Aanduiding of het, vanuit archiveringsoptiek, een resultaattype betreft dat specifiek is voor een bepaalde procesobjectaard. title: indicatie specifiek procestermijn: type: string nullable: true description: De periode dat het zaakdossier na afronding van de zaak actief gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening van de organisatie. title: procestermijn format: duration besluittypen: type: array items: type: string title: Besluittype title: besluittypen description: Omschrijvingen van de besluittypen die de resultaten van dit resultaattype als gevolg kunnen hebben. besluittypeOmschrijving: type: array items: type: string readOnly: true description: Omschrijvingen van de besluittypen die de resultaten van dit resultaattype als gevolg kunnen hebben. title: Besluittype-omschrijving uniqueItems: true informatieobjecttypen: type: array items: type: string format: uri nullable: true description: Omschrijvingen van de INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van dit RESULTAATTYPE kan worden gezet. title: informatieobjecttypen uniqueItems: true informatieobjecttypeOmschrijving: type: array items: type: string title: '' readOnly: true description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. title: informatieobjecttypen uniqueItems: true required: - besluittypeOmschrijving - informatieobjecttypeOmschrijving - omschrijving - omschrijvingGeneriek - resultaattypeomschrijving - selectielijstklasse - url - zaaktype - zaaktypeIdentificatie ResultaatTypeUpdate: type: object description: 'Set gegevensgroepdata from validated nested data. Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 zaaktype: type: string format: uri title: is van description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten van dit RESULTAATTYPE bereikt kunnen worden. zaaktypeIdentificatie: type: string readOnly: true description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: is relevant voor omschrijving: type: string description: Omschrijving van de aard van resultaten van het RESULTAATTYPE. title: omschrijving maxLength: 30 resultaattypeomschrijving: type: string format: uri description: Algemeen gehanteerde omschrijving van de aard van resultaten van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving generiek' title: resultaattypeomschrijving maxLength: 1000 omschrijvingGeneriek: type: string readOnly: true description: Waarde van de omschrijving-generiek referentie (attribuut `omschrijving`) title: omschrijving generiek selectielijstklasse: type: string format: uri description: URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie. title: selectielijstklasse maxLength: 1000 toelichting: type: string description: Een toelichting op dit RESULTAATTYPE en het belang hiervan voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd. title: toelichting archiefnominatie: description: 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de selectielijst. Uitleg bij mogelijke waarden: * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum overgedragen worden naar een archiefbewaarplaats. * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd worden.' title: archiefnominatie oneOf: - $ref: '#/components/schemas/ArchiefnominatieEnum' - $ref: '#/components/schemas/BlankEnum' archiefactietermijn: type: string nullable: true description: De termijn, na het vervallen van het bedrjfsvoeringsbelang, waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen) van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht (naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers betreft het de in die Selectielijst genoemde bewaartermjn. Voor blijvend te bewaren zaakdossiers betreft het de termijn vanaf afronding van de zaak tot overbrenging (de procestermijn is dan nihil). title: archiefactietermijn format: duration brondatumArchiefprocedure: allOf: - $ref: '#/components/schemas/BrondatumArchiefprocedure' nullable: true description: Specificatie voor het bepalen van de brondatum voor de start van de Archiefactietermijn (=brondatum) van het zaakdossier. title: brondatumArchiefprocedure procesobjectaard: type: string nullable: true description: Omschrijving van het object, subject of gebeurtenis waarop, vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking heeft. title: procesobjectaard maxLength: 200 catalogus: type: string format: uri nullable: true description: URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE behoort. title: catalogus beginGeldigheid: type: string format: date nullable: true description: De datum waarop de RESULTAATTYPE is ontstaan. title: datum begin geldigheid deprecated: true eindeGeldigheid: type: string format: date nullable: true description: De datum waarop de RESULTAATTYPE is opgeheven. title: datum einde geldigheid deprecated: true beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object indicatieSpecifiek: type: boolean nullable: true description: Aanduiding of het, vanuit archiveringsoptiek, een resultaattype betreft dat specifiek is voor een bepaalde procesobjectaard. title: indicatie specifiek procestermijn: type: string nullable: true description: De periode dat het zaakdossier na afronding van de zaak actief gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening van de organisatie. title: procestermijn format: duration besluittypen: type: array items: type: string title: '' title: besluittypen besluittypeOmschrijving: type: array items: type: string title: '' readOnly: true description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE. title: is resultaat van uniqueItems: true informatieobjecttypen: type: array items: type: string format: uri nullable: true title: '' description: De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van dit RESULTAATTYPE kan worden gezet. title: informatieobjecttypen uniqueItems: true informatieobjecttypeOmschrijving: type: array items: type: string title: '' readOnly: true description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE. title: informatieobjecttypen uniqueItems: true required: - besluittypeOmschrijving - besluittypen - informatieobjecttypeOmschrijving - omschrijving - omschrijvingGeneriek - resultaattypeomschrijving - selectielijstklasse - url - zaaktype - zaaktypeIdentificatie RichtingEnum: enum: - inkomend - intern - uitgaand type: string RolType: type: object description: Adds nested create feature properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 zaaktype: type: string format: uri description: URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken kunnen zijn. title: Zaaktype zaaktypeIdentificatie: type: string readOnly: true description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: Zaaktype omschrijving: type: string description: Omschrijving van de aard van de ROL. title: omschrijving maxLength: 100 omschrijvingGeneriek: allOf: - $ref: '#/components/schemas/OmschrijvingGeneriekEnum' description: "Algemeen gehanteerde omschrijving van de aard van de ROL.\n\ \nUitleg bij mogelijke waarden:\n\n* `adviseur` - (Adviseur) Kennis in\ \ dienst stellen van de behandeling van (een deel van) een zaak.\n* `behandelaar`\ \ - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van)\ \ een zaak.\n* `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief\ \ belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst\ \ van een zaak.\n* `beslisser` - (Beslisser) Nemen van besluiten die voor\ \ de uitkomst van een zaak noodzakelijk zijn.\n* `initiator` - (Initiator)\ \ Aanleiding geven tot de start van een zaak ..\n* `klantcontacter` -\ \ (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers\ \ en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6rdinator) Er voor\ \ zorg dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt\ \ conform de daarover gemaakte afspraken.\n* `mede_initiator` - Mede-initiator" title: omschrijving generiek catalogus: type: string format: uri nullable: true description: URL-referentie naar de CATALOGUS waartoe dit ROLTYPE behoort. Let op, dit veld is verouderd, maar als je het meegeeft dan moet er naar dezelfde catalogus worden verwezen als die van het zaaktype. title: catalogus deprecated: true beginGeldigheid: type: string format: date nullable: true description: De datum waarop het is ontstaan. title: datum begin geldigheid deprecated: true eindeGeldigheid: type: string format: date nullable: true description: De datum waarop het is opgeheven. title: datum einde geldigheid deprecated: true beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true required: - omschrijving - omschrijvingGeneriek - url - zaaktype - zaaktypeIdentificatie RolTypeExpanded: allOf: - $ref: '#/components/schemas/RolType' - properties: _expand: $ref: '#/components/schemas/RolTypeEmbedded' RolTypeEmbedded: type: object properties: catalogus: oneOf: - $ref: '#/components/schemas/CatalogusExpanded' - $ref: '#/components/schemas/EmptyObject' zaaktype: oneOf: - $ref: '#/components/schemas/ZaakTypeExpanded' - $ref: '#/components/schemas/EmptyObject' StatusType: type: object properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 omschrijving: type: string description: Een korte, voor de initiator van de zaak relevante, omschrijving van de aard van de STATUS van zaken van een ZAAKTYPE. title: omschrijving maxLength: 80 omschrijvingGeneriek: type: string description: Algemeen gehanteerde omschrijving van de aard van STATUSsen van het STATUSTYPE title: omschrijving generiek maxLength: 80 statustekst: type: string description: De tekst die wordt gebruikt om de Initiator te informeren over het bereiken van een STATUS van dit STATUSTYPE bij het desbetreffende ZAAKTYPE. title: statustekst maxLength: 1000 zaaktype: type: string format: uri description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen van dit STATUSTYPE bereikt kunnen worden. title: Zaaktype catalogus: type: string format: uri readOnly: true title: catalogus zaaktypeIdentificatie: type: string readOnly: true description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: Zaaktype volgnummer: type: integer maximum: 9999 minimum: 1 description: Een volgnummer voor statussen van het STATUSTYPE binnen een zaak. title: statustypevolgnummer isEindstatus: type: boolean readOnly: true description: Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven is afgeleid uit alle STATUSTYPEn van dit ZAAKTYPE met het hoogste volgnummer. title: isEindstatus informeren: type: boolean description: "Aanduiding die aangeeft of na het zetten van een STATUS van\ \ dit STATUSTYPE de Initiator moet worden ge\xEFnformeerd over de statusovergang." title: informeren doorlooptijd: type: string nullable: true description: De door de zaakbehandelende organisatie(s) gestelde norm voor de doorlooptijd voor het bereiken van STATUSsen van dit STATUSTYPE bij het desbetreffende ZAAKTYPE. title: doorlooptijd status format: duration toelichting: type: string nullable: true description: Een eventuele toelichting op dit STATUSTYPE. title: toelichting maxLength: 1000 checklistitemStatustype: type: array items: $ref: '#/components/schemas/CheckListItem' title: checklistitem eigenschappen: type: array items: type: string format: uri nullable: true title: '' description: de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen, voordat een STATUS van dit STATUSTYPE kan worden gezet. title: eigenschappen uniqueItems: true beginGeldigheid: type: string format: date nullable: true description: De datum waarop het is ontstaan. title: datum begin geldigheid deprecated: true eindeGeldigheid: type: string format: date nullable: true description: De datum waarop het is opgeheven. title: datum einde geldigheid deprecated: true beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true required: - catalogus - isEindstatus - omschrijving - url - volgnummer - zaaktype - zaaktypeIdentificatie StatusTypeExpanded: allOf: - $ref: '#/components/schemas/StatusType' - properties: _expand: $ref: '#/components/schemas/StatusTypeEmbedded' StatusTypeEmbedded: type: object properties: catalogus: oneOf: - $ref: '#/components/schemas/CatalogusExpanded' - $ref: '#/components/schemas/EmptyObject' zaaktype: oneOf: - $ref: '#/components/schemas/ZaakTypeExpanded' - $ref: '#/components/schemas/EmptyObject' eigenschappen: type: array items: $ref: '#/components/schemas/EigenschapExpanded' ValidatieFout: type: object description: Formaat van HTTP 4xx en 5xx fouten. properties: type: type: string description: URI referentie naar het type fout, bedoeld voor developers title: type code: type: string description: Systeemcode die het type fout aangeeft title: code title: type: string description: Generieke titel voor het type fout title: title status: type: integer description: De HTTP status code title: status detail: type: string description: Extra informatie bij de fout, indien beschikbaar title: detail instance: type: string description: URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. title: instance invalidParams: type: array items: $ref: '#/components/schemas/FieldValidationError' title: invalidParams required: - code - detail - instance - invalidParams - status - title VertrouwelijkheidaanduidingEnum: enum: - openbaar - beperkt_openbaar - intern - zaakvertrouwelijk - vertrouwelijk - confidentieel - geheim - zeer_geheim type: string ZaakObjectType: type: object properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 anderObjecttype: type: boolean description: Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een ander, niet in RSGB en RGBZ voorkomend, objecttype betreft. title: Ander objecttype beginGeldigheid: type: string format: date description: De datum waarop het is ontstaan. title: datum begin geldigheid deprecated: true eindeGeldigheid: type: string format: date nullable: true description: De datum waarop het is opgeheven. title: datum einde geldigheid deprecated: true beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true objecttype: type: string format: uri description: URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE behoort. title: Objecttype maxLength: 200 relatieOmschrijving: type: string description: Omschrijving van de betrekking van het Objecttype op zaken van het gerelateerde ZAAKTYPE. title: Relatie omschrijving maxLength: 80 zaaktype: type: string format: uri description: URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE behoort. title: Zaaktype zaaktypeIdentificatie: type: string readOnly: true description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: Zaaktype resultaattypen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar de RESULTAATTYPEN. title: Zaakobjecttypen uniqueItems: true statustypen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar de STATUSTYPEN. title: Zaakobjecttypen uniqueItems: true catalogus: type: string format: uri description: URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE behoort. title: Catalogus required: - anderObjecttype - catalogus - objecttype - relatieOmschrijving - resultaattypen - statustypen - url - zaaktype - zaaktypeIdentificatie ZaakObjectTypeExpanded: allOf: - $ref: '#/components/schemas/ZaakObjectType' - properties: _expand: $ref: '#/components/schemas/ZaakObjectTypeEmbedded' ZaakObjectTypeEmbedded: type: object properties: zaaktype: oneOf: - $ref: '#/components/schemas/ZaakTypeExpanded' - $ref: '#/components/schemas/EmptyObject' resultaattypen: type: array items: $ref: '#/components/schemas/ResultaatTypeExpanded' statustypen: type: array items: $ref: '#/components/schemas/StatusTypeExpanded' catalogus: oneOf: - $ref: '#/components/schemas/CatalogusExpanded' - $ref: '#/components/schemas/EmptyObject' ZaakType: type: object description: 'Set gegevensgroepdata from validated nested data. Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 identificatie: type: string description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: identificatie maxLength: 50 omschrijving: type: string description: Omschrijving van de aard van ZAAKen van het ZAAKTYPE. title: omschrijving maxLength: 80 omschrijvingGeneriek: type: string description: Algemeen gehanteerde omschrijving van de aard van ZAAKen van het ZAAKTYPE title: omschrijving generiek maxLength: 80 vertrouwelijkheidaanduiding: allOf: - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' description: 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde gezet. Uitleg bij mogelijke waarden: * `openbaar` - Openbaar * `beperkt_openbaar` - Beperkt openbaar * `intern` - Intern * `zaakvertrouwelijk` - Zaakvertrouwelijk * `vertrouwelijk` - Vertrouwelijk * `confidentieel` - Confidentieel * `geheim` - Geheim * `zeer_geheim` - Zeer geheim' title: vertrouwelijkheidaanduiding doel: type: string description: Een omschrijving van hetgeen beoogd is te bereiken met een zaak van dit zaaktype. title: doel aanleiding: type: string description: Een omschrijving van de gebeurtenis die leidt tot het starten van een ZAAK van dit ZAAKTYPE. title: aanleiding toelichting: type: string description: Een eventuele toelichting op dit zaaktype, zoals een beschrijving van het procesverloop op de hoofdlijnen. title: toelichting indicatieInternOfExtern: allOf: - $ref: '#/components/schemas/IndicatieInternOfExternEnum' description: "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\ \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\ \ beide sprake kan zijn, dan prevaleert de externe initiatie." title: indicatie intern of extern handelingInitiator: type: string description: Werkwoord dat hoort bij de handeling die de initiator verricht bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator title: handeling initiator maxLength: 20 onderwerp: type: string description: "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp" title: onderwerp maxLength: 80 handelingBehandelaar: type: string description: Werkwoord dat hoort bij de handeling die de behandelaar verricht bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar title: handeling behandelaar maxLength: 20 doorlooptijd: type: string description: De periode waarbinnen volgens wet- en regelgeving een ZAAK van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. title: doorlooptijd behandeling format: duration servicenorm: type: string nullable: true description: De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE afgerond wordt conform de geldende servicenormen van de zaakbehandelende organisatie(s). title: servicenorm behandeling format: duration opschortingEnAanhoudingMogelijk: type: boolean title: Opschorting/aanhouding mogelijk description: Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE kunnen worden opgeschort en/of aangehouden. verlengingMogelijk: type: boolean description: Aanduiding die aangeeft of de Doorlooptijd behandeling van ZAAKen van dit ZAAKTYPE kan worden verlengd. title: verlenging mogelijk verlengingstermijn: type: string nullable: true description: Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde bevatten als verlenging mogelijk is. title: verlengingstermijn format: duration trefwoorden: type: array items: type: string title: Trefwoord maxLength: 30 description: Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden gekarakteriseerd. title: trefwoorden publicatieIndicatie: type: boolean description: Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd moet worden. title: publicatie indicatie publicatietekst: type: string description: De generieke tekst van de publicatie van ZAAKen van dit ZAAKTYPE. title: publicatietekst verantwoordingsrelatie: type: array items: type: string maxLength: 40 description: "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ \ en/of financi\xEBle verantwoording." title: verantwoordingsrelatie productenOfDiensten: type: array items: type: string format: uri title: URL naar product/dienst maxLength: 1000 description: Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt voortgebracht. title: producten of diensten selectielijstProcestype: type: string format: uri description: URL-referentie naar een vanuit archiveringsoptiek onderkende groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst API). title: selectielijst procestype maxLength: 200 referentieproces: allOf: - $ref: '#/components/schemas/ReferentieProces' description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. title: referentieproces verantwoordelijke: type: string description: De (soort) organisatorische eenheid of (functie van) medewerker die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. title: verantwoordelijke maxLength: 50 zaakobjecttypen: type: array items: type: string format: uri title: '' readOnly: true title: Zaaktype uniqueItems: true broncatalogus: allOf: - $ref: '#/components/schemas/BronCatalogus' description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. title: broncatalogus bronzaaktype: allOf: - $ref: '#/components/schemas/BronZaaktype' description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. title: bronzaaktype catalogus: type: string format: uri description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. title: Catalogus statustypen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen dit ZAAKTYPE. title: Zaaktype uniqueItems: true resultaattypen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen dit ZAAKTYPE. title: is relevant voor uniqueItems: true eigenschappen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn in ZAKEN van dit ZAAKTYPE. title: Zaaktype uniqueItems: true informatieobjecttypen: type: array items: type: string format: uri title: Informatieobjecttype readOnly: true title: Informatieobjecttypen description: URL-referenties naar de INFORMATIEOBJECTTYPEN die mogelijk zijn binnen dit ZAAKTYPE. roltypen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit ZAAKTYPE. title: Zaaktype uniqueItems: true besluittypen: type: array items: type: string format: uri title: heeft relevante besluittypen title: heeft relevante besluittypen description: URL-referenties naar de BESLUITTYPEN die mogelijk zijn binnen dit ZAAKTYPE. uniqueItems: true deelzaaktypen: type: array items: type: string format: uri nullable: true title: '' description: De ZAAKTYPE(n) waaronder ZAAKen als deelzaak kunnen voorkomen bij ZAAKen van dit ZAAKTYPE. title: deelzaaktypen uniqueItems: true gerelateerdeZaaktypen: type: array items: $ref: '#/components/schemas/ZaakTypenRelatie' description: De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit ZAAKTYPE. title: zaaktype van beginGeldigheid: type: string format: date description: De datum waarop het is ontstaan. title: datum begin geldigheid eindeGeldigheid: type: string format: date nullable: true description: De datum waarop het is opgeheven. title: datum einde geldigheid beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true versiedatum: type: string format: date description: De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE geldig zijn geworden title: versiedatum deprecated: true concept: type: boolean readOnly: true description: Geeft aan of het object een concept betreft. Concepten zijn niet-definitieve versies en zouden niet gebruikt moeten worden buiten deze API. title: concept required: - aanleiding - beginGeldigheid - besluittypen - catalogus - concept - doel - doorlooptijd - eigenschappen - gerelateerdeZaaktypen - handelingBehandelaar - handelingInitiator - identificatie - indicatieInternOfExtern - informatieobjecttypen - omschrijving - onderwerp - opschortingEnAanhoudingMogelijk - productenOfDiensten - publicatieIndicatie - referentieproces - resultaattypen - roltypen - statustypen - url - verantwoordelijke - verlengingMogelijk - vertrouwelijkheidaanduiding - zaakobjecttypen ZaakTypeExpanded: allOf: - $ref: '#/components/schemas/ZaakType' - properties: _expand: $ref: '#/components/schemas/ZaakTypeEmbedded' ZaakTypeEmbedded: type: object properties: zaakobjecttypen: type: array items: $ref: '#/components/schemas/ZaakObjectTypeExpanded' catalogus: oneOf: - $ref: '#/components/schemas/CatalogusExpanded' - $ref: '#/components/schemas/EmptyObject' statustypen: type: array items: $ref: '#/components/schemas/StatusTypeExpanded' resultaattypen: type: array items: $ref: '#/components/schemas/ResultaatTypeExpanded' eigenschappen: type: array items: $ref: '#/components/schemas/EigenschapExpanded' informatieobjecttypen: type: array items: $ref: '#/components/schemas/InformatieObjectTypeExpanded' roltypen: type: array items: $ref: '#/components/schemas/RolTypeExpanded' besluittypen: type: array items: $ref: '#/components/schemas/BesluitTypeExpanded' deelzaaktypen: type: array items: $ref: '#/components/schemas/ZaakTypeExpanded' gerelateerdeZaaktypen: type: array items: $ref: '#/components/schemas/ZaakTypeExpanded' ZaakTypeCreate: type: object description: 'Set gegevensgroepdata from validated nested data. Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 identificatie: type: string description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: identificatie maxLength: 50 omschrijving: type: string description: Omschrijving van de aard van ZAAKen van het ZAAKTYPE. title: omschrijving maxLength: 80 omschrijvingGeneriek: type: string description: Algemeen gehanteerde omschrijving van de aard van ZAAKen van het ZAAKTYPE title: omschrijving generiek maxLength: 80 vertrouwelijkheidaanduiding: allOf: - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' description: 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde gezet. Uitleg bij mogelijke waarden: * `openbaar` - Openbaar * `beperkt_openbaar` - Beperkt openbaar * `intern` - Intern * `zaakvertrouwelijk` - Zaakvertrouwelijk * `vertrouwelijk` - Vertrouwelijk * `confidentieel` - Confidentieel * `geheim` - Geheim * `zeer_geheim` - Zeer geheim' title: vertrouwelijkheidaanduiding doel: type: string description: Een omschrijving van hetgeen beoogd is te bereiken met een zaak van dit zaaktype. title: doel aanleiding: type: string description: Een omschrijving van de gebeurtenis die leidt tot het starten van een ZAAK van dit ZAAKTYPE. title: aanleiding toelichting: type: string description: Een eventuele toelichting op dit zaaktype, zoals een beschrijving van het procesverloop op de hoofdlijnen. title: toelichting indicatieInternOfExtern: allOf: - $ref: '#/components/schemas/IndicatieInternOfExternEnum' description: "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\ \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\ \ beide sprake kan zijn, dan prevaleert de externe initiatie." title: indicatie intern of extern handelingInitiator: type: string description: Werkwoord dat hoort bij de handeling die de initiator verricht bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator title: handeling initiator maxLength: 20 onderwerp: type: string description: "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp" title: onderwerp maxLength: 80 handelingBehandelaar: type: string description: Werkwoord dat hoort bij de handeling die de behandelaar verricht bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar title: handeling behandelaar maxLength: 20 doorlooptijd: type: string description: De periode waarbinnen volgens wet- en regelgeving een ZAAK van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. title: doorlooptijd behandeling format: duration servicenorm: type: string nullable: true description: De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE afgerond wordt conform de geldende servicenormen van de zaakbehandelende organisatie(s). title: servicenorm behandeling format: duration opschortingEnAanhoudingMogelijk: type: boolean title: Opschorting/aanhouding mogelijk description: Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE kunnen worden opgeschort en/of aangehouden. verlengingMogelijk: type: boolean description: Aanduiding die aangeeft of de Doorlooptijd behandeling van ZAAKen van dit ZAAKTYPE kan worden verlengd. title: verlenging mogelijk verlengingstermijn: type: string nullable: true description: Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde bevatten als verlenging mogelijk is. title: verlengingstermijn format: duration trefwoorden: type: array items: type: string title: Trefwoord maxLength: 30 description: Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden gekarakteriseerd. title: trefwoorden publicatieIndicatie: type: boolean description: Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd moet worden. title: publicatie indicatie publicatietekst: type: string description: De generieke tekst van de publicatie van ZAAKen van dit ZAAKTYPE. title: publicatietekst verantwoordingsrelatie: type: array items: type: string maxLength: 40 description: "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ \ en/of financi\xEBle verantwoording." title: verantwoordingsrelatie productenOfDiensten: type: array items: type: string format: uri title: URL naar product/dienst maxLength: 1000 description: Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt voortgebracht. title: producten of diensten selectielijstProcestype: type: string format: uri description: URL-referentie naar een vanuit archiveringsoptiek onderkende groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst API). title: selectielijst procestype maxLength: 200 referentieproces: allOf: - $ref: '#/components/schemas/ReferentieProces' description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. title: referentieproces verantwoordelijke: type: string description: De (soort) organisatorische eenheid of (functie van) medewerker die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. title: verantwoordelijke maxLength: 50 zaakobjecttypen: type: array items: type: string format: uri title: '' readOnly: true title: Zaaktype uniqueItems: true broncatalogus: allOf: - $ref: '#/components/schemas/BronCatalogus' description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. title: broncatalogus bronzaaktype: allOf: - $ref: '#/components/schemas/BronZaaktype' description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. title: bronzaaktype catalogus: type: string format: uri description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. title: Catalogus statustypen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen dit ZAAKTYPE. title: Zaaktype uniqueItems: true resultaattypen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen dit ZAAKTYPE. title: is relevant voor uniqueItems: true eigenschappen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn in ZAKEN van dit ZAAKTYPE. title: Zaaktype uniqueItems: true informatieobjecttypen: type: string readOnly: true title: informatieobjecttypen roltypen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit ZAAKTYPE. title: Zaaktype uniqueItems: true besluittypen: type: array items: type: string title: '' description: '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen dit ZAAKTYPE.' title: zaaktypen deelzaaktypen: type: array items: type: string title: '' description: De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak kunnen voorkomen bij ZAAKen van dit ZAAKTYPE. title: deelzaaktypen gerelateerdeZaaktypen: type: array items: $ref: '#/components/schemas/ZaakTypenRelatieCreate' description: De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit ZAAKTYPE. title: zaaktype van beginGeldigheid: type: string format: date description: De datum waarop het is ontstaan. title: datum begin geldigheid eindeGeldigheid: type: string format: date nullable: true description: De datum waarop het is opgeheven. title: datum einde geldigheid beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true versiedatum: type: string format: date description: De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE geldig zijn geworden title: versiedatum deprecated: true concept: type: boolean readOnly: true description: Geeft aan of het object een concept betreft. Concepten zijn niet-definitieve versies en zouden niet gebruikt moeten worden buiten deze API. title: concept required: - aanleiding - beginGeldigheid - besluittypen - catalogus - concept - deelzaaktypen - doel - doorlooptijd - eigenschappen - gerelateerdeZaaktypen - handelingBehandelaar - handelingInitiator - identificatie - indicatieInternOfExtern - informatieobjecttypen - omschrijving - onderwerp - opschortingEnAanhoudingMogelijk - productenOfDiensten - publicatieIndicatie - referentieproces - resultaattypen - roltypen - statustypen - url - verantwoordelijke - verlengingMogelijk - vertrouwelijkheidaanduiding - zaakobjecttypen ZaakTypeInformatieObjectType: type: object description: 'Represent a ZaakTypeInformatieObjectType. Relatie met informatieobjecttype dat relevant is voor zaaktype.' properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 zaaktype: type: string format: uri description: URL-referentie naar het ZAAKTYPE. title: zaaktype zaaktypeIdentificatie: type: string readOnly: true description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: zaaktype catalogus: type: string format: uri readOnly: true title: catalogus informatieobjecttype: type: string title: Informatieobjecttype maxLength: 100 description: De waarde van het attribuut "omschrijving" van het INFORMATIEOBJECTTYPE. Deze waarde wordt gebruikt om het informatieobjecttype te identificeren conform het historiemodel. Let op, dit veld is GEEN URL-referentie! volgnummer: type: integer maximum: 999 minimum: 1 description: Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het ZAAKTYPE. title: volgnummer richting: allOf: - $ref: '#/components/schemas/RichtingEnum' description: 'Aanduiding van de richting van informatieobjecten van het gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE. Uitleg bij mogelijke waarden: * `inkomend` - Inkomend * `intern` - Intern * `uitgaand` - Uitgaand' title: richting statustype: type: string format: uri nullable: true title: Status type description: URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn verplicht aanwezig moeten zijn. required: - catalogus - informatieobjecttype - richting - url - volgnummer - zaaktype - zaaktypeIdentificatie ZaakTypeInformatieObjectTypeExpanded: allOf: - $ref: '#/components/schemas/ZaakTypeInformatieObjectType' - properties: _expand: $ref: '#/components/schemas/ZaakTypeInformatieObjectTypeEmbedded' ZaakTypeInformatieObjectTypeEmbedded: type: object properties: zaaktype: oneOf: - $ref: '#/components/schemas/ZaakTypeExpanded' - $ref: '#/components/schemas/EmptyObject' catalogus: oneOf: - $ref: '#/components/schemas/CatalogusExpanded' - $ref: '#/components/schemas/EmptyObject' informatieobjecttype: oneOf: - $ref: '#/components/schemas/InformatieObjectTypeExpanded' - $ref: '#/components/schemas/EmptyObject' statustype: oneOf: - $ref: '#/components/schemas/StatusTypeExpanded' - $ref: '#/components/schemas/EmptyObject' ZaakTypeUpdate: type: object description: 'Set gegevensgroepdata from validated nested data. Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 identificatie: type: string description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin het ZAAKTYPE voorkomt. title: identificatie maxLength: 50 omschrijving: type: string description: Omschrijving van de aard van ZAAKen van het ZAAKTYPE. title: omschrijving maxLength: 80 omschrijvingGeneriek: type: string description: Algemeen gehanteerde omschrijving van de aard van ZAAKen van het ZAAKTYPE title: omschrijving generiek maxLength: 80 vertrouwelijkheidaanduiding: allOf: - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' description: 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde gezet. Uitleg bij mogelijke waarden: * `openbaar` - Openbaar * `beperkt_openbaar` - Beperkt openbaar * `intern` - Intern * `zaakvertrouwelijk` - Zaakvertrouwelijk * `vertrouwelijk` - Vertrouwelijk * `confidentieel` - Confidentieel * `geheim` - Geheim * `zeer_geheim` - Zeer geheim' title: vertrouwelijkheidaanduiding doel: type: string description: Een omschrijving van hetgeen beoogd is te bereiken met een zaak van dit zaaktype. title: doel aanleiding: type: string description: Een omschrijving van de gebeurtenis die leidt tot het starten van een ZAAK van dit ZAAKTYPE. title: aanleiding toelichting: type: string description: Een eventuele toelichting op dit zaaktype, zoals een beschrijving van het procesverloop op de hoofdlijnen. title: toelichting indicatieInternOfExtern: allOf: - $ref: '#/components/schemas/IndicatieInternOfExternEnum' description: "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\ \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\ \ beide sprake kan zijn, dan prevaleert de externe initiatie." title: indicatie intern of extern handelingInitiator: type: string description: Werkwoord dat hoort bij de handeling die de initiator verricht bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator title: handeling initiator maxLength: 20 onderwerp: type: string description: "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp" title: onderwerp maxLength: 80 handelingBehandelaar: type: string description: Werkwoord dat hoort bij de handeling die de behandelaar verricht bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren', 'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar title: handeling behandelaar maxLength: 20 doorlooptijd: type: string description: De periode waarbinnen volgens wet- en regelgeving een ZAAK van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen. title: doorlooptijd behandeling format: duration servicenorm: type: string nullable: true description: De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE afgerond wordt conform de geldende servicenormen van de zaakbehandelende organisatie(s). title: servicenorm behandeling format: duration opschortingEnAanhoudingMogelijk: type: boolean title: Opschorting/aanhouding mogelijk description: Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE kunnen worden opgeschort en/of aangehouden. verlengingMogelijk: type: boolean description: Aanduiding die aangeeft of de Doorlooptijd behandeling van ZAAKen van dit ZAAKTYPE kan worden verlengd. title: verlenging mogelijk verlengingstermijn: type: string nullable: true description: Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde bevatten als verlenging mogelijk is. title: verlengingstermijn format: duration trefwoorden: type: array items: type: string title: Trefwoord maxLength: 30 description: Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden gekarakteriseerd. title: trefwoorden publicatieIndicatie: type: boolean description: Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd moet worden. title: publicatie indicatie publicatietekst: type: string description: De generieke tekst van de publicatie van ZAAKen van dit ZAAKTYPE. title: publicatietekst verantwoordingsrelatie: type: array items: type: string maxLength: 40 description: "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\ \ en/of financi\xEBle verantwoording." title: verantwoordingsrelatie productenOfDiensten: type: array items: type: string format: uri title: URL naar product/dienst maxLength: 1000 description: Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt voortgebracht. title: producten of diensten selectielijstProcestype: type: string format: uri description: URL-referentie naar een vanuit archiveringsoptiek onderkende groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst API). title: selectielijst procestype maxLength: 200 referentieproces: allOf: - $ref: '#/components/schemas/ReferentieProces' description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE. title: referentieproces verantwoordelijke: type: string description: De (soort) organisatorische eenheid of (functie van) medewerker die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE. title: verantwoordelijke maxLength: 50 zaakobjecttypen: type: array items: type: string format: uri title: '' readOnly: true title: Zaaktype uniqueItems: true broncatalogus: allOf: - $ref: '#/components/schemas/BronCatalogus' description: De CATALOGUS waaraan het ZAAKTYPE is ontleend. title: broncatalogus bronzaaktype: allOf: - $ref: '#/components/schemas/BronZaaktype' description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend. title: bronzaaktype catalogus: type: string format: uri description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort. title: Catalogus statustypen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen dit ZAAKTYPE. title: Zaaktype uniqueItems: true resultaattypen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen dit ZAAKTYPE. title: is relevant voor uniqueItems: true eigenschappen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn in ZAKEN van dit ZAAKTYPE. title: Zaaktype uniqueItems: true informatieobjecttypen: type: string readOnly: true title: informatieobjecttypen roltypen: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit ZAAKTYPE. title: Zaaktype uniqueItems: true besluittypen: type: array items: type: string title: '' description: '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen dit ZAAKTYPE.' title: zaaktypen deelzaaktypen: type: array items: type: string title: '' description: De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak kunnen voorkomen bij ZAAKen van dit ZAAKTYPE. title: deelzaaktypen gerelateerdeZaaktypen: type: array items: $ref: '#/components/schemas/ZaakTypenRelatieCreate' description: De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit ZAAKTYPE. title: zaaktype van beginGeldigheid: type: string format: date description: De datum waarop het is ontstaan. title: datum begin geldigheid eindeGeldigheid: type: string format: date nullable: true description: De datum waarop het is opgeheven. title: datum einde geldigheid beginObject: type: string format: date nullable: true description: De datum waarop de eerst versie van het object ontstaan is. title: datum begin object deprecated: true eindeObject: type: string format: date nullable: true description: De datum van de aller laatste versie van het object. title: datum einde object deprecated: true versiedatum: type: string format: date description: De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE geldig zijn geworden title: versiedatum deprecated: true concept: type: boolean readOnly: true description: Geeft aan of het object een concept betreft. Concepten zijn niet-definitieve versies en zouden niet gebruikt moeten worden buiten deze API. title: concept required: - aanleiding - beginGeldigheid - besluittypen - catalogus - concept - deelzaaktypen - doel - doorlooptijd - eigenschappen - gerelateerdeZaaktypen - handelingBehandelaar - handelingInitiator - identificatie - indicatieInternOfExtern - informatieobjecttypen - omschrijving - onderwerp - opschortingEnAanhoudingMogelijk - productenOfDiensten - publicatieIndicatie - referentieproces - resultaattypen - roltypen - statustypen - url - verantwoordelijke - verlengingMogelijk - vertrouwelijkheidaanduiding - zaakobjecttypen ZaakTypenRelatie: type: object properties: zaaktype: type: string format: uri description: URL referentie naar het gerelateerde zaaktype, mogelijks in een extern ZTC. title: gerelateerd zaaktype maxLength: 200 aardRelatie: allOf: - $ref: '#/components/schemas/AardRelatieEnum' description: 'Omschrijving van de aard van de relatie van zaken van het ZAAKTYPE tot zaken van het andere ZAAKTYPE Uitleg bij mogelijke waarden: * `vervolg` - Vervolg * `bijdrage` - Bijdrage * `onderwerp` - Onderwerp' title: aard relatie toelichting: type: string description: Een toelichting op de aard van de relatie tussen beide ZAAKTYPEN. title: toelichting maxLength: 255 required: - aardRelatie - zaaktype ZaakTypenRelatieCreate: type: object properties: zaaktype: type: string description: '`zaaktype.identificatie` naar het ZAAKTYPE.' title: zaaktype van aardRelatie: allOf: - $ref: '#/components/schemas/AardRelatieEnum' description: 'Omschrijving van de aard van de relatie van zaken van het ZAAKTYPE tot zaken van het andere ZAAKTYPE Uitleg bij mogelijke waarden: * `vervolg` - Vervolg * `bijdrage` - Bijdrage * `onderwerp` - Onderwerp' title: aard relatie toelichting: type: string description: Een toelichting op de aard van de relatie tussen beide ZAAKTYPEN. title: toelichting maxLength: 255 required: - aardRelatie - zaaktype securitySchemes: JWT-Claims: type: http bearerFormat: JWT scheme: bearer servers: # Added by API Auto Mocking Plugin - description: SwaggerHub API Auto Mocking url: https://virtserver.swaggerhub.com/michielverhoef/Catalogussen_API/1.3.0 - url: https://catalogi-api.vng.cloud/api/v1 description: Productie Omgeving tags: - name: besluittypen description: Opvragen en bewerken van BESLUITTYPEn nodig voor BESLUITEN in de Besluiten API. Alle BESLUITTYPEn van de besluiten die het resultaat kunnen zijn van het zaakgericht werken van de behandelende organisatie(s). - name: catalogussen description: "Opvragen en bewerken van CATALOGUSsen. De verzameling van ZAAKTYPEn,\ \ INFORMATIEOBJECTTYPEn en BESLUITTYPEn voor een domein die als \xE9\xE9n geheel\ \ beheerd wordt." - name: eigenschappen description: Opvragen en bewerken van EIGENSCHAPpen van een ZAAKTYPE. Een relevant inhoudelijk gegeven dat bij ZAAKen van dit ZAAKTYPE geregistreerd moet kunnen worden en geen standaard kenmerk is van een zaak. - name: informatieobjecttypen description: Opvragen en bewerken van INFORMATIEOBJECTTYPEn nodig voor INFORMATIEOBJECTen in de Documenten API. Een INFORMATIEOBJECTTYPE beschijft de karakteristieken van een document of ander object dat informatie bevat. - name: resultaattypen description: Opvragen en bewerken van RESULTAATTYPEn van een ZAAKTYPE. Het betreft de indeling of groepering van resultaten van zaken van hetzelfde ZAAKTYPE naar hun aard, zoals 'verleend', 'geweigerd', 'verwerkt', etc. - name: roltypen description: Opvragen en bewerken van ROLTYPEn van een ZAAKTYPE. Generieke aanduiding van de aard van een ROL die een BETROKKENE kan uitoefenen in ZAAKen van een ZAAKTYPE. - name: statustypen description: Opvragen en bewerken van STATUSTYPEn van een ZAAKTYPE. Generieke aanduiding van de aard van een status. - name: zaakobjecttypen description: "Opvragen en bewerken van ZAAKOBJECTTYPEn. Er wordt gevalideerd op:\n\ \ - `zaaktype` behoort tot dezelfde `catalogus`" - name: zaaktype-informatieobjecttypen description: Opvragen en bewerken van ZAAKTYPE-INFORMATIEOBJECTTYPE relaties. Geeft aan welke INFORMATIEOBJECTTYPEn binnen een ZAAKTYPE mogelijk zijn en hoe de richting is. - name: zaaktypen description: Opvragen en bewerken van ZAAKTYPEn nodig voor ZAKEN in de Zaken API.Een ZAAKTYPE beschrijft het geheel van karakteristieke eigenschappen van zaken van eenzelfde soort.