diff --git a/package-lock.json b/package-lock.json
index 7e6c60d0..04a77862 100644
--- a/package-lock.json
+++ b/package-lock.json
@@ -1,12 +1,12 @@
{
"name": "ztc",
- "version": "1.2.0",
+ "version": "1.3.0-rc3",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "ztc",
- "version": "1.2.0",
+ "version": "1.3.0-rc3",
"license": "EUPL-1.2",
"dependencies": {
"microscope-sass": "latest"
diff --git a/requirements/base.in b/requirements/base.in
index 26117edd..d5a3b31c 100644
--- a/requirements/base.in
+++ b/requirements/base.in
@@ -21,7 +21,7 @@ django-filter~=21.1
djangorestframework-camel-case
drf_spectacular
-vng_api_common==2.0.4
+vng_api_common==2.0.5
drf-flex-fields
django-cors-middleware
drf-writable-nested
diff --git a/requirements/base.txt b/requirements/base.txt
index 8d755855..4e82dfc7 100644
--- a/requirements/base.txt
+++ b/requirements/base.txt
@@ -228,7 +228,7 @@ uritemplate==4.1.1
# via drf-spectacular
urllib3==1.26.10
# via requests
-vng-api-common==2.0.4
+vng-api-common==2.0.5
# via -r requirements/base.in
webencodings==0.5.1
# via
diff --git a/requirements/ci.txt b/requirements/ci.txt
index 9b0e5f42..1936e1fc 100644
--- a/requirements/ci.txt
+++ b/requirements/ci.txt
@@ -366,7 +366,7 @@ urllib3==1.26.10
# via
# -r requirements/base.txt
# requests
-vng-api-common==2.0.4
+vng-api-common==2.0.5
# via -r requirements/base.txt
webencodings==0.5.1
# via
diff --git a/requirements/dev.txt b/requirements/dev.txt
index d9106915..c59cfc7f 100644
--- a/requirements/dev.txt
+++ b/requirements/dev.txt
@@ -368,7 +368,7 @@ urllib3==1.26.10
# via
# -r requirements/base.txt
# requests
-vng-api-common==2.0.4
+vng-api-common==2.0.5
# via -r requirements/base.txt
webencodings==0.5.1
# via
diff --git a/requirements/production.txt b/requirements/production.txt
index 2c821aa0..a3ea8ae1 100644
--- a/requirements/production.txt
+++ b/requirements/production.txt
@@ -324,7 +324,7 @@ urllib3==1.26.10
# requests
uwsgi==2.0.20
# via -r requirements/production.in
-vng-api-common==2.0.4
+vng-api-common==2.0.5
# via -r requirements/base.txt
webencodings==0.5.1
# via
diff --git a/src/notificaties.md b/src/notificaties.md
index 9100d7c4..8a6fefc1 100644
--- a/src/notificaties.md
+++ b/src/notificaties.md
@@ -27,8 +27,6 @@ De architectuur van de notificaties staat beschreven op informatieobjecttype: create, update, destroy
-
### zaaktypen
@@ -69,6 +65,4 @@ De architectuur van de notificaties staat beschreven op ",
- "iat": 1572863906,
- "client_id": "",
- "user_id": "",
- "user_representation": ""
- }
- ```
-
- Als `issuer` gebruik je dus je eigen client ID. De `iat` timestamp is een
- UNIX-timestamp die aangeeft op welk moment het token gegenereerd is.
-
- `user_id` en `user_representation` zijn nodig voor de audit trails. Het zijn
- vrije velden met als enige beperking dat de lengte maximaal de lengte van
- de overeenkomstige velden in de audit trail resources is (zie rest API spec).
-
-
- ### Notificaties
-
- Deze API publiceert notificaties op het kanaal `zaaktypen`.
-
- **Main resource**
-
- `zaaktype`
-
-
-
- **Kenmerken**
-
- * `catalogus`: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort.
-
- **Resources en acties**
-
-
- Deze API publiceert notificaties op het kanaal `besluittypen`.
-
- **Main resource**
-
- `besluittype`
-
-
-
- **Kenmerken**
-
- * `catalogus`: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort.
-
- **Resources en acties**
-
-
- Deze API publiceert notificaties op het kanaal `informatieobjecttypen`.
-
- **Main resource**
-
- `informatieobjecttype`
-
-
-
- **Kenmerken**
-
- * `catalogus`: URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE behoort.
-
- **Resources en acties**
-
-
- **Handige links**
-
- * [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard)
- * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken)
+ description:
+ "Een API om een zaaktypecatalogus (ZTC) te benaderen.\n\nDe zaaktypecatalogus\
+ \ helpt gemeenten om het proces vanuit de 'vraag van een\nklant' (productaanvraag,\
+ \ melding, aangifte, informatieverzoek e.d.) tot en met\nhet leveren van een passend\
+ \ antwoord daarop in te richten, inclusief de\nbijbehorende informatievoorziening.\n\
+ \nEen CATALOGUS bestaat uit ZAAKTYPEn, INFORMATIEOBJECTTYPEn en BESLUITTYPEn en\n\
+ wordt typisch gebruikt om een ZAAK (in de Zaken API), INFORMATIEOBJECT (in de\n\
+ Documenten API) en BESLUIT (in de Besluiten API) te voorzien van type,\nstandaardwaarden\
+ \ en processtructuur.\n\n**Afhankelijkheden**\n\nDeze API is afhankelijk van:\n\
+ \n* Gemeentelijke Selectielijst API\n* Autorisaties API *(optioneel)*\n\n\n**Autorisatie**\n\
+ \nDeze API vereist autorisatie. Je kan de\n[token-tool](https://zaken-auth.vng.cloud/)\
+ \ gebruiken om een token te\ngenereren.\n\n_Zelf een token genereren_\n\nDe tokens\
+ \ die gebruikt worden voor autorisatie zijn [jwt.io][JWT's] (JSON web\ntoken).\
+ \ In de API calls moeten deze gebruikt worden in de `Authorization`\nheader:\n\
+ \n```\nAuthorization: Bearer \n```\n\nOm een JWT te genereren heb je een\
+ \ `client ID` en een `secret` nodig. Het JWT\nmoet gebouwd worden volgens het\
+ \ `HS256` algoritme. De vereiste payload is:\n\n```json\n{\n \"iss\": \"\",\n \"iat\": 1572863906,\n \"client_id\": \"\",\n \"\
+ user_id\": \"\",\n \"user_representation\": \"\"\
+ \n}\n```\n\nAls `issuer` gebruik je dus je eigen client ID. De `iat` timestamp\
+ \ is een\nUNIX-timestamp die aangeeft op welk moment het token gegenereerd is.\n\
+ \n`user_id` en `user_representation` zijn nodig voor de audit trails. Het zijn\n\
+ vrije velden met als enige beperking dat de lengte maximaal de lengte van\nde\
+ \ overeenkomstige velden in de audit trail resources is (zie rest API spec).\n\
+ \n\n### Notificaties\n\nDeze API publiceert notificaties op het kanaal `zaaktypen`.\n\
+ \n**Main resource**\n\n`zaaktype`\n\n\n\n**Kenmerken**\n\n* `catalogus`: URL-referentie\
+ \ naar de CATALOGUS waartoe dit ZAAKTYPE behoort.\n\n**Resources en acties**\n\
+ \n\nDeze API publiceert notificaties op het kanaal `besluittypen`.\n\n**Main resource**\n\
+ \n`besluittype`\n\n\n\n**Kenmerken**\n\n* `catalogus`: URL-referentie naar de\
+ \ CATALOGUS waartoe dit BESLUITTYPE behoort.\n\n**Resources en acties**\n\n\n\
+ Deze API publiceert notificaties op het kanaal `informatieobjecttypen`.\n\n**Main\
+ \ resource**\n\n`informatieobjecttype`\n\n\n\n**Kenmerken**\n\n* `catalogus`:\
+ \ URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE behoort.\n\
+ \n**Resources en acties**\n\n\n**Handige links**\n\n* [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard)\n\
+ * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken)\n"
contact:
email: standaarden.ondersteuning@vng.nl
url: https://vng-realisatie.github.io/gemma-zaken
@@ -124,66 +50,72 @@ paths:
description: Deze lijst kan gefilterd wordt met query-string parameters.
summary: Alle BESLUITTYPEn opvragen.
parameters:
- - name: catalogus
- required: false
- in: query
- description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort.
- schema:
- type: string
- format: uri
- - name: zaaktypen
- required: false
- in: query
- description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE
- schema:
- type: string
- - name: informatieobjecttypen
- required: false
- in: query
- description: Het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten
- van dit BESLUITTYPE worden vastgelegd.
- schema:
- type: string
- - name: status
- required: false
- in: query
- description: |
- filter objects depending on their concept status:
- * `alles`: Toon objecten waarvan het attribuut `concept` true of false is.
- * `concept`: Toon objecten waarvan het attribuut `concept` true is.
- * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard).
- schema:
- type: string
- - name: omschrijving
- required: false
- in: query
- description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE.
- schema:
- type: string
- - name: datumGeldigheid
- required: false
- in: query
- description: filter objecten op hun geldigheids datum.
- schema:
- type: string
- - name: page
- required: false
- in: query
- description: Een pagina binnen de gepagineerde set resultaten.
- schema:
- type: integer
+ - name: catalogus
+ required: false
+ in: query
+ description: URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort.
+ schema:
+ type: string
+ format: uri
+ - name: zaaktypen
+ required: false
+ in: query
+ description: ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE
+ schema:
+ type: string
+ - name: informatieobjecttypen
+ required: false
+ in: query
+ description:
+ Het INFORMATIEOBJECTTYPE van informatieobjecten waarin besluiten
+ van dit BESLUITTYPE worden vastgelegd.
+ schema:
+ type: string
+ - name: status
+ required: false
+ in: query
+ description: 'filter objects depending on their concept status:
+
+ * `alles`: Toon objecten waarvan het attribuut `concept` true of false is.
+
+ * `concept`: Toon objecten waarvan het attribuut `concept` true is.
+
+ * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard).
+
+ '
+ schema:
+ type: string
+ - name: omschrijving
+ required: false
+ in: query
+ description: Omschrijving van de aard van BESLUITen van het BESLUITTYPE.
+ schema:
+ type: string
+ - name: datumGeldigheid
+ required: false
+ in: query
+ description: filter objecten op hun geldigheids datum.
+ schema:
+ type: string
+ - name: page
+ required: false
+ in: query
+ description: Een pagina binnen de gepagineerde set resultaten.
+ schema:
+ type: integer
tags:
- - besluittypen
+ - besluittypen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -195,10 +127,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -207,10 +140,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -219,10 +153,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -231,10 +166,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -243,10 +179,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -255,10 +192,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -267,10 +205,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -279,10 +218,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -291,10 +231,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -303,16 +244,16 @@ paths:
description: Maak een BESLUITTYPE aan.
summary: Maak een BESLUITTYPE aan.
parameters:
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - besluittypen
+ - besluittypen
requestBody:
content:
application/json:
@@ -320,8 +261,8 @@ paths:
$ref: '#/components/schemas/BesluitTypeCreate'
required: true
security:
- - JWT-Claims:
- - catalogi.schrijven
+ - JWT-Claims:
+ - catalogi.schrijven
responses:
'201':
headers:
@@ -333,7 +274,8 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -345,10 +287,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -357,10 +300,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -369,10 +313,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -381,10 +326,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -393,10 +339,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -405,10 +352,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -417,10 +365,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -429,10 +378,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -441,10 +391,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -454,48 +405,52 @@ paths:
description: Een specifieke BESLUITTYPE opvragen.
summary: Een specifieke BESLUITTYPE opvragen.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - besluittypen
+ - besluittypen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -507,10 +462,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -519,10 +475,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -531,10 +488,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -543,10 +501,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -555,10 +514,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -567,10 +527,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -579,10 +540,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -591,10 +553,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -603,37 +566,39 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
put:
operationId: besluittype_update
- description: Werk een BESLUITTYPE in zijn geheel bij. Dit kan alleen als het
+ description:
+ Werk een BESLUITTYPE in zijn geheel bij. Dit kan alleen als het
een concept betreft.
summary: Werk een BESLUITTYPE in zijn geheel bij.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - besluittypen
+ - besluittypen
requestBody:
content:
application/json:
@@ -641,15 +606,16 @@ paths:
$ref: '#/components/schemas/BesluitTypeUpdate'
required: true
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -661,10 +627,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -673,10 +640,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -685,10 +653,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -697,10 +666,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -709,10 +679,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -721,10 +692,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -733,10 +705,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -745,10 +718,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -757,10 +731,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -769,52 +744,55 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
patch:
operationId: besluittype_partial_update
- description: Werk een BESLUITTYPE deels bij. Dit kan alleen als het een concept
+ description:
+ Werk een BESLUITTYPE deels bij. Dit kan alleen als het een concept
betreft.
summary: Werk een BESLUITTYPE deels bij.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - besluittypen
+ - besluittypen
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedBesluitType'
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -826,10 +804,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -838,10 +817,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -850,10 +830,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -862,10 +843,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -874,10 +856,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -886,10 +869,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -898,10 +882,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -910,10 +895,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -922,10 +908,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -934,10 +921,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -946,19 +934,19 @@ paths:
description: Verwijder een BESLUITTYPE. Dit kan alleen als het een concept betreft.
summary: Verwijder een BESLUITTYPE.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
tags:
- - besluittypen
+ - besluittypen
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
responses:
'204':
description: No content
@@ -967,10 +955,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -979,10 +968,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -991,10 +981,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -1003,10 +994,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -1015,10 +1007,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -1027,10 +1020,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -1039,10 +1033,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -1051,10 +1046,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -1063,10 +1059,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -1075,45 +1072,49 @@ paths:
description: Vraag de headers op die je bij een GET request zou krijgen.
summary: 'De headers voor een specifiek(e) BESLUITTYPE opvragen '
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - besluittypen
+ - besluittypen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -1123,40 +1124,42 @@ paths:
/besluittypen/{uuid}/publish:
post:
operationId: besluittype_publish
- description: Publiceren van het besluittype zorgt ervoor dat dit in een Besluiten
+ description:
+ Publiceren van het besluittype zorgt ervoor dat dit in een Besluiten
API kan gebruikt worden. Na het publiceren van een besluittype zijn geen inhoudelijke
wijzigingen meer mogelijk. Indien er na het publiceren nog wat gewijzigd moet
worden, dan moet je een nieuwe versie aanmaken.
summary: Publiceer het concept BESLUITTYPE.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - besluittypen
+ - besluittypen
security:
- - JWT-Claims:
- - catalogi.schrijven
+ - JWT-Claims:
+ - catalogi.schrijven
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -1165,61 +1168,61 @@ paths:
description: OK
'400':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
'404':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
'401':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
'403':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
'406':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
'409':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
'410':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
'415':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
'429':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
'500':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -1229,48 +1232,49 @@ paths:
description: Deze lijst kan gefilterd wordt met query-string parameters.
summary: Alle CATALOGUSsen opvragen.
parameters:
- - name: domein
- required: false
- in: query
- description: domein
- schema:
- type: string
- - name: domein__in
- required: false
- in: query
- description: domein__in
- schema:
- type: string
- - name: rsin
- required: false
- in: query
- description: rsin
- schema:
- type: string
- - name: rsin__in
- required: false
- in: query
- description: rsin__in
- schema:
- type: string
- - name: page
- required: false
- in: query
- description: Een pagina binnen de gepagineerde set resultaten.
- schema:
- type: integer
+ - name: domein
+ required: false
+ in: query
+ description: domein
+ schema:
+ type: string
+ - name: domein__in
+ required: false
+ in: query
+ description: domein__in
+ schema:
+ type: string
+ - name: rsin
+ required: false
+ in: query
+ description: rsin
+ schema:
+ type: string
+ - name: rsin__in
+ required: false
+ in: query
+ description: rsin__in
+ schema:
+ type: string
+ - name: page
+ required: false
+ in: query
+ description: Een pagina binnen de gepagineerde set resultaten.
+ schema:
+ type: integer
tags:
- - catalogussen
+ - catalogussen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -1282,10 +1286,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -1294,10 +1299,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -1306,10 +1312,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -1318,10 +1325,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -1330,10 +1338,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -1342,10 +1351,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -1354,10 +1364,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -1366,10 +1377,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -1378,10 +1390,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -1390,16 +1403,16 @@ paths:
description: Maak een CATALOGUS aan.
summary: Maak een CATALOGUS aan.
parameters:
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - catalogussen
+ - catalogussen
requestBody:
content:
application/json:
@@ -1407,8 +1420,8 @@ paths:
$ref: '#/components/schemas/Catalogus'
required: true
security:
- - JWT-Claims:
- - catalogi.schrijven
+ - JWT-Claims:
+ - catalogi.schrijven
responses:
'201':
headers:
@@ -1420,7 +1433,8 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -1432,10 +1446,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -1444,10 +1459,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -1456,10 +1472,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -1468,10 +1485,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -1480,10 +1498,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -1492,10 +1511,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -1504,10 +1524,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -1516,10 +1537,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -1528,10 +1550,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -1541,48 +1564,52 @@ paths:
description: Een specifieke CATALOGUS opvragen.
summary: Een specifieke CATALOGUS opvragen.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - catalogussen
+ - catalogussen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -1594,10 +1621,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -1606,10 +1634,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -1618,10 +1647,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -1630,10 +1660,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -1642,10 +1673,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -1654,10 +1686,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -1666,10 +1699,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -1678,10 +1712,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -1690,10 +1725,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -1702,45 +1738,49 @@ paths:
description: Vraag de headers op die je bij een GET request zou krijgen.
summary: 'De headers voor een specifiek(e) CATALOGUS opvragen '
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - catalogussen
+ - catalogussen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -1753,54 +1793,60 @@ paths:
description: Deze lijst kan gefilterd wordt met query-string parameters.
summary: Alle EIGENSCHAPpen opvragen.
parameters:
- - name: zaaktype
- required: false
- in: query
- description: URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze
- EIGENSCHAP van belang is.
- schema:
- type: string
- format: uri
- - name: zaaktypeIdentificatie
- required: false
- in: query
- description: zaaktype_identificatie
- schema:
- type: string
- - name: status
- required: false
- in: query
- description: |
- filter objects depending on their concept status:
- * `alles`: Toon objecten waarvan het attribuut `concept` true of false is.
- * `concept`: Toon objecten waarvan het attribuut `concept` true is.
- * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard).
- schema:
- type: string
- - name: datumGeldigheid
- required: false
- in: query
- description: filter objecten op hun geldigheids datum.
- schema:
- type: string
- - name: page
- required: false
- in: query
- description: Een pagina binnen de gepagineerde set resultaten.
- schema:
- type: integer
+ - name: zaaktype
+ required: false
+ in: query
+ description:
+ URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze
+ EIGENSCHAP van belang is.
+ schema:
+ type: string
+ format: uri
+ - name: zaaktypeIdentificatie
+ required: false
+ in: query
+ description: zaaktype_identificatie
+ schema:
+ type: string
+ - name: status
+ required: false
+ in: query
+ description: 'filter objects depending on their concept status:
+
+ * `alles`: Toon objecten waarvan het attribuut `concept` true of false is.
+
+ * `concept`: Toon objecten waarvan het attribuut `concept` true is.
+
+ * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard).
+
+ '
+ schema:
+ type: string
+ - name: datumGeldigheid
+ required: false
+ in: query
+ description: filter objecten op hun geldigheids datum.
+ schema:
+ type: string
+ - name: page
+ required: false
+ in: query
+ description: Een pagina binnen de gepagineerde set resultaten.
+ schema:
+ type: integer
tags:
- - eigenschappen
+ - eigenschappen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -1812,10 +1858,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -1824,10 +1871,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -1836,10 +1884,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -1848,10 +1897,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -1860,10 +1910,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -1872,10 +1923,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -1884,10 +1936,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -1896,10 +1949,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -1908,29 +1962,31 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
post:
operationId: eigenschap_create
- description: Maak een EIGENSCHAP aan. Dit kan alleen als het bijbehorende ZAAKTYPE
+ description:
+ Maak een EIGENSCHAP aan. Dit kan alleen als het bijbehorende ZAAKTYPE
een concept betreft.
summary: Maak een EIGENSCHAP aan.
parameters:
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - eigenschappen
+ - eigenschappen
requestBody:
content:
application/json:
@@ -1938,8 +1994,8 @@ paths:
$ref: '#/components/schemas/Eigenschap'
required: true
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'201':
headers:
@@ -1951,7 +2007,8 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -1963,10 +2020,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -1975,10 +2033,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -1987,10 +2046,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -1999,10 +2059,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -2011,10 +2072,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -2023,10 +2085,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -2035,10 +2098,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -2047,10 +2111,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -2059,10 +2124,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -2072,48 +2138,52 @@ paths:
description: Een specifieke EIGENSCHAP opvragen.
summary: Een specifieke EIGENSCHAP opvragen.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - eigenschappen
+ - eigenschappen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -2125,10 +2195,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -2137,10 +2208,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -2149,10 +2221,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -2161,10 +2234,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -2173,10 +2247,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -2185,10 +2260,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -2197,10 +2273,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -2209,10 +2286,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -2221,37 +2299,39 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
put:
operationId: eigenschap_update
- description: Werk een EIGENSCHAP in zijn geheel bij. Dit kan alleen als het
+ description:
+ Werk een EIGENSCHAP in zijn geheel bij. Dit kan alleen als het
bijbehorende ZAAKTYPE een concept betreft.
summary: Werk een EIGENSCHAP in zijn geheel bij.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - eigenschappen
+ - eigenschappen
requestBody:
content:
application/json:
@@ -2259,15 +2339,16 @@ paths:
$ref: '#/components/schemas/Eigenschap'
required: true
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -2279,10 +2360,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -2291,10 +2373,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -2303,10 +2386,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -2315,10 +2399,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -2327,10 +2412,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -2339,10 +2425,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -2351,10 +2438,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -2363,10 +2451,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -2375,10 +2464,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -2387,52 +2477,55 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
patch:
operationId: eigenschap_partial_update
- description: Werk een EIGENSCHAP deels bij. Dit kan alleen als het bijbehorende
+ description:
+ Werk een EIGENSCHAP deels bij. Dit kan alleen als het bijbehorende
ZAAKTYPE een concept betreft.
summary: Werk een EIGENSCHAP deels bij.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - eigenschappen
+ - eigenschappen
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedEigenschap'
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -2444,10 +2537,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -2456,10 +2550,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -2468,10 +2563,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -2480,10 +2576,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -2492,10 +2589,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -2504,10 +2602,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -2516,10 +2615,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -2528,10 +2628,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -2540,10 +2641,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -2552,32 +2654,34 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
delete:
operationId: eigenschap_destroy
- description: Verwijder een EIGENSCHAP. Dit kan alleen als het bijbehorende ZAAKTYPE
+ description:
+ Verwijder een EIGENSCHAP. Dit kan alleen als het bijbehorende ZAAKTYPE
een concept betreft.
summary: Verwijder een EIGENSCHAP.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
tags:
- - eigenschappen
+ - eigenschappen
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
responses:
'204':
description: No content
@@ -2586,10 +2690,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -2598,10 +2703,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -2610,10 +2716,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -2622,10 +2729,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -2634,10 +2742,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -2646,10 +2755,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -2658,10 +2768,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -2670,10 +2781,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -2682,10 +2794,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -2694,45 +2807,49 @@ paths:
description: Vraag de headers op die je bij een GET request zou krijgen.
summary: 'De headers voor een specifiek(e) EIGENSCHAP opvragen '
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - eigenschappen
+ - eigenschappen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -2745,54 +2862,60 @@ paths:
description: Deze lijst kan gefilterd wordt met query-string parameters.
summary: Alle INFORMATIEOBJECTTYPEn opvragen.
parameters:
- - name: catalogus
- required: false
- in: query
- description: URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE
- behoort.
- schema:
- type: string
- format: uri
- - name: status
- required: false
- in: query
- description: |
- filter objects depending on their concept status:
- * `alles`: Toon objecten waarvan het attribuut `concept` true of false is.
- * `concept`: Toon objecten waarvan het attribuut `concept` true is.
- * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard).
- schema:
- type: string
- - name: datumGeldigheid
- required: false
- in: query
- description: filter objecten op hun geldigheids datum.
- schema:
- type: string
- - name: omschrijving
- required: false
- in: query
- description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE.
- schema:
- type: string
- - name: page
- required: false
- in: query
- description: Een pagina binnen de gepagineerde set resultaten.
- schema:
- type: integer
+ - name: catalogus
+ required: false
+ in: query
+ description:
+ URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE
+ behoort.
+ schema:
+ type: string
+ format: uri
+ - name: status
+ required: false
+ in: query
+ description: 'filter objects depending on their concept status:
+
+ * `alles`: Toon objecten waarvan het attribuut `concept` true of false is.
+
+ * `concept`: Toon objecten waarvan het attribuut `concept` true is.
+
+ * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard).
+
+ '
+ schema:
+ type: string
+ - name: datumGeldigheid
+ required: false
+ in: query
+ description: filter objecten op hun geldigheids datum.
+ schema:
+ type: string
+ - name: omschrijving
+ required: false
+ in: query
+ description: Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE.
+ schema:
+ type: string
+ - name: page
+ required: false
+ in: query
+ description: Een pagina binnen de gepagineerde set resultaten.
+ schema:
+ type: integer
tags:
- - informatieobjecttypen
+ - informatieobjecttypen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -2804,10 +2927,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -2816,10 +2940,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -2828,10 +2953,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -2840,10 +2966,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -2852,10 +2979,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -2864,10 +2992,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -2876,10 +3005,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -2888,10 +3018,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -2900,10 +3031,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -2912,16 +3044,16 @@ paths:
description: Maak een INFORMATIEOBJECTTYPE aan.
summary: Maak een INFORMATIEOBJECTTYPE aan.
parameters:
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - informatieobjecttypen
+ - informatieobjecttypen
requestBody:
content:
application/json:
@@ -2929,8 +3061,8 @@ paths:
$ref: '#/components/schemas/InformatieObjectType'
required: true
security:
- - JWT-Claims:
- - catalogi.schrijven
+ - JWT-Claims:
+ - catalogi.schrijven
responses:
'201':
headers:
@@ -2942,7 +3074,8 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -2954,10 +3087,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -2966,10 +3100,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -2978,10 +3113,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -2990,10 +3126,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -3002,10 +3139,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -3014,10 +3152,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -3026,10 +3165,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -3038,10 +3178,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -3050,10 +3191,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -3063,48 +3205,52 @@ paths:
description: Een specifieke INFORMATIEOBJECTTYPE opvragen.
summary: Een specifieke INFORMATIEOBJECTTYPE opvragen.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - informatieobjecttypen
+ - informatieobjecttypen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -3116,10 +3262,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -3128,10 +3275,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -3140,10 +3288,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -3152,10 +3301,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -3164,10 +3314,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -3176,10 +3327,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -3188,10 +3340,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -3200,10 +3353,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -3212,37 +3366,39 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
put:
operationId: informatieobjecttype_update
- description: Werk een INFORMATIEOBJECTTYPE in zijn geheel bij. Dit kan alleen
+ description:
+ Werk een INFORMATIEOBJECTTYPE in zijn geheel bij. Dit kan alleen
als het een concept betreft.
summary: Werk een INFORMATIEOBJECTTYPE in zijn geheel bij.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - informatieobjecttypen
+ - informatieobjecttypen
requestBody:
content:
application/json:
@@ -3250,15 +3406,16 @@ paths:
$ref: '#/components/schemas/InformatieObjectType'
required: true
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -3270,10 +3427,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -3282,10 +3440,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -3294,10 +3453,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -3306,10 +3466,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -3318,10 +3479,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -3330,10 +3492,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -3342,10 +3505,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -3354,10 +3518,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -3366,10 +3531,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -3378,52 +3544,55 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
patch:
operationId: informatieobjecttype_partial_update
- description: Werk een INFORMATIEOBJECTTYPE deels bij. Dit kan alleen als het
+ description:
+ Werk een INFORMATIEOBJECTTYPE deels bij. Dit kan alleen als het
een concept betreft.
summary: ' Werk een INFORMATIEOBJECTTYPE deels bij.'
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - informatieobjecttypen
+ - informatieobjecttypen
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedInformatieObjectType'
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -3435,10 +3604,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -3447,10 +3617,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -3459,10 +3630,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -3471,10 +3643,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -3483,10 +3656,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -3495,10 +3669,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -3507,10 +3682,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -3519,10 +3695,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -3531,10 +3708,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -3543,32 +3721,34 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
delete:
operationId: informatieobjecttype_destroy
- description: Verwijder een INFORMATIEOBJECTTYPE. Dit kan alleen als het een
+ description:
+ Verwijder een INFORMATIEOBJECTTYPE. Dit kan alleen als het een
concept betreft.
summary: Verwijder een INFORMATIEOBJECTTYPE.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
tags:
- - informatieobjecttypen
+ - informatieobjecttypen
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
responses:
'204':
description: No content
@@ -3577,10 +3757,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -3589,10 +3770,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -3601,10 +3783,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -3613,10 +3796,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -3625,10 +3809,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -3637,10 +3822,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -3649,10 +3835,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -3661,10 +3848,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -3673,10 +3861,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -3685,45 +3874,49 @@ paths:
description: Vraag de headers op die je bij een GET request zou krijgen.
summary: 'De headers voor een specifiek(e) INFORMATIEOBJECTTYPE opvragen '
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - informatieobjecttypen
+ - informatieobjecttypen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -3733,40 +3926,42 @@ paths:
/informatieobjecttypen/{uuid}/publish:
post:
operationId: informatieobjecttype_publish
- description: Publiceren van het informatieobjecttype zorgt ervoor dat dit in
+ description:
+ Publiceren van het informatieobjecttype zorgt ervoor dat dit in
een Documenten API kan gebruikt worden. Na het publiceren van een informatieobjecttype
zijn geen inhoudelijke wijzigingen meer mogelijk. Indien er na het publiceren
nog wat gewijzigd moet worden, dan moet je een nieuwe versie aanmaken.
summary: Publiceer het concept INFORMATIEOBJECTTYPE.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - informatieobjecttypen
+ - informatieobjecttypen
security:
- - JWT-Claims:
- - catalogi.schrijven
+ - JWT-Claims:
+ - catalogi.schrijven
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -3775,61 +3970,61 @@ paths:
description: OK
'400':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
'404':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
'401':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
'403':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
'406':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
'409':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
'410':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
'415':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
'429':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
'500':
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -3839,48 +4034,49 @@ paths:
description: Deze lijst kan gefilterd wordt met query-string parameters.
summary: Alle RESULTAATTYPEn opvragen.
parameters:
- - name: zaaktype
- required: false
- in: query
- description: zaaktype
- schema:
- type: string
- - name: zaaktype_identificatie
- required: false
- in: query
- description: zaaktype_identificatie
- schema:
- type: string
- - name: status
- required: false
- in: query
- description: status
- schema:
- type: string
- - name: datum_geldigheid
- required: false
- in: query
- description: datum_geldigheid
- schema:
- type: string
- - name: page
- required: false
- in: query
- description: Een pagina binnen de gepagineerde set resultaten.
- schema:
- type: integer
+ - name: zaaktype
+ required: false
+ in: query
+ description: zaaktype
+ schema:
+ type: string
+ - name: zaaktype_identificatie
+ required: false
+ in: query
+ description: zaaktype_identificatie
+ schema:
+ type: string
+ - name: status
+ required: false
+ in: query
+ description: status
+ schema:
+ type: string
+ - name: datum_geldigheid
+ required: false
+ in: query
+ description: datum_geldigheid
+ schema:
+ type: string
+ - name: page
+ required: false
+ in: query
+ description: Een pagina binnen de gepagineerde set resultaten.
+ schema:
+ type: integer
tags:
- - resultaattypen
+ - resultaattypen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -3892,10 +4088,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -3904,10 +4101,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -3916,10 +4114,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -3928,10 +4127,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -3940,10 +4140,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -3952,10 +4153,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -3964,10 +4166,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -3976,10 +4179,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -3988,29 +4192,31 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
post:
operationId: resultaattype_create
- description: Maak een RESULTAATTYPE aan. Dit kan alleen als het bijbehorende
+ description:
+ Maak een RESULTAATTYPE aan. Dit kan alleen als het bijbehorende
ZAAKTYPE een concept betreft.
summary: Maak een RESULTAATTYPE aan.
parameters:
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - resultaattypen
+ - resultaattypen
requestBody:
content:
application/json:
@@ -4018,8 +4224,8 @@ paths:
$ref: '#/components/schemas/ResultaatTypeCreate'
required: true
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'201':
headers:
@@ -4031,7 +4237,8 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -4043,10 +4250,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -4055,10 +4263,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -4067,10 +4276,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -4079,10 +4289,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -4091,10 +4302,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -4103,10 +4315,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -4115,10 +4328,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -4127,10 +4341,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -4139,10 +4354,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -4152,48 +4368,52 @@ paths:
description: Een specifieke RESULTAATTYPE opvragen.
summary: Een specifieke RESULTAATTYPE opvragen.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - resultaattypen
+ - resultaattypen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -4205,10 +4425,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -4217,10 +4438,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -4229,10 +4451,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -4241,10 +4464,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -4253,10 +4477,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -4265,10 +4490,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -4277,10 +4503,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -4289,10 +4516,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -4301,37 +4529,39 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
put:
operationId: resultaattype_update
- description: Werk een RESULTAATTYPE in zijn geheel bij. Dit kan alleen als het
+ description:
+ Werk een RESULTAATTYPE in zijn geheel bij. Dit kan alleen als het
bijbehorende ZAAKTYPE een concept betreft.
summary: Werk een RESULTAATTYPE in zijn geheel bij.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - resultaattypen
+ - resultaattypen
requestBody:
content:
application/json:
@@ -4339,15 +4569,16 @@ paths:
$ref: '#/components/schemas/ResultaatTypeCreate'
required: true
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -4359,10 +4590,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -4371,10 +4603,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -4383,10 +4616,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -4395,10 +4629,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -4407,10 +4642,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -4419,10 +4655,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -4431,10 +4668,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -4443,10 +4681,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -4455,10 +4694,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -4467,52 +4707,55 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
patch:
operationId: resultaattype_partial_update
- description: Werk een RESULTAATTYPE deels bij. Dit kan alleen als het bijbehorende
+ description:
+ Werk een RESULTAATTYPE deels bij. Dit kan alleen als het bijbehorende
ZAAKTYPE een concept betreft.
summary: Werk een RESULTAATTYPE deels bij.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - resultaattypen
+ - resultaattypen
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedResultaatType'
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -4524,10 +4767,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -4536,10 +4780,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -4548,10 +4793,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -4560,10 +4806,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -4572,10 +4819,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -4584,10 +4832,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -4596,10 +4845,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -4608,10 +4858,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -4620,10 +4871,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -4632,32 +4884,34 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
delete:
operationId: resultaattype_destroy
- description: Verwijder een RESULTAATTYPE. Dit kan alleen als het bijbehorende
+ description:
+ Verwijder een RESULTAATTYPE. Dit kan alleen als het bijbehorende
ZAAKTYPE een concept betreft.
summary: Verwijder een RESULTAATTYPE.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
tags:
- - resultaattypen
+ - resultaattypen
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
responses:
'204':
description: No content
@@ -4666,10 +4920,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -4678,10 +4933,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -4690,10 +4946,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -4702,10 +4959,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -4714,10 +4972,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -4726,10 +4985,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -4738,10 +4998,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -4750,10 +5011,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -4762,10 +5024,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -4774,45 +5037,49 @@ paths:
description: Vraag de headers op die je bij een GET request zou krijgen.
summary: 'De headers voor een specifiek(e) RESULTAATTYPE opvragen '
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - resultaattypen
+ - resultaattypen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -4825,69 +5092,75 @@ paths:
description: Deze lijst kan gefilterd wordt met query-string parameters.
summary: Alle ROLTYPEn opvragen.
parameters:
- - name: zaaktype
- required: false
- in: query
- description: URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken
- kunnen zijn.
- schema:
- type: string
- format: uri
- - name: zaaktypeIdentificatie
- required: false
- in: query
- description: zaaktype_identificatie
- schema:
- type: string
- - name: omschrijvingGeneriek
- required: false
- in: query
- description: Algemeen gehanteerde omschrijving van de aard van de ROL.
- schema:
- type: string
- enum:
- - adviseur
- - behandelaar
- - belanghebbende
- - beslisser
- - initiator
- - klantcontacter
- - zaakcoordinator
- - mede_initiator
- - name: status
- required: false
- in: query
- description: |
- filter objects depending on their concept status:
- * `alles`: Toon objecten waarvan het attribuut `concept` true of false is.
- * `concept`: Toon objecten waarvan het attribuut `concept` true is.
- * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard).
- schema:
- type: string
- - name: datumGeldigheid
- required: false
- in: query
- description: filter objecten op hun geldigheids datum.
- schema:
- type: string
- - name: page
- required: false
- in: query
- description: Een pagina binnen de gepagineerde set resultaten.
- schema:
- type: integer
+ - name: zaaktype
+ required: false
+ in: query
+ description:
+ URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken
+ kunnen zijn.
+ schema:
+ type: string
+ format: uri
+ - name: zaaktypeIdentificatie
+ required: false
+ in: query
+ description: zaaktype_identificatie
+ schema:
+ type: string
+ - name: omschrijvingGeneriek
+ required: false
+ in: query
+ description: Algemeen gehanteerde omschrijving van de aard van de ROL.
+ schema:
+ type: string
+ enum:
+ - adviseur
+ - behandelaar
+ - belanghebbende
+ - beslisser
+ - initiator
+ - klantcontacter
+ - zaakcoordinator
+ - mede_initiator
+ - name: status
+ required: false
+ in: query
+ description: 'filter objects depending on their concept status:
+
+ * `alles`: Toon objecten waarvan het attribuut `concept` true of false is.
+
+ * `concept`: Toon objecten waarvan het attribuut `concept` true is.
+
+ * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard).
+
+ '
+ schema:
+ type: string
+ - name: datumGeldigheid
+ required: false
+ in: query
+ description: filter objecten op hun geldigheids datum.
+ schema:
+ type: string
+ - name: page
+ required: false
+ in: query
+ description: Een pagina binnen de gepagineerde set resultaten.
+ schema:
+ type: integer
tags:
- - roltypen
+ - roltypen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -4899,10 +5172,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -4911,10 +5185,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -4923,10 +5198,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -4935,10 +5211,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -4947,10 +5224,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -4959,10 +5237,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -4971,10 +5250,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -4983,10 +5263,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -4995,29 +5276,31 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
post:
operationId: roltype_create
- description: Maak een ROLTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE
+ description:
+ Maak een ROLTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE
een concept betreft.
summary: Maak een ROLTYPE aan.
parameters:
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - roltypen
+ - roltypen
requestBody:
content:
application/json:
@@ -5025,8 +5308,8 @@ paths:
$ref: '#/components/schemas/RolType'
required: true
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'201':
headers:
@@ -5038,7 +5321,8 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -5050,10 +5334,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -5062,10 +5347,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -5074,10 +5360,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -5086,10 +5373,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -5098,10 +5386,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -5110,10 +5399,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -5122,10 +5412,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -5134,10 +5425,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -5146,10 +5438,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -5159,47 +5452,51 @@ paths:
description: Een specifieke ROLTYPE opvragen.
summary: Een specifieke ROLTYPE opvragen.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - roltypen
+ - roltypen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -5211,10 +5508,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -5223,10 +5521,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -5235,10 +5534,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -5247,10 +5547,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -5259,10 +5560,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -5271,10 +5573,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -5283,10 +5586,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -5295,10 +5599,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -5307,36 +5612,38 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
put:
operationId: roltype_update
- description: Werk een ROLTYPE in zijn geheel bij. Dit kan alleen als het een
+ description:
+ Werk een ROLTYPE in zijn geheel bij. Dit kan alleen als het een
concept betreft.
summary: Werk een ROLTYPE in zijn geheel bij.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - roltypen
+ - roltypen
requestBody:
content:
application/json:
@@ -5344,15 +5651,16 @@ paths:
$ref: '#/components/schemas/RolType'
required: true
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -5364,10 +5672,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -5376,10 +5685,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -5388,10 +5698,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -5400,10 +5711,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -5412,10 +5724,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -5424,10 +5737,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -5436,10 +5750,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -5448,10 +5763,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -5460,10 +5776,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -5472,51 +5789,54 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
patch:
operationId: roltype_partial_update
- description: Werk een ROLTYPE deels bij. Dit kan alleen als het een concept
+ description:
+ Werk een ROLTYPE deels bij. Dit kan alleen als het een concept
betreft.
summary: Werk een ROLTYPE deels bij.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - roltypen
+ - roltypen
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedRolType'
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -5528,10 +5848,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -5540,10 +5861,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -5552,10 +5874,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -5564,10 +5887,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -5576,10 +5900,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -5588,10 +5913,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -5600,10 +5926,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -5612,10 +5939,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -5624,10 +5952,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -5636,10 +5965,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -5648,18 +5978,18 @@ paths:
description: Verwijder een ROLTYPE. Dit kan alleen als het een concept betreft.
summary: Verwijder een ROLTYPE.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- title: uuid
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ title: uuid
+ required: true
tags:
- - roltypen
+ - roltypen
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
responses:
'204':
description: No content
@@ -5668,10 +5998,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -5680,10 +6011,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -5692,10 +6024,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -5704,10 +6037,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -5716,10 +6050,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -5728,10 +6063,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -5740,10 +6076,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -5752,10 +6089,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -5764,10 +6102,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -5776,44 +6115,48 @@ paths:
description: Vraag de headers op die je bij een GET request zou krijgen.
summary: 'De headers voor een specifiek(e) ROLTYPE opvragen '
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - roltypen
+ - roltypen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -5826,54 +6169,60 @@ paths:
description: Deze lijst kan gefilterd wordt met query-string parameters.
summary: Alle STATUSTYPEn opvragen.
parameters:
- - name: zaaktype
- required: false
- in: query
- description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen
- van dit STATUSTYPE bereikt kunnen worden.
- schema:
- type: string
- format: uri
- - name: zaaktypeIdentificatie
- required: false
- in: query
- description: zaaktype_identificatie
- schema:
- type: string
- - name: status
- required: false
- in: query
- description: |
- filter objects depending on their concept status:
- * `alles`: Toon objecten waarvan het attribuut `concept` true of false is.
- * `concept`: Toon objecten waarvan het attribuut `concept` true is.
- * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard).
- schema:
- type: string
- - name: datumGeldigheid
- required: false
- in: query
- description: filter objecten op hun geldigheids datum.
- schema:
- type: string
- - name: page
- required: false
- in: query
- description: Een pagina binnen de gepagineerde set resultaten.
- schema:
- type: integer
+ - name: zaaktype
+ required: false
+ in: query
+ description:
+ URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen
+ van dit STATUSTYPE bereikt kunnen worden.
+ schema:
+ type: string
+ format: uri
+ - name: zaaktypeIdentificatie
+ required: false
+ in: query
+ description: zaaktype_identificatie
+ schema:
+ type: string
+ - name: status
+ required: false
+ in: query
+ description: 'filter objects depending on their concept status:
+
+ * `alles`: Toon objecten waarvan het attribuut `concept` true of false is.
+
+ * `concept`: Toon objecten waarvan het attribuut `concept` true is.
+
+ * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard).
+
+ '
+ schema:
+ type: string
+ - name: datumGeldigheid
+ required: false
+ in: query
+ description: filter objecten op hun geldigheids datum.
+ schema:
+ type: string
+ - name: page
+ required: false
+ in: query
+ description: Een pagina binnen de gepagineerde set resultaten.
+ schema:
+ type: integer
tags:
- - statustypen
+ - statustypen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -5885,10 +6234,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -5897,10 +6247,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -5909,10 +6260,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -5921,10 +6273,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -5933,10 +6286,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -5945,10 +6299,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -5957,10 +6312,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -5969,10 +6325,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -5981,29 +6338,31 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
post:
operationId: statustype_create
- description: Maak een STATUSTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE
+ description:
+ Maak een STATUSTYPE aan. Dit kan alleen als het bijbehorende ZAAKTYPE
een concept betreft.
summary: Maak een STATUSTYPE aan.
parameters:
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - statustypen
+ - statustypen
requestBody:
content:
application/json:
@@ -6011,8 +6370,8 @@ paths:
$ref: '#/components/schemas/StatusType'
required: true
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'201':
headers:
@@ -6024,7 +6383,8 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -6036,10 +6396,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -6048,10 +6409,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -6060,10 +6422,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -6072,10 +6435,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -6084,10 +6448,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -6096,10 +6461,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -6108,10 +6474,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -6120,10 +6487,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -6132,10 +6500,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -6145,48 +6514,52 @@ paths:
description: Een specifieke STATUSTYPE opvragen.
summary: Een specifieke STATUSTYPE opvragen.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - statustypen
+ - statustypen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -6198,10 +6571,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -6210,10 +6584,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -6222,10 +6597,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -6234,10 +6610,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -6246,10 +6623,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -6258,10 +6636,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -6270,10 +6649,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -6282,10 +6662,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -6294,37 +6675,39 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
put:
operationId: statustype_update
- description: Werk een STATUSTYPE in zijn geheel bij. Dit kan alleen als het
+ description:
+ Werk een STATUSTYPE in zijn geheel bij. Dit kan alleen als het
bijbehorende ZAAKTYPE een concept betreft.
summary: Werk een STATUSTYPE in zijn geheel bij.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - statustypen
+ - statustypen
requestBody:
content:
application/json:
@@ -6332,15 +6715,16 @@ paths:
$ref: '#/components/schemas/StatusType'
required: true
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -6352,10 +6736,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -6364,10 +6749,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -6376,10 +6762,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -6388,10 +6775,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -6400,10 +6788,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -6412,10 +6801,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -6424,10 +6814,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -6436,10 +6827,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -6448,10 +6840,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -6460,52 +6853,55 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
patch:
operationId: statustype_partial_update
- description: Werk een STATUSTYPE deels bij. Dit kan alleen als het bijbehorende
+ description:
+ Werk een STATUSTYPE deels bij. Dit kan alleen als het bijbehorende
ZAAKTYPE een concept betreft.
summary: Werk een STATUSTYPE deels bij.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - statustypen
+ - statustypen
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedStatusType'
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -6517,10 +6913,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -6529,10 +6926,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -6541,10 +6939,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -6553,10 +6952,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -6565,10 +6965,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -6577,10 +6978,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -6589,10 +6991,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -6601,10 +7004,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -6613,10 +7017,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -6625,32 +7030,34 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
delete:
operationId: statustype_destroy
- description: Verwijder een STATUSTYPE. Dit kan alleen als het bijbehorende ZAAKTYPE
+ description:
+ Verwijder een STATUSTYPE. Dit kan alleen als het bijbehorende ZAAKTYPE
een concept betreft.
summary: Verwijder een STATUSTYPE.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
tags:
- - statustypen
+ - statustypen
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
responses:
'204':
description: No content
@@ -6659,10 +7066,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -6671,10 +7079,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -6683,10 +7092,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -6695,10 +7105,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -6707,10 +7118,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -6719,10 +7131,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -6731,10 +7144,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -6743,10 +7157,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -6755,10 +7170,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -6767,45 +7183,49 @@ paths:
description: Vraag de headers op die je bij een GET request zou krijgen.
summary: 'De headers voor een specifiek(e) STATUSTYPE opvragen '
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - statustypen
+ - statustypen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -6818,84 +7238,88 @@ paths:
description: Deze lijst kan gefilterd wordt met query-string parameters.
summary: Alle ZAAKOBJECTTYPEn opvragen.
parameters:
- - name: anderObjecttype
- required: false
- in: query
- description: Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een
- ander, niet in RSGB en RGBZ voorkomend, objecttype betreft.
- schema:
- type: string
- - name: catalogus
- required: false
- in: query
- description: URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE behoort.
- schema:
- type: string
- format: uri
- - name: datumBeginGeldigheid
- required: false
- in: query
- description: De datum waarop het is ontstaan.
- schema:
- type: string
- - name: datumEindeGeldigheid
- required: false
- in: query
- description: De datum waarop het is opgeheven.
- schema:
- type: string
- - name: datumGeldigheid
- required: false
- in: query
- description: filter objecten op hun geldigheids datum.
- schema:
- type: string
- - name: objecttype
- required: false
- in: query
- description: URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE
- behoort.
- schema:
- type: string
- format: uri
- - name: relatieOmschrijving
- required: false
- in: query
- description: Omschrijving van de betrekking van het Objecttype op zaken van
- het gerelateerde ZAAKTYPE.
- schema:
- type: string
- - name: zaaktype
- required: false
- in: query
- description: URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE behoort.
- schema:
- type: string
- format: uri
- - name: zaaktypeIdentificatie
- required: false
- in: query
- description: zaaktype_identificatie
- schema:
- type: string
- - name: page
- required: false
- in: query
- description: Een pagina binnen de gepagineerde set resultaten.
- schema:
- type: integer
+ - name: anderObjecttype
+ required: false
+ in: query
+ description:
+ Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een
+ ander, niet in RSGB en RGBZ voorkomend, objecttype betreft.
+ schema:
+ type: string
+ - name: catalogus
+ required: false
+ in: query
+ description: URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE behoort.
+ schema:
+ type: string
+ format: uri
+ - name: datumBeginGeldigheid
+ required: false
+ in: query
+ description: De datum waarop het is ontstaan.
+ schema:
+ type: string
+ - name: datumEindeGeldigheid
+ required: false
+ in: query
+ description: De datum waarop het is opgeheven.
+ schema:
+ type: string
+ - name: datumGeldigheid
+ required: false
+ in: query
+ description: filter objecten op hun geldigheids datum.
+ schema:
+ type: string
+ - name: objecttype
+ required: false
+ in: query
+ description:
+ URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE
+ behoort.
+ schema:
+ type: string
+ format: uri
+ - name: relatieOmschrijving
+ required: false
+ in: query
+ description:
+ Omschrijving van de betrekking van het Objecttype op zaken van
+ het gerelateerde ZAAKTYPE.
+ schema:
+ type: string
+ - name: zaaktype
+ required: false
+ in: query
+ description: URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE behoort.
+ schema:
+ type: string
+ format: uri
+ - name: zaaktypeIdentificatie
+ required: false
+ in: query
+ description: zaaktype_identificatie
+ schema:
+ type: string
+ - name: page
+ required: false
+ in: query
+ description: Een pagina binnen de gepagineerde set resultaten.
+ schema:
+ type: integer
tags:
- - zaakobjecttypen
+ - zaakobjecttypen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -6907,10 +7331,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -6919,10 +7344,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -6931,10 +7357,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -6943,10 +7370,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -6955,10 +7383,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -6967,10 +7396,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -6979,10 +7409,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -6991,10 +7422,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -7003,10 +7435,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -7015,16 +7448,16 @@ paths:
description: Maak een ZAAKOBJECTTYPE aan.
summary: Maak een ZAAKOBJECTTYPE aan.
parameters:
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - zaakobjecttypen
+ - zaakobjecttypen
requestBody:
content:
application/json:
@@ -7032,8 +7465,8 @@ paths:
$ref: '#/components/schemas/ZaakObjectType'
required: true
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'201':
headers:
@@ -7045,7 +7478,8 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -7057,10 +7491,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -7069,10 +7504,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -7081,10 +7517,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -7093,10 +7530,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -7105,10 +7543,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -7117,10 +7556,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -7129,10 +7569,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -7141,10 +7582,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -7153,10 +7595,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -7166,48 +7609,52 @@ paths:
description: Een specifieke ZAAKOBJECTTYPE opvragen.
summary: Een specifieke ZAAKOBJECTTYPE opvragen.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - zaakobjecttypen
+ - zaakobjecttypen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -7219,10 +7666,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -7231,10 +7679,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -7243,10 +7692,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -7255,10 +7705,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -7267,10 +7718,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -7279,10 +7731,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -7291,10 +7744,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -7303,10 +7757,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -7315,10 +7770,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -7327,24 +7783,24 @@ paths:
description: Werk een ZAAKOBJECTTYPE in zijn geheel bij.
summary: Werk een ZAAKOBJECTTYPE in zijn geheel bij.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - zaakobjecttypen
+ - zaakobjecttypen
requestBody:
content:
application/json:
@@ -7352,15 +7808,16 @@ paths:
$ref: '#/components/schemas/ZaakObjectType'
required: true
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -7372,10 +7829,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -7384,10 +7842,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -7396,10 +7855,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -7408,10 +7868,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -7420,10 +7881,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -7432,10 +7894,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -7444,10 +7907,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -7456,10 +7920,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -7468,10 +7933,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -7480,10 +7946,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -7492,39 +7959,40 @@ paths:
description: Werk een ZAAKOBJECTTYPE deels bij.
summary: Werk een ZAAKOBJECTTYPE deels bij.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - zaakobjecttypen
+ - zaakobjecttypen
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedZaakObjectType'
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -7536,10 +8004,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -7548,10 +8017,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -7560,10 +8030,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -7572,10 +8043,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -7584,10 +8056,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -7596,10 +8069,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -7608,10 +8082,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -7620,10 +8095,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -7632,10 +8108,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -7644,10 +8121,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -7656,19 +8134,19 @@ paths:
description: Verwijder een ZAAKOBJECTTYPE.
summary: Verwijder een ZAAKOBJECTTYPE.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
tags:
- - zaakobjecttypen
+ - zaakobjecttypen
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
responses:
'204':
description: No content
@@ -7677,10 +8155,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -7689,10 +8168,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -7701,10 +8181,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -7713,10 +8194,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -7725,10 +8207,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -7737,10 +8220,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -7749,10 +8233,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -7761,10 +8246,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -7773,10 +8259,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -7785,45 +8272,49 @@ paths:
description: Vraag de headers op die je bij een GET request zou krijgen.
summary: 'De headers voor een specifiek(e) ZAAKOBJECTTYPE opvragen '
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - zaakobjecttypen
+ - zaakobjecttypen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -7836,59 +8327,65 @@ paths:
description: Deze lijst kan gefilterd wordt met query-string parameters.
summary: Alle ZAAKTYPE-INFORMATIEOBJECTTYPE relaties opvragen.
parameters:
- - name: zaaktype
- required: false
- in: query
- description: URL-referentie naar het ZAAKTYPE.
- schema:
- type: string
- format: uri
- - name: informatieobjecttype
- required: false
- in: query
- description: URL-referentie naar het INFORMATIEOBJECTTYPE.
- schema:
- type: string
- format: uri
- - name: richting
- required: false
- in: query
- description: Aanduiding van de richting van informatieobjecten van het gerelateerde
- INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE.
- schema:
- type: string
- enum:
- - inkomend
- - intern
- - uitgaand
- - name: status
- required: false
- in: query
- description: |
- filter objects depending on their concept status:
- * `alles`: Toon objecten waarvan het attribuut `concept` true of false is.
- * `concept`: Toon objecten waarvan het attribuut `concept` true is.
- * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard).
- schema:
- type: string
- - name: page
- required: false
- in: query
- description: Een pagina binnen de gepagineerde set resultaten.
- schema:
- type: integer
+ - name: zaaktype
+ required: false
+ in: query
+ description: URL-referentie naar het ZAAKTYPE.
+ schema:
+ type: string
+ format: uri
+ - name: informatieobjecttype
+ required: false
+ in: query
+ description: URL-referentie naar het INFORMATIEOBJECTTYPE.
+ schema:
+ type: string
+ format: uri
+ - name: richting
+ required: false
+ in: query
+ description:
+ Aanduiding van de richting van informatieobjecten van het gerelateerde
+ INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE.
+ schema:
+ type: string
+ enum:
+ - inkomend
+ - intern
+ - uitgaand
+ - name: status
+ required: false
+ in: query
+ description: 'filter objects depending on their concept status:
+
+ * `alles`: Toon objecten waarvan het attribuut `concept` true of false is.
+
+ * `concept`: Toon objecten waarvan het attribuut `concept` true is.
+
+ * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard).
+
+ '
+ schema:
+ type: string
+ - name: page
+ required: false
+ in: query
+ description: Een pagina binnen de gepagineerde set resultaten.
+ schema:
+ type: integer
tags:
- - zaaktype-informatieobjecttypen
+ - zaaktype-informatieobjecttypen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -7900,10 +8397,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -7912,10 +8410,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -7924,10 +8423,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -7936,10 +8436,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -7948,10 +8449,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -7960,10 +8462,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -7972,10 +8475,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -7984,10 +8488,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -7996,30 +8501,33 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
post:
operationId: zaakinformatieobjecttype_create
- description: |-
- Maak een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie aan. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op:
- - `zaaktype` en `informatieobjecttype` behoren tot dezelfde `catalogus`
+ description:
+ 'Maak een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie aan. Dit kan alleen
+ als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op:
+
+ - `zaaktype` en `informatieobjecttype` behoren tot dezelfde `catalogus`'
summary: Maak een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie aan.
parameters:
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - zaaktype-informatieobjecttypen
+ - zaaktype-informatieobjecttypen
requestBody:
content:
application/json:
@@ -8027,8 +8535,8 @@ paths:
$ref: '#/components/schemas/ZaakTypeInformatieObjectTypeCreate'
required: true
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'201':
headers:
@@ -8040,7 +8548,8 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -8052,10 +8561,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -8064,10 +8574,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -8076,10 +8587,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -8088,10 +8600,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -8100,10 +8613,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -8112,10 +8626,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -8124,10 +8639,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -8136,10 +8652,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -8148,10 +8665,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -8161,48 +8679,52 @@ paths:
description: Een specifieke ZAAKTYPE-INFORMATIEOBJECTTYPE relatie opvragen.
summary: Een specifieke ZAAKTYPE-INFORMATIEOBJECTTYPE relatie opvragen.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - zaaktype-informatieobjecttypen
+ - zaaktype-informatieobjecttypen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -8214,10 +8736,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -8226,10 +8749,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -8238,10 +8762,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -8250,10 +8775,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -8262,10 +8788,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -8274,10 +8801,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -8286,10 +8814,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -8298,10 +8827,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -8310,38 +8840,41 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
put:
operationId: zaakinformatieobjecttype_update
- description: |-
- Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op:
- - `zaaktype` en `informatieobjecttype` behoren tot dezelfde `catalogus`
+ description:
+ "Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel\
+ \ bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er\
+ \ wordt gevalideerd op:\n - `zaaktype` en `informatieobjecttype` behoren tot\
+ \ dezelfde `catalogus`"
summary: Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie in zijn geheel bij.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - zaaktype-informatieobjecttypen
+ - zaaktype-informatieobjecttypen
requestBody:
content:
application/json:
@@ -8349,15 +8882,16 @@ paths:
$ref: '#/components/schemas/ZaakTypeInformatieObjectTypeUpdate'
required: true
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -8369,10 +8903,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -8381,10 +8916,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -8393,10 +8929,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -8405,10 +8942,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -8417,10 +8955,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -8429,10 +8968,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -8441,10 +8981,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -8453,10 +8994,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -8465,10 +9007,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -8477,53 +9020,57 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
patch:
operationId: zaakinformatieobjecttype_partial_update
- description: |-
- Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op:
- - `zaaktype` en `informatieobjecttype` behoren tot dezelfde `catalogus`
+ description:
+ "Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij. Dit\
+ \ kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt\
+ \ gevalideerd op:\n - `zaaktype` en `informatieobjecttype` behoren tot dezelfde\
+ \ `catalogus`"
summary: Werk een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie deels bij.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - zaaktype-informatieobjecttypen
+ - zaaktype-informatieobjecttypen
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedZaakTypeInformatieObjectType'
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -8535,10 +9082,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -8547,10 +9095,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -8559,10 +9108,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -8571,10 +9121,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -8583,10 +9134,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -8595,10 +9147,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -8607,10 +9160,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -8619,10 +9173,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -8631,10 +9186,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -8643,33 +9199,35 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
delete:
operationId: zaakinformatieobjecttype_destroy
- description: |-
- Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie. Dit kan alleen als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd op:
- - `zaaktype` of `informatieobjecttype` is nog niet gepubliceerd
+ description:
+ "Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie. Dit kan alleen\
+ \ als het bijbehorende ZAAKTYPE een concept betreft. Er wordt gevalideerd\
+ \ op:\n - `zaaktype` of `informatieobjecttype` is nog niet gepubliceerd"
summary: Verwijder een ZAAKTYPE-INFORMATIEOBJECTTYPE relatie.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
tags:
- - zaaktype-informatieobjecttypen
+ - zaaktype-informatieobjecttypen
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
responses:
'204':
description: No content
@@ -8678,10 +9236,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -8690,10 +9249,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -8702,10 +9262,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -8714,10 +9275,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -8726,10 +9288,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -8738,10 +9301,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -8750,10 +9314,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -8762,10 +9327,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -8774,10 +9340,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -8786,45 +9353,49 @@ paths:
description: Vraag de headers op die je bij een GET request zou krijgen.
summary: 'De headers voor een specifiek(e) ZAAK-INFORMATIEOBJECT-TYPE opvragen '
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - zaaktype-informatieobjecttypen
+ - zaaktype-informatieobjecttypen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -8837,64 +9408,70 @@ paths:
description: Deze lijst kan gefilterd wordt met query-string parameters.
summary: Alle ZAAKTYPEn opvragen.
parameters:
- - name: catalogus
- required: false
- in: query
- description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort.
- schema:
- type: string
- format: uri
- - name: identificatie
- required: false
- in: query
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
- het ZAAKTYPE voorkomt.
- schema:
- type: string
- - name: trefwoorden
- required: false
- in: query
- description: Multiple values may be separated by commas.
- schema:
- type: array
- items:
+ - name: catalogus
+ required: false
+ in: query
+ description: URL-referentie naar de CATALOGUS waartoe dit ZAAKTYPE behoort.
+ schema:
type: string
- style: form
- explode: false
- - name: status
- required: false
- in: query
- description: |
- filter objects depending on their concept status:
- * `alles`: Toon objecten waarvan het attribuut `concept` true of false is.
- * `concept`: Toon objecten waarvan het attribuut `concept` true is.
- * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard).
- schema:
- type: string
- - name: datumGeldigheid
- required: false
- in: query
- description: filter objecten op hun geldigheids datum.
- schema:
- type: string
- - name: page
- required: false
- in: query
- description: Een pagina binnen de gepagineerde set resultaten.
- schema:
- type: integer
+ format: uri
+ - name: identificatie
+ required: false
+ in: query
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ het ZAAKTYPE voorkomt.
+ schema:
+ type: string
+ - name: trefwoorden
+ required: false
+ in: query
+ description: Multiple values may be separated by commas.
+ schema:
+ type: array
+ items:
+ type: string
+ style: form
+ explode: false
+ - name: status
+ required: false
+ in: query
+ description: 'filter objects depending on their concept status:
+
+ * `alles`: Toon objecten waarvan het attribuut `concept` true of false is.
+
+ * `concept`: Toon objecten waarvan het attribuut `concept` true is.
+
+ * `definitief`: Toon objecten waarvan het attribuut `concept` false is (standaard).
+
+ '
+ schema:
+ type: string
+ - name: datumGeldigheid
+ required: false
+ in: query
+ description: filter objecten op hun geldigheids datum.
+ schema:
+ type: string
+ - name: page
+ required: false
+ in: query
+ description: Een pagina binnen de gepagineerde set resultaten.
+ schema:
+ type: integer
tags:
- - zaaktypen
+ - zaaktypen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -8906,10 +9483,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -8918,10 +9496,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -8930,10 +9509,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -8942,10 +9522,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -8954,10 +9535,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -8966,10 +9548,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -8978,10 +9561,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -8990,10 +9574,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -9002,32 +9587,34 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
post:
operationId: zaaktype_create
- description: |-
- Er wordt gevalideerd op:
- - geldigheid `catalogus` URL, dit moet een catalogus binnen dezelfde API zijn
- - Uniciteit `catalogus` en `omschrijving`. Dezelfde omeschrijving mag enkel opnieuw gebruikt worden als het zaaktype een andere geldigheidsperiode kent dan bestaande zaaktypen.
- - `deelzaaktypen` moeten tot dezelfde catalogus behoren als het ZAAKTYPE.
+ description:
+ "Er wordt gevalideerd op:\n- geldigheid `catalogus` URL, dit moet\
+ \ een catalogus binnen dezelfde API zijn\n - Uniciteit `catalogus` en `omschrijving`.\
+ \ Dezelfde omeschrijving mag enkel opnieuw gebruikt worden als het zaaktype\
+ \ een andere geldigheidsperiode kent dan bestaande zaaktypen.\n - `deelzaaktypen`\
+ \ moeten tot dezelfde catalogus behoren als het ZAAKTYPE."
summary: Maak een ZAAKTYPE aan.
parameters:
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - zaaktypen
+ - zaaktypen
requestBody:
content:
application/json:
@@ -9035,8 +9622,8 @@ paths:
$ref: '#/components/schemas/ZaakTypeCreate'
required: true
security:
- - JWT-Claims:
- - catalogi.schrijven
+ - JWT-Claims:
+ - catalogi.schrijven
responses:
'201':
headers:
@@ -9048,7 +9635,8 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -9060,10 +9648,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -9072,10 +9661,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -9084,10 +9674,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -9096,10 +9687,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -9108,10 +9700,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -9120,10 +9713,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -9132,10 +9726,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -9144,10 +9739,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -9156,10 +9752,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -9169,48 +9766,59 @@ paths:
description: Een specifieke ZAAKTYPE opvragen.
summary: Een specifieke ZAAKTYPE opvragen.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
+ - in: query
+ name: datumGeldigheid
+ schema:
+ type: string
+ description:
+ filter op datumGeldigheid voor het zelf en alle onderliggende
+ objecten
tags:
- - zaaktypen
+ - zaaktypen
security:
- - JWT-Claims:
- - catalogi.lezen
+ - JWT-Claims:
+ - catalogi.lezen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -9222,10 +9830,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -9234,10 +9843,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -9246,10 +9856,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -9258,10 +9869,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -9270,10 +9882,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -9282,10 +9895,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -9294,10 +9908,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -9306,10 +9921,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -9318,38 +9934,40 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
put:
operationId: zaaktype_update
- description: |-
- Werk een ZAAKTYPE in zijn geheel bij. Dit kan alleen als het een concept betreft. Er wordt gevalideerd op:
- - `deelzaaktypen` moeten tot dezelfde catalogus behoren als het ZAAKTYPE.
+ description:
+ "Werk een ZAAKTYPE in zijn geheel bij. Dit kan alleen als het een\
+ \ concept betreft. Er wordt gevalideerd op:\n - `deelzaaktypen` moeten tot\
+ \ dezelfde catalogus behoren als het ZAAKTYPE."
summary: Werk een ZAAKTYPE in zijn geheel bij.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - zaaktypen
+ - zaaktypen
requestBody:
content:
application/json:
@@ -9357,15 +9975,16 @@ paths:
$ref: '#/components/schemas/ZaakTypeUpdate'
required: true
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -9377,10 +9996,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -9389,10 +10009,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -9401,10 +10022,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -9413,10 +10035,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -9425,10 +10048,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -9437,10 +10061,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -9449,10 +10074,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -9461,10 +10087,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -9473,10 +10100,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -9485,53 +10113,56 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
patch:
operationId: zaaktype_partial_update
- description: |-
- Werk een ZAAKTYPE deels bij. Dit kan alleen als het een concept betreft. Er wordt gevalideerd op:
- - `deelzaaktypen` moeten tot dezelfde catalogus behoren als het ZAAKTYPE.
+ description:
+ "Werk een ZAAKTYPE deels bij. Dit kan alleen als het een concept\
+ \ betreft. Er wordt gevalideerd op:\n - `deelzaaktypen` moeten tot dezelfde\
+ \ catalogus behoren als het ZAAKTYPE."
summary: Werk een ZAAKTYPE deels bij.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - zaaktypen
+ - zaaktypen
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PatchedZaakType'
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-schrijven)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-schrijven)
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -9543,10 +10174,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -9555,10 +10187,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -9567,10 +10200,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -9579,10 +10213,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -9591,10 +10226,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -9603,10 +10239,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -9615,10 +10252,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -9627,10 +10265,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -9639,10 +10278,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -9651,10 +10291,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -9663,19 +10304,19 @@ paths:
description: Verwijder een ZAAKTYPE. Dit kan alleen als het een concept betreft.
summary: Verwijder een ZAAKTYPE.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
tags:
- - zaaktypen
+ - zaaktypen
security:
- - JWT-Claims:
- - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
+ - JWT-Claims:
+ - (catalogi.schrijven | catalogi.geforceerd-verwijderen)
responses:
'204':
description: No content
@@ -9684,10 +10325,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -9696,10 +10338,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -9708,10 +10351,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -9720,10 +10364,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -9732,10 +10377,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -9744,10 +10390,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -9756,10 +10403,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -9768,10 +10416,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -9780,10 +10429,11 @@ paths:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
@@ -9792,45 +10442,49 @@ paths:
description: Vraag de headers op die je bij een GET request zou krijgen.
summary: 'De headers voor een specifiek(e) ZAAKTYPE opvragen '
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: If-None-Match
- schema:
- type: string
- description: Voer een voorwaardelijk verzoek uit. Deze header moet één of
- meerdere ETag-waardes bevatten van resources die de consumer gecached heeft.
- Indien de waarde van de ETag van de huidige resource voorkomt in deze set,
- dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)
- voor meer informatie.
- examples:
- OneValue:
- value: '"79054025255fb1a26e4bc422aef54eb4"'
- summary: Eén ETag-waarde
- MultipleValues:
- value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
- summary: Meerdere ETag-waardes
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: If-None-Match
+ schema:
+ type: string
+ description:
+ "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\
+ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\
+ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\
+ \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\
+ \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\
+ \ voor meer informatie."
+ examples:
+ OneValue:
+ value: '"79054025255fb1a26e4bc422aef54eb4"'
+ summary: "E\xE9n ETag-waarde"
+ MultipleValues:
+ value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
+ summary: Meerdere ETag-waardes
tags:
- - zaaktypen
+ - zaaktypen
responses:
'200':
headers:
ETag:
schema:
type: string
- description: De ETag berekend op de response body JSON. Indien twee
+ description:
+ De ETag berekend op de response body JSON. Indien twee
resources exact dezelfde ETag hebben, dan zijn deze resources identiek
aan elkaar. Je kan de ETag gebruiken om caching te implementeren.
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
@@ -9840,31 +10494,32 @@ paths:
/zaaktypen/{uuid}/publish:
post:
operationId: zaaktype_publish
- description: Publiceren van het zaaktype zorgt ervoor dat dit in een Zaken API
+ description:
+ Publiceren van het zaaktype zorgt ervoor dat dit in een Zaken API
kan gebruiktworden. Na het publiceren van een zaaktype zijn geen inhoudelijke
wijzigingenmeer mogelijk - ook niet de statustypen, eigenschappen... etc.
Indien er na hetpubliceren nog wat gewijzigd moet worden, dan moet je een
nieuwe versieaanmaken.
summary: Publiceer het concept ZAAKTYPE.
parameters:
- - in: path
- name: uuid
- schema:
- type: string
- format: uuid
- description: Unieke resource identifier (UUID4)
- title: uuid
- required: true
- - in: header
- name: Content-Type
- schema:
- type: string
- enum:
- - application/json
- description: Content type van de verzoekinhoud.
- required: true
+ - in: path
+ name: uuid
+ schema:
+ type: string
+ format: uuid
+ description: Unieke resource identifier (UUID4)
+ title: uuid
+ required: true
+ - in: header
+ name: Content-Type
+ schema:
+ type: string
+ enum:
+ - application/json
+ description: Content type van de verzoekinhoud.
+ required: true
tags:
- - zaaktypen
+ - zaaktypen
requestBody:
content:
application/json:
@@ -9872,21 +10527,82 @@ paths:
$ref: '#/components/schemas/ZaakType'
required: true
security:
- - JWT-Claims:
- - catalogi.schrijven
+ - JWT-Claims:
+ - catalogi.schrijven
responses:
'200':
headers:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van
+ description:
+ 'Geeft een specifieke API-versie aan in de context van
een specifieke aanroep. Voorbeeld: 1.2.1.'
content:
application/json:
schema:
$ref: '#/components/schemas/ZaakType'
description: OK
+ '400':
+ content:
+ application/problem+json:
+ schema:
+ $ref: '#/components/schemas/ValidatieFout'
+ description: Bad request
+ '404':
+ content:
+ application/problem+json:
+ schema:
+ $ref: '#/components/schemas/Fout'
+ description: Not found
+ '401':
+ content:
+ application/problem+json:
+ schema:
+ $ref: '#/components/schemas/Fout'
+ description: Unauthorized
+ '403':
+ content:
+ application/problem+json:
+ schema:
+ $ref: '#/components/schemas/Fout'
+ description: Forbidden
+ '406':
+ content:
+ application/problem+json:
+ schema:
+ $ref: '#/components/schemas/Fout'
+ description: Not acceptable
+ '409':
+ content:
+ application/problem+json:
+ schema:
+ $ref: '#/components/schemas/Fout'
+ description: Conflict
+ '410':
+ content:
+ application/problem+json:
+ schema:
+ $ref: '#/components/schemas/Fout'
+ description: Gone
+ '415':
+ content:
+ application/problem+json:
+ schema:
+ $ref: '#/components/schemas/Fout'
+ description: Unsupported media type
+ '429':
+ content:
+ application/problem+json:
+ schema:
+ $ref: '#/components/schemas/Fout'
+ description: Too many requests
+ '500':
+ content:
+ application/problem+json:
+ schema:
+ $ref: '#/components/schemas/Fout'
+ description: Internal server error
components:
responses:
'400':
@@ -9894,10 +10610,11 @@ components:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van een
+ description:
+ 'Geeft een specifieke API-versie aan in de context van een
specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/ValidatieFout'
description: Bad request
@@ -9906,10 +10623,11 @@ components:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van een
+ description:
+ 'Geeft een specifieke API-versie aan in de context van een
specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unauthorized
@@ -9918,10 +10636,11 @@ components:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van een
+ description:
+ 'Geeft een specifieke API-versie aan in de context van een
specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Forbidden
@@ -9930,10 +10649,11 @@ components:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van een
+ description:
+ 'Geeft een specifieke API-versie aan in de context van een
specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not found
@@ -9942,10 +10662,11 @@ components:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van een
+ description:
+ 'Geeft een specifieke API-versie aan in de context van een
specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Not acceptable
@@ -9954,10 +10675,11 @@ components:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van een
+ description:
+ 'Geeft een specifieke API-versie aan in de context van een
specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Conflict
@@ -9966,10 +10688,11 @@ components:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van een
+ description:
+ 'Geeft een specifieke API-versie aan in de context van een
specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Gone
@@ -9978,10 +10701,11 @@ components:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van een
+ description:
+ 'Geeft een specifieke API-versie aan in de context van een
specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Unsupported media type
@@ -9990,10 +10714,11 @@ components:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van een
+ description:
+ 'Geeft een specifieke API-versie aan in de context van een
specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Too many requests
@@ -10002,36 +10727,37 @@ components:
API-version:
schema:
type: string
- description: 'Geeft een specifieke API-versie aan in de context van een
+ description:
+ 'Geeft een specifieke API-versie aan in de context van een
specifieke aanroep. Voorbeeld: 1.2.1.'
content:
- application/json:
+ application/problem+json:
schema:
$ref: '#/components/schemas/Fout'
description: Internal server error
schemas:
AardRelatieEnum:
enum:
- - vervolg
- - bijdrage
- - onderwerp
+ - vervolg
+ - bijdrage
+ - onderwerp
type: string
AfleidingswijzeEnum:
enum:
- - afgehandeld
- - ander_datumkenmerk
- - eigenschap
- - gerelateerde_zaak
- - hoofdzaak
- - ingangsdatum_besluit
- - termijn
- - vervaldatum_besluit
- - zaakobject
+ - afgehandeld
+ - ander_datumkenmerk
+ - eigenschap
+ - gerelateerde_zaak
+ - hoofdzaak
+ - ingangsdatum_besluit
+ - termijn
+ - vervaldatum_besluit
+ - zaakobject
type: string
ArchiefnominatieEnum:
enum:
- - blijvend_bewaren
- - vernietigen
+ - blijvend_bewaren
+ - vernietigen
type: string
BesluitType:
type: object
@@ -10041,7 +10767,8 @@ components:
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
@@ -10067,7 +10794,8 @@ components:
maxLength: 80
omschrijvingGeneriek:
type: string
- description: Algemeen gehanteerde omschrijving van de aard van BESLUITen
+ description:
+ Algemeen gehanteerde omschrijving van de aard van BESLUITen
van het BESLUITTYPE
title: omschrijving generiek
maxLength: 80
@@ -10079,25 +10807,29 @@ components:
reactietermijn:
type: string
nullable: true
- description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend-
+ description:
+ Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend-
of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype
mogelijk is.
title: reactietermijn
format: duration
publicatieIndicatie:
type: boolean
- description: Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten
+ description:
+ Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten
worden.
title: publicatie indicatie
publicatietekst:
type: string
- description: De generieke tekst van de publicatie van BESLUITen van dit
+ description:
+ De generieke tekst van de publicatie van BESLUITen van dit
BESLUITTYPE
title: publicatietekst
publicatietermijn:
type: string
nullable: true
- description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend-
+ description:
+ Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend-
of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten
blijven.
title: publicatietermijn
@@ -10112,7 +10844,8 @@ components:
type: string
format: uri
title: ''
- description: URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten
+ description:
+ URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten
waarin besluiten van dit BESLUITTYPE worden vastgelegd.
title: informatieobjecttypen
uniqueItems: true
@@ -10142,7 +10875,8 @@ components:
concept:
type: boolean
readOnly: true
- description: Geeft aan of het object een concept betreft. Concepten zijn
+ description:
+ Geeft aan of het object een concept betreft. Concepten zijn
niet-definitieve versies en zouden niet gebruikt moeten worden buiten
deze API.
title: concept
@@ -10154,7 +10888,8 @@ components:
title: Is resultaat van
readOnly: true
title: Is resultaat van
- description: Het BESLUITTYPE van besluiten die gepaard gaan met resultaten
+ description:
+ Het BESLUITTYPE van besluiten die gepaard gaan met resultaten
van het RESULTAATTYPE.
uniqueItems: true
resultaattypenOmschrijving:
@@ -10176,16 +10911,16 @@ components:
title: informatieobjecttypen
uniqueItems: true
required:
- - beginGeldigheid
- - catalogus
- - concept
- - informatieobjecttypen
- - publicatieIndicatie
- - resultaattypen
- - resultaattypenOmschrijving
- - url
- - vastgelegdIn
- - zaaktypen
+ - beginGeldigheid
+ - catalogus
+ - concept
+ - informatieobjecttypen
+ - publicatieIndicatie
+ - resultaattypen
+ - resultaattypenOmschrijving
+ - url
+ - vastgelegdIn
+ - zaaktypen
BesluitTypeCreate:
type: object
properties:
@@ -10194,7 +10929,8 @@ components:
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
@@ -10220,7 +10956,8 @@ components:
maxLength: 80
omschrijvingGeneriek:
type: string
- description: Algemeen gehanteerde omschrijving van de aard van BESLUITen
+ description:
+ Algemeen gehanteerde omschrijving van de aard van BESLUITen
van het BESLUITTYPE
title: omschrijving generiek
maxLength: 80
@@ -10232,25 +10969,29 @@ components:
reactietermijn:
type: string
nullable: true
- description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend-
+ description:
+ Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend-
of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype
mogelijk is.
title: reactietermijn
format: duration
publicatieIndicatie:
type: boolean
- description: Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten
+ description:
+ Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten
worden.
title: publicatie indicatie
publicatietekst:
type: string
- description: De generieke tekst van de publicatie van BESLUITen van dit
+ description:
+ De generieke tekst van de publicatie van BESLUITen van dit
BESLUITTYPE
title: publicatietekst
publicatietermijn:
type: string
nullable: true
- description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend-
+ description:
+ Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend-
of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten
blijven.
title: publicatietermijn
@@ -10264,7 +11005,8 @@ components:
items:
type: string
title: ''
- description: '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten
+ description:
+ '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten
waarin besluiten van dit BESLUITTYPE worden vastgelegd.'
title: informatieobjecttypen
beginGeldigheid:
@@ -10293,7 +11035,8 @@ components:
concept:
type: boolean
readOnly: true
- description: Geeft aan of het object een concept betreft. Concepten zijn
+ description:
+ Geeft aan of het object een concept betreft. Concepten zijn
niet-definitieve versies en zouden niet gebruikt moeten worden buiten
deze API.
title: concept
@@ -10305,7 +11048,8 @@ components:
title: Is resultaat van
readOnly: true
title: Is resultaat van
- description: Het BESLUITTYPE van besluiten die gepaard gaan met resultaten
+ description:
+ Het BESLUITTYPE van besluiten die gepaard gaan met resultaten
van het RESULTAATTYPE.
uniqueItems: true
resultaattypenOmschrijving:
@@ -10327,16 +11071,16 @@ components:
title: informatieobjecttypen
uniqueItems: true
required:
- - beginGeldigheid
- - catalogus
- - concept
- - informatieobjecttypen
- - publicatieIndicatie
- - resultaattypen
- - resultaattypenOmschrijving
- - url
- - vastgelegdIn
- - zaaktypen
+ - beginGeldigheid
+ - catalogus
+ - concept
+ - informatieobjecttypen
+ - publicatieIndicatie
+ - resultaattypen
+ - resultaattypenOmschrijving
+ - url
+ - vastgelegdIn
+ - zaaktypen
BesluitTypeUpdate:
type: object
properties:
@@ -10345,7 +11089,8 @@ components:
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
@@ -10371,7 +11116,8 @@ components:
maxLength: 80
omschrijvingGeneriek:
type: string
- description: Algemeen gehanteerde omschrijving van de aard van BESLUITen
+ description:
+ Algemeen gehanteerde omschrijving van de aard van BESLUITen
van het BESLUITTYPE
title: omschrijving generiek
maxLength: 80
@@ -10383,25 +11129,29 @@ components:
reactietermijn:
type: string
nullable: true
- description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend-
+ description:
+ Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend-
of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype
mogelijk is.
title: reactietermijn
format: duration
publicatieIndicatie:
type: boolean
- description: Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten
+ description:
+ Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten
worden.
title: publicatie indicatie
publicatietekst:
type: string
- description: De generieke tekst van de publicatie van BESLUITen van dit
+ description:
+ De generieke tekst van de publicatie van BESLUITen van dit
BESLUITTYPE
title: publicatietekst
publicatietermijn:
type: string
nullable: true
- description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend-
+ description:
+ Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend-
of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten
blijven.
title: publicatietermijn
@@ -10415,7 +11165,8 @@ components:
items:
type: string
title: ''
- description: '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten
+ description:
+ '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten
waarin besluiten van dit BESLUITTYPE worden vastgelegd.'
title: informatieobjecttypen
beginGeldigheid:
@@ -10444,7 +11195,8 @@ components:
concept:
type: boolean
readOnly: true
- description: Geeft aan of het object een concept betreft. Concepten zijn
+ description:
+ Geeft aan of het object een concept betreft. Concepten zijn
niet-definitieve versies en zouden niet gebruikt moeten worden buiten
deze API.
title: concept
@@ -10456,7 +11208,8 @@ components:
title: Is resultaat van
readOnly: true
title: Is resultaat van
- description: Het BESLUITTYPE van besluiten die gepaard gaan met resultaten
+ description:
+ Het BESLUITTYPE van besluiten die gepaard gaan met resultaten
van het RESULTAATTYPE.
uniqueItems: true
resultaattypenOmschrijving:
@@ -10478,19 +11231,19 @@ components:
title: informatieobjecttypen
uniqueItems: true
required:
- - beginGeldigheid
- - catalogus
- - concept
- - informatieobjecttypen
- - publicatieIndicatie
- - resultaattypen
- - resultaattypenOmschrijving
- - url
- - vastgelegdIn
- - zaaktypen
+ - beginGeldigheid
+ - catalogus
+ - concept
+ - informatieobjecttypen
+ - publicatieIndicatie
+ - resultaattypen
+ - resultaattypenOmschrijving
+ - url
+ - vastgelegdIn
+ - zaaktypen
BlankEnum:
enum:
- - ''
+ - ''
BronCatalogus:
type: object
description: De CATALOGUS waaraan het ZAAKTYPE is ontleend.
@@ -10507,14 +11260,15 @@ components:
maxLength: 5
rsin:
type: string
- description: Het RSIN van de INGESCHREVEN NIET-NATUURLIJK PERSOON die beheerder
+ description:
+ Het RSIN van de INGESCHREVEN NIET-NATUURLIJK PERSOON die beheerder
is van de CATALOGUS waaraan het ZAAKTYPE is ontleend.
title: broncatalogus rsin
maxLength: 9
required:
- - domein
- - rsin
- - url
+ - domein
+ - rsin
+ - url
BronZaaktype:
type: object
description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend.
@@ -10531,24 +11285,27 @@ components:
maxLength: 50
omschrijving:
type: string
- description: De Zaaktype-omschrijving van het bronzaaktype, zoals gehanteerd
+ description:
+ De Zaaktype-omschrijving van het bronzaaktype, zoals gehanteerd
in de Broncatalogus.
title: bronzaaktype omschrijving
maxLength: 80
required:
- - identificatie
- - omschrijving
- - url
+ - identificatie
+ - omschrijving
+ - url
BrondatumArchiefprocedure:
type: object
- description: Specificatie voor het bepalen van de brondatum voor de start van
+ description:
+ Specificatie voor het bepalen van de brondatum voor de start van
de Archiefactietermijn (=brondatum) van het zaakdossier.
properties:
afleidingswijze:
allOf:
- - $ref: '#/components/schemas/AfleidingswijzeEnum'
+ - $ref: '#/components/schemas/AfleidingswijzeEnum'
title: Afleidingswijze brondatum
- description: "Wijze van bepalen van de brondatum.\n\nUitleg bij mogelijke\
+ description:
+ "Wijze van bepalen van de brondatum.\n\nUitleg bij mogelijke\
\ waarden:\n\n* `afgehandeld` - (Afgehandeld) De termijn start op de datum\
\ waarop de zaak is afgehandeld (ZAAK.Einddatum in het RGBZ).\n* `ander_datumkenmerk`\
\ - (Ander datumkenmerk) De termijn start op de datum die is vastgelegd\
@@ -10579,61 +11336,96 @@ components:
\ van het zaakobjecttype het betreft."
datumkenmerk:
type: string
- description: Naam van de attribuutsoort van het procesobject dat bepalend
+ description:
+ Naam van de attribuutsoort van het procesobject dat bepalend
is voor het einde van de procestermijn.
title: datumkenmerk
maxLength: 80
einddatumBekend:
type: boolean
- description: Indicatie dat de einddatum van het procesobject gedurende de
+ description:
+ Indicatie dat de einddatum van het procesobject gedurende de
uitvoering van de zaak bekend moet worden. Indien deze nog niet bekend
is en deze waarde staat op `true`, dan kan de zaak (nog) niet afgesloten
worden.
title: einddatum bekend
objecttype:
- description: |-
- Het soort object in de registratie dat het procesobject representeert.
+ description:
+ 'Het soort object in de registratie dat het procesobject representeert.
+
Uitleg bij mogelijke waarden:
+
* `adres` - Adres
+
* `besluit` - Besluit
+
* `buurt` - Buurt
+
* `enkelvoudig_document` - Enkelvoudig document
+
* `gemeente` - Gemeente
+
* `gemeentelijke_openbare_ruimte` - Gemeentelijke openbare ruimte
+
* `huishouden` - Huishouden
+
* `inrichtingselement` - Inrichtingselement
+
* `kadastrale_onroerende_zaak` - Kadastrale onroerende zaak
+
* `kunstwerkdeel` - Kunstwerkdeel
+
* `maatschappelijke_activiteit` - Maatschappelijke activiteit
+
* `medewerker` - Medewerker
+
* `natuurlijk_persoon` - Natuurlijk persoon
+
* `niet_natuurlijk_persoon` - Niet-natuurlijk persoon
+
* `openbare_ruimte` - Openbare ruimte
+
* `organisatorische_eenheid` - Organisatorische eenheid
+
* `pand` - Pand
+
* `spoorbaandeel` - Spoorbaandeel
+
* `status` - Status
+
* `terreindeel` - Terreindeel
+
* `terrein_gebouwd_object` - Terrein gebouwd object
+
* `vestiging` - Vestiging
+
* `waterdeel` - Waterdeel
+
* `wegdeel` - Wegdeel
+
* `wijk` - Wijk
+
* `woonplaats` - Woonplaats
+
* `woz_deelobject` - Woz deel object
+
* `woz_object` - Woz object
+
* `woz_waarde` - Woz waarde
+
* `zakelijk_recht` - Zakelijk recht
- * `overige` - Overige
+
+ * `overige` - Overige'
title: objecttype
oneOf:
- - $ref: '#/components/schemas/ObjecttypeEnum'
- - $ref: '#/components/schemas/BlankEnum'
+ - $ref: '#/components/schemas/ObjecttypeEnum'
+ - $ref: '#/components/schemas/BlankEnum'
registratie:
type: string
- description: De naam van de registratie waarvan het procesobject deel uit
+ description:
+ De naam van de registratie waarvan het procesobject deel uit
maakt.
title: registratie
maxLength: 80
@@ -10641,13 +11433,14 @@ components:
type: string
nullable: true
title: Brondatum procestermijn
- description: De periode dat het zaakdossier na afronding van de zaak actief
+ description:
+ De periode dat het zaakdossier na afronding van de zaak actief
gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening
van de organisatie. Enkel relevant indien de afleidingswijze 'termijn'
is.
format: duration
required:
- - afleidingswijze
+ - afleidingswijze
nullable: true
Catalogus:
type: object
@@ -10657,39 +11450,45 @@ components:
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
domein:
type: string
- description: Een afkorting waarmee wordt aangegeven voor welk domein in
+ description:
+ Een afkorting waarmee wordt aangegeven voor welk domein in
een CATALOGUS ZAAKTYPEn zijn uitgewerkt.
title: domein
maxLength: 5
rsin:
type: string
- description: Het door een kamer toegekend uniek nummer voor de INGESCHREVEN
+ description:
+ Het door een kamer toegekend uniek nummer voor de INGESCHREVEN
NIET-NATUURLIJK PERSOON die de eigenaar is van een CATALOGUS.
title: rsin
maxLength: 9
contactpersoonBeheerNaam:
type: string
title: Naam contactpersoon
- description: De naam van de contactpersoon die verantwoordelijk is voor
+ description:
+ De naam van de contactpersoon die verantwoordelijk is voor
het beheer van de CATALOGUS.
maxLength: 40
contactpersoonBeheerTelefoonnummer:
type: string
title: Telefoonnummer
- description: Het telefoonnummer van de contactpersoon die verantwoordelijk
+ description:
+ Het telefoonnummer van de contactpersoon die verantwoordelijk
is voor het beheer van de CATALOGUS.
maxLength: 20
contactpersoonBeheerEmailadres:
type: string
format: email
title: Emailadres
- description: Het emailadres van de contactpersoon die verantwoordelijk is
+ description:
+ Het emailadres van de contactpersoon die verantwoordelijk is
voor het beheer van de CATALOGUS.
maxLength: 254
zaaktypen:
@@ -10699,7 +11498,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar ZAAKTYPEn die in deze CATALOGUS worden
+ description:
+ URL-referenties naar ZAAKTYPEn die in deze CATALOGUS worden
ontsloten.
title: Catalogus
uniqueItems: true
@@ -10710,7 +11510,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar BESLUITTYPEn die in deze CATALOGUS worden
+ description:
+ URL-referenties naar BESLUITTYPEn die in deze CATALOGUS worden
ontsloten.
title: catalogus
uniqueItems: true
@@ -10721,7 +11522,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar INFORMATIEOBJECTTYPEn die in deze CATALOGUS
+ description:
+ URL-referenties naar INFORMATIEOBJECTTYPEn die in deze CATALOGUS
worden ontsloten.
title: Catalogus
uniqueItems: true
@@ -10741,17 +11543,18 @@ components:
type: string
format: date
nullable: true
- description: Datum waarop de versie van de zaaktypecatalogus van toepassing
+ description:
+ Datum waarop de versie van de zaaktypecatalogus van toepassing
is geworden.
title: begindatum versie
required:
- - besluittypen
- - contactpersoonBeheerNaam
- - domein
- - informatieobjecttypen
- - rsin
- - url
- - zaaktypen
+ - besluittypen
+ - contactpersoonBeheerNaam
+ - domein
+ - informatieobjecttypen
+ - rsin
+ - url
+ - zaaktypen
CheckListItem:
type: object
properties:
@@ -10763,24 +11566,27 @@ components:
toelichting:
type: string
nullable: true
- description: Beschrijving van de overwegingen bij het controleren van het
+ description:
+ Beschrijving van de overwegingen bij het controleren van het
aandachtspunt
title: toelichting
maxLength: 1000
vraagstelling:
type: string
- description: Een betekenisvolle vraag waaruit blijkt waarop het aandachtspunt
+ description:
+ Een betekenisvolle vraag waaruit blijkt waarop het aandachtspunt
gecontroleerd moet worden.
title: vraagstelling
maxLength: 255
verplicht:
type: boolean
- description: Het al dan niet verplicht zijn van controle van het aandachtspunt
+ description:
+ Het al dan niet verplicht zijn van controle van het aandachtspunt
voorafgaand aan het bereiken van de status van het gerelateerde STATUSTYPE.
title: verplicht
required:
- - itemnaam
- - vraagstelling
+ - itemnaam
+ - vraagstelling
Eigenschap:
type: object
properties:
@@ -10789,7 +11595,8 @@ components:
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
@@ -10810,24 +11617,27 @@ components:
maxLength: 255
specificatie:
allOf:
- - $ref: '#/components/schemas/EigenschapSpecificatie'
+ - $ref: '#/components/schemas/EigenschapSpecificatie'
title: specificatie van eigenschap
toelichting:
type: string
- description: Een toelichting op deze EIGENSCHAP en het belang hiervan voor
+ description:
+ Een toelichting op deze EIGENSCHAP en het belang hiervan voor
zaken van dit ZAAKTYPE.
title: toelichting
maxLength: 1000
zaaktype:
type: string
format: uri
- description: URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze
+ description:
+ URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze
EIGENSCHAP van belang is.
title: Zaaktype
zaaktypeIdentificatie:
type: string
readOnly: true
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: Zaaktype
statustype:
@@ -10835,7 +11645,8 @@ components:
format: uri
nullable: true
title: Status type
- description: Status type moet (onder andere) deze EIGENSCHAP hebben, voordat
+ description:
+ Status type moet (onder andere) deze EIGENSCHAP hebben, voordat
een STATUS van het STATUSTYPE kan worden gezet.
beginGeldigheid:
type: string
@@ -10862,44 +11673,53 @@ components:
description: De datum van de aller laatste versie van het object.
title: datum einde object
required:
- - catalogus
- - definitie
- - naam
- - specificatie
- - url
- - zaaktype
- - zaaktypeIdentificatie
+ - catalogus
+ - definitie
+ - naam
+ - specificatie
+ - url
+ - zaaktype
+ - zaaktypeIdentificatie
EigenschapSpecificatie:
type: object
properties:
groep:
type: string
- description: Benaming van het object of groepattribuut waarvan de EIGENSCHAP
+ description:
+ Benaming van het object of groepattribuut waarvan de EIGENSCHAP
een inhoudelijk gegeven specificeert.
title: groep
maxLength: 32
formaat:
allOf:
- - $ref: '#/components/schemas/FormaatEnum'
- description: |-
- Het soort tekens waarmee waarden van de EIGENSCHAP kunnen worden vastgelegd.
+ - $ref: '#/components/schemas/FormaatEnum'
+ description:
+ 'Het soort tekens waarmee waarden van de EIGENSCHAP kunnen
+ worden vastgelegd.
+
Uitleg bij mogelijke waarden:
+
* `tekst` - Tekst
+
* `getal` - Getal
+
* `datum` - Datum
- * `datum_tijd` - Datum/tijd
+
+ * `datum_tijd` - Datum/tijd'
title: formaat
lengte:
type: string
- description: Het aantal karakters (lengte) waarmee waarden van de EIGENSCHAP
+ description:
+ Het aantal karakters (lengte) waarmee waarden van de EIGENSCHAP
worden vastgelegd.
title: lengte
maxLength: 14
kardinaliteit:
type: string
- description: Het aantal mogelijke voorkomens van waarden van deze EIGENSCHAP
+ description:
+ Het aantal mogelijke voorkomens van waarden van deze EIGENSCHAP
bij een zaak van het ZAAKTYPE.
title: kardinaliteit
maxLength: 3
@@ -10911,9 +11731,9 @@ components:
description: Waarden die deze EIGENSCHAP kan hebben.
title: waardenverzameling
required:
- - formaat
- - kardinaliteit
- - lengte
+ - formaat
+ - kardinaliteit
+ - lengte
FieldValidationError:
type: object
description: Formaat van validatiefouten.
@@ -10931,15 +11751,15 @@ components:
description: Uitleg wat er precies fout is met de gegevens
title: reason
required:
- - code
- - name
- - reason
+ - code
+ - name
+ - reason
FormaatEnum:
enum:
- - tekst
- - getal
- - datum
- - datum_tijd
+ - tekst
+ - getal
+ - datum
+ - datum_tijd
type: string
Fout:
type: object
@@ -10967,19 +11787,20 @@ components:
title: detail
instance:
type: string
- description: URI met referentie naar dit specifiek voorkomen van de fout.
+ description:
+ URI met referentie naar dit specifiek voorkomen van de fout.
Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld.
title: instance
required:
- - code
- - detail
- - instance
- - status
- - title
+ - code
+ - detail
+ - instance
+ - status
+ - title
IndicatieInternOfExternEnum:
enum:
- - intern
- - extern
+ - intern
+ - extern
type: string
InformatieObjectType:
type: object
@@ -10990,14 +11811,16 @@ components:
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
catalogus:
type: string
format: uri
- description: URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE
+ description:
+ URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE
behoort.
title: Catalogus
omschrijving:
@@ -11007,20 +11830,30 @@ components:
maxLength: 80
vertrouwelijkheidaanduiding:
allOf:
- - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum'
- description: |-
- Aanduiding van de mate waarin informatieobjecten van dit INFORMATIEOBJECTTYPE voor de openbaarheid bestemd zijn.
+ - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum'
+ description:
+ 'Aanduiding van de mate waarin informatieobjecten van dit INFORMATIEOBJECTTYPE
+ voor de openbaarheid bestemd zijn.
+
Uitleg bij mogelijke waarden:
+
* `openbaar` - Openbaar
+
* `beperkt_openbaar` - Beperkt openbaar
+
* `intern` - Intern
+
* `zaakvertrouwelijk` - Zaakvertrouwelijk
+
* `vertrouwelijk` - Vertrouwelijk
+
* `confidentieel` - Confidentieel
+
* `geheim` - Geheim
- * `zeer_geheim` - Zeer geheim
+
+ * `zeer_geheim` - Zeer geheim'
title: vertrouwelijkheidaanduiding
beginGeldigheid:
type: string
@@ -11048,7 +11881,8 @@ components:
concept:
type: boolean
readOnly: true
- description: Geeft aan of het object een concept betreft. Concepten zijn
+ description:
+ Geeft aan of het object een concept betreft. Concepten zijn
niet-definitieve versies en zouden niet gebruikt moeten worden buiten
deze API.
title: concept
@@ -11059,7 +11893,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar De INFORMATIEOBJECTTYPEn die relevant
+ description:
+ URL-referenties naar De INFORMATIEOBJECTTYPEn die relevant
kunnen zijn voor ZAAKen van dit ZAAKTYPE.
title: zaaktypen
uniqueItems: true
@@ -11070,7 +11905,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten
+ description:
+ URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten
waarin besluiten van dit BESLUITTYPE worden vastgelegd.
title: informatieobjecttypen
uniqueItems: true
@@ -11084,24 +11920,25 @@ components:
items:
type: string
maxLength: 30
- description: Trefwoord(en) waarmee informatieobjecten van het INFORMATIEOBJECTTYPE
+ description:
+ Trefwoord(en) waarmee informatieobjecten van het INFORMATIEOBJECTTYPE
kunnen worden gekarakteriseerd. (Gebruik een komma om waarden van elkaar
te onderscheiden.)
title: trefwoord
omschrijvingGeneriek:
allOf:
- - $ref: '#/components/schemas/InformatieObjectTypeOmschrijvingGeneriek'
+ - $ref: '#/components/schemas/InformatieObjectTypeOmschrijvingGeneriek'
title: omschrijving generiek
required:
- - beginGeldigheid
- - besluittypen
- - catalogus
- - concept
- - informatieobjectcategorie
- - omschrijving
- - url
- - vertrouwelijkheidaanduiding
- - zaaktypen
+ - beginGeldigheid
+ - besluittypen
+ - catalogus
+ - concept
+ - informatieobjectcategorie
+ - omschrijving
+ - url
+ - vertrouwelijkheidaanduiding
+ - zaaktypen
InformatieObjectTypeOmschrijvingGeneriek:
type: object
properties:
@@ -11118,7 +11955,8 @@ components:
herkomstInformatieobjecttypeOmschrijvingGeneriek:
type: string
title: Herkomst
- description: De naam van de waardenverzameling, of van de beherende organisatie
+ description:
+ De naam van de waardenverzameling, of van de beherende organisatie
daarvan, waaruit de waarde is overgenomen.
maxLength: 12
hierarchieInformatieobjecttypeOmschrijvingGeneriek:
@@ -11133,54 +11971,54 @@ components:
description: Zinvolle toelichting bij het informatieobjecttype
maxLength: 255
required:
- - definitieInformatieobjecttypeOmschrijvingGeneriek
- - herkomstInformatieobjecttypeOmschrijvingGeneriek
- - hierarchieInformatieobjecttypeOmschrijvingGeneriek
- - informatieobjecttypeOmschrijvingGeneriek
+ - definitieInformatieobjecttypeOmschrijvingGeneriek
+ - herkomstInformatieobjecttypeOmschrijvingGeneriek
+ - hierarchieInformatieobjecttypeOmschrijvingGeneriek
+ - informatieobjecttypeOmschrijvingGeneriek
ObjecttypeEnum:
enum:
- - adres
- - besluit
- - buurt
- - enkelvoudig_document
- - gemeente
- - gemeentelijke_openbare_ruimte
- - huishouden
- - inrichtingselement
- - kadastrale_onroerende_zaak
- - kunstwerkdeel
- - maatschappelijke_activiteit
- - medewerker
- - natuurlijk_persoon
- - niet_natuurlijk_persoon
- - openbare_ruimte
- - organisatorische_eenheid
- - pand
- - spoorbaandeel
- - status
- - terreindeel
- - terrein_gebouwd_object
- - vestiging
- - waterdeel
- - wegdeel
- - wijk
- - woonplaats
- - woz_deelobject
- - woz_object
- - woz_waarde
- - zakelijk_recht
- - overige
+ - adres
+ - besluit
+ - buurt
+ - enkelvoudig_document
+ - gemeente
+ - gemeentelijke_openbare_ruimte
+ - huishouden
+ - inrichtingselement
+ - kadastrale_onroerende_zaak
+ - kunstwerkdeel
+ - maatschappelijke_activiteit
+ - medewerker
+ - natuurlijk_persoon
+ - niet_natuurlijk_persoon
+ - openbare_ruimte
+ - organisatorische_eenheid
+ - pand
+ - spoorbaandeel
+ - status
+ - terreindeel
+ - terrein_gebouwd_object
+ - vestiging
+ - waterdeel
+ - wegdeel
+ - wijk
+ - woonplaats
+ - woz_deelobject
+ - woz_object
+ - woz_waarde
+ - zakelijk_recht
+ - overige
type: string
OmschrijvingGeneriekEnum:
enum:
- - adviseur
- - behandelaar
- - belanghebbende
- - beslisser
- - initiator
- - klantcontacter
- - zaakcoordinator
- - mede_initiator
+ - adviseur
+ - behandelaar
+ - belanghebbende
+ - beslisser
+ - initiator
+ - klantcontacter
+ - zaakcoordinator
+ - mede_initiator
type: string
PaginatedBesluitTypeList:
type: object
@@ -11390,7 +12228,8 @@ components:
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
@@ -11416,7 +12255,8 @@ components:
maxLength: 80
omschrijvingGeneriek:
type: string
- description: Algemeen gehanteerde omschrijving van de aard van BESLUITen
+ description:
+ Algemeen gehanteerde omschrijving van de aard van BESLUITen
van het BESLUITTYPE
title: omschrijving generiek
maxLength: 80
@@ -11428,25 +12268,29 @@ components:
reactietermijn:
type: string
nullable: true
- description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend-
+ description:
+ Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend-
of publicatiedatum, waarbinnen verweer tegen een besluit van het besluittype
mogelijk is.
title: reactietermijn
format: duration
publicatieIndicatie:
type: boolean
- description: Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten
+ description:
+ Aanduiding of BESLUITen van dit BESLUITTYPE gepubliceerd moeten
worden.
title: publicatie indicatie
publicatietekst:
type: string
- description: De generieke tekst van de publicatie van BESLUITen van dit
+ description:
+ De generieke tekst van de publicatie van BESLUITen van dit
BESLUITTYPE
title: publicatietekst
publicatietermijn:
type: string
nullable: true
- description: Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend-
+ description:
+ Een tijdsduur in ISO 8601 formaat, gerekend vanaf de verzend-
of publicatiedatum, dat BESLUITen van dit BESLUITTYPE gepubliceerd moeten
blijven.
title: publicatietermijn
@@ -11461,7 +12305,8 @@ components:
type: string
format: uri
title: ''
- description: URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten
+ description:
+ URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten
waarin besluiten van dit BESLUITTYPE worden vastgelegd.
title: informatieobjecttypen
uniqueItems: true
@@ -11491,7 +12336,8 @@ components:
concept:
type: boolean
readOnly: true
- description: Geeft aan of het object een concept betreft. Concepten zijn
+ description:
+ Geeft aan of het object een concept betreft. Concepten zijn
niet-definitieve versies en zouden niet gebruikt moeten worden buiten
deze API.
title: concept
@@ -11503,7 +12349,8 @@ components:
title: Is resultaat van
readOnly: true
title: Is resultaat van
- description: Het BESLUITTYPE van besluiten die gepaard gaan met resultaten
+ description:
+ Het BESLUITTYPE van besluiten die gepaard gaan met resultaten
van het RESULTAATTYPE.
uniqueItems: true
resultaattypenOmschrijving:
@@ -11532,7 +12379,8 @@ components:
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
@@ -11553,24 +12401,27 @@ components:
maxLength: 255
specificatie:
allOf:
- - $ref: '#/components/schemas/EigenschapSpecificatie'
+ - $ref: '#/components/schemas/EigenschapSpecificatie'
title: specificatie van eigenschap
toelichting:
type: string
- description: Een toelichting op deze EIGENSCHAP en het belang hiervan voor
+ description:
+ Een toelichting op deze EIGENSCHAP en het belang hiervan voor
zaken van dit ZAAKTYPE.
title: toelichting
maxLength: 1000
zaaktype:
type: string
format: uri
- description: URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze
+ description:
+ URL-referentie naar het ZAAKTYPE van de ZAAKen waarvoor deze
EIGENSCHAP van belang is.
title: Zaaktype
zaaktypeIdentificatie:
type: string
readOnly: true
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: Zaaktype
statustype:
@@ -11578,7 +12429,8 @@ components:
format: uri
nullable: true
title: Status type
- description: Status type moet (onder andere) deze EIGENSCHAP hebben, voordat
+ description:
+ Status type moet (onder andere) deze EIGENSCHAP hebben, voordat
een STATUS van het STATUSTYPE kan worden gezet.
beginGeldigheid:
type: string
@@ -11613,14 +12465,16 @@ components:
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
catalogus:
type: string
format: uri
- description: URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE
+ description:
+ URL-referentie naar de CATALOGUS waartoe dit INFORMATIEOBJECTTYPE
behoort.
title: Catalogus
omschrijving:
@@ -11630,20 +12484,30 @@ components:
maxLength: 80
vertrouwelijkheidaanduiding:
allOf:
- - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum'
- description: |-
- Aanduiding van de mate waarin informatieobjecten van dit INFORMATIEOBJECTTYPE voor de openbaarheid bestemd zijn.
+ - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum'
+ description:
+ 'Aanduiding van de mate waarin informatieobjecten van dit INFORMATIEOBJECTTYPE
+ voor de openbaarheid bestemd zijn.
+
Uitleg bij mogelijke waarden:
+
* `openbaar` - Openbaar
+
* `beperkt_openbaar` - Beperkt openbaar
+
* `intern` - Intern
+
* `zaakvertrouwelijk` - Zaakvertrouwelijk
+
* `vertrouwelijk` - Vertrouwelijk
+
* `confidentieel` - Confidentieel
+
* `geheim` - Geheim
- * `zeer_geheim` - Zeer geheim
+
+ * `zeer_geheim` - Zeer geheim'
title: vertrouwelijkheidaanduiding
beginGeldigheid:
type: string
@@ -11671,7 +12535,8 @@ components:
concept:
type: boolean
readOnly: true
- description: Geeft aan of het object een concept betreft. Concepten zijn
+ description:
+ Geeft aan of het object een concept betreft. Concepten zijn
niet-definitieve versies en zouden niet gebruikt moeten worden buiten
deze API.
title: concept
@@ -11682,7 +12547,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar De INFORMATIEOBJECTTYPEn die relevant
+ description:
+ URL-referenties naar De INFORMATIEOBJECTTYPEn die relevant
kunnen zijn voor ZAAKen van dit ZAAKTYPE.
title: zaaktypen
uniqueItems: true
@@ -11693,7 +12559,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten
+ description:
+ URL-referenties naar het INFORMATIEOBJECTTYPE van informatieobjecten
waarin besluiten van dit BESLUITTYPE worden vastgelegd.
title: informatieobjecttypen
uniqueItems: true
@@ -11707,27 +12574,29 @@ components:
items:
type: string
maxLength: 30
- description: Trefwoord(en) waarmee informatieobjecten van het INFORMATIEOBJECTTYPE
+ description:
+ Trefwoord(en) waarmee informatieobjecten van het INFORMATIEOBJECTTYPE
kunnen worden gekarakteriseerd. (Gebruik een komma om waarden van elkaar
te onderscheiden.)
title: trefwoord
omschrijvingGeneriek:
allOf:
- - $ref: '#/components/schemas/InformatieObjectTypeOmschrijvingGeneriek'
+ - $ref: '#/components/schemas/InformatieObjectTypeOmschrijvingGeneriek'
title: omschrijving generiek
PatchedResultaatType:
type: object
- description: |-
- Set gegevensgroepdata from validated nested data.
+ description: 'Set gegevensgroepdata from validated nested data.
- Usage: include the mixin on the ModelSerializer that has gegevensgroepen.
+
+ Usage: include the mixin on the ModelSerializer that has gegevensgroepen.'
properties:
url:
type: string
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
@@ -11735,12 +12604,14 @@ components:
type: string
format: uri
title: is van
- description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten
+ description:
+ URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten
van dit RESULTAATTYPE bereikt kunnen worden.
zaaktypeIdentificatie:
type: string
readOnly: true
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: is relevant voor
omschrijving:
@@ -11751,7 +12622,8 @@ components:
resultaattypeomschrijving:
type: string
format: uri
- description: Algemeen gehanteerde omschrijving van de aard van resultaten
+ description:
+ Algemeen gehanteerde omschrijving van de aard van resultaten
van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst
van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving
generiek'
@@ -11765,32 +12637,43 @@ components:
selectielijstklasse:
type: string
format: uri
- description: URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE
+ description:
+ URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE
relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT
in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie.
title: selectielijstklasse
maxLength: 1000
toelichting:
type: string
- description: Een toelichting op dit RESULTAATTYPE en het belang hiervan
+ description:
+ Een toelichting op dit RESULTAATTYPE en het belang hiervan
voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd.
title: toelichting
archiefnominatie:
- description: |-
- Aanduiding die aangeeft of ZAAKen met een resultaat van dit RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de selectielijst.
+ description:
+ 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit
+ RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden
+ vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de
+ selectielijst.
+
Uitleg bij mogelijke waarden:
- * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum overgedragen worden naar een archiefbewaarplaats.
- * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd worden.
+
+ * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum
+ overgedragen worden naar een archiefbewaarplaats.
+
+ * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd
+ worden.'
title: archiefnominatie
oneOf:
- - $ref: '#/components/schemas/ArchiefnominatieEnum'
- - $ref: '#/components/schemas/BlankEnum'
+ - $ref: '#/components/schemas/ArchiefnominatieEnum'
+ - $ref: '#/components/schemas/BlankEnum'
archiefactietermijn:
type: string
nullable: true
- description: De termijn, na het vervallen van het bedrjfsvoeringsbelang,
+ description:
+ De termijn, na het vervallen van het bedrjfsvoeringsbelang,
waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen)
van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht
(naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers
@@ -11801,15 +12684,17 @@ components:
format: duration
brondatumArchiefprocedure:
allOf:
- - $ref: '#/components/schemas/BrondatumArchiefprocedure'
+ - $ref: '#/components/schemas/BrondatumArchiefprocedure'
nullable: true
- description: Specificatie voor het bepalen van de brondatum voor de start
+ description:
+ Specificatie voor het bepalen van de brondatum voor de start
van de Archiefactietermijn (=brondatum) van het zaakdossier.
title: brondatumArchiefprocedure
procesobjectaard:
type: string
nullable: true
- description: Omschrijving van het object, subject of gebeurtenis waarop,
+ description:
+ Omschrijving van het object, subject of gebeurtenis waarop,
vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking
heeft.
title: procesobjectaard
@@ -11818,7 +12703,8 @@ components:
type: string
format: uri
nullable: true
- description: URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE
+ description:
+ URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE
behoort.
title: catalogus
beginGeldigheid:
@@ -11848,13 +12734,15 @@ components:
indicatieSpecifiek:
type: boolean
nullable: true
- description: Aanduiding of het, vanuit archiveringsoptiek, een resultaattype
+ description:
+ Aanduiding of het, vanuit archiveringsoptiek, een resultaattype
betreft dat specifiek is voor een bepaalde procesobjectaard.
title: indicatie specifiek
procestermijn:
type: string
nullable: true
- description: De periode dat het zaakdossier na afronding van de zaak actief
+ description:
+ De periode dat het zaakdossier na afronding van de zaak actief
gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening
van de organisatie.
title: procestermijn
@@ -11884,7 +12772,8 @@ components:
format: uri
nullable: true
title: ''
- description: De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn
+ description:
+ De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn
in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van
dit RESULTAATTYPE kan worden gezet.
title: informatieobjecttypen
@@ -11907,20 +12796,23 @@ components:
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
zaaktype:
type: string
format: uri
- description: URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken
+ description:
+ URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken
kunnen zijn.
title: Zaaktype
zaaktypeIdentificatie:
type: string
readOnly: true
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: Zaaktype
omschrijving:
@@ -11930,20 +12822,21 @@ components:
maxLength: 100
omschrijvingGeneriek:
allOf:
- - $ref: '#/components/schemas/OmschrijvingGeneriekEnum'
- description: |-
- Algemeen gehanteerde omschrijving van de aard van de ROL.
-
- Uitleg bij mogelijke waarden:
-
- * `adviseur` - (Adviseur) Kennis in dienst stellen van de behandeling van (een deel van) een zaak.
- * `behandelaar` - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van) een zaak.
- * `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst van een zaak.
- * `beslisser` - (Beslisser) Nemen van besluiten die voor de uitkomst van een zaak noodzakelijk zijn.
- * `initiator` - (Initiator) Aanleiding geven tot de start van een zaak ..
- * `klantcontacter` - (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers en bedrijven ..
- * `zaakcoordinator` - (Zaakcoördinator) Er voor zorg dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt conform de daarover gemaakte afspraken.
- * `mede_initiator` - Mede-initiator
+ - $ref: '#/components/schemas/OmschrijvingGeneriekEnum'
+ description:
+ "Algemeen gehanteerde omschrijving van de aard van de ROL.\n\
+ \nUitleg bij mogelijke waarden:\n\n* `adviseur` - (Adviseur) Kennis in\
+ \ dienst stellen van de behandeling van (een deel van) een zaak.\n* `behandelaar`\
+ \ - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van)\
+ \ een zaak.\n* `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief\
+ \ belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst\
+ \ van een zaak.\n* `beslisser` - (Beslisser) Nemen van besluiten die voor\
+ \ de uitkomst van een zaak noodzakelijk zijn.\n* `initiator` - (Initiator)\
+ \ Aanleiding geven tot de start van een zaak ..\n* `klantcontacter` -\
+ \ (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers\
+ \ en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6rdinator) Er voor\
+ \ zorg dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt\
+ \ conform de daarover gemaakte afspraken.\n* `mede_initiator` - Mede-initiator"
title: omschrijving generiek
catalogus:
type: string
@@ -11983,25 +12876,29 @@ components:
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
omschrijving:
type: string
- description: Een korte, voor de initiator van de zaak relevante, omschrijving
+ description:
+ Een korte, voor de initiator van de zaak relevante, omschrijving
van de aard van de STATUS van zaken van een ZAAKTYPE.
title: omschrijving
maxLength: 80
omschrijvingGeneriek:
type: string
- description: Algemeen gehanteerde omschrijving van de aard van STATUSsen
+ description:
+ Algemeen gehanteerde omschrijving van de aard van STATUSsen
van het STATUSTYPE
title: omschrijving generiek
maxLength: 80
statustekst:
type: string
- description: De tekst die wordt gebruikt om de Initiator te informeren over
+ description:
+ De tekst die wordt gebruikt om de Initiator te informeren over
het bereiken van een STATUS van dit STATUSTYPE bij het desbetreffende
ZAAKTYPE.
title: statustekst
@@ -12009,7 +12906,8 @@ components:
zaaktype:
type: string
format: uri
- description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen
+ description:
+ URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen
van dit STATUSTYPE bereikt kunnen worden.
title: Zaaktype
catalogus:
@@ -12020,31 +12918,36 @@ components:
zaaktypeIdentificatie:
type: string
readOnly: true
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: Zaaktype
volgnummer:
type: integer
maximum: 9999
minimum: 1
- description: Een volgnummer voor statussen van het STATUSTYPE binnen een
+ description:
+ Een volgnummer voor statussen van het STATUSTYPE binnen een
zaak.
title: statustypevolgnummer
isEindstatus:
type: boolean
readOnly: true
- description: Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven
+ description:
+ Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven
is afgeleid uit alle STATUSTYPEn van dit ZAAKTYPE met het hoogste volgnummer.
title: isEindstatus
informeren:
type: boolean
- description: Aanduiding die aangeeft of na het zetten van een STATUS van
- dit STATUSTYPE de Initiator moet worden geïnformeerd over de statusovergang.
+ description:
+ "Aanduiding die aangeeft of na het zetten van een STATUS van\
+ \ dit STATUSTYPE de Initiator moet worden ge\xEFnformeerd over de statusovergang."
title: informeren
doorlooptijd:
type: string
nullable: true
- description: De door de zaakbehandelende organisatie(s) gestelde norm voor
+ description:
+ De door de zaakbehandelende organisatie(s) gestelde norm voor
de doorlooptijd voor het bereiken van STATUSsen van dit STATUSTYPE bij
het desbetreffende ZAAKTYPE.
title: doorlooptijd status
@@ -12067,7 +12970,8 @@ components:
format: uri
nullable: true
title: ''
- description: de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen,
+ description:
+ de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen,
voordat een STATUS van dit STATUSTYPE kan worden gezet.
title: eigenschappen
uniqueItems: true
@@ -12103,13 +13007,15 @@ components:
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
anderObjecttype:
type: boolean
- description: Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een
+ description:
+ Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een
ander, niet in RSGB en RGBZ voorkomend, objecttype betreft.
title: Ander objecttype
beginGeldigheid:
@@ -12138,26 +13044,30 @@ components:
objecttype:
type: string
format: uri
- description: URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE
+ description:
+ URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE
behoort.
title: Objecttype
maxLength: 200
relatieOmschrijving:
type: string
- description: Omschrijving van de betrekking van het Objecttype op zaken
+ description:
+ Omschrijving van de betrekking van het Objecttype op zaken
van het gerelateerde ZAAKTYPE.
title: Relatie omschrijving
maxLength: 80
zaaktype:
type: string
format: uri
- description: URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE
+ description:
+ URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE
behoort.
title: Zaaktype
zaaktypeIdentificatie:
type: string
readOnly: true
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: Zaaktype
resultaattypen:
@@ -12183,28 +13093,31 @@ components:
catalogus:
type: string
format: uri
- description: URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE
+ description:
+ URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE
behoort.
title: Catalogus
PatchedZaakType:
type: object
- description: |-
- Set gegevensgroepdata from validated nested data.
+ description: 'Set gegevensgroepdata from validated nested data.
+
- Usage: include the mixin on the ModelSerializer that has gegevensgroepen.
+ Usage: include the mixin on the ModelSerializer that has gegevensgroepen.'
properties:
url:
type: string
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
identificatie:
type: string
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: identificatie
maxLength: 50
@@ -12215,86 +13128,105 @@ components:
maxLength: 80
omschrijvingGeneriek:
type: string
- description: Algemeen gehanteerde omschrijving van de aard van ZAAKen van
+ description:
+ Algemeen gehanteerde omschrijving van de aard van ZAAKen van
het ZAAKTYPE
title: omschrijving generiek
maxLength: 80
vertrouwelijkheidaanduiding:
allOf:
- - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum'
- description: |-
- Aanduiding van de mate waarin zaakdossiers van ZAAKen van dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde gezet.
+ - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum'
+ description:
+ 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van
+ dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het
+ aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde
+ gezet.
+
Uitleg bij mogelijke waarden:
+
* `openbaar` - Openbaar
+
* `beperkt_openbaar` - Beperkt openbaar
+
* `intern` - Intern
+
* `zaakvertrouwelijk` - Zaakvertrouwelijk
+
* `vertrouwelijk` - Vertrouwelijk
+
* `confidentieel` - Confidentieel
+
* `geheim` - Geheim
- * `zeer_geheim` - Zeer geheim
+
+ * `zeer_geheim` - Zeer geheim'
title: vertrouwelijkheidaanduiding
doel:
type: string
- description: Een omschrijving van hetgeen beoogd is te bereiken met een
+ description:
+ Een omschrijving van hetgeen beoogd is te bereiken met een
zaak van dit zaaktype.
title: doel
aanleiding:
type: string
- description: Een omschrijving van de gebeurtenis die leidt tot het starten
+ description:
+ Een omschrijving van de gebeurtenis die leidt tot het starten
van een ZAAK van dit ZAAKTYPE.
title: aanleiding
toelichting:
type: string
- description: Een eventuele toelichting op dit zaaktype, zoals een beschrijving
+ description:
+ Een eventuele toelichting op dit zaaktype, zoals een beschrijving
van het procesverloop op de hoofdlijnen.
title: toelichting
indicatieInternOfExtern:
allOf:
- - $ref: '#/components/schemas/IndicatieInternOfExternEnum'
- description: |-
- Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn die Intern respectievelijk Extern geïnitieerd worden. Indien van beide sprake kan zijn, dan prevaleert de externe initiatie.
-
- Uitleg bij mogelijke waarden:
-
- * `inkomend` - Inkomend
- * `intern` - Intern
- * `uitgaand` - Uitgaand
+ - $ref: '#/components/schemas/IndicatieInternOfExternEnum'
+ description:
+ "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\
+ \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\
+ \ beide sprake kan zijn, dan prevaleert de externe initiatie.\n\nUitleg\
+ \ bij mogelijke waarden:\n\n* `inkomend` - Inkomend\n* `intern` - Intern\n\
+ * `uitgaand` - Uitgaand"
title: indicatie intern of extern
handelingInitiator:
type: string
- description: Werkwoord dat hoort bij de handeling die de initiator verricht
+ description:
+ Werkwoord dat hoort bij de handeling die de initiator verricht
bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook
het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator
title: handeling initiator
maxLength: 20
onderwerp:
type: string
- description: 'Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen
+ description:
+ "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen
nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus
- (PDC). Bijvoorbeeld: ''Evenementenvergunning'', ''Geboorte'', ''Klacht''.
- Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp'
+ (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'.
+ Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp"
title: onderwerp
maxLength: 80
handelingBehandelaar:
type: string
- description: Werkwoord dat hoort bij de handeling die de behandelaar verricht
+ description:
+ Werkwoord dat hoort bij de handeling die de behandelaar verricht
bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren',
'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar
title: handeling behandelaar
maxLength: 20
doorlooptijd:
type: string
- description: De periode waarbinnen volgens wet- en regelgeving een ZAAK
+ description:
+ De periode waarbinnen volgens wet- en regelgeving een ZAAK
van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen.
title: doorlooptijd behandeling
format: duration
servicenorm:
type: string
nullable: true
- description: De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE
+ description:
+ De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE
afgerond wordt conform de geldende servicenormen van de zaakbehandelende
organisatie(s).
title: servicenorm behandeling
@@ -12302,17 +13234,20 @@ components:
opschortingEnAanhoudingMogelijk:
type: boolean
title: Opschorting/aanhouding mogelijk
- description: Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE
+ description:
+ Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE
kunnen worden opgeschort en/of aangehouden.
verlengingMogelijk:
type: boolean
- description: Aanduiding die aangeeft of de Doorlooptijd behandeling van
+ description:
+ Aanduiding die aangeeft of de Doorlooptijd behandeling van
ZAAKen van dit ZAAKTYPE kan worden verlengd.
title: verlenging mogelijk
verlengingstermijn:
type: string
nullable: true
- description: Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling
+ description:
+ Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling
van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde
bevatten als verlenging mogelijk is.
title: verlengingstermijn
@@ -12323,12 +13258,14 @@ components:
type: string
title: Trefwoord
maxLength: 30
- description: Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden
+ description:
+ Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden
gekarakteriseerd.
title: trefwoorden
publicatieIndicatie:
type: boolean
- description: Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd
+ description:
+ Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd
moet worden.
title: publicatie indicatie
publicatietekst:
@@ -12340,8 +13277,9 @@ components:
items:
type: string
maxLength: 40
- description: De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige
- en/of financiële verantwoording.
+ description:
+ "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\
+ \ en/of financi\xEBle verantwoording."
title: verantwoordingsrelatie
productenOfDiensten:
type: array
@@ -12350,25 +13288,28 @@ components:
format: uri
title: URL naar product/dienst
maxLength: 1000
- description: Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt
+ description:
+ Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt
voortgebracht.
title: producten of diensten
selectielijstProcestype:
type: string
format: uri
- description: URL-referentie naar een vanuit archiveringsoptiek onderkende
+ description:
+ URL-referentie naar een vanuit archiveringsoptiek onderkende
groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst
API).
title: selectielijst procestype
maxLength: 200
referentieproces:
allOf:
- - $ref: '#/components/schemas/ReferentieProces'
+ - $ref: '#/components/schemas/ReferentieProces'
description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE.
title: referentieproces
verantwoordelijke:
type: string
- description: De (soort) organisatorische eenheid of (functie van) medewerker
+ description:
+ De (soort) organisatorische eenheid of (functie van) medewerker
die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE.
title: verantwoordelijke
maxLength: 50
@@ -12383,12 +13324,12 @@ components:
uniqueItems: true
broncatalogus:
allOf:
- - $ref: '#/components/schemas/BronCatalogus'
+ - $ref: '#/components/schemas/BronCatalogus'
description: De CATALOGUS waaraan het ZAAKTYPE is ontleend.
title: broncatalogus
bronzaaktype:
allOf:
- - $ref: '#/components/schemas/BronZaaktype'
+ - $ref: '#/components/schemas/BronZaaktype'
description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend.
title: bronzaaktype
catalogus:
@@ -12403,7 +13344,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen
+ description:
+ URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen
dit ZAAKTYPE.
title: Zaaktype
uniqueItems: true
@@ -12414,7 +13356,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen
+ description:
+ URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen
dit ZAAKTYPE.
title: is relevant voor
uniqueItems: true
@@ -12425,7 +13368,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn
+ description:
+ URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn
in ZAKEN van dit ZAAKTYPE.
title: Zaaktype
uniqueItems: true
@@ -12436,7 +13380,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de INFORMATIEOBJECTTYPEN die mogelijk
+ description:
+ URL-referenties naar de INFORMATIEOBJECTTYPEN die mogelijk
zijn binnen dit ZAAKTYPE.
title: zaaktypen
uniqueItems: true
@@ -12447,7 +13392,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit
+ description:
+ URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit
ZAAKTYPE.
title: Zaaktype
uniqueItems: true
@@ -12458,7 +13404,8 @@ components:
format: uri
title: heeft relevante besluittypen
title: heeft relevante besluittypen
- description: URL-referenties naar de BESLUITTYPEN die mogelijk zijn binnen
+ description:
+ URL-referenties naar de BESLUITTYPEN die mogelijk zijn binnen
dit ZAAKTYPE.
uniqueItems: true
deelzaaktypen:
@@ -12468,7 +13415,8 @@ components:
format: uri
nullable: true
title: ''
- description: De ZAAKTYPE(n) waaronder ZAAKen als deelzaak kunnen voorkomen
+ description:
+ De ZAAKTYPE(n) waaronder ZAAKen als deelzaak kunnen voorkomen
bij ZAAKen van dit ZAAKTYPE.
title: deelzaaktypen
uniqueItems: true
@@ -12476,7 +13424,8 @@ components:
type: array
items:
$ref: '#/components/schemas/ZaakTypenRelatie'
- description: De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit
+ description:
+ De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit
ZAAKTYPE.
title: zaaktype van
beginGeldigheid:
@@ -12505,29 +13454,32 @@ components:
versiedatum:
type: string
format: date
- description: De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE
+ description:
+ De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE
geldig zijn geworden
title: versiedatum
concept:
type: boolean
readOnly: true
- description: Geeft aan of het object een concept betreft. Concepten zijn
+ description:
+ Geeft aan of het object een concept betreft. Concepten zijn
niet-definitieve versies en zouden niet gebruikt moeten worden buiten
deze API.
title: concept
PatchedZaakTypeInformatieObjectType:
type: object
- description: |-
- Represent a ZaakTypeInformatieObjectType.
+ description: 'Represent a ZaakTypeInformatieObjectType.
- Relatie met informatieobjecttype dat relevant is voor zaaktype.
+
+ Relatie met informatieobjecttype dat relevant is voor zaaktype.'
properties:
url:
type: string
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
@@ -12539,7 +13491,8 @@ components:
zaaktypeIdentificatie:
type: string
readOnly: true
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: zaaktype
catalogus:
@@ -12561,27 +13514,34 @@ components:
type: integer
maximum: 999
minimum: 1
- description: Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het
+ description:
+ Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het
ZAAKTYPE.
title: volgnummer
richting:
allOf:
- - $ref: '#/components/schemas/RichtingEnum'
- description: |-
- Aanduiding van de richting van informatieobjecten van het gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE.
+ - $ref: '#/components/schemas/RichtingEnum'
+ description:
+ 'Aanduiding van de richting van informatieobjecten van het
+ gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE.
+
Uitleg bij mogelijke waarden:
+
* `inkomend` - Inkomend
+
* `intern` - Intern
- * `uitgaand` - Uitgaand
+
+ * `uitgaand` - Uitgaand'
title: richting
statustype:
type: string
format: uri
nullable: true
title: Status type
- description: URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn
+ description:
+ URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn
verplicht aanwezig moeten zijn.
ReferentieProces:
type: object
@@ -12599,20 +13559,21 @@ components:
description: De URL naar de beschrijving van het Referentieproces
maxLength: 200
required:
- - naam
+ - naam
ResultaatType:
type: object
- description: |-
- Set gegevensgroepdata from validated nested data.
+ description: 'Set gegevensgroepdata from validated nested data.
+
- Usage: include the mixin on the ModelSerializer that has gegevensgroepen.
+ Usage: include the mixin on the ModelSerializer that has gegevensgroepen.'
properties:
url:
type: string
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
@@ -12620,12 +13581,14 @@ components:
type: string
format: uri
title: is van
- description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten
+ description:
+ URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten
van dit RESULTAATTYPE bereikt kunnen worden.
zaaktypeIdentificatie:
type: string
readOnly: true
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: is relevant voor
omschrijving:
@@ -12636,7 +13599,8 @@ components:
resultaattypeomschrijving:
type: string
format: uri
- description: Algemeen gehanteerde omschrijving van de aard van resultaten
+ description:
+ Algemeen gehanteerde omschrijving van de aard van resultaten
van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst
van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving
generiek'
@@ -12650,32 +13614,43 @@ components:
selectielijstklasse:
type: string
format: uri
- description: URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE
+ description:
+ URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE
relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT
in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie.
title: selectielijstklasse
maxLength: 1000
toelichting:
type: string
- description: Een toelichting op dit RESULTAATTYPE en het belang hiervan
+ description:
+ Een toelichting op dit RESULTAATTYPE en het belang hiervan
voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd.
title: toelichting
archiefnominatie:
- description: |-
- Aanduiding die aangeeft of ZAAKen met een resultaat van dit RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de selectielijst.
+ description:
+ 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit
+ RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden
+ vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de
+ selectielijst.
+
Uitleg bij mogelijke waarden:
- * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum overgedragen worden naar een archiefbewaarplaats.
- * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd worden.
+
+ * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum
+ overgedragen worden naar een archiefbewaarplaats.
+
+ * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd
+ worden.'
title: archiefnominatie
oneOf:
- - $ref: '#/components/schemas/ArchiefnominatieEnum'
- - $ref: '#/components/schemas/BlankEnum'
+ - $ref: '#/components/schemas/ArchiefnominatieEnum'
+ - $ref: '#/components/schemas/BlankEnum'
archiefactietermijn:
type: string
nullable: true
- description: De termijn, na het vervallen van het bedrjfsvoeringsbelang,
+ description:
+ De termijn, na het vervallen van het bedrjfsvoeringsbelang,
waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen)
van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht
(naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers
@@ -12686,15 +13661,17 @@ components:
format: duration
brondatumArchiefprocedure:
allOf:
- - $ref: '#/components/schemas/BrondatumArchiefprocedure'
+ - $ref: '#/components/schemas/BrondatumArchiefprocedure'
nullable: true
- description: Specificatie voor het bepalen van de brondatum voor de start
+ description:
+ Specificatie voor het bepalen van de brondatum voor de start
van de Archiefactietermijn (=brondatum) van het zaakdossier.
title: brondatumArchiefprocedure
procesobjectaard:
type: string
nullable: true
- description: Omschrijving van het object, subject of gebeurtenis waarop,
+ description:
+ Omschrijving van het object, subject of gebeurtenis waarop,
vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking
heeft.
title: procesobjectaard
@@ -12703,7 +13680,8 @@ components:
type: string
format: uri
nullable: true
- description: URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE
+ description:
+ URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE
behoort.
title: catalogus
beginGeldigheid:
@@ -12733,13 +13711,15 @@ components:
indicatieSpecifiek:
type: boolean
nullable: true
- description: Aanduiding of het, vanuit archiveringsoptiek, een resultaattype
+ description:
+ Aanduiding of het, vanuit archiveringsoptiek, een resultaattype
betreft dat specifiek is voor een bepaalde procesobjectaard.
title: indicatie specifiek
procestermijn:
type: string
nullable: true
- description: De periode dat het zaakdossier na afronding van de zaak actief
+ description:
+ De periode dat het zaakdossier na afronding van de zaak actief
gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening
van de organisatie.
title: procestermijn
@@ -12769,7 +13749,8 @@ components:
format: uri
nullable: true
title: ''
- description: De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn
+ description:
+ De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn
in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van
dit RESULTAATTYPE kan worden gezet.
title: informatieobjecttypen
@@ -12784,28 +13765,29 @@ components:
title: informatieobjecttypen
uniqueItems: true
required:
- - besluittypeOmschrijving
- - informatieobjecttypeOmschrijving
- - omschrijving
- - omschrijvingGeneriek
- - resultaattypeomschrijving
- - selectielijstklasse
- - url
- - zaaktype
- - zaaktypeIdentificatie
+ - besluittypeOmschrijving
+ - informatieobjecttypeOmschrijving
+ - omschrijving
+ - omschrijvingGeneriek
+ - resultaattypeomschrijving
+ - selectielijstklasse
+ - url
+ - zaaktype
+ - zaaktypeIdentificatie
ResultaatTypeCreate:
type: object
- description: |-
- Set gegevensgroepdata from validated nested data.
+ description: 'Set gegevensgroepdata from validated nested data.
+
- Usage: include the mixin on the ModelSerializer that has gegevensgroepen.
+ Usage: include the mixin on the ModelSerializer that has gegevensgroepen.'
properties:
url:
type: string
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
@@ -12813,12 +13795,14 @@ components:
type: string
format: uri
title: is van
- description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten
+ description:
+ URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten
van dit RESULTAATTYPE bereikt kunnen worden.
zaaktypeIdentificatie:
type: string
readOnly: true
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: is relevant voor
omschrijving:
@@ -12829,7 +13813,8 @@ components:
resultaattypeomschrijving:
type: string
format: uri
- description: Algemeen gehanteerde omschrijving van de aard van resultaten
+ description:
+ Algemeen gehanteerde omschrijving van de aard van resultaten
van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst
van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving
generiek'
@@ -12843,32 +13828,43 @@ components:
selectielijstklasse:
type: string
format: uri
- description: URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE
+ description:
+ URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE
relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT
in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie.
title: selectielijstklasse
maxLength: 1000
toelichting:
type: string
- description: Een toelichting op dit RESULTAATTYPE en het belang hiervan
+ description:
+ Een toelichting op dit RESULTAATTYPE en het belang hiervan
voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd.
title: toelichting
archiefnominatie:
- description: |-
- Aanduiding die aangeeft of ZAAKen met een resultaat van dit RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de selectielijst.
+ description:
+ 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit
+ RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden
+ vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de
+ selectielijst.
+
Uitleg bij mogelijke waarden:
- * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum overgedragen worden naar een archiefbewaarplaats.
- * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd worden.
+
+ * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum
+ overgedragen worden naar een archiefbewaarplaats.
+
+ * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd
+ worden.'
title: archiefnominatie
oneOf:
- - $ref: '#/components/schemas/ArchiefnominatieEnum'
- - $ref: '#/components/schemas/BlankEnum'
+ - $ref: '#/components/schemas/ArchiefnominatieEnum'
+ - $ref: '#/components/schemas/BlankEnum'
archiefactietermijn:
type: string
nullable: true
- description: De termijn, na het vervallen van het bedrjfsvoeringsbelang,
+ description:
+ De termijn, na het vervallen van het bedrjfsvoeringsbelang,
waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen)
van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht
(naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers
@@ -12879,15 +13875,17 @@ components:
format: duration
brondatumArchiefprocedure:
allOf:
- - $ref: '#/components/schemas/BrondatumArchiefprocedure'
+ - $ref: '#/components/schemas/BrondatumArchiefprocedure'
nullable: true
- description: Specificatie voor het bepalen van de brondatum voor de start
+ description:
+ Specificatie voor het bepalen van de brondatum voor de start
van de Archiefactietermijn (=brondatum) van het zaakdossier.
title: brondatumArchiefprocedure
procesobjectaard:
type: string
nullable: true
- description: Omschrijving van het object, subject of gebeurtenis waarop,
+ description:
+ Omschrijving van het object, subject of gebeurtenis waarop,
vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking
heeft.
title: procesobjectaard
@@ -12896,7 +13894,8 @@ components:
type: string
format: uri
nullable: true
- description: URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE
+ description:
+ URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE
behoort.
title: catalogus
beginGeldigheid:
@@ -12926,13 +13925,15 @@ components:
indicatieSpecifiek:
type: boolean
nullable: true
- description: Aanduiding of het, vanuit archiveringsoptiek, een resultaattype
+ description:
+ Aanduiding of het, vanuit archiveringsoptiek, een resultaattype
betreft dat specifiek is voor een bepaalde procesobjectaard.
title: indicatie specifiek
procestermijn:
type: string
nullable: true
- description: De periode dat het zaakdossier na afronding van de zaak actief
+ description:
+ De periode dat het zaakdossier na afronding van de zaak actief
gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening
van de organisatie.
title: procestermijn
@@ -12959,7 +13960,8 @@ components:
format: uri
nullable: true
title: ''
- description: De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn
+ description:
+ De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn
in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van
dit RESULTAATTYPE kan worden gezet.
title: informatieobjecttypen
@@ -12974,29 +13976,30 @@ components:
title: informatieobjecttypen
uniqueItems: true
required:
- - besluittypeOmschrijving
- - besluittypen
- - informatieobjecttypeOmschrijving
- - omschrijving
- - omschrijvingGeneriek
- - resultaattypeomschrijving
- - selectielijstklasse
- - url
- - zaaktype
- - zaaktypeIdentificatie
+ - besluittypeOmschrijving
+ - besluittypen
+ - informatieobjecttypeOmschrijving
+ - omschrijving
+ - omschrijvingGeneriek
+ - resultaattypeomschrijving
+ - selectielijstklasse
+ - url
+ - zaaktype
+ - zaaktypeIdentificatie
ResultaatTypeUpdate:
type: object
- description: |-
- Set gegevensgroepdata from validated nested data.
+ description: 'Set gegevensgroepdata from validated nested data.
+
- Usage: include the mixin on the ModelSerializer that has gegevensgroepen.
+ Usage: include the mixin on the ModelSerializer that has gegevensgroepen.'
properties:
url:
type: string
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
@@ -13004,12 +14007,14 @@ components:
type: string
format: uri
title: is van
- description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten
+ description:
+ URL-referentie naar het ZAAKTYPE van ZAAKen waarin resultaten
van dit RESULTAATTYPE bereikt kunnen worden.
zaaktypeIdentificatie:
type: string
readOnly: true
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: is relevant voor
omschrijving:
@@ -13020,7 +14025,8 @@ components:
resultaattypeomschrijving:
type: string
format: uri
- description: Algemeen gehanteerde omschrijving van de aard van resultaten
+ description:
+ Algemeen gehanteerde omschrijving van de aard van resultaten
van het RESULTAATTYPE. Dit moet een URL-referentie zijn naar de referenlijst
van generieke resultaattypeomschrijvingen. Im ImZTC heet dit 'omschrijving
generiek'
@@ -13034,32 +14040,43 @@ components:
selectielijstklasse:
type: string
format: uri
- description: URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE
+ description:
+ URL-referentie naar de, voor het archiefregime bij het RESULTAATTYPE
relevante, categorie in de Selectielijst Archiefbescheiden (RESULTAAT
in de Selectielijst API) van de voor het ZAAKTYPE verantwoordelijke overheidsorganisatie.
title: selectielijstklasse
maxLength: 1000
toelichting:
type: string
- description: Een toelichting op dit RESULTAATTYPE en het belang hiervan
+ description:
+ Een toelichting op dit RESULTAATTYPE en het belang hiervan
voor ZAAKen waarin een resultaat van dit RESULTAATTYPE wordt geselecteerd.
title: toelichting
archiefnominatie:
- description: |-
- Aanduiding die aangeeft of ZAAKen met een resultaat van dit RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de selectielijst.
+ description:
+ 'Aanduiding die aangeeft of ZAAKen met een resultaat van dit
+ RESULTAATTYPE blijvend moeten worden bewaard of (op termijn) moeten worden
+ vernietigd. Indien niet expliciet opgegeven wordt dit gevuld vanuit de
+ selectielijst.
+
Uitleg bij mogelijke waarden:
- * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum overgedragen worden naar een archiefbewaarplaats.
- * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd worden.
+
+ * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum
+ overgedragen worden naar een archiefbewaarplaats.
+
+ * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd
+ worden.'
title: archiefnominatie
oneOf:
- - $ref: '#/components/schemas/ArchiefnominatieEnum'
- - $ref: '#/components/schemas/BlankEnum'
+ - $ref: '#/components/schemas/ArchiefnominatieEnum'
+ - $ref: '#/components/schemas/BlankEnum'
archiefactietermijn:
type: string
nullable: true
- description: De termijn, na het vervallen van het bedrjfsvoeringsbelang,
+ description:
+ De termijn, na het vervallen van het bedrjfsvoeringsbelang,
waarna het zaakdossier (de ZAAK met alle bijbehorende INFORMATIEOBJECTen)
van een ZAAK met een resultaat van dit RESULTAATTYPE vernietigd of overgebracht
(naar een archiefbewaarplaats) moet worden. Voor te vernietigen dossiers
@@ -13070,15 +14087,17 @@ components:
format: duration
brondatumArchiefprocedure:
allOf:
- - $ref: '#/components/schemas/BrondatumArchiefprocedure'
+ - $ref: '#/components/schemas/BrondatumArchiefprocedure'
nullable: true
- description: Specificatie voor het bepalen van de brondatum voor de start
+ description:
+ Specificatie voor het bepalen van de brondatum voor de start
van de Archiefactietermijn (=brondatum) van het zaakdossier.
title: brondatumArchiefprocedure
procesobjectaard:
type: string
nullable: true
- description: Omschrijving van het object, subject of gebeurtenis waarop,
+ description:
+ Omschrijving van het object, subject of gebeurtenis waarop,
vanuit archiveringsoptiek, het resultaattype bij zaken van dit type betrekking
heeft.
title: procesobjectaard
@@ -13087,7 +14106,8 @@ components:
type: string
format: uri
nullable: true
- description: URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE
+ description:
+ URL-referentie naar de CATALOGUS waartoe dit RESULTAATTYPE
behoort.
title: catalogus
beginGeldigheid:
@@ -13117,13 +14137,15 @@ components:
indicatieSpecifiek:
type: boolean
nullable: true
- description: Aanduiding of het, vanuit archiveringsoptiek, een resultaattype
+ description:
+ Aanduiding of het, vanuit archiveringsoptiek, een resultaattype
betreft dat specifiek is voor een bepaalde procesobjectaard.
title: indicatie specifiek
procestermijn:
type: string
nullable: true
- description: De periode dat het zaakdossier na afronding van de zaak actief
+ description:
+ De periode dat het zaakdossier na afronding van de zaak actief
gebruikt en/of geraadpleegd wordt ter ondersteuning van de taakuitoefening
van de organisatie.
title: procestermijn
@@ -13150,7 +14172,8 @@ components:
format: uri
nullable: true
title: ''
- description: De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn
+ description:
+ De INFORMATIEOBJECTTYPEn die verplicht aanwezig moeten zijn
in het zaakdossier van ZAAKen van dit ZAAKTYPE voordat een resultaat van
dit RESULTAATTYPE kan worden gezet.
title: informatieobjecttypen
@@ -13165,21 +14188,21 @@ components:
title: informatieobjecttypen
uniqueItems: true
required:
- - besluittypeOmschrijving
- - besluittypen
- - informatieobjecttypeOmschrijving
- - omschrijving
- - omschrijvingGeneriek
- - resultaattypeomschrijving
- - selectielijstklasse
- - url
- - zaaktype
- - zaaktypeIdentificatie
+ - besluittypeOmschrijving
+ - besluittypen
+ - informatieobjecttypeOmschrijving
+ - omschrijving
+ - omschrijvingGeneriek
+ - resultaattypeomschrijving
+ - selectielijstklasse
+ - url
+ - zaaktype
+ - zaaktypeIdentificatie
RichtingEnum:
enum:
- - inkomend
- - intern
- - uitgaand
+ - inkomend
+ - intern
+ - uitgaand
type: string
RolType:
type: object
@@ -13190,20 +14213,23 @@ components:
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
zaaktype:
type: string
format: uri
- description: URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken
+ description:
+ URL-referentie naar het ZAAKTYPE waar deze ROLTYPEn betrokken
kunnen zijn.
title: Zaaktype
zaaktypeIdentificatie:
type: string
readOnly: true
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: Zaaktype
omschrijving:
@@ -13213,20 +14239,21 @@ components:
maxLength: 100
omschrijvingGeneriek:
allOf:
- - $ref: '#/components/schemas/OmschrijvingGeneriekEnum'
- description: |-
- Algemeen gehanteerde omschrijving van de aard van de ROL.
-
- Uitleg bij mogelijke waarden:
-
- * `adviseur` - (Adviseur) Kennis in dienst stellen van de behandeling van (een deel van) een zaak.
- * `behandelaar` - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van) een zaak.
- * `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst van een zaak.
- * `beslisser` - (Beslisser) Nemen van besluiten die voor de uitkomst van een zaak noodzakelijk zijn.
- * `initiator` - (Initiator) Aanleiding geven tot de start van een zaak ..
- * `klantcontacter` - (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers en bedrijven ..
- * `zaakcoordinator` - (Zaakcoördinator) Er voor zorg dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt conform de daarover gemaakte afspraken.
- * `mede_initiator` - Mede-initiator
+ - $ref: '#/components/schemas/OmschrijvingGeneriekEnum'
+ description:
+ "Algemeen gehanteerde omschrijving van de aard van de ROL.\n\
+ \nUitleg bij mogelijke waarden:\n\n* `adviseur` - (Adviseur) Kennis in\
+ \ dienst stellen van de behandeling van (een deel van) een zaak.\n* `behandelaar`\
+ \ - (Behandelaar) De vakinhoudelijke behandeling doen van (een deel van)\
+ \ een zaak.\n* `belanghebbende` - (Belanghebbende) Vanuit eigen en objectief\
+ \ belang rechtstreeks betrokken zijn bij de behandeling en/of de uitkomst\
+ \ van een zaak.\n* `beslisser` - (Beslisser) Nemen van besluiten die voor\
+ \ de uitkomst van een zaak noodzakelijk zijn.\n* `initiator` - (Initiator)\
+ \ Aanleiding geven tot de start van een zaak ..\n* `klantcontacter` -\
+ \ (Klantcontacter) Het eerste aanspreekpunt zijn voor vragen van burgers\
+ \ en bedrijven ..\n* `zaakcoordinator` - (Zaakco\xF6rdinator) Er voor\
+ \ zorg dragen dat de behandeling van de zaak in samenhang uitgevoerd wordt\
+ \ conform de daarover gemaakte afspraken.\n* `mede_initiator` - Mede-initiator"
title: omschrijving generiek
catalogus:
type: string
@@ -13259,11 +14286,11 @@ components:
description: De datum van de aller laatste versie van het object.
title: datum einde object
required:
- - omschrijving
- - omschrijvingGeneriek
- - url
- - zaaktype
- - zaaktypeIdentificatie
+ - omschrijving
+ - omschrijvingGeneriek
+ - url
+ - zaaktype
+ - zaaktypeIdentificatie
StatusType:
type: object
properties:
@@ -13272,25 +14299,29 @@ components:
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
omschrijving:
type: string
- description: Een korte, voor de initiator van de zaak relevante, omschrijving
+ description:
+ Een korte, voor de initiator van de zaak relevante, omschrijving
van de aard van de STATUS van zaken van een ZAAKTYPE.
title: omschrijving
maxLength: 80
omschrijvingGeneriek:
type: string
- description: Algemeen gehanteerde omschrijving van de aard van STATUSsen
+ description:
+ Algemeen gehanteerde omschrijving van de aard van STATUSsen
van het STATUSTYPE
title: omschrijving generiek
maxLength: 80
statustekst:
type: string
- description: De tekst die wordt gebruikt om de Initiator te informeren over
+ description:
+ De tekst die wordt gebruikt om de Initiator te informeren over
het bereiken van een STATUS van dit STATUSTYPE bij het desbetreffende
ZAAKTYPE.
title: statustekst
@@ -13298,7 +14329,8 @@ components:
zaaktype:
type: string
format: uri
- description: URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen
+ description:
+ URL-referentie naar het ZAAKTYPE van ZAAKen waarin STATUSsen
van dit STATUSTYPE bereikt kunnen worden.
title: Zaaktype
catalogus:
@@ -13309,31 +14341,36 @@ components:
zaaktypeIdentificatie:
type: string
readOnly: true
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: Zaaktype
volgnummer:
type: integer
maximum: 9999
minimum: 1
- description: Een volgnummer voor statussen van het STATUSTYPE binnen een
+ description:
+ Een volgnummer voor statussen van het STATUSTYPE binnen een
zaak.
title: statustypevolgnummer
isEindstatus:
type: boolean
readOnly: true
- description: Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven
+ description:
+ Geeft aan dat dit STATUSTYPE een eindstatus betreft. Dit gegeven
is afgeleid uit alle STATUSTYPEn van dit ZAAKTYPE met het hoogste volgnummer.
title: isEindstatus
informeren:
type: boolean
- description: Aanduiding die aangeeft of na het zetten van een STATUS van
- dit STATUSTYPE de Initiator moet worden geïnformeerd over de statusovergang.
+ description:
+ "Aanduiding die aangeeft of na het zetten van een STATUS van\
+ \ dit STATUSTYPE de Initiator moet worden ge\xEFnformeerd over de statusovergang."
title: informeren
doorlooptijd:
type: string
nullable: true
- description: De door de zaakbehandelende organisatie(s) gestelde norm voor
+ description:
+ De door de zaakbehandelende organisatie(s) gestelde norm voor
de doorlooptijd voor het bereiken van STATUSsen van dit STATUSTYPE bij
het desbetreffende ZAAKTYPE.
title: doorlooptijd status
@@ -13356,7 +14393,8 @@ components:
format: uri
nullable: true
title: ''
- description: de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen,
+ description:
+ de EIGENSCHAPpen die verplicht een waarde moeten hebben gekregen,
voordat een STATUS van dit STATUSTYPE kan worden gezet.
title: eigenschappen
uniqueItems: true
@@ -13385,13 +14423,13 @@ components:
description: De datum van de aller laatste versie van het object.
title: datum einde object
required:
- - catalogus
- - isEindstatus
- - omschrijving
- - url
- - volgnummer
- - zaaktype
- - zaaktypeIdentificatie
+ - catalogus
+ - isEindstatus
+ - omschrijving
+ - url
+ - volgnummer
+ - zaaktype
+ - zaaktypeIdentificatie
ValidatieFout:
type: object
description: Formaat van HTTP 4xx en 5xx fouten.
@@ -13418,7 +14456,8 @@ components:
title: detail
instance:
type: string
- description: URI met referentie naar dit specifiek voorkomen van de fout.
+ description:
+ URI met referentie naar dit specifiek voorkomen van de fout.
Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld.
title: instance
invalidParams:
@@ -13427,22 +14466,22 @@ components:
$ref: '#/components/schemas/FieldValidationError'
title: invalidParams
required:
- - code
- - detail
- - instance
- - invalidParams
- - status
- - title
+ - code
+ - detail
+ - instance
+ - invalidParams
+ - status
+ - title
VertrouwelijkheidaanduidingEnum:
enum:
- - openbaar
- - beperkt_openbaar
- - intern
- - zaakvertrouwelijk
- - vertrouwelijk
- - confidentieel
- - geheim
- - zeer_geheim
+ - openbaar
+ - beperkt_openbaar
+ - intern
+ - zaakvertrouwelijk
+ - vertrouwelijk
+ - confidentieel
+ - geheim
+ - zeer_geheim
type: string
ZaakObjectType:
type: object
@@ -13452,13 +14491,15 @@ components:
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
anderObjecttype:
type: boolean
- description: Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een
+ description:
+ Aanduiding waarmee wordt aangegeven of het ZAAKOBJECTTYPE een
ander, niet in RSGB en RGBZ voorkomend, objecttype betreft.
title: Ander objecttype
beginGeldigheid:
@@ -13487,26 +14528,30 @@ components:
objecttype:
type: string
format: uri
- description: URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE
+ description:
+ URL-referentie naar de OBJECTTYPE waartoe dit ZAAKOBJECTTYPE
behoort.
title: Objecttype
maxLength: 200
relatieOmschrijving:
type: string
- description: Omschrijving van de betrekking van het Objecttype op zaken
+ description:
+ Omschrijving van de betrekking van het Objecttype op zaken
van het gerelateerde ZAAKTYPE.
title: Relatie omschrijving
maxLength: 80
zaaktype:
type: string
format: uri
- description: URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE
+ description:
+ URL-referentie naar de ZAAKTYPE waartoe dit ZAAKOBJECTTYPE
behoort.
title: Zaaktype
zaaktypeIdentificatie:
type: string
readOnly: true
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: Zaaktype
resultaattypen:
@@ -13532,39 +14577,42 @@ components:
catalogus:
type: string
format: uri
- description: URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE
+ description:
+ URL-referentie naar de CATALOGUS waartoe dit ZAAKOBJECTTYPE
behoort.
title: Catalogus
required:
- - anderObjecttype
- - beginGeldigheid
- - catalogus
- - objecttype
- - relatieOmschrijving
- - resultaattypen
- - statustypen
- - url
- - zaaktype
- - zaaktypeIdentificatie
+ - anderObjecttype
+ - beginGeldigheid
+ - catalogus
+ - objecttype
+ - relatieOmschrijving
+ - resultaattypen
+ - statustypen
+ - url
+ - zaaktype
+ - zaaktypeIdentificatie
ZaakType:
type: object
- description: |-
- Set gegevensgroepdata from validated nested data.
+ description: 'Set gegevensgroepdata from validated nested data.
- Usage: include the mixin on the ModelSerializer that has gegevensgroepen.
+
+ Usage: include the mixin on the ModelSerializer that has gegevensgroepen.'
properties:
url:
type: string
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
identificatie:
type: string
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: identificatie
maxLength: 50
@@ -13575,86 +14623,105 @@ components:
maxLength: 80
omschrijvingGeneriek:
type: string
- description: Algemeen gehanteerde omschrijving van de aard van ZAAKen van
+ description:
+ Algemeen gehanteerde omschrijving van de aard van ZAAKen van
het ZAAKTYPE
title: omschrijving generiek
maxLength: 80
vertrouwelijkheidaanduiding:
allOf:
- - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum'
- description: |-
- Aanduiding van de mate waarin zaakdossiers van ZAAKen van dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde gezet.
+ - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum'
+ description:
+ 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van
+ dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het
+ aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde
+ gezet.
+
Uitleg bij mogelijke waarden:
+
* `openbaar` - Openbaar
+
* `beperkt_openbaar` - Beperkt openbaar
+
* `intern` - Intern
+
* `zaakvertrouwelijk` - Zaakvertrouwelijk
+
* `vertrouwelijk` - Vertrouwelijk
+
* `confidentieel` - Confidentieel
+
* `geheim` - Geheim
- * `zeer_geheim` - Zeer geheim
+
+ * `zeer_geheim` - Zeer geheim'
title: vertrouwelijkheidaanduiding
doel:
type: string
- description: Een omschrijving van hetgeen beoogd is te bereiken met een
+ description:
+ Een omschrijving van hetgeen beoogd is te bereiken met een
zaak van dit zaaktype.
title: doel
aanleiding:
type: string
- description: Een omschrijving van de gebeurtenis die leidt tot het starten
+ description:
+ Een omschrijving van de gebeurtenis die leidt tot het starten
van een ZAAK van dit ZAAKTYPE.
title: aanleiding
toelichting:
type: string
- description: Een eventuele toelichting op dit zaaktype, zoals een beschrijving
+ description:
+ Een eventuele toelichting op dit zaaktype, zoals een beschrijving
van het procesverloop op de hoofdlijnen.
title: toelichting
indicatieInternOfExtern:
allOf:
- - $ref: '#/components/schemas/IndicatieInternOfExternEnum'
- description: |-
- Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn die Intern respectievelijk Extern geïnitieerd worden. Indien van beide sprake kan zijn, dan prevaleert de externe initiatie.
-
- Uitleg bij mogelijke waarden:
-
- * `inkomend` - Inkomend
- * `intern` - Intern
- * `uitgaand` - Uitgaand
+ - $ref: '#/components/schemas/IndicatieInternOfExternEnum'
+ description:
+ "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\
+ \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\
+ \ beide sprake kan zijn, dan prevaleert de externe initiatie.\n\nUitleg\
+ \ bij mogelijke waarden:\n\n* `inkomend` - Inkomend\n* `intern` - Intern\n\
+ * `uitgaand` - Uitgaand"
title: indicatie intern of extern
handelingInitiator:
type: string
- description: Werkwoord dat hoort bij de handeling die de initiator verricht
+ description:
+ Werkwoord dat hoort bij de handeling die de initiator verricht
bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook
het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator
title: handeling initiator
maxLength: 20
onderwerp:
type: string
- description: 'Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen
+ description:
+ "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen
nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus
- (PDC). Bijvoorbeeld: ''Evenementenvergunning'', ''Geboorte'', ''Klacht''.
- Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp'
+ (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'.
+ Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp"
title: onderwerp
maxLength: 80
handelingBehandelaar:
type: string
- description: Werkwoord dat hoort bij de handeling die de behandelaar verricht
+ description:
+ Werkwoord dat hoort bij de handeling die de behandelaar verricht
bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren',
'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar
title: handeling behandelaar
maxLength: 20
doorlooptijd:
type: string
- description: De periode waarbinnen volgens wet- en regelgeving een ZAAK
+ description:
+ De periode waarbinnen volgens wet- en regelgeving een ZAAK
van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen.
title: doorlooptijd behandeling
format: duration
servicenorm:
type: string
nullable: true
- description: De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE
+ description:
+ De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE
afgerond wordt conform de geldende servicenormen van de zaakbehandelende
organisatie(s).
title: servicenorm behandeling
@@ -13662,17 +14729,20 @@ components:
opschortingEnAanhoudingMogelijk:
type: boolean
title: Opschorting/aanhouding mogelijk
- description: Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE
+ description:
+ Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE
kunnen worden opgeschort en/of aangehouden.
verlengingMogelijk:
type: boolean
- description: Aanduiding die aangeeft of de Doorlooptijd behandeling van
+ description:
+ Aanduiding die aangeeft of de Doorlooptijd behandeling van
ZAAKen van dit ZAAKTYPE kan worden verlengd.
title: verlenging mogelijk
verlengingstermijn:
type: string
nullable: true
- description: Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling
+ description:
+ Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling
van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde
bevatten als verlenging mogelijk is.
title: verlengingstermijn
@@ -13683,12 +14753,14 @@ components:
type: string
title: Trefwoord
maxLength: 30
- description: Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden
+ description:
+ Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden
gekarakteriseerd.
title: trefwoorden
publicatieIndicatie:
type: boolean
- description: Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd
+ description:
+ Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd
moet worden.
title: publicatie indicatie
publicatietekst:
@@ -13700,8 +14772,9 @@ components:
items:
type: string
maxLength: 40
- description: De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige
- en/of financiële verantwoording.
+ description:
+ "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\
+ \ en/of financi\xEBle verantwoording."
title: verantwoordingsrelatie
productenOfDiensten:
type: array
@@ -13710,25 +14783,28 @@ components:
format: uri
title: URL naar product/dienst
maxLength: 1000
- description: Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt
+ description:
+ Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt
voortgebracht.
title: producten of diensten
selectielijstProcestype:
type: string
format: uri
- description: URL-referentie naar een vanuit archiveringsoptiek onderkende
+ description:
+ URL-referentie naar een vanuit archiveringsoptiek onderkende
groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst
API).
title: selectielijst procestype
maxLength: 200
referentieproces:
allOf:
- - $ref: '#/components/schemas/ReferentieProces'
+ - $ref: '#/components/schemas/ReferentieProces'
description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE.
title: referentieproces
verantwoordelijke:
type: string
- description: De (soort) organisatorische eenheid of (functie van) medewerker
+ description:
+ De (soort) organisatorische eenheid of (functie van) medewerker
die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE.
title: verantwoordelijke
maxLength: 50
@@ -13743,12 +14819,12 @@ components:
uniqueItems: true
broncatalogus:
allOf:
- - $ref: '#/components/schemas/BronCatalogus'
+ - $ref: '#/components/schemas/BronCatalogus'
description: De CATALOGUS waaraan het ZAAKTYPE is ontleend.
title: broncatalogus
bronzaaktype:
allOf:
- - $ref: '#/components/schemas/BronZaaktype'
+ - $ref: '#/components/schemas/BronZaaktype'
description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend.
title: bronzaaktype
catalogus:
@@ -13763,7 +14839,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen
+ description:
+ URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen
dit ZAAKTYPE.
title: Zaaktype
uniqueItems: true
@@ -13774,7 +14851,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen
+ description:
+ URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen
dit ZAAKTYPE.
title: is relevant voor
uniqueItems: true
@@ -13785,7 +14863,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn
+ description:
+ URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn
in ZAKEN van dit ZAAKTYPE.
title: Zaaktype
uniqueItems: true
@@ -13796,7 +14875,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de INFORMATIEOBJECTTYPEN die mogelijk
+ description:
+ URL-referenties naar de INFORMATIEOBJECTTYPEN die mogelijk
zijn binnen dit ZAAKTYPE.
title: zaaktypen
uniqueItems: true
@@ -13807,7 +14887,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit
+ description:
+ URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit
ZAAKTYPE.
title: Zaaktype
uniqueItems: true
@@ -13818,7 +14899,8 @@ components:
format: uri
title: heeft relevante besluittypen
title: heeft relevante besluittypen
- description: URL-referenties naar de BESLUITTYPEN die mogelijk zijn binnen
+ description:
+ URL-referenties naar de BESLUITTYPEN die mogelijk zijn binnen
dit ZAAKTYPE.
uniqueItems: true
deelzaaktypen:
@@ -13828,7 +14910,8 @@ components:
format: uri
nullable: true
title: ''
- description: De ZAAKTYPE(n) waaronder ZAAKen als deelzaak kunnen voorkomen
+ description:
+ De ZAAKTYPE(n) waaronder ZAAKen als deelzaak kunnen voorkomen
bij ZAAKen van dit ZAAKTYPE.
title: deelzaaktypen
uniqueItems: true
@@ -13836,7 +14919,8 @@ components:
type: array
items:
$ref: '#/components/schemas/ZaakTypenRelatie'
- description: De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit
+ description:
+ De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit
ZAAKTYPE.
title: zaaktype van
beginGeldigheid:
@@ -13865,65 +14949,69 @@ components:
versiedatum:
type: string
format: date
- description: De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE
+ description:
+ De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE
geldig zijn geworden
title: versiedatum
concept:
type: boolean
readOnly: true
- description: Geeft aan of het object een concept betreft. Concepten zijn
+ description:
+ Geeft aan of het object een concept betreft. Concepten zijn
niet-definitieve versies en zouden niet gebruikt moeten worden buiten
deze API.
title: concept
required:
- - aanleiding
- - beginGeldigheid
- - besluittypen
- - catalogus
- - concept
- - doel
- - doorlooptijd
- - eigenschappen
- - gerelateerdeZaaktypen
- - handelingBehandelaar
- - handelingInitiator
- - identificatie
- - indicatieInternOfExtern
- - informatieobjecttypen
- - omschrijving
- - onderwerp
- - opschortingEnAanhoudingMogelijk
- - productenOfDiensten
- - publicatieIndicatie
- - referentieproces
- - resultaattypen
- - roltypen
- - statustypen
- - url
- - verantwoordelijke
- - verlengingMogelijk
- - versiedatum
- - vertrouwelijkheidaanduiding
- - zaakobjecttypen
+ - aanleiding
+ - beginGeldigheid
+ - besluittypen
+ - catalogus
+ - concept
+ - doel
+ - doorlooptijd
+ - eigenschappen
+ - gerelateerdeZaaktypen
+ - handelingBehandelaar
+ - handelingInitiator
+ - identificatie
+ - indicatieInternOfExtern
+ - informatieobjecttypen
+ - omschrijving
+ - onderwerp
+ - opschortingEnAanhoudingMogelijk
+ - productenOfDiensten
+ - publicatieIndicatie
+ - referentieproces
+ - resultaattypen
+ - roltypen
+ - statustypen
+ - url
+ - verantwoordelijke
+ - verlengingMogelijk
+ - versiedatum
+ - vertrouwelijkheidaanduiding
+ - zaakobjecttypen
ZaakTypeCreate:
type: object
- description: |-
- Set gegevensgroepdata from validated nested data.
+ description: 'Set gegevensgroepdata from validated nested data.
+
- Usage: include the mixin on the ModelSerializer that has gegevensgroepen.
+ Usage: include the mixin on the ModelSerializer that has gegevensgroepen.'
properties:
url:
type: string
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
identificatie:
type: string
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: identificatie
maxLength: 50
@@ -13934,86 +15022,105 @@ components:
maxLength: 80
omschrijvingGeneriek:
type: string
- description: Algemeen gehanteerde omschrijving van de aard van ZAAKen van
+ description:
+ Algemeen gehanteerde omschrijving van de aard van ZAAKen van
het ZAAKTYPE
title: omschrijving generiek
maxLength: 80
vertrouwelijkheidaanduiding:
allOf:
- - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum'
- description: |-
- Aanduiding van de mate waarin zaakdossiers van ZAAKen van dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde gezet.
+ - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum'
+ description:
+ 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van
+ dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het
+ aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde
+ gezet.
+
Uitleg bij mogelijke waarden:
+
* `openbaar` - Openbaar
+
* `beperkt_openbaar` - Beperkt openbaar
+
* `intern` - Intern
+
* `zaakvertrouwelijk` - Zaakvertrouwelijk
+
* `vertrouwelijk` - Vertrouwelijk
+
* `confidentieel` - Confidentieel
+
* `geheim` - Geheim
- * `zeer_geheim` - Zeer geheim
+
+ * `zeer_geheim` - Zeer geheim'
title: vertrouwelijkheidaanduiding
doel:
type: string
- description: Een omschrijving van hetgeen beoogd is te bereiken met een
+ description:
+ Een omschrijving van hetgeen beoogd is te bereiken met een
zaak van dit zaaktype.
title: doel
aanleiding:
type: string
- description: Een omschrijving van de gebeurtenis die leidt tot het starten
+ description:
+ Een omschrijving van de gebeurtenis die leidt tot het starten
van een ZAAK van dit ZAAKTYPE.
title: aanleiding
toelichting:
type: string
- description: Een eventuele toelichting op dit zaaktype, zoals een beschrijving
+ description:
+ Een eventuele toelichting op dit zaaktype, zoals een beschrijving
van het procesverloop op de hoofdlijnen.
title: toelichting
indicatieInternOfExtern:
allOf:
- - $ref: '#/components/schemas/IndicatieInternOfExternEnum'
- description: |-
- Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn die Intern respectievelijk Extern geïnitieerd worden. Indien van beide sprake kan zijn, dan prevaleert de externe initiatie.
-
- Uitleg bij mogelijke waarden:
-
- * `inkomend` - Inkomend
- * `intern` - Intern
- * `uitgaand` - Uitgaand
+ - $ref: '#/components/schemas/IndicatieInternOfExternEnum'
+ description:
+ "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\
+ \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\
+ \ beide sprake kan zijn, dan prevaleert de externe initiatie.\n\nUitleg\
+ \ bij mogelijke waarden:\n\n* `inkomend` - Inkomend\n* `intern` - Intern\n\
+ * `uitgaand` - Uitgaand"
title: indicatie intern of extern
handelingInitiator:
type: string
- description: Werkwoord dat hoort bij de handeling die de initiator verricht
+ description:
+ Werkwoord dat hoort bij de handeling die de initiator verricht
bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook
het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator
title: handeling initiator
maxLength: 20
onderwerp:
type: string
- description: 'Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen
+ description:
+ "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen
nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus
- (PDC). Bijvoorbeeld: ''Evenementenvergunning'', ''Geboorte'', ''Klacht''.
- Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp'
+ (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'.
+ Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp"
title: onderwerp
maxLength: 80
handelingBehandelaar:
type: string
- description: Werkwoord dat hoort bij de handeling die de behandelaar verricht
+ description:
+ Werkwoord dat hoort bij de handeling die de behandelaar verricht
bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren',
'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar
title: handeling behandelaar
maxLength: 20
doorlooptijd:
type: string
- description: De periode waarbinnen volgens wet- en regelgeving een ZAAK
+ description:
+ De periode waarbinnen volgens wet- en regelgeving een ZAAK
van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen.
title: doorlooptijd behandeling
format: duration
servicenorm:
type: string
nullable: true
- description: De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE
+ description:
+ De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE
afgerond wordt conform de geldende servicenormen van de zaakbehandelende
organisatie(s).
title: servicenorm behandeling
@@ -14021,17 +15128,20 @@ components:
opschortingEnAanhoudingMogelijk:
type: boolean
title: Opschorting/aanhouding mogelijk
- description: Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE
+ description:
+ Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE
kunnen worden opgeschort en/of aangehouden.
verlengingMogelijk:
type: boolean
- description: Aanduiding die aangeeft of de Doorlooptijd behandeling van
+ description:
+ Aanduiding die aangeeft of de Doorlooptijd behandeling van
ZAAKen van dit ZAAKTYPE kan worden verlengd.
title: verlenging mogelijk
verlengingstermijn:
type: string
nullable: true
- description: Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling
+ description:
+ Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling
van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde
bevatten als verlenging mogelijk is.
title: verlengingstermijn
@@ -14042,12 +15152,14 @@ components:
type: string
title: Trefwoord
maxLength: 30
- description: Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden
+ description:
+ Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden
gekarakteriseerd.
title: trefwoorden
publicatieIndicatie:
type: boolean
- description: Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd
+ description:
+ Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd
moet worden.
title: publicatie indicatie
publicatietekst:
@@ -14059,8 +15171,9 @@ components:
items:
type: string
maxLength: 40
- description: De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige
- en/of financiële verantwoording.
+ description:
+ "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\
+ \ en/of financi\xEBle verantwoording."
title: verantwoordingsrelatie
productenOfDiensten:
type: array
@@ -14069,25 +15182,28 @@ components:
format: uri
title: URL naar product/dienst
maxLength: 1000
- description: Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt
+ description:
+ Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt
voortgebracht.
title: producten of diensten
selectielijstProcestype:
type: string
format: uri
- description: URL-referentie naar een vanuit archiveringsoptiek onderkende
+ description:
+ URL-referentie naar een vanuit archiveringsoptiek onderkende
groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst
API).
title: selectielijst procestype
maxLength: 200
referentieproces:
allOf:
- - $ref: '#/components/schemas/ReferentieProces'
+ - $ref: '#/components/schemas/ReferentieProces'
description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE.
title: referentieproces
verantwoordelijke:
type: string
- description: De (soort) organisatorische eenheid of (functie van) medewerker
+ description:
+ De (soort) organisatorische eenheid of (functie van) medewerker
die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE.
title: verantwoordelijke
maxLength: 50
@@ -14102,12 +15218,12 @@ components:
uniqueItems: true
broncatalogus:
allOf:
- - $ref: '#/components/schemas/BronCatalogus'
+ - $ref: '#/components/schemas/BronCatalogus'
description: De CATALOGUS waaraan het ZAAKTYPE is ontleend.
title: broncatalogus
bronzaaktype:
allOf:
- - $ref: '#/components/schemas/BronZaaktype'
+ - $ref: '#/components/schemas/BronZaaktype'
description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend.
title: bronzaaktype
catalogus:
@@ -14122,7 +15238,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen
+ description:
+ URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen
dit ZAAKTYPE.
title: Zaaktype
uniqueItems: true
@@ -14133,7 +15250,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen
+ description:
+ URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen
dit ZAAKTYPE.
title: is relevant voor
uniqueItems: true
@@ -14144,7 +15262,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn
+ description:
+ URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn
in ZAKEN van dit ZAAKTYPE.
title: Zaaktype
uniqueItems: true
@@ -14155,7 +15274,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de INFORMATIEOBJECTTYPEN die mogelijk
+ description:
+ URL-referenties naar de INFORMATIEOBJECTTYPEN die mogelijk
zijn binnen dit ZAAKTYPE.
title: zaaktypen
uniqueItems: true
@@ -14166,7 +15286,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit
+ description:
+ URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit
ZAAKTYPE.
title: Zaaktype
uniqueItems: true
@@ -14175,7 +15296,8 @@ components:
items:
type: string
title: ''
- description: '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen
+ description:
+ '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen
dit ZAAKTYPE.'
title: zaaktypen
deelzaaktypen:
@@ -14183,14 +15305,16 @@ components:
items:
type: string
title: ''
- description: De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak
+ description:
+ De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak
kunnen voorkomen bij ZAAKen van dit ZAAKTYPE.
title: deelzaaktypen
gerelateerdeZaaktypen:
type: array
items:
$ref: '#/components/schemas/ZaakTypenRelatieCreate'
- description: De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit
+ description:
+ De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit
ZAAKTYPE.
title: zaaktype van
beginGeldigheid:
@@ -14219,60 +15343,63 @@ components:
versiedatum:
type: string
format: date
- description: De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE
+ description:
+ De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE
geldig zijn geworden
title: versiedatum
concept:
type: boolean
readOnly: true
- description: Geeft aan of het object een concept betreft. Concepten zijn
+ description:
+ Geeft aan of het object een concept betreft. Concepten zijn
niet-definitieve versies en zouden niet gebruikt moeten worden buiten
deze API.
title: concept
required:
- - aanleiding
- - beginGeldigheid
- - besluittypen
- - catalogus
- - concept
- - deelzaaktypen
- - doel
- - doorlooptijd
- - eigenschappen
- - gerelateerdeZaaktypen
- - handelingBehandelaar
- - handelingInitiator
- - identificatie
- - indicatieInternOfExtern
- - informatieobjecttypen
- - omschrijving
- - onderwerp
- - opschortingEnAanhoudingMogelijk
- - productenOfDiensten
- - publicatieIndicatie
- - referentieproces
- - resultaattypen
- - roltypen
- - statustypen
- - url
- - verantwoordelijke
- - verlengingMogelijk
- - versiedatum
- - vertrouwelijkheidaanduiding
- - zaakobjecttypen
+ - aanleiding
+ - beginGeldigheid
+ - besluittypen
+ - catalogus
+ - concept
+ - deelzaaktypen
+ - doel
+ - doorlooptijd
+ - eigenschappen
+ - gerelateerdeZaaktypen
+ - handelingBehandelaar
+ - handelingInitiator
+ - identificatie
+ - indicatieInternOfExtern
+ - informatieobjecttypen
+ - omschrijving
+ - onderwerp
+ - opschortingEnAanhoudingMogelijk
+ - productenOfDiensten
+ - publicatieIndicatie
+ - referentieproces
+ - resultaattypen
+ - roltypen
+ - statustypen
+ - url
+ - verantwoordelijke
+ - verlengingMogelijk
+ - versiedatum
+ - vertrouwelijkheidaanduiding
+ - zaakobjecttypen
ZaakTypeInformatieObjectType:
type: object
- description: |-
- Represent a ZaakTypeInformatieObjectType.
+ description: 'Represent a ZaakTypeInformatieObjectType.
- Relatie met informatieobjecttype dat relevant is voor zaaktype.
+
+ Relatie met informatieobjecttype dat relevant is voor zaaktype.'
properties:
url:
type: string
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
@@ -14284,7 +15411,8 @@ components:
zaaktypeIdentificatie:
type: string
readOnly: true
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: zaaktype
catalogus:
@@ -14306,50 +15434,58 @@ components:
type: integer
maximum: 999
minimum: 1
- description: Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het
+ description:
+ Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het
ZAAKTYPE.
title: volgnummer
richting:
allOf:
- - $ref: '#/components/schemas/RichtingEnum'
- description: |-
- Aanduiding van de richting van informatieobjecten van het gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE.
+ - $ref: '#/components/schemas/RichtingEnum'
+ description:
+ 'Aanduiding van de richting van informatieobjecten van het
+ gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE.
+
Uitleg bij mogelijke waarden:
+
* `inkomend` - Inkomend
+
* `intern` - Intern
- * `uitgaand` - Uitgaand
+
+ * `uitgaand` - Uitgaand'
title: richting
statustype:
type: string
format: uri
nullable: true
title: Status type
- description: URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn
+ description:
+ URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn
verplicht aanwezig moeten zijn.
required:
- - catalogus
- - informatieobjecttype
- - informatieobjecttypeOmschrijving
- - richting
- - url
- - volgnummer
- - zaaktype
- - zaaktypeIdentificatie
+ - catalogus
+ - informatieobjecttype
+ - informatieobjecttypeOmschrijving
+ - richting
+ - url
+ - volgnummer
+ - zaaktype
+ - zaaktypeIdentificatie
ZaakTypeInformatieObjectTypeCreate:
type: object
- description: |-
- Represent a ZaakTypeInformatieObjectType.
+ description: 'Represent a ZaakTypeInformatieObjectType.
+
- Relatie met informatieobjecttype dat relevant is voor zaaktype.
+ Relatie met informatieobjecttype dat relevant is voor zaaktype.'
properties:
url:
type: string
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
@@ -14361,7 +15497,8 @@ components:
zaaktypeIdentificatie:
type: string
readOnly: true
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: zaaktype
catalogus:
@@ -14371,7 +15508,8 @@ components:
title: catalogus
informatieobjecttype:
type: string
- description: '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten
+ description:
+ '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten
waarin besluiten van dit BESLUITTYPE worden vastgelegd.'
title: informatie object type
informatieobjecttypeOmschrijving:
@@ -14383,50 +15521,58 @@ components:
type: integer
maximum: 999
minimum: 1
- description: Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het
+ description:
+ Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het
ZAAKTYPE.
title: volgnummer
richting:
allOf:
- - $ref: '#/components/schemas/RichtingEnum'
- description: |-
- Aanduiding van de richting van informatieobjecten van het gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE.
+ - $ref: '#/components/schemas/RichtingEnum'
+ description:
+ 'Aanduiding van de richting van informatieobjecten van het
+ gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE.
+
Uitleg bij mogelijke waarden:
+
* `inkomend` - Inkomend
+
* `intern` - Intern
- * `uitgaand` - Uitgaand
+
+ * `uitgaand` - Uitgaand'
title: richting
statustype:
type: string
format: uri
nullable: true
title: Status type
- description: URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn
+ description:
+ URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn
verplicht aanwezig moeten zijn.
required:
- - catalogus
- - informatieobjecttype
- - informatieobjecttypeOmschrijving
- - richting
- - url
- - volgnummer
- - zaaktype
- - zaaktypeIdentificatie
+ - catalogus
+ - informatieobjecttype
+ - informatieobjecttypeOmschrijving
+ - richting
+ - url
+ - volgnummer
+ - zaaktype
+ - zaaktypeIdentificatie
ZaakTypeInformatieObjectTypeUpdate:
type: object
- description: |-
- Represent a ZaakTypeInformatieObjectType.
+ description: 'Represent a ZaakTypeInformatieObjectType.
- Relatie met informatieobjecttype dat relevant is voor zaaktype.
+
+ Relatie met informatieobjecttype dat relevant is voor zaaktype.'
properties:
url:
type: string
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
@@ -14438,7 +15584,8 @@ components:
zaaktypeIdentificatie:
type: string
readOnly: true
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: zaaktype
catalogus:
@@ -14448,7 +15595,8 @@ components:
title: catalogus
informatieobjecttype:
type: string
- description: '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten
+ description:
+ '`Omschrijvingen` van het INFORMATIEOBJECTTYPE van informatieobjecten
waarin besluiten van dit BESLUITTYPE worden vastgelegd.'
title: informatie object type
informatieobjecttypeOmschrijving:
@@ -14460,56 +15608,65 @@ components:
type: integer
maximum: 999
minimum: 1
- description: Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het
+ description:
+ Uniek volgnummer van het ZAAK-INFORMATIEOBJECTTYPE binnen het
ZAAKTYPE.
title: volgnummer
richting:
allOf:
- - $ref: '#/components/schemas/RichtingEnum'
- description: |-
- Aanduiding van de richting van informatieobjecten van het gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE.
+ - $ref: '#/components/schemas/RichtingEnum'
+ description:
+ 'Aanduiding van de richting van informatieobjecten van het
+ gerelateerde INFORMATIEOBJECTTYPE bij zaken van het gerelateerde ZAAKTYPE.
+
Uitleg bij mogelijke waarden:
+
* `inkomend` - Inkomend
+
* `intern` - Intern
- * `uitgaand` - Uitgaand
+
+ * `uitgaand` - Uitgaand'
title: richting
statustype:
type: string
format: uri
nullable: true
title: Status type
- description: URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn
+ description:
+ URL-referentie naar het STATUSTYPE waarbij deze INFORMATIEOBJECTTYPEn
verplicht aanwezig moeten zijn.
required:
- - catalogus
- - informatieobjecttype
- - informatieobjecttypeOmschrijving
- - richting
- - url
- - volgnummer
- - zaaktype
- - zaaktypeIdentificatie
+ - catalogus
+ - informatieobjecttype
+ - informatieobjecttypeOmschrijving
+ - richting
+ - url
+ - volgnummer
+ - zaaktype
+ - zaaktypeIdentificatie
ZaakTypeUpdate:
type: object
- description: |-
- Set gegevensgroepdata from validated nested data.
+ description: 'Set gegevensgroepdata from validated nested data.
+
- Usage: include the mixin on the ModelSerializer that has gegevensgroepen.
+ Usage: include the mixin on the ModelSerializer that has gegevensgroepen.'
properties:
url:
type: string
format: uri
readOnly: true
title: url
- description: URL-referentie naar dit object. Dit is de unieke identificatie
+ description:
+ URL-referentie naar dit object. Dit is de unieke identificatie
en locatie van dit object.
minLength: 1
maxLength: 1000
identificatie:
type: string
- description: Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
+ description:
+ Unieke identificatie van het ZAAKTYPE binnen de CATALOGUS waarin
het ZAAKTYPE voorkomt.
title: identificatie
maxLength: 50
@@ -14520,86 +15677,105 @@ components:
maxLength: 80
omschrijvingGeneriek:
type: string
- description: Algemeen gehanteerde omschrijving van de aard van ZAAKen van
+ description:
+ Algemeen gehanteerde omschrijving van de aard van ZAAKen van
het ZAAKTYPE
title: omschrijving generiek
maxLength: 80
vertrouwelijkheidaanduiding:
allOf:
- - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum'
- description: |-
- Aanduiding van de mate waarin zaakdossiers van ZAAKen van dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde gezet.
+ - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum'
+ description:
+ 'Aanduiding van de mate waarin zaakdossiers van ZAAKen van
+ dit ZAAKTYPE voor de openbaarheid bestemd zijn. Indien de zaak bij het
+ aanmaken geen vertrouwelijkheidaanduiding krijgt, dan wordt deze waarde
+ gezet.
+
Uitleg bij mogelijke waarden:
+
* `openbaar` - Openbaar
+
* `beperkt_openbaar` - Beperkt openbaar
+
* `intern` - Intern
+
* `zaakvertrouwelijk` - Zaakvertrouwelijk
+
* `vertrouwelijk` - Vertrouwelijk
+
* `confidentieel` - Confidentieel
+
* `geheim` - Geheim
- * `zeer_geheim` - Zeer geheim
+
+ * `zeer_geheim` - Zeer geheim'
title: vertrouwelijkheidaanduiding
doel:
type: string
- description: Een omschrijving van hetgeen beoogd is te bereiken met een
+ description:
+ Een omschrijving van hetgeen beoogd is te bereiken met een
zaak van dit zaaktype.
title: doel
aanleiding:
type: string
- description: Een omschrijving van de gebeurtenis die leidt tot het starten
+ description:
+ Een omschrijving van de gebeurtenis die leidt tot het starten
van een ZAAK van dit ZAAKTYPE.
title: aanleiding
toelichting:
type: string
- description: Een eventuele toelichting op dit zaaktype, zoals een beschrijving
+ description:
+ Een eventuele toelichting op dit zaaktype, zoals een beschrijving
van het procesverloop op de hoofdlijnen.
title: toelichting
indicatieInternOfExtern:
allOf:
- - $ref: '#/components/schemas/IndicatieInternOfExternEnum'
- description: |-
- Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn die Intern respectievelijk Extern geïnitieerd worden. Indien van beide sprake kan zijn, dan prevaleert de externe initiatie.
-
- Uitleg bij mogelijke waarden:
-
- * `inkomend` - Inkomend
- * `intern` - Intern
- * `uitgaand` - Uitgaand
+ - $ref: '#/components/schemas/IndicatieInternOfExternEnum'
+ description:
+ "Een aanduiding waarmee onderscheid wordt gemaakt tussen ZAAKTYPEn\
+ \ die Intern respectievelijk Extern ge\xEFnitieerd worden. Indien van\
+ \ beide sprake kan zijn, dan prevaleert de externe initiatie.\n\nUitleg\
+ \ bij mogelijke waarden:\n\n* `inkomend` - Inkomend\n* `intern` - Intern\n\
+ * `uitgaand` - Uitgaand"
title: indicatie intern of extern
handelingInitiator:
type: string
- description: Werkwoord dat hoort bij de handeling die de initiator verricht
+ description:
+ Werkwoord dat hoort bij de handeling die de initiator verricht
bij dit zaaktype. Meestal 'aanvragen', 'indienen' of 'melden'. Zie ook
het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_initiator
title: handeling initiator
maxLength: 20
onderwerp:
type: string
- description: 'Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen
+ description:
+ "Het onderwerp van ZAAKen van dit ZAAKTYPE. In veel gevallen
nauw gerelateerd aan de product- of dienstnaam uit de Producten- en Dienstencatalogus
- (PDC). Bijvoorbeeld: ''Evenementenvergunning'', ''Geboorte'', ''Klacht''.
- Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp'
+ (PDC). Bijvoorbeeld: 'Evenementenvergunning', 'Geboorte', 'Klacht'.
+ Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.onderwerp"
title: onderwerp
maxLength: 80
handelingBehandelaar:
type: string
- description: Werkwoord dat hoort bij de handeling die de behandelaar verricht
+ description:
+ Werkwoord dat hoort bij de handeling die de behandelaar verricht
bij het afdoen van ZAAKen van dit ZAAKTYPE. Meestal 'behandelen', 'uitvoeren',
'vaststellen' of 'onderhouden'. Zie ook het IOB model op https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/attribuutsoort/zaaktype.handeling_behandelaar
title: handeling behandelaar
maxLength: 20
doorlooptijd:
type: string
- description: De periode waarbinnen volgens wet- en regelgeving een ZAAK
+ description:
+ De periode waarbinnen volgens wet- en regelgeving een ZAAK
van het ZAAKTYPE afgerond dient te zijn, in kalenderdagen.
title: doorlooptijd behandeling
format: duration
servicenorm:
type: string
nullable: true
- description: De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE
+ description:
+ De periode waarbinnen verwacht wordt dat een ZAAK van het ZAAKTYPE
afgerond wordt conform de geldende servicenormen van de zaakbehandelende
organisatie(s).
title: servicenorm behandeling
@@ -14607,17 +15783,20 @@ components:
opschortingEnAanhoudingMogelijk:
type: boolean
title: Opschorting/aanhouding mogelijk
- description: Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE
+ description:
+ Aanduiding die aangeeft of ZAAKen van dit mogelijk ZAAKTYPE
kunnen worden opgeschort en/of aangehouden.
verlengingMogelijk:
type: boolean
- description: Aanduiding die aangeeft of de Doorlooptijd behandeling van
+ description:
+ Aanduiding die aangeeft of de Doorlooptijd behandeling van
ZAAKen van dit ZAAKTYPE kan worden verlengd.
title: verlenging mogelijk
verlengingstermijn:
type: string
nullable: true
- description: Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling
+ description:
+ Een tijdsduur in ISO 8601 formaat waarmee de Doorlooptijd behandeling
van ZAAKen van dit ZAAKTYPE kan worden verlengd. Mag alleen een waarde
bevatten als verlenging mogelijk is.
title: verlengingstermijn
@@ -14628,12 +15807,14 @@ components:
type: string
title: Trefwoord
maxLength: 30
- description: Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden
+ description:
+ Een trefwoord waarmee ZAAKen van het ZAAKTYPE kunnen worden
gekarakteriseerd.
title: trefwoorden
publicatieIndicatie:
type: boolean
- description: Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd
+ description:
+ Aanduiding of (het starten van) een ZAAK dit ZAAKTYPE gepubliceerd
moet worden.
title: publicatie indicatie
publicatietekst:
@@ -14645,8 +15826,9 @@ components:
items:
type: string
maxLength: 40
- description: De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige
- en/of financiële verantwoording.
+ description:
+ "De relatie tussen ZAAKen van dit ZAAKTYPE en de beleidsmatige\
+ \ en/of financi\xEBle verantwoording."
title: verantwoordingsrelatie
productenOfDiensten:
type: array
@@ -14655,25 +15837,28 @@ components:
format: uri
title: URL naar product/dienst
maxLength: 1000
- description: Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt
+ description:
+ Het product of de dienst die door ZAAKen van dit ZAAKTYPE wordt
voortgebracht.
title: producten of diensten
selectielijstProcestype:
type: string
format: uri
- description: URL-referentie naar een vanuit archiveringsoptiek onderkende
+ description:
+ URL-referentie naar een vanuit archiveringsoptiek onderkende
groep processen met dezelfde kenmerken (PROCESTYPE in de Selectielijst
API).
title: selectielijst procestype
maxLength: 200
referentieproces:
allOf:
- - $ref: '#/components/schemas/ReferentieProces'
+ - $ref: '#/components/schemas/ReferentieProces'
description: Het Referentieproces dat ten grondslag ligt aan dit ZAAKTYPE.
title: referentieproces
verantwoordelijke:
type: string
- description: De (soort) organisatorische eenheid of (functie van) medewerker
+ description:
+ De (soort) organisatorische eenheid of (functie van) medewerker
die verantwoordelijk is voor de uitvoering van zaken van het ZAAKTYPE.
title: verantwoordelijke
maxLength: 50
@@ -14688,12 +15873,12 @@ components:
uniqueItems: true
broncatalogus:
allOf:
- - $ref: '#/components/schemas/BronCatalogus'
+ - $ref: '#/components/schemas/BronCatalogus'
description: De CATALOGUS waaraan het ZAAKTYPE is ontleend.
title: broncatalogus
bronzaaktype:
allOf:
- - $ref: '#/components/schemas/BronZaaktype'
+ - $ref: '#/components/schemas/BronZaaktype'
description: Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend.
title: bronzaaktype
catalogus:
@@ -14708,7 +15893,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen
+ description:
+ URL-referenties naar de STATUSTYPEN die mogelijk zijn binnen
dit ZAAKTYPE.
title: Zaaktype
uniqueItems: true
@@ -14719,7 +15905,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen
+ description:
+ URL-referenties naar de RESULTAATTYPEN die mogelijk zijn binnen
dit ZAAKTYPE.
title: is relevant voor
uniqueItems: true
@@ -14730,7 +15917,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn
+ description:
+ URL-referenties naar de EIGENSCHAPPEN die aanwezig moeten zijn
in ZAKEN van dit ZAAKTYPE.
title: Zaaktype
uniqueItems: true
@@ -14741,7 +15929,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de INFORMATIEOBJECTTYPEN die mogelijk
+ description:
+ URL-referenties naar de INFORMATIEOBJECTTYPEN die mogelijk
zijn binnen dit ZAAKTYPE.
title: zaaktypen
uniqueItems: true
@@ -14752,7 +15941,8 @@ components:
format: uri
title: ''
readOnly: true
- description: URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit
+ description:
+ URL-referenties naar de ROLTYPEN die mogelijk zijn binnen dit
ZAAKTYPE.
title: Zaaktype
uniqueItems: true
@@ -14761,7 +15951,8 @@ components:
items:
type: string
title: ''
- description: '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen
+ description:
+ '`Omschrijvingen` van BESLUITTYPEN die mogelijk zijn binnen
dit ZAAKTYPE.'
title: zaaktypen
deelzaaktypen:
@@ -14769,14 +15960,16 @@ components:
items:
type: string
title: ''
- description: De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak
+ description:
+ De `zaaktypen.identificaties` waaronder ZAAKen als deelzaak
kunnen voorkomen bij ZAAKen van dit ZAAKTYPE.
title: deelzaaktypen
gerelateerdeZaaktypen:
type: array
items:
$ref: '#/components/schemas/ZaakTypenRelatieCreate'
- description: De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit
+ description:
+ De ZAAKTYPEn van zaken die relevant zijn voor zaken van dit
ZAAKTYPE.
title: zaaktype van
beginGeldigheid:
@@ -14805,68 +15998,76 @@ components:
versiedatum:
type: string
format: date
- description: De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE
+ description:
+ De datum waarop de (gewijzigde) kenmerken van het ZAAKTYPE
geldig zijn geworden
title: versiedatum
concept:
type: boolean
readOnly: true
- description: Geeft aan of het object een concept betreft. Concepten zijn
+ description:
+ Geeft aan of het object een concept betreft. Concepten zijn
niet-definitieve versies en zouden niet gebruikt moeten worden buiten
deze API.
title: concept
required:
- - aanleiding
- - beginGeldigheid
- - besluittypen
- - catalogus
- - concept
- - deelzaaktypen
- - doel
- - doorlooptijd
- - eigenschappen
- - gerelateerdeZaaktypen
- - handelingBehandelaar
- - handelingInitiator
- - identificatie
- - indicatieInternOfExtern
- - informatieobjecttypen
- - omschrijving
- - onderwerp
- - opschortingEnAanhoudingMogelijk
- - productenOfDiensten
- - publicatieIndicatie
- - referentieproces
- - resultaattypen
- - roltypen
- - statustypen
- - url
- - verantwoordelijke
- - verlengingMogelijk
- - versiedatum
- - vertrouwelijkheidaanduiding
- - zaakobjecttypen
+ - aanleiding
+ - beginGeldigheid
+ - besluittypen
+ - catalogus
+ - concept
+ - deelzaaktypen
+ - doel
+ - doorlooptijd
+ - eigenschappen
+ - gerelateerdeZaaktypen
+ - handelingBehandelaar
+ - handelingInitiator
+ - identificatie
+ - indicatieInternOfExtern
+ - informatieobjecttypen
+ - omschrijving
+ - onderwerp
+ - opschortingEnAanhoudingMogelijk
+ - productenOfDiensten
+ - publicatieIndicatie
+ - referentieproces
+ - resultaattypen
+ - roltypen
+ - statustypen
+ - url
+ - verantwoordelijke
+ - verlengingMogelijk
+ - versiedatum
+ - vertrouwelijkheidaanduiding
+ - zaakobjecttypen
ZaakTypenRelatie:
type: object
properties:
zaaktype:
type: string
format: uri
- description: URL referentie naar het gerelateerde zaaktype, mogelijks in
+ description:
+ URL referentie naar het gerelateerde zaaktype, mogelijks in
een extern ZTC.
title: gerelateerd zaaktype
maxLength: 200
aardRelatie:
allOf:
- - $ref: '#/components/schemas/AardRelatieEnum'
- description: |-
- Omschrijving van de aard van de relatie van zaken van het ZAAKTYPE tot zaken van het andere ZAAKTYPE
+ - $ref: '#/components/schemas/AardRelatieEnum'
+ description:
+ 'Omschrijving van de aard van de relatie van zaken van het
+ ZAAKTYPE tot zaken van het andere ZAAKTYPE
+
Uitleg bij mogelijke waarden:
+
* `vervolg` - Vervolg
+
* `bijdrage` - Bijdrage
- * `onderwerp` - Onderwerp
+
+ * `onderwerp` - Onderwerp'
title: aard relatie
toelichting:
type: string
@@ -14874,8 +16075,8 @@ components:
title: toelichting
maxLength: 255
required:
- - aardRelatie
- - zaaktype
+ - aardRelatie
+ - zaaktype
ZaakTypenRelatieCreate:
type: object
properties:
@@ -14885,15 +16086,20 @@ components:
title: zaaktype van
aardRelatie:
allOf:
- - $ref: '#/components/schemas/AardRelatieEnum'
- description: |-
- Omschrijving van de aard van de relatie van zaken van het ZAAKTYPE tot zaken van het andere ZAAKTYPE
+ - $ref: '#/components/schemas/AardRelatieEnum'
+ description:
+ 'Omschrijving van de aard van de relatie van zaken van het
+ ZAAKTYPE tot zaken van het andere ZAAKTYPE
+
Uitleg bij mogelijke waarden:
+
* `vervolg` - Vervolg
+
* `bijdrage` - Bijdrage
- * `onderwerp` - Onderwerp
+
+ * `onderwerp` - Onderwerp'
title: aard relatie
toelichting:
type: string
@@ -14901,52 +16107,61 @@ components:
title: toelichting
maxLength: 255
required:
- - aardRelatie
- - zaaktype
+ - aardRelatie
+ - zaaktype
securitySchemes:
JWT-Claims:
type: http
bearerFormat: JWT
scheme: bearer
servers:
-- url: https://catalogi-api.vng.cloud/api/v1
- description: Productie Omgeving
+ - url: https://catalogi-api.vng.cloud/api/v1
+ description: Productie Omgeving
tags:
-- name: besluittypen
- description: Opvragen en bewerken van BESLUITTYPEn nodig voor BESLUITEN in de Besluiten
- API. Alle BESLUITTYPEn van de besluiten die het resultaat kunnen zijn van het
- zaakgericht werken van de behandelende organisatie(s).
-- name: catalogussen
- description: Opvragen en bewerken van CATALOGUSsen. De verzameling van ZAAKTYPEn,
- INFORMATIEOBJECTTYPEn en BESLUITTYPEn voor een domein die als één geheel beheerd
- wordt.
-- name: eigenschappen
- description: Opvragen en bewerken van EIGENSCHAPpen van een ZAAKTYPE. Een relevant
- inhoudelijk gegeven dat bij ZAAKen van dit ZAAKTYPE geregistreerd moet kunnen
- worden en geen standaard kenmerk is van een zaak.
-- name: informatieobjecttypen
- description: Opvragen en bewerken van INFORMATIEOBJECTTYPEn nodig voor INFORMATIEOBJECTen
- in de Documenten API. Een INFORMATIEOBJECTTYPE beschijft de karakteristieken van
- een document of ander object dat informatie bevat.
-- name: resultaattypen
- description: Opvragen en bewerken van RESULTAATTYPEn van een ZAAKTYPE. Het betreft
- de indeling of groepering van resultaten van zaken van hetzelfde ZAAKTYPE naar
- hun aard, zoals 'verleend', 'geweigerd', 'verwerkt', etc.
-- name: roltypen
- description: Opvragen en bewerken van ROLTYPEn van een ZAAKTYPE. Generieke aanduiding
- van de aard van een ROL die een BETROKKENE kan uitoefenen in ZAAKen van een ZAAKTYPE.
-- name: statustypen
- description: Opvragen en bewerken van STATUSTYPEn van een ZAAKTYPE. Generieke aanduiding
- van de aard van een status.
-- name: zaakobjecttypen
- description: |-
- Opvragen en bewerken van ZAAKOBJECTTYPEn. Er wordt gevalideerd op:
- - `zaaktype` behoort tot dezelfde `catalogus`
-- name: zaaktype-informatieobjecttypen
- description: Opvragen en bewerken van ZAAKTYPE-INFORMATIEOBJECTTYPE relaties. Geeft
- aan welke INFORMATIEOBJECTTYPEn binnen een ZAAKTYPE mogelijk zijn en hoe de richting
- is.
-- name: zaaktypen
- description: Opvragen en bewerken van ZAAKTYPEn nodig voor ZAKEN in de Zaken API.Een
- ZAAKTYPE beschrijft het geheel van karakteristieke eigenschappen van zaken van
- eenzelfde soort.
+ - name: besluittypen
+ description:
+ Opvragen en bewerken van BESLUITTYPEn nodig voor BESLUITEN in de Besluiten
+ API. Alle BESLUITTYPEn van de besluiten die het resultaat kunnen zijn van het
+ zaakgericht werken van de behandelende organisatie(s).
+ - name: catalogussen
+ description:
+ "Opvragen en bewerken van CATALOGUSsen. De verzameling van ZAAKTYPEn,\
+ \ INFORMATIEOBJECTTYPEn en BESLUITTYPEn voor een domein die als \xE9\xE9n geheel\
+ \ beheerd wordt."
+ - name: eigenschappen
+ description:
+ Opvragen en bewerken van EIGENSCHAPpen van een ZAAKTYPE. Een relevant
+ inhoudelijk gegeven dat bij ZAAKen van dit ZAAKTYPE geregistreerd moet kunnen
+ worden en geen standaard kenmerk is van een zaak.
+ - name: informatieobjecttypen
+ description:
+ Opvragen en bewerken van INFORMATIEOBJECTTYPEn nodig voor INFORMATIEOBJECTen
+ in de Documenten API. Een INFORMATIEOBJECTTYPE beschijft de karakteristieken van
+ een document of ander object dat informatie bevat.
+ - name: resultaattypen
+ description:
+ Opvragen en bewerken van RESULTAATTYPEn van een ZAAKTYPE. Het betreft
+ de indeling of groepering van resultaten van zaken van hetzelfde ZAAKTYPE naar
+ hun aard, zoals 'verleend', 'geweigerd', 'verwerkt', etc.
+ - name: roltypen
+ description:
+ Opvragen en bewerken van ROLTYPEn van een ZAAKTYPE. Generieke aanduiding
+ van de aard van een ROL die een BETROKKENE kan uitoefenen in ZAAKen van een ZAAKTYPE.
+ - name: statustypen
+ description:
+ Opvragen en bewerken van STATUSTYPEn van een ZAAKTYPE. Generieke aanduiding
+ van de aard van een status.
+ - name: zaakobjecttypen
+ description:
+ "Opvragen en bewerken van ZAAKOBJECTTYPEn. Er wordt gevalideerd op:\n\
+ \ - `zaaktype` behoort tot dezelfde `catalogus`"
+ - name: zaaktype-informatieobjecttypen
+ description:
+ Opvragen en bewerken van ZAAKTYPE-INFORMATIEOBJECTTYPE relaties. Geeft
+ aan welke INFORMATIEOBJECTTYPEn binnen een ZAAKTYPE mogelijk zijn en hoe de richting
+ is.
+ - name: zaaktypen
+ description:
+ Opvragen en bewerken van ZAAKTYPEn nodig voor ZAKEN in de Zaken API.Een
+ ZAAKTYPE beschrijft het geheel van karakteristieke eigenschappen van zaken van
+ eenzelfde soort.
diff --git a/src/resources.md b/src/resources.md
index 9a711e3a..f151ce78 100644
--- a/src/resources.md
+++ b/src/resources.md
@@ -12,7 +12,7 @@ Objecttype op [GEMMA Online](https://www.gemmaonline.nl/index.php/Imztc_2.1/doc/
| --- | --- | --- | --- | --- |
| url | URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. | string | ja | ~~C~~R~~U~~~~D~~ |
| catalogus | URL-referentie naar de CATALOGUS waartoe dit BESLUITTYPE behoort. | string | ja | CRUD |
-| zaaktypen | ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE | array | ja | CRUD |
+| zaaktypen | ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit BESLUITTYPE | array | ja | ~~C~~R~~U~~~~D~~ |
| omschrijving | Omschrijving van de aard van BESLUITen van het BESLUITTYPE. | string | nee | CRUD |
| omschrijvingGeneriek | Algemeen gehanteerde omschrijving van de aard van BESLUITen van het BESLUITTYPE | string | nee | CRUD |
| besluitcategorie | Typering van de aard van BESLUITen van het BESLUITTYPE. | string | nee | CRUD |
diff --git a/src/ztc/api/filters.py b/src/ztc/api/filters.py
index d3eef84c..117921d7 100644
--- a/src/ztc/api/filters.py
+++ b/src/ztc/api/filters.py
@@ -32,7 +32,7 @@
DATUM_GELDIGHEID_HELP_TEXT = "filter objecten op hun geldigheids datum."
-def get_objects_between_geldigheid_dates(queryset, name, value):
+def get_objects_between_geldigheid_dates(queryset, name, value, *args, **kwargs):
qs_old_version = queryset.filter(
datum_begin_geldigheid__lte=value, datum_einde_geldigheid__gte=value
)
@@ -42,6 +42,11 @@ def get_objects_between_geldigheid_dates(queryset, name, value):
return qs_old_version
+def detail_filter(queryset, name, value):
+ """filtering is handled in the viewset"""
+ return queryset
+
+
def status_filter(queryset, name, value):
if value == "concept":
return queryset.filter(**{name: True})
@@ -100,14 +105,9 @@ class Meta:
def status_filter_m2m(self, queryset, name, value):
if value == "concept":
- return queryset.filter(
- models.Q(zaaktype__concept=True)
- | models.Q(informatieobjecttype__concept=True)
- )
+ return queryset.filter(models.Q(zaaktype__concept=True))
elif value == "definitief":
- return queryset.filter(
- zaaktype__concept=False, informatieobjecttype__concept=False
- )
+ return queryset.filter(zaaktype__concept=False)
elif value == "alles":
return queryset
@@ -183,6 +183,17 @@ class Meta:
)
+class ZaakTypeDetailFilter(FilterSet):
+ datum_geldigheid = filters.DateFilter(
+ method=detail_filter,
+ help_text=DATUM_GELDIGHEID_HELP_TEXT,
+ )
+
+ class Meta:
+ model = ZaakType
+ fields = ("datum_geldigheid",)
+
+
class ZaakObjectTypeFilter(FilterSet):
datum_geldigheid = filters.DateFilter(
method=get_objects_between_geldigheid_dates,
diff --git a/src/ztc/api/serializers/informatieobjecttype.py b/src/ztc/api/serializers/informatieobjecttype.py
index 09f08edb..d679e3f5 100644
--- a/src/ztc/api/serializers/informatieobjecttype.py
+++ b/src/ztc/api/serializers/informatieobjecttype.py
@@ -3,10 +3,13 @@
from rest_framework import serializers
from vng_api_common.constants import VertrouwelijkheidsAanduiding
from vng_api_common.serializers import add_choice_values_help_text
+from vng_api_common.tests import reverse
from ...datamodel.models import (
InformatieObjectType,
InformatieObjectTypeOmschrijvingGeneriek,
+ ZaakInformatieobjectType,
+ ZaakType,
)
from ..validators import ConceptUpdateValidator
@@ -23,6 +26,12 @@ class Meta:
)
+class ZaakInformatieobjectTypeSlugSerializer(serializers.ModelSerializer):
+ class Meta:
+ model = ZaakInformatieobjectType
+ fields = ["zaaktype"]
+
+
class InformatieObjectTypeSerializer(serializers.HyperlinkedModelSerializer):
"""
Serializer based on ``IOT-basis`` specified in XSD ``ztc0310_ent_basis.xsd``.
@@ -32,6 +41,25 @@ class InformatieObjectTypeSerializer(serializers.HyperlinkedModelSerializer):
required=False
)
+ zaaktypen = serializers.SerializerMethodField()
+
+ def get_zaaktypen(self, obj):
+ q1 = ZaakInformatieobjectType.objects.filter(
+ informatieobjecttype=obj.omschrijving
+ )
+ serializer = ZaakInformatieobjectTypeSlugSerializer(q1, many=True)
+ request = self.context.get("request")
+ return_list = []
+ for odict in serializer.data:
+ for key, value in odict.items():
+ related_model = ZaakType.objects.get(id=value)
+ return_list.append(
+ request.build_absolute_uri(
+ reverse("zaaktype-detail", kwargs={"uuid": related_model.uuid})
+ )
+ )
+ return return_list
+
class Meta:
model = InformatieObjectType
extra_kwargs = {
@@ -42,14 +70,6 @@ class Meta:
"begin_object": {"source": "datum_begin_object"},
"einde_object": {"source": "datum_einde_object"},
"concept": {"read_only": True},
- "zaaktypen": {
- "lookup_field": "uuid",
- "read_only": True,
- "help_text": _(
- "URL-referenties naar De INFORMATIEOBJECTTYPEn die relevant"
- " kunnen zijn voor ZAAKen van dit ZAAKTYPE."
- ),
- },
"besluittypen": {
"lookup_field": "uuid",
"read_only": True,
diff --git a/src/ztc/api/serializers/relatieklassen.py b/src/ztc/api/serializers/relatieklassen.py
index 7a406584..70feb4ac 100644
--- a/src/ztc/api/serializers/relatieklassen.py
+++ b/src/ztc/api/serializers/relatieklassen.py
@@ -24,14 +24,14 @@ class ZaakTypeInformatieObjectTypeSerializer(serializers.HyperlinkedModelSeriali
),
)
- informatieobjecttype_omschrijving = serializers.SlugRelatedField(
- source="informatieobjecttype",
- read_only=True,
- slug_field="omschrijving",
- help_text=_(
- "Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE."
- ),
- )
+ # informatieobjecttype_omschrijving = serializers.SlugRelatedField(
+ # source="informatieobjecttype",
+ # read_only=True,
+ # slug_field="omschrijving",
+ # help_text=_(
+ # "Omschrijving van de aard van informatieobjecten van dit INFORMATIEOBJECTTYPE."
+ # ),
+ # )
catalogus = serializers.HyperlinkedRelatedField(
source="zaaktype.catalogus",
@@ -48,7 +48,7 @@ class Meta:
"zaaktype_identificatie",
"catalogus",
"informatieobjecttype",
- "informatieobjecttype_omschrijving",
+ # "informatieobjecttype_omschrijving",
"volgnummer",
"richting",
"statustype",
@@ -56,12 +56,12 @@ class Meta:
extra_kwargs = {
"url": {"lookup_field": "uuid"},
"zaaktype": {"lookup_field": "uuid"},
- "informatieobjecttype": {"lookup_field": "uuid"},
+ # "informatieobjecttype": {"lookup_field": "uuid"},
"statustype": {"lookup_field": "uuid"},
}
- validators = [
- ZaakInformatieObjectTypeCatalogusValidator(),
- ]
+ # validators = [
+ # ZaakInformatieObjectTypeCatalogusValidator(),
+ # ]
def __init__(self, *args, **kwargs):
super().__init__(*args, **kwargs)
@@ -75,25 +75,14 @@ def validate(self, attrs):
if self.instance:
zaaktype = validated_data.get("zaaktype") or self.instance.zaaktype
- informatieobjecttype = (
- validated_data.get("informatieobjecttype")
- or self.instance.informatieobjecttype
- )
-
- if (
- not (zaaktype.concept or informatieobjecttype.concept)
- and not allow_action_with_force
- ):
+
+ if not zaaktype.concept and not allow_action_with_force:
message = _("Objects related to non-concept objects can't be updated")
raise serializers.ValidationError(message, code="non-concept-relation")
else:
zaaktype = validated_data.get("zaaktype")
- informatieobjecttype = validated_data.get("informatieobjecttype")
- if (
- not (zaaktype.concept or informatieobjecttype.concept)
- and not allow_action_with_force
- ):
+ if not zaaktype.concept and not allow_action_with_force:
message = _(
"Creating relations between non-concept objects is forbidden"
)
diff --git a/src/ztc/api/serializers/zaken.py b/src/ztc/api/serializers/zaken.py
index c8782193..aff551e6 100644
--- a/src/ztc/api/serializers/zaken.py
+++ b/src/ztc/api/serializers/zaken.py
@@ -10,17 +10,21 @@
NestedGegevensGroepMixin,
add_choice_values_help_text,
)
+from vng_api_common.tests import reverse
from vng_api_common.validators import ResourceValidator
from ...datamodel.choices import AardRelatieChoices, RichtingChoices
-from ...datamodel.models import ZaakType, ZaakTypenRelatie
+from ...datamodel.models import (
+ InformatieObjectType,
+ ZaakInformatieobjectType,
+ ZaakType,
+ ZaakTypenRelatie,
+)
from ..utils.validators import RelationCatalogValidator
from ..validators import (
ConceptUpdateValidator,
DeelzaaktypeCatalogusValidator,
- M2MConceptCreateValidator,
- M2MConceptUpdateValidator,
- ZaaktypeGeldigheidValidator,
+ ZaaktypeDoubleConceptValidator,
)
@@ -61,6 +65,12 @@ class ZaakTypenRelatieCreateSerializer(ZaakTypenRelatieSerializer):
)
+class ZaakInformatieobjectTypeSlugSerializer(serializers.ModelSerializer):
+ class Meta:
+ model = ZaakInformatieobjectType
+ fields = ["informatieobjecttype"]
+
+
class ZaakTypeSerializer(
NestedGegevensGroepMixin,
NestedCreateMixin,
@@ -87,6 +97,25 @@ class ZaakTypeSerializer(
"Het zaaktype binnen de CATALOGUS waaraan dit ZAAKTYPE is ontleend."
),
)
+ informatieobjecttypen = serializers.SerializerMethodField()
+
+ def get_informatieobjecttypen(self, obj):
+ request = self.context.get("request")
+ q1 = ZaakInformatieobjectType.objects.filter(zaaktype=obj)
+ serializer = ZaakInformatieobjectTypeSlugSerializer(q1, many=True)
+ filter_list = []
+ return_list = []
+ for odict in serializer.data:
+ for key, value in odict.items():
+ filter_list.append(value)
+ q2 = InformatieObjectType.objects.filter(omschrijving__in=filter_list)
+ for obj in q2:
+ return_list.append(
+ request.build_absolute_uri(
+ reverse("informatieobjecttype-detail", kwargs={"uuid": obj.uuid})
+ )
+ )
+ return return_list
class Meta:
model = ZaakType
@@ -154,13 +183,13 @@ class Meta:
ResourceValidator("ProcesType", settings.REFERENTIELIJSTEN_API_SPEC)
]
},
- "informatieobjecttypen": {
- "read_only": True,
- "lookup_field": "uuid",
- "help_text": _(
- "URL-referenties naar de INFORMATIEOBJECTTYPEN die mogelijk zijn binnen dit ZAAKTYPE."
- ),
- },
+ # "informatieobjecttypen": {
+ # "read_only": True,
+ # "lookup_field": "uuid",
+ # "help_text": _(
+ # "URL-referenties naar de INFORMATIEOBJECTTYPEN die mogelijk zijn binnen dit ZAAKTYPE."
+ # ),
+ # },
"besluittypen": {
"label": _("heeft relevante besluittypen"),
"lookup_field": "uuid",
@@ -207,7 +236,7 @@ class Meta:
}
validators = [
- ZaaktypeGeldigheidValidator(),
+ ZaaktypeDoubleConceptValidator(),
RelationCatalogValidator("besluittypen"),
ConceptUpdateValidator(),
DeelzaaktypeCatalogusValidator(),
diff --git a/src/ztc/api/tests/test_auth.py b/src/ztc/api/tests/test_auth.py
index d88ae1a7..1fee0392 100644
--- a/src/ztc/api/tests/test_auth.py
+++ b/src/ztc/api/tests/test_auth.py
@@ -110,7 +110,7 @@ def test_force_delete_informatieobjecttype_related_to_non_concept_zaaktype(self)
zaaktype = ZaakTypeFactory.create(concept=False)
ZaakInformatieobjectTypeFactory(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
+ zaaktype=zaaktype, informatieobjecttype=informatieobjecttype.omschrijving
)
informatieobjecttype_url = reverse(informatieobjecttype)
@@ -212,10 +212,10 @@ def test_force_delete_zaaktype_related_to_non_concept_informatieobjecttype(self)
zaaktype_url = reverse(zaaktype)
informatieobjecttype = InformatieObjectTypeFactory.create(
- catalogus=catalogus, concept=False, zaaktypen=[]
+ catalogus=catalogus, concept=False
)
ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
+ zaaktype=zaaktype, informatieobjecttype=informatieobjecttype.omschrijving
)
response = self.client.delete(zaaktype_url)
diff --git a/src/ztc/api/tests/test_besluittype.py b/src/ztc/api/tests/test_besluittype.py
index c0acb58a..2ef58526 100644
--- a/src/ztc/api/tests/test_besluittype.py
+++ b/src/ztc/api/tests/test_besluittype.py
@@ -57,13 +57,16 @@ def test_get_detail(self):
catalogus=self.catalogus, datum_begin_geldigheid="2018-01-01"
)
- resultaattype = ResultaatTypeFactory(zaaktype=zaaktype)
+ resultaattype = ResultaatTypeFactory(
+ zaaktype=zaaktype, datum_begin_geldigheid="2018-01-01"
+ )
besluittype = BesluitTypeFactory(
catalogus=self.catalogus,
zaaktypen=[zaaktype],
resultaattypen=[resultaattype],
publicatie_indicatie=True,
+ datum_begin_geldigheid="2018-01-01",
)
zaaktype_url = reverse("zaaktype-detail", kwargs={"uuid": zaaktype.uuid})
diff --git a/src/ztc/api/tests/test_filters.py b/src/ztc/api/tests/test_filters.py
index ee54843f..130096d5 100644
--- a/src/ztc/api/tests/test_filters.py
+++ b/src/ztc/api/tests/test_filters.py
@@ -90,7 +90,6 @@ def test_filter_by_invalid_url(self):
def test_filter_by_valid_url_object_does_not_exist(self):
informatieobjecttype = InformatieObjectTypeFactory.create(concept=False)
- informatieobjecttype.zaaktypen.clear()
response = self.client.get(
reverse(InformatieObjectType), {"catalogus": "https://google.com"}
@@ -173,7 +172,7 @@ class ZaakInformatieobjectTypeFilterTests(APITestCase):
heeft_alle_autorisaties = True
def test_filter_by_invalid_url(self):
- for query_param in ["zaaktype", "informatieobjecttype"]:
+ for query_param in ["zaaktype"]:
with self.subTest(query_param=query_param):
response = self.client.get(
reverse(ZaakInformatieobjectType), {query_param: "bla"}
@@ -215,7 +214,6 @@ def test_filter_by_invalid_url(self):
def test_filter_by_valid_url_object_does_not_exist(self):
zaaktype = ZaakTypeFactory.create(concept=False)
- zaaktype.informatieobjecttypen.clear()
response = self.client.get(
reverse(ZaakType), {"catalogus": "https://google.com"}
diff --git a/src/ztc/api/tests/test_informatieobjecttype.py b/src/ztc/api/tests/test_informatieobjecttype.py
index 76d89e28..2a2627cf 100644
--- a/src/ztc/api/tests/test_informatieobjecttype.py
+++ b/src/ztc/api/tests/test_informatieobjecttype.py
@@ -57,7 +57,6 @@ def test_get_detail(self):
besluittype = BesluitTypeFactory(catalogus=self.catalogus)
informatieobjecttype = InformatieObjectTypeFactory(
catalogus=self.catalogus,
- zaaktypen=None,
model=["http://www.example.com"],
trefwoord=["abc", "def"],
datum_begin_geldigheid="2019-01-01",
@@ -65,9 +64,13 @@ def test_get_detail(self):
)
zaaktype = ZaakTypeFactory(catalogus=self.catalogus)
+ zaaktype2 = ZaakTypeFactory(catalogus=self.catalogus)
ZaakInformatieobjectTypeFactory(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
+ zaaktype=zaaktype, informatieobjecttype=informatieobjecttype.omschrijving
+ )
+ ZaakInformatieobjectTypeFactory(
+ zaaktype=zaaktype2, informatieobjecttype=informatieobjecttype.omschrijving
)
informatieobjecttype_detail_url = get_operation_url(
@@ -88,7 +91,10 @@ def test_get_detail(self):
"concept": True,
"informatieobjectcategorie": "informatieobjectcategorie",
"trefwoord": ["abc", "def"],
- "zaaktypen": [f"http://testserver{reverse(zaaktype)}"],
+ "zaaktypen": [
+ f"http://testserver{reverse(zaaktype)}",
+ f"http://testserver{reverse(zaaktype2)}",
+ ],
"besluittypen": [f"http://testserver{reverse(besluittype)}"],
"beginObject": None,
"eindeObject": None,
@@ -101,6 +107,9 @@ def test_get_detail(self):
},
}
self.assertEqual(expected, response.json())
+ from pprint import pprint
+
+ pprint(response.json())
@skip("Not MVP yet")
def test_is_relevant_voor(self):
@@ -120,7 +129,7 @@ def test_is_relevant_voor(self):
ziot = ZaakInformatieobjectTypeFactory.create(
zaaktype=zaaktype,
- informatieobjecttype=informatieobjecttype,
+ informatieobjecttype=informatieobjecttype.omschrijving,
volgnummer=1,
richting="richting",
)
@@ -270,7 +279,7 @@ def test_delete_informatieobjecttype_not_related_to_non_concept_zaaktype(self):
zaaktype = ZaakTypeFactory.create()
ZaakInformatieobjectTypeFactory(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
+ zaaktype=zaaktype, informatieobjecttype=informatieobjecttype.omschrijving
)
informatieobjecttype_url = reverse(informatieobjecttype)
@@ -294,23 +303,6 @@ def test_delete_informatieobjecttype_not_related_to_non_concept_besluittype(self
self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT)
self.assertFalse(InformatieObjectType.objects.exists())
- def test_delete_informatieobjecttype_related_to_non_concept_zaaktype_fails(self):
- informatieobjecttype = InformatieObjectTypeFactory.create()
-
- zaaktype = ZaakTypeFactory.create(concept=False)
- ZaakInformatieobjectTypeFactory(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
- )
-
- informatieobjecttype_url = reverse(informatieobjecttype)
-
- response = self.client.delete(informatieobjecttype_url)
-
- self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
-
- error = get_validation_errors(response, "nonFieldErrors")
- self.assertEqual(error["code"], "non-concept-relation")
-
def test_delete_informatieobjecttype_related_to_non_concept_besluittype_fails(self):
informatieobjecttype = InformatieObjectTypeFactory.create()
@@ -333,7 +325,7 @@ def test_update_informatieobjecttype_not_related_to_non_concept_zaaktype(self):
zaaktype = ZaakTypeFactory.create(catalogus=catalogus)
ZaakInformatieobjectTypeFactory(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
+ zaaktype=zaaktype, informatieobjecttype=informatieobjecttype.omschrijving
)
informatieobjecttype_url = reverse(informatieobjecttype)
@@ -383,7 +375,7 @@ def test_partial_update_informatieobjecttype_not_related_to_non_concept_zaaktype
informatieobjecttype = InformatieObjectTypeFactory.create(catalogus=catalogus)
zaaktype = ZaakTypeFactory.create(catalogus=catalogus)
ZaakInformatieobjectTypeFactory(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
+ zaaktype=zaaktype, informatieobjecttype=informatieobjecttype.omschrijving
)
informatieobjecttype_url = reverse(informatieobjecttype)
@@ -430,7 +422,7 @@ def test_partial_update_informatieobjecttype_einde_geldigheid_related_to_non_con
informatieobjecttype = InformatieObjectTypeFactory.create(catalogus=catalogus)
zaaktype = ZaakTypeFactory.create(catalogus=catalogus, concept=False)
ZaakInformatieobjectTypeFactory(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
+ zaaktype=zaaktype, informatieobjecttype=informatieobjecttype.omschrijving
)
informatieobjecttype_url = reverse(informatieobjecttype)
diff --git a/src/ztc/api/tests/test_relatieklassen.py b/src/ztc/api/tests/test_relatieklassen.py
index 43f73411..f86653bb 100644
--- a/src/ztc/api/tests/test_relatieklassen.py
+++ b/src/ztc/api/tests/test_relatieklassen.py
@@ -34,18 +34,10 @@ class ZaakInformatieobjectTypeAPITests(APITestCase):
list_url = reverse_lazy(ZaakInformatieobjectType)
def test_get_list_default_definitief(self):
- ziot1 = ZaakInformatieobjectTypeFactory.create(
- zaaktype__concept=True, informatieobjecttype__concept=True
- )
- ziot2 = ZaakInformatieobjectTypeFactory.create(
- zaaktype__concept=False, informatieobjecttype__concept=True
- )
- ziot3 = ZaakInformatieobjectTypeFactory.create(
- zaaktype__concept=True, informatieobjecttype__concept=False
- )
- ziot4 = ZaakInformatieobjectTypeFactory.create(
- zaaktype__concept=False, informatieobjecttype__concept=False
- )
+ ziot1 = ZaakInformatieobjectTypeFactory.create(zaaktype__concept=True)
+ ziot2 = ZaakInformatieobjectTypeFactory.create(zaaktype__concept=True)
+ ziot3 = ZaakInformatieobjectTypeFactory.create(zaaktype__concept=True)
+ ziot4 = ZaakInformatieobjectTypeFactory.create(zaaktype__concept=False)
ziot4_url = reverse(ziot4)
response = self.client.get(self.list_url)
@@ -60,7 +52,6 @@ def test_get_detail(self):
ztiot = ZaakInformatieobjectTypeFactory.create()
url = reverse(ztiot)
zaaktype_url = reverse(ztiot.zaaktype)
- informatieobjecttype_url = reverse(ztiot.informatieobjecttype)
response = self.client.get(url)
self.assertEqual(response.status_code, 200)
@@ -69,8 +60,7 @@ def test_get_detail(self):
"url": f"http://testserver{url}",
"zaaktype": f"http://testserver{zaaktype_url}",
"zaaktypeIdentificatie": ztiot.zaaktype.identificatie,
- "informatieobjecttype": f"http://testserver{informatieobjecttype_url}",
- "informatieobjecttypeOmschrijving": ztiot.informatieobjecttype.omschrijving,
+ "informatieobjecttype": f"{ztiot.informatieobjecttype}",
"volgnummer": ztiot.volgnummer,
"richting": ztiot.richting,
"statustype": None,
@@ -84,10 +74,7 @@ def test_create_ziot(self):
informatieobjecttype = InformatieObjectTypeFactory.create(
catalogus=zaaktype.catalogus, omschrijving="test"
)
- informatieobjecttype2 = InformatieObjectTypeFactory.create(
- catalogus=zaaktype.catalogus, omschrijving="test"
- )
- informatieobjecttype_url = reverse(informatieobjecttype)
+
data = {
"zaaktype": f"http://testserver{zaaktype_url}",
"informatieobjecttype": "test",
@@ -102,33 +89,12 @@ def test_create_ziot(self):
ziot = ZaakInformatieobjectType.objects.filter(volgnummer=13)[0]
self.assertEqual(ziot.zaaktype, zaaktype)
- self.assertEqual(ziot.informatieobjecttype, informatieobjecttype)
+ self.assertEqual(ziot.informatieobjecttype, informatieobjecttype.omschrijving)
- def test_create_ziot_not_concept_zaaktype(self):
- zaaktype = ZaakTypeFactory.create(concept=False)
+ def test_create_ziot_concept_zaaktype(self):
+ zaaktype = ZaakTypeFactory.create(concept=True)
zaaktype_url = reverse(zaaktype)
- informatieobjecttype = InformatieObjectTypeFactory.create(
- catalogus=zaaktype.catalogus, omschrijving="test"
- )
- informatieobjecttype_url = reverse(informatieobjecttype)
- data = {
- "zaaktype": f"http://testserver{zaaktype_url}",
- "informatieobjecttype": "test",
- "volgnummer": 13,
- "richting": RichtingChoices.inkomend,
- }
-
- response = self.client.post(self.list_url, data)
-
- self.assertEqual(response.status_code, status.HTTP_201_CREATED)
- def test_create_ziot_not_concept_informatieobjecttype(self):
- zaaktype = ZaakTypeFactory.create()
- zaaktype_url = reverse(zaaktype)
- informatieobjecttype = InformatieObjectTypeFactory.create(
- concept=False, catalogus=zaaktype.catalogus, omschrijving="test"
- )
- informatieobjecttype_url = reverse(informatieobjecttype)
data = {
"zaaktype": f"http://testserver{zaaktype_url}",
"informatieobjecttype": "test",
@@ -140,13 +106,9 @@ def test_create_ziot_not_concept_informatieobjecttype(self):
self.assertEqual(response.status_code, status.HTTP_201_CREATED)
- def test_create_ziot_fail_not_concept_zaaktype_and_informatieobjecttype(self):
+ def test_create_ziot_fail_not_concept_zaaktype(self):
zaaktype = ZaakTypeFactory.create(concept=False)
zaaktype_url = reverse(zaaktype)
- informatieobjecttype = InformatieObjectTypeFactory.create(
- concept=False, catalogus=zaaktype.catalogus, omschrijving="test"
- )
- informatieobjecttype_url = reverse(informatieobjecttype)
data = {
"zaaktype": f"http://testserver{zaaktype_url}",
"informatieobjecttype": "test",
@@ -161,27 +123,6 @@ def test_create_ziot_fail_not_concept_zaaktype_and_informatieobjecttype(self):
error = get_validation_errors(response, "nonFieldErrors")
self.assertEqual(error["code"], "non-concept-relation")
- def test_create_ziot_fail_catalogus_mismatch(self):
- zaaktype = ZaakTypeFactory.create()
- zaaktype_url = reverse(zaaktype)
- informatieobjecttype = InformatieObjectTypeFactory.create(
- concept=False, omschrijving="test"
- ) # todo make ticket omschrijving/identficatie verplicht veld
- informatieobjecttype_url = reverse(informatieobjecttype)
- data = {
- "zaaktype": f"http://testserver{zaaktype_url}",
- "informatieobjecttype": "test",
- "volgnummer": 13,
- "richting": RichtingChoices.inkomend,
- }
-
- response = self.client.post(self.list_url, data)
-
- self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
-
- error = get_validation_errors(response, "nonFieldErrors")
- self.assertEqual(error["code"], "relations-incorrect-catalogus")
-
def test_delete_ziot(self):
ziot = ZaakInformatieobjectTypeFactory.create()
ziot_url = reverse(ziot)
@@ -192,7 +133,7 @@ def test_delete_ziot(self):
self.assertFalse(ZaakInformatieobjectType.objects.filter(id=ziot.id))
def test_delete_ziot_not_concept_zaaktype(self):
- ziot = ZaakInformatieobjectTypeFactory.create(zaaktype__concept=False)
+ ziot = ZaakInformatieobjectTypeFactory.create(zaaktype__concept=True)
ziot_url = reverse(ziot)
response = self.client.delete(ziot_url)
@@ -200,56 +141,27 @@ def test_delete_ziot_not_concept_zaaktype(self):
self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT)
self.assertFalse(ZaakInformatieobjectType.objects.filter(id=ziot.id))
- def test_delete_ziot_not_concept_informatieobjecttype(self):
- ziot = ZaakInformatieobjectTypeFactory.create(
- informatieobjecttype__concept=False
- )
- ziot_url = reverse(ziot)
-
- response = self.client.delete(ziot_url)
-
- self.assertEqual(response.status_code, status.HTTP_204_NO_CONTENT)
- self.assertFalse(ZaakInformatieobjectType.objects.filter(id=ziot.id))
-
- def test_delete_ziot_fail_not_concept(self):
- ziot = ZaakInformatieobjectTypeFactory.create(
- zaaktype__concept=False, informatieobjecttype__concept=False
- )
- ziot_url = reverse(ziot)
-
- response = self.client.delete(ziot_url)
-
- self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
-
- error = get_validation_errors(response, "nonFieldErrors")
- self.assertEqual(error["code"], "non-concept-relation")
-
def test_update_ziot(self):
- zaaktype = ZaakTypeFactory.create()
+ zaaktype = ZaakTypeFactory.create(concept=True)
zaaktype_url = reverse(zaaktype)
informatieobjecttype = InformatieObjectTypeFactory.create(
catalogus=zaaktype.catalogus, omschrijving="test"
)
- informatieobjecttype2 = InformatieObjectTypeFactory.create(
- catalogus=zaaktype.catalogus, omschrijving="test"
- )
+
ziot = ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
- )
- ziot2 = ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype2
+ zaaktype=zaaktype, informatieobjecttype=informatieobjecttype.omschrijving
)
+
ziot_url = reverse(ziot)
data = {
"zaaktype": f"http://testserver{zaaktype_url}",
- "informatieobjecttype": f"test",
+ "informatieobjecttype": f"{informatieobjecttype.omschrijving}",
"volgnummer": 13,
"richting": RichtingChoices.inkomend,
}
self.assertNotEqual(ziot.volgnummer, 13)
- self.assertNotEqual(ziot2.volgnummer, 13)
response = self.client.put(ziot_url, data)
@@ -257,152 +169,25 @@ def test_update_ziot(self):
self.assertEqual(response.data["volgnummer"], 13)
ziot.refresh_from_db()
- ziot2.refresh_from_db()
self.assertEqual(ziot.volgnummer, 13)
- self.assertEqual(ziot2.volgnummer, 13)
def test_partial_update_ziot(self):
- zaaktype = ZaakTypeFactory.create()
+ zaaktype = ZaakTypeFactory.create(concept=True)
informatieobjecttype = InformatieObjectTypeFactory.create(
catalogus=zaaktype.catalogus, omschrijving="test"
)
- informatieobjecttype2 = InformatieObjectTypeFactory.create(
- catalogus=zaaktype.catalogus, omschrijving="test"
- )
for item in ZaakInformatieobjectType.objects.all():
item.delete()
ziot = ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
- )
- ziot2 = ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype2
- )
- ziot_url = reverse(ziot)
-
- self.assertNotEqual(ziot.volgnummer, 12)
- self.assertNotEqual(ziot2.volgnummer, 12)
-
- response = self.client.patch(ziot_url, {"volgnummer": 12})
-
- self.assertEqual(response.status_code, status.HTTP_200_OK)
- self.assertEqual(response.data["volgnummer"], 12)
-
- ziot.refresh_from_db()
- ziot2.refresh_from_db()
-
- self.assertEqual(ziot.volgnummer, 12)
- self.assertEqual(ziot2.volgnummer, 12)
-
- def test_partial_update_ziot_informatieobjecttype(self):
- zaaktype = ZaakTypeFactory.create()
- ziot = ZaakInformatieobjectTypeFactory.create(zaaktype=zaaktype)
- ziot_url = reverse(ziot)
- informatieobjecttype = InformatieObjectTypeFactory.create()
- informatieobjecttype_url = reverse(informatieobjecttype)
-
- response = self.client.patch(
- ziot_url, {"informatieobjecttype": informatieobjecttype_url}
+ zaaktype=zaaktype, informatieobjecttype=informatieobjecttype.omschrijving
)
- self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
-
- error = get_validation_errors(response, "nonFieldErrors")
- self.assertEqual(error["code"], "relations-incorrect-catalogus")
-
- def test_update_ziot_not_concept_zaaktype(self):
- zaaktype = ZaakTypeFactory.create(concept=False)
- zaaktype_url = reverse(zaaktype)
- informatieobjecttype = InformatieObjectTypeFactory.create(
- catalogus=zaaktype.catalogus
- )
- informatieobjecttype_url = reverse(informatieobjecttype)
- ziot = ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
- )
ziot_url = reverse(ziot)
- data = {
- "zaaktype": f"http://testserver{zaaktype_url}",
- "informatieobjecttype": f"http://testserver{informatieobjecttype_url}",
- "volgnummer": 13,
- "richting": RichtingChoices.inkomend,
- }
-
- response = self.client.put(ziot_url, data)
-
- self.assertEqual(response.status_code, status.HTTP_200_OK)
- self.assertEqual(response.data["volgnummer"], 13)
-
- ziot.refresh_from_db()
- self.assertEqual(ziot.volgnummer, 13)
-
- def test_update_ziot_not_concept_informatieobjecttype(self):
- zaaktype = ZaakTypeFactory.create()
- zaaktype_url = reverse(zaaktype)
- informatieobjecttype = InformatieObjectTypeFactory.create(
- catalogus=zaaktype.catalogus, concept=False
- )
- informatieobjecttype_url = reverse(informatieobjecttype)
- ziot = ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
- )
- ziot_url = reverse(ziot)
-
- data = {
- "zaaktype": f"http://testserver{zaaktype_url}",
- "informatieobjecttype": f"http://testserver{informatieobjecttype_url}",
- "volgnummer": 13,
- "richting": RichtingChoices.inkomend,
- }
-
- response = self.client.put(ziot_url, data)
-
- self.assertEqual(response.status_code, status.HTTP_200_OK)
- self.assertEqual(response.data["volgnummer"], 13)
-
- ziot.refresh_from_db()
- self.assertEqual(ziot.volgnummer, 13)
-
- def test_update_ziot_not_concept_zaaktype_and_informatieobjecttype_fails(self):
- zaaktype = ZaakTypeFactory.create(concept=False)
- zaaktype_url = reverse(zaaktype)
- informatieobjecttype = InformatieObjectTypeFactory.create(
- catalogus=zaaktype.catalogus, concept=False
- )
- informatieobjecttype_url = reverse(informatieobjecttype)
- ziot = ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
- )
- ziot_url = reverse(ziot)
-
- data = {
- "zaaktype": f"http://testserver{zaaktype_url}",
- "informatieobjecttype": f"http://testserver{informatieobjecttype_url}",
- "volgnummer": 13,
- "richting": RichtingChoices.inkomend,
- }
-
- response = self.client.put(ziot_url, data)
-
- self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
-
- error = get_validation_errors(response, "nonFieldErrors")
- self.assertEqual(error["code"], "non-concept-relation")
-
- def test_partial_update_ziot_not_concept_zaaktype(self):
- zaaktype = ZaakTypeFactory.create(concept=False)
- zaaktype_url = reverse(zaaktype)
- informatieobjecttype = InformatieObjectTypeFactory.create(
- catalogus=zaaktype.catalogus
- )
- informatieobjecttype_url = reverse(informatieobjecttype)
- ziot = ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
- )
- ziot_url = reverse(ziot)
+ self.assertNotEqual(ziot.volgnummer, 12)
response = self.client.patch(ziot_url, {"volgnummer": 12})
@@ -410,74 +195,9 @@ def test_partial_update_ziot_not_concept_zaaktype(self):
self.assertEqual(response.data["volgnummer"], 12)
ziot.refresh_from_db()
- self.assertEqual(ziot.volgnummer, 12)
-
- def test_partial_update_ziot_not_concept_informatieobjecttype(self):
- zaaktype = ZaakTypeFactory.create()
- zaaktype_url = reverse(zaaktype)
- informatieobjecttype = InformatieObjectTypeFactory.create(
- catalogus=zaaktype.catalogus, concept=False, omschrijving="test"
- )
- informatieobjecttype_url = reverse(informatieobjecttype)
- ziot = ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
- )
- ziot_url = reverse(ziot)
-
- response = self.client.patch(ziot_url, {"volgnummer": 12})
-
- self.assertEqual(response.status_code, status.HTTP_200_OK)
- self.assertEqual(response.data["volgnummer"], 12)
-
- ziot.refresh_from_db()
self.assertEqual(ziot.volgnummer, 12)
- def test_partial_update_ziot_not_concept_zaaktype_and_informatieobjecttype_fails(
- self,
- ):
- zaaktype = ZaakTypeFactory.create(concept=False)
- zaaktype_url = reverse(zaaktype)
- informatieobjecttype = InformatieObjectTypeFactory.create(
- catalogus=zaaktype.catalogus, concept=False
- )
- informatieobjecttype_url = reverse(informatieobjecttype)
- ziot = ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
- )
- ziot_url = reverse(ziot)
-
- response = self.client.patch(ziot_url, {"volgnummer": 12})
-
- self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
-
- error = get_validation_errors(response, "nonFieldErrors")
- self.assertEqual(error["code"], "non-concept-relation")
-
- def test_full_update_ziot_informatieobjecttype(self):
- zaaktype = ZaakTypeFactory.create()
- ziot = ZaakInformatieobjectTypeFactory.create(zaaktype=zaaktype)
- ziot_url = reverse(ziot)
- informatieobjecttype = InformatieObjectTypeFactory.create()
- informatieobjecttype_url = reverse(informatieobjecttype)
- zaaktype_url = reverse(ziot.zaaktype)
-
- response = self.client.put(
- ziot_url,
- {
- "zaaktype": f"http://testserver{zaaktype_url}",
- "informatieobjecttype": informatieobjecttype_url,
- "volgnummer": ziot.volgnummer,
- "richting": ziot.richting,
- "statustype": None,
- },
- )
-
- self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
-
- error = get_validation_errors(response, "nonFieldErrors")
- self.assertEqual(error["code"], "relations-incorrect-catalogus")
-
class ZaakInformatieobjectTypeFilterAPITests(APITestCase):
maxDiff = None
@@ -485,7 +205,7 @@ class ZaakInformatieobjectTypeFilterAPITests(APITestCase):
def test_filter_zaaktype(self):
ztiot1, ztiot2 = ZaakInformatieobjectTypeFactory.create_batch(
- 2, zaaktype__concept=False, informatieobjecttype__concept=False
+ 2, zaaktype__concept=False
)
url = f"http://testserver.com{reverse(ztiot1)}"
zaaktype1_url = reverse(ztiot1.zaaktype)
@@ -507,17 +227,13 @@ def test_filter_zaaktype(self):
def test_filter_informatieobjecttype(self):
ztiot1, ztiot2 = ZaakInformatieobjectTypeFactory.create_batch(
- 2, zaaktype__concept=False, informatieobjecttype__concept=False
+ 2, zaaktype__concept=False
)
url = f"http://testserver.com{reverse(ztiot1)}"
- informatieobjecttype1_url = reverse(ztiot1.informatieobjecttype)
- informatieobjecttype2_url = reverse(ztiot2.informatieobjecttype)
- informatieobjecttype1_url = f"http://testserver.com{informatieobjecttype1_url}"
- informatieobjecttype2_url = f"http://testserver.com{informatieobjecttype2_url}"
response = self.client.get(
self.list_url,
- {"informatieobjecttype": informatieobjecttype1_url},
+ {"informatieobjecttype": ztiot1.informatieobjecttype},
HTTP_HOST="testserver.com",
)
@@ -526,22 +242,13 @@ def test_filter_informatieobjecttype(self):
data = response.json()["results"]
self.assertEqual(data[0]["url"], url)
- self.assertEqual(data[0]["informatieobjecttype"], informatieobjecttype1_url)
- self.assertNotEqual(data[0]["informatieobjecttype"], informatieobjecttype2_url)
+ self.assertEqual(data[0]["informatieobjecttype"], ztiot1.informatieobjecttype)
def test_filter_ziot_status_alles(self):
- ZaakInformatieobjectTypeFactory.create(
- zaaktype__concept=True, informatieobjecttype__concept=True
- )
- ZaakInformatieobjectTypeFactory.create(
- zaaktype__concept=False, informatieobjecttype__concept=True
- )
- ZaakInformatieobjectTypeFactory.create(
- zaaktype__concept=True, informatieobjecttype__concept=False
- )
- ZaakInformatieobjectTypeFactory.create(
- zaaktype__concept=False, informatieobjecttype__concept=False
- )
+ ZaakInformatieobjectTypeFactory.create(zaaktype__concept=True)
+ ZaakInformatieobjectTypeFactory.create(zaaktype__concept=False)
+ ZaakInformatieobjectTypeFactory.create(zaaktype__concept=True)
+ ZaakInformatieobjectTypeFactory.create(zaaktype__concept=False)
response = self.client.get(self.list_url, {"status": "alles"})
self.assertEqual(response.status_code, 200)
@@ -551,18 +258,10 @@ def test_filter_ziot_status_alles(self):
self.assertEqual(len(data), 4)
def test_filter_ziot_status_concept(self):
- ziot1 = ZaakInformatieobjectTypeFactory.create(
- zaaktype__concept=True, informatieobjecttype__concept=True
- )
- ziot2 = ZaakInformatieobjectTypeFactory.create(
- zaaktype__concept=False, informatieobjecttype__concept=True
- )
- ziot3 = ZaakInformatieobjectTypeFactory.create(
- zaaktype__concept=True, informatieobjecttype__concept=False
- )
- ZaakInformatieobjectTypeFactory.create(
- zaaktype__concept=False, informatieobjecttype__concept=False
- )
+ ziot1 = ZaakInformatieobjectTypeFactory.create(zaaktype__concept=True)
+ ziot2 = ZaakInformatieobjectTypeFactory.create(zaaktype__concept=False)
+ ziot3 = ZaakInformatieobjectTypeFactory.create(zaaktype__concept=True)
+ ZaakInformatieobjectTypeFactory.create(zaaktype__concept=False)
ziot1_url = reverse(ziot1)
ziot2_url = reverse(ziot2)
ziot3_url = reverse(ziot3)
@@ -572,41 +271,17 @@ def test_filter_ziot_status_concept(self):
data = response.json()["results"]
- self.assertEqual(len(data), 3)
+ self.assertEqual(len(data), 2)
urls = {obj["url"] for obj in data}
self.assertEqual(
urls,
{
f"http://testserver{ziot1_url}",
- f"http://testserver{ziot2_url}",
f"http://testserver{ziot3_url}",
},
)
- def test_filter_ziot_status_definitief(self):
- ziot1 = ZaakInformatieobjectTypeFactory.create(
- zaaktype__concept=True, informatieobjecttype__concept=True
- )
- ziot2 = ZaakInformatieobjectTypeFactory.create(
- zaaktype__concept=False, informatieobjecttype__concept=True
- )
- ziot3 = ZaakInformatieobjectTypeFactory.create(
- zaaktype__concept=True, informatieobjecttype__concept=False
- )
- ziot4 = ZaakInformatieobjectTypeFactory.create(
- zaaktype__concept=False, informatieobjecttype__concept=False
- )
- ziot4_url = reverse(ziot4)
-
- response = self.client.get(self.list_url, {"status": "definitief"})
- self.assertEqual(response.status_code, 200)
-
- data = response.json()["results"]
-
- self.assertEqual(len(data), 1)
- self.assertEqual(data[0]["url"], f"http://testserver{ziot4_url}")
-
class FilterValidationTests(APITestCase):
def test_unknown_query_params_give_error(self):
@@ -630,9 +305,7 @@ class ZaakInformatieobjectTypePaginationTestCase(APITestCase):
list_url = reverse_lazy(ZaakInformatieobjectType)
def test_pagination_default(self):
- ZaakInformatieobjectTypeFactory.create_batch(
- 2, zaaktype__concept=False, informatieobjecttype__concept=False
- )
+ ZaakInformatieobjectTypeFactory.create_batch(2, zaaktype__concept=False)
response = self.client.get(self.list_url)
@@ -644,9 +317,7 @@ def test_pagination_default(self):
self.assertIsNone(response_data["next"])
def test_pagination_page_param(self):
- ZaakInformatieobjectTypeFactory.create_batch(
- 2, zaaktype__concept=False, informatieobjecttype__concept=False
- )
+ ZaakInformatieobjectTypeFactory.create_batch(2, zaaktype__concept=False)
response = self.client.get(self.list_url, {"page": 1})
@@ -745,7 +416,6 @@ def test_create_ziot_not_concept_zaaktype_and_informatieobjecttype(self):
informatieobjecttype = InformatieObjectTypeFactory.create(
catalogus=zaaktype.catalogus, concept=False, omschrijving="test"
)
- informatieobjecttype_url = reverse(informatieobjecttype)
data = {
"zaaktype": f"http://testserver{zaaktype_url}",
"informatieobjecttype": "test",
@@ -764,13 +434,13 @@ def test_update_ziot_not_concept_zaaktype_and_informatieobjecttype(self):
)
informatieobjecttype_url = reverse(informatieobjecttype)
ziot = ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
+ zaaktype=zaaktype, informatieobjecttype=informatieobjecttype.omschrijving
)
ziot_url = reverse(ziot)
data = {
"zaaktype": f"http://testserver{zaaktype_url}",
- "informatieobjecttype": f"http://testserver{informatieobjecttype_url}",
+ "informatieobjecttype": f"{informatieobjecttype.omschrijving}",
"volgnummer": 13,
"richting": RichtingChoices.inkomend,
}
@@ -789,15 +459,14 @@ def test_update_ziot_not_concept_zaaktype_and_informatieobjecttype(self):
informatieobjecttype = InformatieObjectTypeFactory.create(
catalogus=zaaktype.catalogus, concept=False
)
- informatieobjecttype_url = reverse(informatieobjecttype)
ziot = ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
+ zaaktype=zaaktype, informatieobjecttype=informatieobjecttype.omschrijving
)
ziot_url = reverse(ziot)
data = {
"zaaktype": f"http://testserver{zaaktype_url}",
- "informatieobjecttype": f"http://testserver{informatieobjecttype_url}",
+ "informatieobjecttype": f"{informatieobjecttype.omschrijving}",
"volgnummer": 13,
"richting": RichtingChoices.inkomend,
}
diff --git a/src/ztc/api/tests/test_zaken.py b/src/ztc/api/tests/test_zaken.py
index a94ce84c..7fb81e58 100644
--- a/src/ztc/api/tests/test_zaken.py
+++ b/src/ztc/api/tests/test_zaken.py
@@ -14,11 +14,7 @@
)
from zds_client.tests.mocks import mock_client
-from ztc.api.validators import (
- ConceptUpdateValidator,
- M2MConceptCreateValidator,
- M2MConceptUpdateValidator,
-)
+from ztc.api.validators import ConceptUpdateValidator
from ztc.datamodel.choices import AardRelatieChoices, InternExtern
from ztc.datamodel.models import ZaakType
from ztc.datamodel.tests.factories import (
@@ -136,6 +132,155 @@ def test_get_detail(self):
}
self.assertEqual(expected, response.json())
+ def test_get_detail_with_ziot(self):
+ zaaktype = ZaakTypeFactory.create(
+ catalogus=self.catalogus,
+ verantwoordelijke="Organisatie eenheid X",
+ objecttypen=[ZaakObjectTypeFactory(catalogus=self.catalogus)],
+ broncatalogus_url="https://catalogus.url/foo",
+ broncatalogus_domein="XYZ",
+ broncatalogus_rsin="100000000",
+ bronzaaktype_url="https://zaaktype.url/foo",
+ bronzaaktype_identificatie="1",
+ bronzaaktype_omschrijving="omschrijving",
+ )
+ zaaktype_detail_url = get_operation_url("zaaktype_retrieve", uuid=zaaktype.uuid)
+ zaakobjecttype_url = get_operation_url(
+ "zaakobjecttype_retrieve", uuid=zaaktype.objecttypen.first().uuid
+ )
+
+ ziot = ZaakInformatieobjectTypeFactory.create(
+ zaaktype=zaaktype, informatieobjecttype="omschrijving_1"
+ )
+
+ info = InformatieObjectTypeFactory.create(omschrijving="omschrijving_1")
+
+ response = self.client.get(zaaktype_detail_url)
+
+ self.assertEqual(response.status_code, 200)
+
+ expected = {
+ "url": f"http://testserver{zaaktype_detail_url}",
+ "identificatie": zaaktype.identificatie,
+ "productenOfDiensten": ["https://example.com/product/123"],
+ "publicatieIndicatie": zaaktype.publicatie_indicatie,
+ "trefwoorden": [],
+ "toelichting": "",
+ "handelingInitiator": zaaktype.handeling_initiator,
+ "aanleiding": zaaktype.aanleiding,
+ "verlengingstermijn": None if not zaaktype.verlenging_mogelijk else "P30D",
+ "opschortingEnAanhoudingMogelijk": zaaktype.opschorting_en_aanhouding_mogelijk,
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "indicatieInternOfExtern": zaaktype.indicatie_intern_of_extern,
+ "verlengingMogelijk": zaaktype.verlenging_mogelijk,
+ "handelingBehandelaar": zaaktype.handeling_behandelaar,
+ "doel": zaaktype.doel,
+ "onderwerp": zaaktype.onderwerp,
+ "publicatietekst": "",
+ "omschrijvingGeneriek": "",
+ "vertrouwelijkheidaanduiding": "",
+ "verantwoordingsrelatie": [],
+ "selectielijstProcestype": zaaktype.selectielijst_procestype,
+ "servicenorm": None,
+ "referentieproces": {"naam": zaaktype.referentieproces_naam, "link": ""},
+ "doorlooptijd": "P30D",
+ "omschrijving": "",
+ "eigenschappen": [],
+ "informatieobjecttypen": [
+ f"http://testserver{get_operation_url('informatieobjecttype_retrieve', uuid=info.uuid)}"
+ ],
+ "deelzaaktypen": [],
+ "gerelateerdeZaaktypen": [],
+ "statustypen": [],
+ "resultaattypen": [],
+ "roltypen": [],
+ "besluittypen": [],
+ "beginGeldigheid": "2018-01-01",
+ "eindeGeldigheid": None,
+ "beginObject": None,
+ "eindeObject": None,
+ "versiedatum": "2018-01-01",
+ "concept": True,
+ "verantwoordelijke": "Organisatie eenheid X",
+ "zaakobjecttypen": [f"http://testserver{zaakobjecttype_url}"],
+ "broncatalogus": {
+ "url": "https://catalogus.url/foo",
+ "domein": "XYZ",
+ "rsin": "100000000",
+ },
+ "bronzaaktype": {
+ "url": "https://zaaktype.url/foo",
+ "identificatie": "1",
+ "omschrijving": "omschrijving",
+ },
+ "beginObject": None,
+ "eindeObject": None,
+ }
+ self.assertEqual(expected, response.json())
+
+ def test_get_detail_params_geldigheid_no_besluittype(self):
+ zaaktype = ZaakTypeFactory.create(
+ catalogus=self.catalogus,
+ verantwoordelijke="Organisatie eenheid X",
+ objecttypen=[ZaakObjectTypeFactory(catalogus=self.catalogus)],
+ broncatalogus_url="https://catalogus.url/foo",
+ broncatalogus_domein="XYZ",
+ broncatalogus_rsin="100000000",
+ bronzaaktype_url="https://zaaktype.url/foo",
+ bronzaaktype_identificatie="1",
+ bronzaaktype_omschrijving="omschrijving",
+ datum_begin_geldigheid="2018-01-01",
+ )
+ besluittype = BesluitTypeFactory.create(
+ concept=False,
+ datum_begin_geldigheid="2018-01-01",
+ datum_einde_geldigheid="2019-01-01",
+ )
+ zaaktype.besluittypen.add(besluittype)
+
+ zaaktype_detail_url = get_operation_url("zaaktype_retrieve", uuid=zaaktype.uuid)
+
+ response = self.client.get(
+ zaaktype_detail_url, {"datum_geldigheid": "2020-02-02"}
+ )
+
+ self.assertEqual(response.status_code, 200)
+ self.assertEqual(response.json()["besluittypen"], [])
+
+ def test_get_detail_params_geldigheid_find_besluittype(self):
+ zaaktype = ZaakTypeFactory.create(
+ catalogus=self.catalogus,
+ verantwoordelijke="Organisatie eenheid X",
+ objecttypen=[ZaakObjectTypeFactory(catalogus=self.catalogus)],
+ broncatalogus_url="https://catalogus.url/foo",
+ broncatalogus_domein="XYZ",
+ broncatalogus_rsin="100000000",
+ bronzaaktype_url="https://zaaktype.url/foo",
+ bronzaaktype_identificatie="1",
+ bronzaaktype_omschrijving="omschrijving",
+ datum_begin_geldigheid="2018-01-01",
+ )
+ besluittype = BesluitTypeFactory.create(
+ concept=False,
+ datum_begin_geldigheid="2018-01-01",
+ datum_einde_geldigheid="2022-01-01",
+ )
+ zaaktype.besluittypen.add(besluittype)
+
+ zaaktype_detail_url = get_operation_url("zaaktype_retrieve", uuid=zaaktype.uuid)
+
+ response = self.client.get(
+ zaaktype_detail_url, {"datumGeldigheid": "2020-02-02"}
+ )
+
+ self.assertEqual(response.status_code, 200)
+ self.assertEqual(
+ response.json()["besluittypen"],
+ [
+ f"http://testserver{get_operation_url('besluittype_retrieve', uuid=besluittype.uuid)}"
+ ],
+ )
+
def test_get_detail_404(self):
ZaakTypeFactory.create(catalogus=self.catalogus)
@@ -379,23 +524,110 @@ def test_publish_zaaktype(self):
self.assertEqual(zaaktype.concept, False)
- def test_publish_zaaktype_fail_not_concept_besluittype(self):
- zaaktype = ZaakTypeFactory.create()
- besluittype = BesluitTypeFactory.create()
- zaaktype.besluittypen.add(besluittype)
+ def test_publish_zaaktype_fail_overlapping_geldigheid_open_end_date(self):
+ zaaktype_existing = ZaakTypeFactory.create(
+ catalogus=self.catalogus,
+ datum_begin_geldigheid=date(2019, 1, 1),
+ datum_einde_geldigheid=None,
+ concept=False,
+ identificatie="test",
+ )
+ zaaktype_to_publish = ZaakTypeFactory.create(
+ catalogus=self.catalogus,
+ datum_begin_geldigheid=date(2018, 1, 1),
+ datum_einde_geldigheid=None,
+ concept=True,
+ identificatie="test",
+ )
- zaaktype_url = get_operation_url("zaaktype_publish", uuid=zaaktype.uuid)
+ zaaktype_url = get_operation_url(
+ "zaaktype_publish", uuid=zaaktype_to_publish.uuid
+ )
response = self.client.post(zaaktype_url)
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
- error = get_validation_errors(response, "nonFieldErrors")
- self.assertEqual(error["code"], "concept-relation")
+ error = response.json()["invalidParams"][0]
+ self.assertEqual(error["code"], "overlap")
+
+ def test_publish_zaaktype_geldigheid_other_identification(self):
+ zaaktype_existing = ZaakTypeFactory.create(
+ catalogus=self.catalogus,
+ datum_begin_geldigheid=date(2019, 1, 1),
+ datum_einde_geldigheid=None,
+ concept=False,
+ identificatie="test",
+ )
+ zaaktype_to_publish = ZaakTypeFactory.create(
+ catalogus=self.catalogus,
+ datum_begin_geldigheid=date(2019, 1, 1),
+ datum_einde_geldigheid=None,
+ concept=True,
+ identificatie="test1",
+ )
+
+ zaaktype_url = get_operation_url(
+ "zaaktype_publish", uuid=zaaktype_to_publish.uuid
+ )
+
+ response = self.client.post(zaaktype_url)
+
+ self.assertEqual(response.status_code, status.HTTP_200_OK)
- def test_publish_zaaktype_fail_not_concept_iotype(self):
+ def test_publish_zaaktype_geldigheid_no_overlap(self):
+ zaaktype_existing = ZaakTypeFactory.create(
+ catalogus=self.catalogus,
+ datum_begin_geldigheid=date(2019, 1, 1),
+ datum_einde_geldigheid=date(2020, 1, 1),
+ concept=False,
+ identificatie="test",
+ )
+ zaaktype_to_publish = ZaakTypeFactory.create(
+ catalogus=self.catalogus,
+ datum_begin_geldigheid=date(2021, 1, 1),
+ datum_einde_geldigheid=None,
+ concept=True,
+ identificatie="test1",
+ )
+
+ zaaktype_url = get_operation_url(
+ "zaaktype_publish", uuid=zaaktype_to_publish.uuid
+ )
+
+ response = self.client.post(zaaktype_url)
+
+ self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+ def test_publish_zaaktype_geldigheid_exclusive(self):
+ zaaktype_existing = ZaakTypeFactory.create(
+ catalogus=self.catalogus,
+ datum_begin_geldigheid=date(2019, 1, 1),
+ datum_einde_geldigheid=date(2020, 1, 1),
+ concept=False,
+ identificatie="test",
+ )
+ zaaktype_to_publish = ZaakTypeFactory.create(
+ catalogus=self.catalogus,
+ datum_begin_geldigheid=date(2020, 1, 1),
+ datum_einde_geldigheid=None,
+ concept=True,
+ identificatie="test",
+ )
+
+ zaaktype_url = get_operation_url(
+ "zaaktype_publish", uuid=zaaktype_to_publish.uuid
+ )
+
+ response = self.client.post(zaaktype_url)
+
+ self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+ def test_publish_zaaktype_fail_not_concept_besluittype(self):
zaaktype = ZaakTypeFactory.create()
- ZaakInformatieobjectTypeFactory.create(zaaktype=zaaktype)
+ besluittype = BesluitTypeFactory.create()
+
+ zaaktype.besluittypen.add(besluittype)
zaaktype_url = get_operation_url("zaaktype_publish", uuid=zaaktype.uuid)
@@ -556,7 +788,7 @@ def test_delete_zaaktype_not_related_to_non_concept_informatieobjecttypen(self):
informatieobjecttype = InformatieObjectTypeFactory.create(catalogus=catalogus)
ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
+ zaaktype=zaaktype, informatieobjecttype=informatieobjecttype.omschrijving
)
response = self.client.delete(zaaktype_url)
@@ -597,26 +829,6 @@ def test_delete_zaaktype_related_to_non_concept_besluittype_fails(self):
error = get_validation_errors(response, "nonFieldErrors")
self.assertEqual(error["code"], "non-concept-relation")
- def test_delete_zaaktype_related_to_non_concept_informatieobjecttype_fails(self):
- catalogus = CatalogusFactory.create()
-
- zaaktype = ZaakTypeFactory.create(catalogus=catalogus)
- zaaktype_url = reverse(zaaktype)
-
- informatieobjecttype = InformatieObjectTypeFactory.create(
- catalogus=catalogus, concept=False
- )
- ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
- )
-
- response = self.client.delete(zaaktype_url)
-
- self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
-
- error = get_validation_errors(response, "nonFieldErrors")
- self.assertEqual(error["code"], "non-concept-relation")
-
def test_update_zaaktype_not_related_to_non_concept_besluittypen(self):
catalogus = CatalogusFactory.create()
@@ -665,55 +877,6 @@ def test_update_zaaktype_not_related_to_non_concept_besluittypen(self):
self.assertEqual(response.data["aanleiding"], "aangepast")
zaaktype.delete()
- def test_update_zaaktype_not_related_to_non_concept_informatieobjecttypen(self):
- catalogus = CatalogusFactory.create()
-
- zaaktype = ZaakTypeFactory.create(catalogus=catalogus)
- zaaktype_url = reverse(zaaktype)
-
- informatieobjecttype = InformatieObjectTypeFactory.create(catalogus=catalogus)
- ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
- )
-
- data = {
- "identificatie": 0,
- "doel": "some test",
- "aanleiding": "aangepast",
- "indicatieInternOfExtern": InternExtern.extern,
- "handelingInitiator": "indienen",
- "onderwerp": "Klacht",
- "handelingBehandelaar": "uitvoeren",
- "doorlooptijd": "P30D",
- "opschortingEnAanhoudingMogelijk": False,
- "verlengingMogelijk": True,
- "verlengingstermijn": "P30D",
- "publicatieIndicatie": True,
- "verantwoordingsrelatie": [],
- "productenOfDiensten": ["https://example.com/product/123"],
- "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
- "omschrijving": "some test",
- "gerelateerdeZaaktypen": [
- {
- "zaaktype": "http://example.com/zaaktype/1",
- "aard_relatie": AardRelatieChoices.bijdrage,
- "toelichting": "test relations",
- }
- ],
- "referentieproces": {"naam": "ReferentieProces 0", "link": ""},
- "catalogus": reverse(catalogus),
- "besluittypen": [],
- "beginGeldigheid": "2018-01-01",
- "versiedatum": "2018-01-01",
- "verantwoordelijke": "Organisatie eenheid X",
- }
-
- response = self.client.put(zaaktype_url, data)
-
- self.assertEqual(response.status_code, status.HTTP_200_OK)
- self.assertEqual(response.data["aanleiding"], "aangepast")
- zaaktype.delete()
-
def test_update_zaaktype_not_related_to_non_concept_zaaktypes(self):
catalogus = CatalogusFactory.create()
@@ -793,7 +956,7 @@ def test_partial_update_zaaktype_not_related_to_non_concept_informatieobjecttype
informatieobjecttype = InformatieObjectTypeFactory.create(catalogus=catalogus)
ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
+ zaaktype=zaaktype, informatieobjecttype=informatieobjecttype.omschrijving
)
response = self.client.patch(zaaktype_url, {"aanleiding": "aangepast"})
@@ -832,45 +995,6 @@ def test_partial_update_non_concept_zaaktype_einde_geldigheid(self):
self.assertEqual(response.status_code, status.HTTP_200_OK)
self.assertEqual(response.data["einde_geldigheid"], "2020-01-01")
- def test_partial_update_non_concept_zaaktype_reset_einde_geldigheid(self):
- """
- Assert that ``null`` can be set as value for eindeGeldigheid.
- Regression test for https://github.com/open-zaak/open-zaak/issues/981
- """
- zaaktype = ZaakTypeFactory.create(
- concept=False,
- zaaktype_omschrijving="OZ-981",
- identificatie="paspoort",
- datum_begin_geldigheid=date(2021, 1, 1),
- datum_einde_geldigheid=date(2022, 1, 1),
- )
- endpoint = reverse(zaaktype)
-
- with self.subTest("no overlap"):
- response = self.client.patch(endpoint, {"eindeGeldigheid": None})
-
- self.assertEqual(response.status_code, status.HTTP_200_OK)
- zaaktype.refresh_from_db()
- self.assertIsNone(zaaktype.datum_einde_geldigheid)
-
- with self.subTest("would introduce overlap"):
- zaaktype_old = ZaakTypeFactory.create(
- concept=False,
- catalogus=zaaktype.catalogus,
- zaaktype_omschrijving="OZ-981",
- identificatie="paspoort",
- datum_begin_geldigheid=date(2020, 1, 1),
- datum_einde_geldigheid=date(2020, 12, 31),
- )
-
- response = self.client.patch(
- reverse(zaaktype_old), {"eindeGeldigheid": None}
- )
-
- self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
- error = get_validation_errors(response, "eindeGeldigheid")
- self.assertEqual(error["code"], "overlap")
-
def test_partial_update_zaaktype_einde_geldigheid_related_to_non_concept_besluittype(
self,
):
@@ -901,7 +1025,7 @@ def test_partial_update_zaaktype_einde_geldigheid_related_to_non_concept_informa
catalogus=catalogus, concept=False
)
ZaakInformatieobjectTypeFactory.create(
- zaaktype=zaaktype, informatieobjecttype=informatieobjecttype
+ zaaktype=zaaktype, informatieobjecttype=informatieobjecttype.omschrijving
)
response = self.client.patch(zaaktype_url, {"eindeGeldigheid": "2020-01-01"})
@@ -1004,7 +1128,6 @@ def test_zaaktype_bronzaaktype(self):
class ZaakTypeCreateDuplicateTests(APITestCase):
"""
Test the creation business rules w/r to duplicates.
-
A Zaaktype with the same code is allowed IF and ONLY IF it does not overlap
in validity period.
"""
@@ -1019,12 +1142,13 @@ def setUpTestData(cls):
cls.url = get_operation_url("zaaktype_list")
- def test_overlap_specified_dates(self):
+ def test_zaaktype_non_concept_allows_creating_a_concept(self):
ZaakTypeFactory.create(
catalogus=self.catalogus,
identificatie=1,
datum_begin_geldigheid=date(2019, 1, 1),
datum_einde_geldigheid=date(2020, 1, 1),
+ concept=False,
zaaktype_omschrijving="zaaktype",
)
@@ -1054,54 +1178,15 @@ def test_overlap_specified_dates(self):
response = self.client.post(self.url, data)
- self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
-
- error = get_validation_errors(response, "beginGeldigheid")
- self.assertEqual(error["code"], "overlap")
-
- def test_overlap_specified_dates_other_identificatie(self):
- ZaakTypeFactory.create(
- catalogus=self.catalogus,
- identificatie=1,
- datum_begin_geldigheid=date(2019, 1, 1),
- datum_einde_geldigheid=date(2020, 1, 1),
- zaaktype_omschrijving="zaaktype",
- )
-
- data = {
- "omschrijving": "zaaktype",
- "identificatie": 2,
- "catalogus": f"http://testserver{reverse(self.catalogus)}",
- "beginGeldigheid": "2019-02-01",
- "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
- "doel": "doel",
- "aanleiding": "aanleiding",
- "indicatieInternOfExtern": "extern",
- "handelingInitiator": "aanvragen",
- "onderwerp": "dummy",
- "handelingBehandelaar": "behandelen",
- "doorlooptijd": "P7D",
- "opschortingEnAanhoudingMogelijk": False,
- "verlengingMogelijk": False,
- "publicatieIndicatie": False,
- "productenOfDiensten": [],
- "referentieproces": {"naam": "ref"},
- "besluittypen": [],
- "gerelateerdeZaaktypen": [],
- "versiedatum": "2019-02-01",
- "verantwoordelijke": "Organisatie eenheid X",
- }
-
- response = self.client.post(self.url, data)
-
self.assertEqual(response.status_code, status.HTTP_201_CREATED)
- def test_overlap_open_end_date(self):
+ def test_overlap_with_two_concepts(self):
ZaakTypeFactory.create(
catalogus=self.catalogus,
identificatie=1,
datum_begin_geldigheid=date(2019, 1, 1),
- datum_einde_geldigheid=None,
+ datum_einde_geldigheid=date(2020, 1, 1),
+ concept=True,
zaaktype_omschrijving="zaaktype",
)
@@ -1133,123 +1218,9 @@ def test_overlap_open_end_date(self):
self.assertEqual(response.status_code, status.HTTP_400_BAD_REQUEST)
- error = get_validation_errors(response, "beginGeldigheid")
+ error = get_validation_errors(response, "concept")
self.assertEqual(error["code"], "overlap")
- def test_overlap_open_end_date_other_identificatie(self):
- ZaakTypeFactory.create(
- catalogus=self.catalogus,
- identificatie=1,
- datum_begin_geldigheid=date(2019, 1, 1),
- datum_einde_geldigheid=None,
- zaaktype_omschrijving="zaaktype",
- )
-
- data = {
- "omschrijving": "zaaktype",
- "identificatie": 2,
- "catalogus": f"http://testserver{reverse(self.catalogus)}",
- "beginGeldigheid": "2019-02-01",
- "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
- "doel": "doel",
- "aanleiding": "aanleiding",
- "indicatieInternOfExtern": "extern",
- "handelingInitiator": "aanvragen",
- "onderwerp": "dummy",
- "handelingBehandelaar": "behandelen",
- "doorlooptijd": "P7D",
- "opschortingEnAanhoudingMogelijk": False,
- "verlengingMogelijk": False,
- "publicatieIndicatie": False,
- "productenOfDiensten": [],
- "referentieproces": {"naam": "ref"},
- "besluittypen": [],
- "gerelateerdeZaaktypen": [],
- "versiedatum": "2019-02-01",
- "verantwoordelijke": "Organisatie eenheid X",
- }
-
- response = self.client.post(self.url, data)
-
- self.assertEqual(response.status_code, status.HTTP_201_CREATED)
-
- def test_no_overlap(self):
- ZaakTypeFactory.create(
- catalogus=self.catalogus,
- identificatie=1,
- datum_begin_geldigheid=date(2019, 1, 1),
- datum_einde_geldigheid=date(2020, 1, 1),
- zaaktype_omschrijving="zaaktype",
- )
-
- data = {
- "omschrijving": "zaaktype",
- "identificatie": 1,
- "catalogus": f"http://testserver{reverse(self.catalogus)}",
- "beginGeldigheid": "2020-02-01",
- "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
- "doel": "doel",
- "aanleiding": "aanleiding",
- "indicatieInternOfExtern": "extern",
- "handelingInitiator": "aanvragen",
- "onderwerp": "dummy",
- "handelingBehandelaar": "behandelen",
- "doorlooptijd": "P7D",
- "opschortingEnAanhoudingMogelijk": False,
- "verlengingMogelijk": False,
- "publicatieIndicatie": False,
- "productenOfDiensten": [],
- "referentieproces": {"naam": "ref", "link": "https://example.com"},
- "besluittypen": [],
- "gerelateerdeZaaktypen": [],
- "versiedatum": "2019-02-01",
- "verantwoordelijke": "Organisatie eenheid X",
- }
-
- response = self.client.post(self.url, data)
-
- self.assertEqual(response.status_code, status.HTTP_201_CREATED)
-
- def test_overlap_exclusive(self):
- """
- Assert that the end date is exclusive.
- """
- ZaakTypeFactory.create(
- catalogus=self.catalogus,
- identificatie=1,
- datum_begin_geldigheid=date(2019, 1, 1),
- datum_einde_geldigheid=date(2020, 1, 1),
- zaaktype_omschrijving="zaaktype",
- )
-
- data = {
- "omschrijving": "zaaktype",
- "identificatie": 1,
- "catalogus": f"http://testserver{reverse(self.catalogus)}",
- "beginGeldigheid": "2020-01-01",
- "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
- "doel": "doel",
- "aanleiding": "aanleiding",
- "indicatieInternOfExtern": "extern",
- "handelingInitiator": "aanvragen",
- "onderwerp": "dummy",
- "handelingBehandelaar": "behandelen",
- "doorlooptijd": "P7D",
- "opschortingEnAanhoudingMogelijk": False,
- "verlengingMogelijk": False,
- "publicatieIndicatie": False,
- "productenOfDiensten": [],
- "referentieproces": {"naam": "ref", "link": "https://example.com"},
- "besluittypen": [],
- "gerelateerdeZaaktypen": [],
- "versiedatum": "2019-02-01",
- "verantwoordelijke": "Organisatie eenheid X",
- }
-
- response = self.client.post(self.url, data)
-
- self.assertEqual(response.status_code, status.HTTP_201_CREATED)
-
class ZaakTypeFilterAPITests(APITestCase):
maxDiff = None
diff --git a/src/ztc/api/utils/validators.py b/src/ztc/api/utils/validators.py
index d4a5c24b..7f9d9adb 100644
--- a/src/ztc/api/utils/validators.py
+++ b/src/ztc/api/utils/validators.py
@@ -1,8 +1,10 @@
+from datetime import datetime
+
from django.conf import settings
from django.utils.module_loading import import_string
from django.utils.translation import ugettext_lazy as _
-from rest_framework.exceptions import ErrorDetail
+from rest_framework.exceptions import ErrorDetail, NotFound
from rest_framework.serializers import ValidationError
from vng_api_common.constants import (
BrondatumArchiefprocedureAfleidingswijze as Afleidingswijze,
@@ -241,3 +243,25 @@ def __call__(self, attrs: dict):
}
)
raise ValidationError(error_dict)
+
+
+def validate_detail_geldigheid(instance, filter_datum_geldigheid):
+ """validates whether the searched zaaktype is valid on the given date"""
+ filter_datum_geldigheid = datetime.strptime(
+ filter_datum_geldigheid, "%Y-%m-%d"
+ ).date()
+ if (
+ instance.datum_einde_geldigheid == None
+ and instance.datum_begin_geldigheid <= filter_datum_geldigheid
+ ):
+ return
+ elif (
+ instance.datum_begin_geldigheid
+ <= filter_datum_geldigheid
+ <= instance.datum_einde_geldigheid
+ ):
+ return
+ else:
+ raise NotFound(
+ detail=f"Zaaktype {instance.uuid} is niet geldig op {filter_datum_geldigheid}"
+ )
diff --git a/src/ztc/api/utils/viewsets.py b/src/ztc/api/utils/viewsets.py
index 034970d7..93059495 100644
--- a/src/ztc/api/utils/viewsets.py
+++ b/src/ztc/api/utils/viewsets.py
@@ -4,6 +4,8 @@
from django.db.models import Q
+from vng_api_common.tests import reverse
+
from ztc.datamodel.models import (
BesluitType,
InformatieObjectType,
@@ -12,9 +14,12 @@
)
-def is_url(pattern: str):
- is_url = urlparse(pattern)
- return all([is_url.scheme, is_url.netloc])
+def is_valid_url(url):
+ try:
+ result = urlparse(url)
+ return all([result.scheme, result.netloc])
+ except ValueError:
+ return False
def build_absolute_url(action, request):
@@ -88,7 +93,6 @@ def m2m_array_of_str_to_url(request, m2m_fields: list, action: str):
The m2m array 'm2m_field' (like 'besluittypen') is transformed to an array of urls, which are required for the
m2m relationship.
"""
-
for m2m_field in m2m_fields:
m2m_data = request.data.get(m2m_field, []).copy()
if m2m_data:
@@ -110,14 +114,18 @@ def m2m_array_of_str_to_url(request, m2m_fields: list, action: str):
search_parameter
)
for m2m_object in m2m_objects:
- build_url = f"{build_absolute_url(action, request)}/{MAPPING_FIELD_TO_MODEL[m2m_field]._meta.verbose_name_plural.title().lower()}/{str(m2m_object.uuid)}"
+ build_url = request.build_absolute_uri(
+ reverse(
+ f"{MAPPING_FIELD_TO_MODEL[m2m_field]._meta.verbose_name.title().lower()}-detail",
+ kwargs={"uuid": m2m_object.uuid},
+ )
+ )
if m2m_field == "gerelateerde_zaaktypen":
new_m2m_str = m2m_str.copy()
new_m2m_str.update({"zaaktype": build_url})
request.data[m2m_field].extend([new_m2m_str])
else:
request.data[m2m_field].extend([build_url])
-
return request
@@ -127,13 +135,19 @@ def extract_relevant_m2m(serializer, m2m_fields: list, action: str, date=None):
data = serializer.data if action == "list" else [serializer.data]
for query_object in data:
valid_urls = []
- for m2m_url in query_object[m2m_field]:
- uuid_from_url = uuid.UUID(m2m_url.rsplit("/", 1)[1]).hex
+ for m2m_object in query_object[m2m_field]:
+ if isinstance(m2m_object, dict):
+ for key, value in m2m_object.items():
+ if is_valid_url(value):
+ uuid_from_url = uuid.UUID(
+ m2m_object[key].rsplit("/", 1)[1]
+ ).hex
+ else:
+ uuid_from_url = uuid.UUID(m2m_object.rsplit("/", 1)[1]).hex
valid_m2m = get_valid_m2m_objects(m2m_field, uuid_from_url, date)
-
if valid_m2m:
- valid_urls.append(m2m_url)
+ valid_urls.append(m2m_object)
query_object[m2m_field].clear()
query_object[m2m_field].extend(valid_urls)
@@ -151,6 +165,47 @@ def get_valid_m2m_objects(m2m_field: str, uuid_from_url, date=None):
qs_old_version = MAPPING_FIELD_TO_MODEL[m2m_field].objects.filter(search_parameter)
if not qs_old_version:
- search_parameter = Q(datum_einde_geldigheid=None, uuid=uuid_from_url)
+ if date:
+ search_parameter = Q(
+ datum_begin_geldigheid__lte=date,
+ datum_einde_geldigheid=None,
+ uuid=uuid_from_url,
+ )
+ else:
+ search_parameter = Q(
+ datum_einde_geldigheid=None,
+ datum_begin_geldigheid__lte=datetime.datetime.now(),
+ uuid=uuid_from_url,
+ )
+
return MAPPING_FIELD_TO_MODEL[m2m_field].objects.filter(search_parameter)
return qs_old_version
+
+
+def has_valid_non_concept_m2m_relations(instance, m2m):
+ """
+ Check if the object has m2m relations, and if it does, check if these are valid within the time frame of their ZaakType.
+ """
+ if m2m.all().exists():
+ search_parameter = Q(
+ datum_begin_geldigheid__lte=instance.datum_begin_geldigheid,
+ datum_einde_geldigheid__gte=instance.datum_begin_geldigheid,
+ concept=False,
+ )
+
+ qs_old_version = m2m.filter(search_parameter)
+ if not qs_old_version:
+ search_parameter = Q(
+ datum_begin_geldigheid__lte=instance.datum_begin_geldigheid,
+ datum_einde_geldigheid=None,
+ concept=False,
+ )
+ if m2m.filter(search_parameter):
+ return True
+
+ else:
+ return True
+
+ return False
+
+ return True
diff --git a/src/ztc/api/validators.py b/src/ztc/api/validators.py
index e204dd97..ee28026e 100644
--- a/src/ztc/api/validators.py
+++ b/src/ztc/api/validators.py
@@ -2,9 +2,10 @@
from rest_framework.serializers import ValidationError
-from ztc.datamodel.utils import get_overlapping_zaaktypes
-
-from .utils.serializers import get_from_serializer_data_or_instance
+from ztc.datamodel.utils import (
+ get_overlapping_concept_zaaktypes,
+ get_overlapping_zaaktypes,
+)
class ZaaktypeGeldigheidValidator:
@@ -27,17 +28,12 @@ def set_context(self, serializer):
"""
self.serializer = serializer
- def __call__(self, attrs):
+ def __call__(self):
instance = self.serializer.instance
- catalogus = attrs.get("catalogus") or instance.catalogus
- identificatie = attrs.get("identificatie") or instance.identificatie
- datum_begin_geldigheid = (
- attrs.get("datum_begin_geldigheid") or instance.datum_begin_geldigheid
- )
- datum_einde_geldigheid = get_from_serializer_data_or_instance(
- "einde_geldigheid", attrs, self.serializer
- )
-
+ catalogus = instance.catalogus
+ identificatie = instance.identificatie
+ datum_begin_geldigheid = instance.datum_begin_geldigheid
+ datum_einde_geldigheid = instance.datum_einde_geldigheid
query = get_overlapping_zaaktypes(
catalogus,
identificatie,
@@ -47,9 +43,7 @@ def __call__(self, attrs):
)
if query.exists():
# are we patching eindeGeldigheid?
- changing_published_geldigheid = self.serializer.partial and list(attrs) == [
- "datum_einde_geldigheid"
- ]
+ changing_published_geldigheid = self.serializer.partial
error_field = (
"einde_geldigheid"
if changing_published_geldigheid
@@ -58,6 +52,41 @@ def __call__(self, attrs):
raise ValidationError({error_field: self.message}, code=self.code)
+class ZaaktypeDoubleConceptValidator:
+ """
+ Validate that the (new) object is not a double concept
+
+ Empty end date is an open interval, which means that the object cannot
+ be created after the start date.
+ """
+
+ message = _("Dit zaaktype komt al voor binnen de catalogus met een concept versie")
+ code = "overlap"
+
+ def set_context(self, serializer):
+ """
+ This hook is called by the serializer instance,
+ prior to the validation call being made.
+ """
+ self.serializer = serializer
+
+ def __call__(self, attrs):
+ instance = self.serializer.instance
+ if instance is not None:
+ return
+
+ catalogus = attrs["catalogus"]
+ identificatie = attrs["identificatie"]
+ query = get_overlapping_concept_zaaktypes(
+ catalogus,
+ identificatie,
+ )
+ if query.exists():
+
+ error_field = "concept"
+ raise ValidationError({error_field: self.message}, code=self.code)
+
+
class ConceptUpdateValidator:
message = _(
"Het is niet toegestaan om een non-concept object bij te werken zonder de geforceerd-bijwerken scope"
diff --git a/src/ztc/api/views/besluittype.py b/src/ztc/api/views/besluittype.py
index 91c297c2..4203ee2c 100644
--- a/src/ztc/api/views/besluittype.py
+++ b/src/ztc/api/views/besluittype.py
@@ -1,13 +1,11 @@
from django.utils.translation import gettext as _
from drf_spectacular.utils import extend_schema, extend_schema_view
-from notifications_api_common.viewsets import NotificationViewSetMixin
from rest_framework import viewsets
-from rest_framework.response import Response
from vng_api_common.caching import conditional_retrieve
from vng_api_common.viewsets import CheckQueryParamsMixin
-from ...datamodel.models import BesluitType, ZaakType
+from ...datamodel.models import BesluitType
from ..filters import BesluitTypeFilter
from ..kanalen import KANAAL_BESLUITTYPEN
from ..scopes import (
@@ -121,44 +119,40 @@ def update(self, request, *args, **kwargs):
)
return super(viewsets.ModelViewSet, self).update(request, *args, **kwargs)
- def retrieve(self, request, *args, **kwargs):
- instance = self.get_object()
- serializer = extract_relevant_m2m(
- self.get_serializer(instance),
- ["zaaktypen", "informatieobjecttypen", "resultaattypen"],
- self.action,
- )
- return Response(serializer.data)
-
- def list(self, request, *args, **kwargs):
- self._check_query_params(request)
- queryset = self.filter_queryset(self.get_queryset())
- filters = (
- self.filter_backends[0]()
- .get_filterset_kwargs(self.request, queryset, self)
- .get("data", {})
- )
+ def get_serializer(self, *args, **kwargs):
+ """
+ Return the serializer instance that should be used for validating and
+ deserializing input, and for serializing output. Two special scenarios have been added for the retrieve and list operations. These are used to filter the m2m relations based on the geldigheid of the underlying objects.
+ """
+ serializer = super().get_serializer(*args, **kwargs)
+
+ if not self.request:
+ return serializer
+
+ if self.action in ["list", "retrieve"]:
+ filter_datum_geldigheid = self.request.query_params.get(
+ "datumGeldigheid", None
+ )
- page = self.paginate_queryset(queryset)
- if page is not None:
- serializer = self.get_serializer(page, many=True)
serializer = extract_relevant_m2m(
serializer,
["zaaktypen", "informatieobjecttypen", "resultaattypen"],
self.action,
- filters.get("datum_geldigheid", None),
+ filter_datum_geldigheid,
)
- return self.get_paginated_response(serializer.data)
-
- serializer = self.get_serializer(queryset, many=True)
- serializer = extract_relevant_m2m(
- serializer,
- ["zaaktypen", "informatieobjecttypen", "resultaattypen"],
- self.action,
- filters.get("datum_geldigheid", None),
- )
- return Response(serializer.data)
+ return serializer
+
+ def perform_create(self, serializer):
+ """automatically create new zaaktype relations when creating a new version of a besluittype"""
+ new_besluittype = serializer.save()
+ besluittypen = BesluitType.objects.filter(
+ omschrijving=serializer.data.get("omschrijving", [])
+ )
+ for besluittype in besluittypen:
+ for zaaktype in besluittype.zaaktypen.all():
+ new_besluittype.zaaktypen.add(zaaktype)
+ new_besluittype.save()
BesluitTypeViewSet.publish = swagger_publish_schema(BesluitTypeViewSet)
diff --git a/src/ztc/api/views/informatieobjecttype.py b/src/ztc/api/views/informatieobjecttype.py
index 779b3c52..f6d3f870 100644
--- a/src/ztc/api/views/informatieobjecttype.py
+++ b/src/ztc/api/views/informatieobjecttype.py
@@ -92,44 +92,31 @@ class InformatieObjectTypeViewSet(
"destroy": SCOPE_CATALOGI_WRITE | SCOPE_CATALOGI_FORCED_DELETE,
"publish": SCOPE_CATALOGI_WRITE,
}
- concept_related_fields = ["besluittypen", "zaaktypen"]
+ concept_related_fields = ["besluittypen"]
notifications_kanaal = KANAAL_INFORMATIEOBJECTTYPEN
- def retrieve(self, request, *args, **kwargs):
- instance = self.get_object()
- serializer = extract_relevant_m2m(
- self.get_serializer(instance), ["besluittypen", "zaaktypen"], self.action
- )
- return Response(serializer.data)
+ def get_serializer(self, *args, **kwargs):
+ """
+ Return the serializer instance that should be used for validating and
+ deserializing input, and for serializing output. Two special scenarios have been added for the retrieve and list operations. These are used to filter the m2m relations based on the geldigheid of the underlying objects.
+ """
+ serializer = super().get_serializer(*args, **kwargs)
- def list(self, request, *args, **kwargs):
- self._check_query_params(request)
- queryset = self.filter_queryset(self.get_queryset())
- filters = (
- self.filter_backends[0]()
- .get_filterset_kwargs(self.request, queryset, self)
- .get("data", {})
- )
- page = self.paginate_queryset(queryset)
- if page is not None:
- serializer = self.get_serializer(page, many=True)
+ if not self.request:
+ return serializer
+
+ if self.action in ["list", "retrieve"]:
+ filter_datum_geldigheid = self.request.query_params.get(
+ "datumGeldigheid", None
+ )
serializer = extract_relevant_m2m(
serializer,
["besluittypen", "zaaktypen"],
self.action,
- filters.get("datum_geldigheid", None),
+ filter_datum_geldigheid,
)
- return self.get_paginated_response(serializer.data)
-
- serializer = self.get_serializer(queryset, many=True)
- serializer = extract_relevant_m2m(
- serializer,
- ["besluittypen", "zaaktypen"],
- self.action,
- filters.get("datum_geldigheid", None),
- )
- return Response(serializer.data)
+ return serializer
InformatieObjectTypeViewSet.publish = swagger_publish_schema(
diff --git a/src/ztc/api/views/mixins.py b/src/ztc/api/views/mixins.py
index 06eb4d9a..04c48891 100644
--- a/src/ztc/api/views/mixins.py
+++ b/src/ztc/api/views/mixins.py
@@ -13,6 +13,7 @@
from vng_api_common.serializers import FoutSerializer, ValidatieFoutSerializer
from ..scopes import SCOPE_CATALOGI_FORCED_DELETE, SCOPE_CATALOGI_FORCED_WRITE
+from ..utils.viewsets import extract_relevant_m2m
def swagger_publish_schema(viewset_cls):
@@ -83,7 +84,6 @@ def get_queryset(self):
filters = self.get_concept_filter()
if not isinstance(filters, models.Q):
filters = models.Q(**filters)
-
return qs.filter(filters)
diff --git a/src/ztc/api/views/relatieklassen.py b/src/ztc/api/views/relatieklassen.py
index f402cca9..fde5dadc 100644
--- a/src/ztc/api/views/relatieklassen.py
+++ b/src/ztc/api/views/relatieklassen.py
@@ -2,13 +2,12 @@
from django.utils.translation import gettext as _
from drf_spectacular.utils import extend_schema, extend_schema_view
-from rest_framework import status, viewsets
-from rest_framework.response import Response
+from rest_framework import viewsets
from rest_framework.serializers import ValidationError
from vng_api_common.caching import conditional_retrieve
from vng_api_common.viewsets import CheckQueryParamsMixin
-from ...datamodel.models import InformatieObjectType, ZaakInformatieobjectType
+from ...datamodel.models import ZaakInformatieobjectType
from ..filters import ZaakInformatieobjectTypeFilter
from ..scopes import (
SCOPE_CATALOGI_FORCED_DELETE,
@@ -16,12 +15,7 @@
SCOPE_CATALOGI_READ,
SCOPE_CATALOGI_WRITE,
)
-from ..serializers import (
- ZaakTypeInformatieObjectTypeCreateSerializer,
- ZaakTypeInformatieObjectTypeSerializer,
- ZaakTypeInformatieObjectTypeUpdateSerializer,
-)
-from ..utils.viewsets import build_absolute_url
+from ..serializers import ZaakTypeInformatieObjectTypeSerializer
from .mixins import ConceptFilterMixin, ForcedCreateUpdateMixin
@@ -98,13 +92,10 @@ class ZaakTypeInformatieObjectTypeViewSet(
def get_concept(self, instance):
ziot = self.get_object()
zaaktype = getattr(instance, "zaaktype", None) or ziot.zaaktype
- informatieobjecttype = (
- getattr(instance, "informatieobjecttype", None) or ziot.informatieobjecttype
- )
- return zaaktype.concept or informatieobjecttype.concept
+ return zaaktype.concept
def get_concept_filter(self):
- return ~(Q(zaaktype__concept=True) | Q(informatieobjecttype__concept=True))
+ return ~(Q(zaaktype__concept=True))
def perform_destroy(self, instance):
forced_delete = self.request.jwt_auth.has_auth(
@@ -119,53 +110,3 @@ def perform_destroy(self, instance):
)
super().perform_destroy(instance)
-
- @extend_schema(
- request=ZaakTypeInformatieObjectTypeCreateSerializer,
- responses={201: ZaakTypeInformatieObjectTypeSerializer},
- )
- def create(self, request, *args, **kwargs):
- search_parameter = Q(omschrijving=request.data["informatieobjecttype"])
- iots = InformatieObjectType.objects.filter(search_parameter)
- for iot in iots:
- data = request.data.copy()
- data[
- "informatieobjecttype"
- ] = f"{build_absolute_url(self.action, request)}/informatieobjecttypen/{str(iot.uuid)}"
- serializer = self.get_serializer(data=data)
- serializer.is_valid(raise_exception=True)
- self.perform_create(serializer)
- headers = self.get_success_headers(serializer.data)
- return Response(
- serializer.data, status=status.HTTP_201_CREATED, headers=headers
- )
-
- @extend_schema(
- request=ZaakTypeInformatieObjectTypeUpdateSerializer,
- responses={200: ZaakTypeInformatieObjectTypeSerializer},
- )
- def update(self, request, *args, **kwargs):
- """
- Update multiple ZIOT instances with `informatieobjecttype__omschrijving` as input. Update all correlated ZIOTs
- """
- partial = kwargs.pop("partial", False)
- instance = self.get_object()
-
- search_parameter = Q(
- informatieobjecttype__omschrijving=instance.informatieobjecttype.omschrijving,
- informatieobjecttype__catalogus=instance.informatieobjecttype.catalogus,
- zaaktype__catalogus=instance.zaaktype.catalogus,
- )
- ziots = ZaakInformatieobjectType.objects.filter(search_parameter)
-
- for ziot in ziots:
- data = request.data.copy()
- data[
- "informatieobjecttype"
- ] = f"{build_absolute_url(self.action, request)}/informatieobjecttypen/{str(ziot.informatieobjecttype.uuid)}"
-
- serializer = self.get_serializer(ziot, data=data, partial=partial)
- serializer.is_valid(raise_exception=True)
- self.perform_update(serializer)
-
- return Response(serializer.data)
diff --git a/src/ztc/api/views/zaken.py b/src/ztc/api/views/zaken.py
index cd24066d..bd98f41e 100644
--- a/src/ztc/api/views/zaken.py
+++ b/src/ztc/api/views/zaken.py
@@ -1,7 +1,7 @@
+from django.shortcuts import get_object_or_404
from django.utils.translation import gettext as _
from drf_spectacular.utils import extend_schema, extend_schema_view
-from notifications_api_common.viewsets import NotificationViewSetMixin
from rest_framework import status, viewsets
from rest_framework.decorators import action
from rest_framework.response import Response
@@ -12,8 +12,9 @@
from vng_api_common.serializers import FoutSerializer, ValidatieFoutSerializer
from vng_api_common.viewsets import CheckQueryParamsMixin
-from ...datamodel.models import BesluitType, ZaakType
-from ..filters import ZaakTypeFilter
+from ...datamodel.constants import DATUM_GELDIGHEID_QUERY_PARAM
+from ...datamodel.models import BesluitType, ZaakType, ZaakTypenRelatie
+from ..filters import ZaakTypeDetailFilter, ZaakTypeFilter
from ..kanalen import KANAAL_ZAAKTYPEN
from ..scopes import (
SCOPE_CATALOGI_FORCED_DELETE,
@@ -26,7 +27,13 @@
ZaakTypeSerializer,
ZaakTypeUpdateSerializer,
)
-from ..utils.viewsets import extract_relevant_m2m, m2m_array_of_str_to_url
+from ..utils.validators import validate_detail_geldigheid
+from ..utils.viewsets import (
+ extract_relevant_m2m,
+ has_valid_non_concept_m2m_relations,
+ m2m_array_of_str_to_url,
+)
+from ..validators import ZaaktypeGeldigheidValidator
from .mixins import ConceptMixin, ForcedCreateUpdateMixin, M2MConceptDestroyMixin
@@ -99,8 +106,6 @@ class ZaakTypeViewSet(
queryset = ZaakType.objects.prefetch_related(
"statustypen",
- "zaaktypenrelaties",
- "informatieobjecttypen",
"statustypen",
"resultaattypen",
"eigenschap_set",
@@ -120,11 +125,10 @@ class ZaakTypeViewSet(
"destroy": SCOPE_CATALOGI_WRITE | SCOPE_CATALOGI_FORCED_DELETE,
"publish": SCOPE_CATALOGI_WRITE,
}
- concept_related_fields = ["besluittypen", "informatieobjecttypen"]
+ concept_related_fields = ["besluittypen"]
notifications_kanaal = KANAAL_ZAAKTYPEN
relation_fields = ["zaaktypenrelaties"]
- @action(detail=True, methods=["post"])
@extend_schema(
responses={
status.HTTP_200_OK: serializer_class,
@@ -133,19 +137,22 @@ class ZaakTypeViewSet(
**{exc.status_code: FoutSerializer for exc in COMMON_ERRORS},
},
)
+ @action(detail=True, methods=["post"])
def publish(self, request, *args, **kwargs):
instance = self.get_object()
- # check related objects
- if (
- instance.besluittypen.filter(concept=True).exists()
- or instance.informatieobjecttypen.filter(concept=True).exists()
- or instance.deelzaaktypen.filter(concept=True).exists()
- ):
+
+ if not has_valid_non_concept_m2m_relations(
+ instance, instance.deelzaaktypen
+ ) or not has_valid_non_concept_m2m_relations(instance, instance.besluittypen):
msg = _("All related resources should be published")
raise ValidationError(
{api_settings.NON_FIELD_ERRORS_KEY: msg}, code="concept-relation"
)
+ geldigheid_validator = ZaaktypeGeldigheidValidator()
+ geldigheid_validator.set_context(serializer=self.get_serializer(instance))
+ geldigheid_validator()
+
instance.concept = False
instance.save()
@@ -158,28 +165,48 @@ def publish(self, request, *args, **kwargs):
responses={201: ZaakTypeSerializer},
)
def create(self, request, *args, **kwargs):
-
request = m2m_array_of_str_to_url(
request,
["besluittypen", "deelzaaktypen", "gerelateerde_zaaktypen"],
self.action,
)
-
return super(viewsets.ModelViewSet, self).create(request, *args, **kwargs)
+ def perform_create(self, serializer):
+ """automatically create new zaaktype relations when creating a new version of a zaaktype"""
+ serializer.save()
+ if serializer.data.get("gerelateerde_zaaktypen", None):
+ for rel_zaaktype in serializer.data["gerelateerde_zaaktypen"]:
+ if rel_zaaktype.get("zaaktype", None):
+ uuid = rel_zaaktype["zaaktype"].split("/")[-1]
+ model = get_object_or_404(ZaakType, uuid=uuid)
+ query = model.zaaktypenrelaties.all()
+ if query.filter(
+ gerelateerd_zaaktype=serializer.data.get("url", None)
+ ).exists():
+ continue
+ new_relation = ZaakTypenRelatie.objects.create(
+ gerelateerd_zaaktype=serializer.data.get("url", None),
+ zaaktype=model,
+ aard_relatie=rel_zaaktype.get("aard_relatie", None),
+ toelichting=rel_zaaktype.get("toelichting", None),
+ )
+
+ model.zaaktypenrelaties.add(new_relation)
+ model.save()
+
+ @extend_schema(parameters=[DATUM_GELDIGHEID_QUERY_PARAM])
def retrieve(self, request, *args, **kwargs):
- instance = self.get_object()
- serializer = extract_relevant_m2m(
- self.get_serializer(instance),
- [
- "besluittypen",
- "informatieobjecttypen",
- "deelzaaktypen",
- "gerelateerde_zaaktypen",
- ],
- self.action,
- )
- return Response(serializer.data)
+ return super(viewsets.ModelViewSet, self).retrieve(request, *args, **kwargs)
+
+ @property
+ def filterset_class(self):
+ """
+ To support filtering by versie and datum geldigheid for detail view
+ """
+ if self.detail:
+ return ZaakTypeDetailFilter
+ return ZaakTypeFilter
@extend_schema(
request=ZaakTypeUpdateSerializer,
@@ -193,18 +220,25 @@ def update(self, request, *args, **kwargs):
)
return super(viewsets.ModelViewSet, self).update(request, *args, **kwargs)
- def list(self, request, *args, **kwargs):
- self._check_query_params(request)
- queryset = self.filter_queryset(self.get_queryset())
- filters = (
- self.filter_backends[0]()
- .get_filterset_kwargs(self.request, queryset, self)
- .get("data", {})
- )
+ def get_serializer(self, *args, **kwargs):
+ """
+ Return the serializer instance that should be used for validating and
+ deserializing input, and for serializing output. Two special scenarios have been added for the retrieve and list operations. These are used to filter the m2m relations based on the geldigheid of the underlying objects.
+ """
+ serializer = super().get_serializer(*args, **kwargs)
+
+ if not self.request:
+ return serializer
+
+ if self.action in ["list", "retrieve"]:
+ filter_datum_geldigheid = self.request.query_params.get(
+ "datumGeldigheid", None
+ )
+ if self.detail:
+ instance = self.get_object()
+ if filter_datum_geldigheid and self.detail:
+ validate_detail_geldigheid(instance, filter_datum_geldigheid)
- page = self.paginate_queryset(queryset)
- if page is not None:
- serializer = self.get_serializer(page, many=True)
serializer = extract_relevant_m2m(
serializer,
[
@@ -214,21 +248,7 @@ def list(self, request, *args, **kwargs):
"gerelateerde_zaaktypen",
],
self.action,
- filters.get("datum_geldigheid", None),
+ filter_datum_geldigheid,
)
- return self.get_paginated_response(serializer.data)
-
- serializer = self.get_serializer(queryset, many=True)
- serializer = extract_relevant_m2m(
- serializer,
- [
- "besluittypen",
- "informatieobjecttypen",
- "deelzaaktypen",
- "gerelateerde_zaaktypen",
- ],
- self.action,
- filters.get("datum_geldigheid", None),
- )
- return Response(serializer.data)
+ return serializer
diff --git a/src/ztc/conf/base.py b/src/ztc/conf/base.py
index bca61a56..a47c9618 100644
--- a/src/ztc/conf/base.py
+++ b/src/ztc/conf/base.py
@@ -338,3 +338,4 @@
# URL for documentation that's shown in API schema
DOCUMENTATION_URL = "https://vng-realisatie.github.io/gemma-zaken"
+NOTIFICATIONS_DISABLED = True # During dev unable to create 'notifications_api_service' required for sending notifications.
diff --git a/src/ztc/datamodel/admin/informatieobjecttype.py b/src/ztc/datamodel/admin/informatieobjecttype.py
index 63563e25..ece925a6 100644
--- a/src/ztc/datamodel/admin/informatieobjecttype.py
+++ b/src/ztc/datamodel/admin/informatieobjecttype.py
@@ -104,5 +104,5 @@ class InformatieObjectTypeAdmin(
readonly_fields = ("uuid",)
inlines = (
BesluitTypenInline,
- ZaakInformatieobjectTypeInline,
+ # ZaakInformatieobjectTypeInline,
) # zaaktypes
diff --git a/src/ztc/datamodel/constants.py b/src/ztc/datamodel/constants.py
index e7d92040..382a5bb9 100644
--- a/src/ztc/datamodel/constants.py
+++ b/src/ztc/datamodel/constants.py
@@ -1,6 +1,8 @@
from django.utils.translation import ugettext_lazy as _
from djchoices import ChoiceItem, DjangoChoices
+from drf_spectacular.types import OpenApiTypes
+from drf_spectacular.utils import OpenApiParameter
class SelectielijstKlasseProcestermijn(DjangoChoices):
@@ -18,3 +20,11 @@ class SelectielijstKlasseProcestermijn(DjangoChoices):
"procestermijn en bewaartermijn samen een bewaartermijn vormen die direct kan gaan lopen na de procesfase."
),
)
+
+
+DATUM_GELDIGHEID_QUERY_PARAM = OpenApiParameter(
+ name="datumGeldigheid",
+ location=OpenApiParameter.QUERY,
+ description="filter op datumGeldigheid voor het zelf en alle onderliggende objecten",
+ type=OpenApiTypes.STR,
+)
diff --git a/src/ztc/datamodel/migrations/0139_auto_20230531_1039.py b/src/ztc/datamodel/migrations/0139_auto_20230531_1039.py
new file mode 100644
index 00000000..8822c4eb
--- /dev/null
+++ b/src/ztc/datamodel/migrations/0139_auto_20230531_1039.py
@@ -0,0 +1,22 @@
+# Generated by Django 3.2.14 on 2023-05-31 10:39
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+ dependencies = [
+ ("datamodel", "0138_alter_zaaktypenrelatie_unique_together"),
+ ]
+
+ operations = [
+ migrations.RemoveField(
+ model_name="informatieobjecttype",
+ name="zaaktypen",
+ ),
+ migrations.AlterField(
+ model_name="zaakinformatieobjecttype",
+ name="informatieobjecttype",
+ field=models.CharField(max_length=100),
+ ),
+ ]
diff --git a/src/ztc/datamodel/models/informatieobjecttype.py b/src/ztc/datamodel/models/informatieobjecttype.py
index 9caabceb..bae0e8ed 100644
--- a/src/ztc/datamodel/models/informatieobjecttype.py
+++ b/src/ztc/datamodel/models/informatieobjecttype.py
@@ -152,16 +152,16 @@ class InformatieObjectType(
),
)
- zaaktypen = models.ManyToManyField(
- "datamodel.ZaakType",
- blank=True,
- verbose_name=_("zaaktypen"),
- related_name="informatieobjecttypen",
- through="datamodel.ZaakInformatieobjectType",
- help_text=_(
- "ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit INFORMATIEOBJECTTYPE"
- ),
- )
+ # zaaktypen = models.ManyToManyField(
+ # "datamodel.ZaakType",
+ # blank=True,
+ # verbose_name=_("zaaktypen"),
+ # related_name="informatieobjecttypen",
+ # through="datamodel.ZaakInformatieobjectType",
+ # help_text=_(
+ # "ZAAKTYPE met ZAAKen die relevant kunnen zijn voor dit INFORMATIEOBJECTTYPE"
+ # ),
+ # )
class Meta:
# unique_together = ("catalogus", "omschrijving")
diff --git a/src/ztc/datamodel/models/relatieklassen.py b/src/ztc/datamodel/models/relatieklassen.py
index 79ee0c36..ea206505 100644
--- a/src/ztc/datamodel/models/relatieklassen.py
+++ b/src/ztc/datamodel/models/relatieklassen.py
@@ -30,12 +30,7 @@ class ZaakInformatieobjectType(ETagMixin, models.Model):
on_delete=models.CASCADE,
help_text=_("URL-referentie naar het ZAAKTYPE."),
)
- informatieobjecttype = models.ForeignKey(
- "datamodel.InformatieObjectType",
- on_delete=models.CASCADE,
- verbose_name=_("informatie object type"),
- help_text=_("URL-referentie naar het INFORMATIEOBJECTTYPE."),
- )
+ informatieobjecttype = models.CharField(max_length=100)
volgnummer = models.PositiveSmallIntegerField(
_("volgnummer"),
diff --git a/src/ztc/datamodel/tests/base_tests.py b/src/ztc/datamodel/tests/base_tests.py
index dc0b8b8b..9412f1a6 100644
--- a/src/ztc/datamodel/tests/base_tests.py
+++ b/src/ztc/datamodel/tests/base_tests.py
@@ -353,7 +353,6 @@ def setUp(self):
informatieobjectcategorie="Aanvraag",
vertrouwelijkheidaanduiding=VertrouwelijkheidsAanduiding.zaakvertrouwelijk,
model=[], # ArrayField
- zaaktypen=[self.zaaktype],
# TODO: following fields are in haaglanden doc but not in the datamodel
# volgnummer=1 # is pk...
# bron=ontvangen
@@ -367,7 +366,6 @@ def setUp(self):
informatieobjectcategorie="Brief",
vertrouwelijkheidaanduiding=VertrouwelijkheidsAanduiding.zaakvertrouwelijk,
model=[], # ArrayField
- zaaktypen=[self.zaaktype],
# TODO: following fields are in haaglanden doc but not in the datamodel
# volgnummer=1 # is pk...
# bron=ontvangen of uitgaand
diff --git a/src/ztc/datamodel/tests/factories/informatie_objecten.py b/src/ztc/datamodel/tests/factories/informatie_objecten.py
index dd3aacaf..e7b0db0c 100644
--- a/src/ztc/datamodel/tests/factories/informatie_objecten.py
+++ b/src/ztc/datamodel/tests/factories/informatie_objecten.py
@@ -26,9 +26,9 @@ class InformatieObjectTypeFactory(factory.django.DjangoModelFactory):
model = [] # ArrayField has blank=True but not null=True
informatieobjectcategorie = "informatieobjectcategorie"
catalogus = factory.SubFactory(CatalogusFactory)
- zaaktypen = factory.RelatedFactory(
- ZaakInformatieobjectTypeFactory, "informatieobjecttype"
- )
+ # zaaktypen = factory.RelatedFactory(
+ # ZaakInformatieobjectTypeFactory, "informatieobjecttype"
+ # )
datum_begin_geldigheid = date(2018, 1, 1)
class Meta:
diff --git a/src/ztc/datamodel/tests/factories/relatieklassen.py b/src/ztc/datamodel/tests/factories/relatieklassen.py
index 2f904854..65f1b64e 100644
--- a/src/ztc/datamodel/tests/factories/relatieklassen.py
+++ b/src/ztc/datamodel/tests/factories/relatieklassen.py
@@ -11,9 +11,10 @@
class ZaakInformatieobjectTypeFactory(factory.django.DjangoModelFactory):
zaaktype = factory.SubFactory("ztc.datamodel.tests.factories.ZaakTypeFactory")
- informatieobjecttype = factory.SubFactory(
- "ztc.datamodel.tests.factories.InformatieObjectTypeFactory", zaaktypen=None
- )
+ # informatieobjecttype = factory.SubFactory(
+ # "ztc.datamodel.tests.factories.InformatieObjectTypeFactory", zaaktypen=None
+ # )
+ informatieobjecttype = factory.fuzzy.FuzzyText(length=15)
volgnummer = factory.sequence(lambda x: x)
richting = RichtingChoices.inkomend
diff --git a/src/ztc/datamodel/tests/test_factories.py b/src/ztc/datamodel/tests/test_factories.py
index 7ac6b109..e2c1603f 100644
--- a/src/ztc/datamodel/tests/test_factories.py
+++ b/src/ztc/datamodel/tests/test_factories.py
@@ -60,8 +60,8 @@ def test_informatieobjecttype_factory(self):
InformatieObjectTypeFactory.create()
self.assertEqual(InformatieObjectType.objects.count(), 1)
- self.assertEqual(ZaakInformatieobjectType.objects.count(), 1)
- self.assertEqual(ZaakType.objects.count(), 1)
+ self.assertEqual(ZaakInformatieobjectType.objects.count(), 0)
+ self.assertEqual(ZaakType.objects.count(), 0)
@skip("ZaakInformatieobjectTypeArchiefregime is disabled at the moment")
def test_zaak_informatieobject_type_archiefregime_factory(self):
diff --git a/src/ztc/datamodel/utils.py b/src/ztc/datamodel/utils.py
index 58db7965..a23dc00e 100644
--- a/src/ztc/datamodel/utils.py
+++ b/src/ztc/datamodel/utils.py
@@ -26,3 +26,14 @@ def get_overlapping_zaaktypes(
query = query.exclude(pk=instance.pk)
return query
+
+
+def get_overlapping_concept_zaaktypes(
+ catalogus: Catalogus,
+ identificatie: str,
+) -> QuerySet:
+ query = ZaakType.objects.filter(
+ Q(catalogus=catalogus), Q(identificatie=identificatie), Q(concept=True) # noqa
+ )
+
+ return query
diff --git a/src/ztc/static/ico/favicon.png b/src/ztc/static/ico/favicon.png
index 3c97c10a..5cd7eacf 100644
Binary files a/src/ztc/static/ico/favicon.png and b/src/ztc/static/ico/favicon.png differ
diff --git a/src/ztc/static/img/maykinmedia_logo.png b/src/ztc/static/img/maykinmedia_logo.png
deleted file mode 100644
index 712e0b47..00000000
Binary files a/src/ztc/static/img/maykinmedia_logo.png and /dev/null differ
diff --git a/src/ztc/tests/test_userstory_history_model.py b/src/ztc/tests/test_userstory_history_model.py
index cae539ff..06b28c97 100644
--- a/src/ztc/tests/test_userstory_history_model.py
+++ b/src/ztc/tests/test_userstory_history_model.py
@@ -1,3 +1,5 @@
+from datetime import datetime, timedelta
+
from rest_framework import status
from vng_api_common.constants import VertrouwelijkheidsAanduiding
from vng_api_common.tests import get_operation_url, reverse, reverse_lazy
@@ -65,18 +67,17 @@ def test_user_story_new_version_model(self):
def get_zaaktype_list(self):
zaaktype_list_url = get_operation_url("zaaktype_list")
response = self.client.get(zaaktype_list_url)
- besluittype = BesluitType.objects.filter(
- datum_begin_geldigheid="2000-01-01", omschrijving="foo"
- )[0]
- besluittype_2 = BesluitType.objects.filter(
- datum_begin_geldigheid="2000-01-01", omschrijving="foo2"
- )[0]
+
besluittype_3 = BesluitType.objects.filter(
datum_begin_geldigheid="2016-01-01", omschrijving="foo"
)[0]
besluittype_4 = BesluitType.objects.filter(
datum_begin_geldigheid="2016-01-01", omschrijving="foo2"
)[0]
+ besluittype_5 = BesluitType.objects.filter(datum_begin_geldigheid="2030-01-01")[
+ 0
+ ]
+
data_zaaktype_2 = response.json()["results"]
self.assertEqual(
@@ -113,6 +114,20 @@ def post_informatieobjecttype(self):
"omschrijving": "test",
"vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
"beginGeldigheid": "2017-01-01",
+ "eindeGeldigheid": "2020-01-01",
+ "informatieobjectcategorie": "test",
+ }
+ informatieobjecttypen_list_url = get_operation_url("informatieobjecttype_list")
+
+ response = self.client.post(informatieobjecttypen_list_url, data)
+
+ self.assertEqual(response.status_code, status.HTTP_201_CREATED)
+
+ data = {
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "omschrijving": "test2",
+ "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
+ "beginGeldigheid": "2017-01-01",
"informatieobjectcategorie": "test",
}
informatieobjecttypen_list_url = get_operation_url("informatieobjecttype_list")
@@ -122,15 +137,13 @@ def post_informatieobjecttype(self):
self.assertEqual(response.status_code, status.HTTP_201_CREATED)
def post_besluittype_1(self):
- informatieobjecttype = InformatieObjectType.objects.get()
- informatieobjecttype_detail_url = get_operation_url(
- "informatieobjecttype_retrieve", uuid=informatieobjecttype.uuid
- )
+ informatieobjecttype = InformatieObjectType.objects.filter(omschrijving="test")[
+ 0
+ ]
besluittype_list_url = reverse("besluittype-list")
data = {
"catalogus": f"http://testserver{self.catalogus_detail_url}",
"omschrijving": "foo",
- "zaaktypen": ["ID"],
"omschrijvingGeneriek": "",
"besluitcategorie": "",
"reactietermijn": "P14D",
@@ -150,7 +163,6 @@ def post_besluittype_1(self):
data2 = {
"catalogus": f"http://testserver{self.catalogus_detail_url}",
"omschrijving": "foo2",
- "zaaktypen": ["ID"],
"omschrijvingGeneriek": "",
"besluitcategorie": "",
"reactietermijn": "P14D",
@@ -170,7 +182,6 @@ def post_besluittype_1(self):
data3 = {
"catalogus": f"http://testserver{self.catalogus_detail_url}",
"omschrijving": "foo3",
- "zaaktypen": ["ID"],
"omschrijvingGeneriek": "",
"besluitcategorie": "",
"reactietermijn": "P14D",
@@ -215,7 +226,6 @@ def post_zaaktype_1(self):
"besluittypen": ["foo", "foo2"],
"beginGeldigheid": "2000-01-01",
"eindeGeldigheid": "2000-01-02",
- # todo normaal staat deze op None, waar word deze gezet bij nieuwe versie van een zaaktype?
"versiedatum": "2000-01-01",
"verantwoordelijke": "Organisatie eenheid X",
"concept": True,
@@ -240,6 +250,20 @@ def post_ziot(self):
response = self.client.post(list_url, data)
self.assertEqual(response.status_code, 201)
+ list_url = reverse_lazy(ZaakInformatieobjectType)
+ zaaktype = ZaakType.objects.get()
+ zaaktype_detail_url = get_operation_url("zaaktype_retrieve", uuid=zaaktype.uuid)
+
+ data = {
+ "zaaktype": f"http://testserver{zaaktype_detail_url}",
+ "informatieobjecttype": "test2",
+ "volgnummer": 13,
+ "richting": RichtingChoices.inkomend,
+ }
+
+ response = self.client.post(list_url, data)
+ self.assertEqual(response.status_code, 201)
+
def post_ziot_2(self):
list_url = reverse_lazy(ZaakInformatieobjectType)
zaaktype_2 = ZaakType.objects.filter(datum_begin_geldigheid="2011-01-01")[0]
@@ -256,6 +280,16 @@ def post_ziot_2(self):
response = self.client.post(list_url, data)
self.assertEqual(response.status_code, 201)
+ data = {
+ "zaaktype": f"http://testserver{zaaktype_detail_url}",
+ "informatieobjecttype": "test2",
+ "volgnummer": 13,
+ "richting": RichtingChoices.inkomend,
+ }
+
+ response = self.client.post(list_url, data)
+ self.assertEqual(response.status_code, 201)
+
def publish_besluittype_1(self):
self.besluittype_1 = BesluitType.objects.all()[0]
self.besluittype_2 = BesluitType.objects.all()[1]
@@ -299,7 +333,23 @@ def publish_besluittype_2(self):
self.assertEqual(response_besluittype_publish.status_code, 200)
def publish_informatieobject_1(self):
- informatieobjecttype = InformatieObjectType.objects.get()
+ informatieobjecttype = InformatieObjectType.objects.filter(omschrijving="test")[
+ 0
+ ]
+
+ informatieobjecttypee_url = get_operation_url(
+ "informatieobjecttype_publish", uuid=informatieobjecttype.uuid
+ )
+
+ response_informatieobjecttypee_url = self.client.post(informatieobjecttypee_url)
+
+ self.assertEqual(
+ response_informatieobjecttypee_url.status_code, status.HTTP_200_OK
+ )
+
+ informatieobjecttype = InformatieObjectType.objects.filter(
+ omschrijving="test2"
+ )[0]
informatieobjecttypee_url = get_operation_url(
"informatieobjecttype_publish", uuid=informatieobjecttype.uuid
@@ -369,18 +419,12 @@ def publish_zaaktype_2(self):
self.assertEqual(response_2_publish.status_code, status.HTTP_200_OK)
def post_besluittype_2(self):
- """
- test if we can post with ' "zaaktypen": ["ID"], '. Where "ID" is converted into a URL in the View.
- """
-
- informatieobjecttype = InformatieObjectType.objects.get()
- informatieobjecttype_detail_url = get_operation_url(
- "informatieobjecttype_retrieve", uuid=informatieobjecttype.uuid
- )
+ informatieobjecttype = InformatieObjectType.objects.filter(omschrijving="test")[
+ 0
+ ]
besluittype_list_url = reverse("besluittype-list")
data = {
"catalogus": f"http://testserver{self.catalogus_detail_url}",
- "zaaktypen": ["ID"],
"omschrijving": "foo",
"omschrijvingGeneriek": "",
"besluitcategorie": "",
@@ -417,15 +461,13 @@ def post_besluittype_2(self):
self.assertEqual(response_besluit_2.status_code, 201)
def post_besluittype_3(self):
- informatieobjecttype = InformatieObjectType.objects.get()
- informatieobjecttype_detail_url = get_operation_url(
- "informatieobjecttype_retrieve", uuid=informatieobjecttype.uuid
- )
+ informatieobjecttype = InformatieObjectType.objects.filter(omschrijving="test")[
+ 0
+ ]
besluittype_list_url = reverse("besluittype-list")
data = {
"catalogus": f"http://testserver{self.catalogus_detail_url}",
- "zaaktypen": [f"ID"],
- "omschrijving": "foo",
+ "omschrijving": "foo2",
"omschrijvingGeneriek": "",
"besluitcategorie": "",
"reactietermijn": "P14D",
@@ -442,7 +484,7 @@ def post_besluittype_3(self):
self.assertEqual(response_besluit_1.status_code, 201)
def get_besluittype_2(self):
- """test that a GET request only returns the most recent associated besluittypen with concept=False"""
+ """test that a GET request only returns the most recent associated besluittypen"""
besluittype_2 = BesluitType.objects.filter(datum_begin_geldigheid="2016-01-01")[
0
@@ -462,39 +504,42 @@ def get_besluittype_2(self):
)
def get_zaaktype_2(self):
- """test that a GET request only returns the most recent associated besluittypen with concept=False"""
+ """test that a GET request only returns the most recent associated besluittypen"""
zaaktype_2 = ZaakType.objects.filter(datum_begin_geldigheid="2016-01-01")[0]
zaaktype_detail_url = get_operation_url(
"zaaktype_retrieve", uuid=zaaktype_2.uuid
)
+ informatieobjecttype = InformatieObjectType.objects.filter(
+ omschrijving="test2"
+ )[0]
response = self.client.get(zaaktype_detail_url)
- besluittype = BesluitType.objects.filter(datum_begin_geldigheid="2016-01-01")[0]
- besluittype_2 = BesluitType.objects.filter(datum_begin_geldigheid="2016-01-01")[
- 1
- ]
- self.assertEqual(response.status_code, 200)
+ self.assertEqual(response.status_code, 200)
self.assertEqual(len(response.json()["besluittypen"]), 2)
self.assertEqual(
- sorted(response.json()["besluittypen"]),
- sorted(
- [
- f"http://testserver{get_operation_url('besluittype_retrieve', uuid=besluittype.uuid)}",
- f"http://testserver{get_operation_url('besluittype_retrieve', uuid=besluittype_2.uuid)}",
- ]
- ),
+ (response.json()["informatieobjecttypen"][0]),
+ f"http://testserver{get_operation_url('informatieobjecttype_retrieve', uuid=informatieobjecttype.uuid)}",
)
def get_informatieobjecttype(self):
- informatieobjecttype = InformatieObjectType.objects.get()
+ informatieobjecttype = InformatieObjectType.objects.filter(omschrijving="test")[
+ 0
+ ]
informatieobjecttype_detail_url = get_operation_url(
"informatieobjecttype_retrieve", uuid=informatieobjecttype.uuid
)
+ z2 = ZaakType.objects.filter(datum_begin_geldigheid="2016-01-01")[0]
response = self.client.get(informatieobjecttype_detail_url)
+ self.assertEqual(response.status_code, 200)
+
+ self.assertEqual(
+ (response.json()["zaaktypen"][0]),
+ f"http://testserver{get_operation_url('zaaktype_retrieve', uuid=z2.uuid)}",
+ )
def update_zaaktype_2(self):
zaaktype_2 = ZaakType.objects.filter(datum_begin_geldigheid="2011-01-01")[0]
@@ -544,3 +589,969 @@ def delete_besluittype_3(self):
response_besluit_1 = self.client.delete(besluittype_url)
self.assertEqual(response_besluit_1.status_code, 204)
+
+
+class HistoryModelMichielScenario1Test(APITestCase):
+ maxDiff = None
+ heeft_alle_autorisaties = False
+ scopes = [SCOPE_CATALOGI_READ, SCOPE_CATALOGI_WRITE, SCOPE_CATALOGI_FORCED_DELETE]
+
+ def test_user_story_new_version_model(self):
+ "====== AANMAKEN OBJECTEN ======"
+ self.post_informatieobjecttype()
+ self.post_besluittype_1()
+ self.post_zaaktype_1()
+ self.post_ziot()
+
+ self.publish_besluittype_1()
+ self.publish_informatieobject_1()
+ self.publish_zaaktype_1()
+
+ self.post_zaaktype_2()
+ self.publish_zaaktype_2()
+
+ self.post_zaaktype_3()
+
+ "====== TESTEN SCENARIOS ======"
+
+ self.get_zaaktype_2()
+
+ self.post_zaaktype_1_V2()
+
+ self.get_zaaktype_2_with_updated_Z1()
+
+ self.get_zaaktype_list()
+
+ def post_informatieobjecttype(self):
+ data = {
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "omschrijving": "document1",
+ "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
+ "beginGeldigheid": "2001-01-01",
+ "informatieobjectcategorie": "test",
+ }
+ informatieobjecttypen_list_url = get_operation_url("informatieobjecttype_list")
+
+ response = self.client.post(informatieobjecttypen_list_url, data)
+
+ self.assertEqual(response.status_code, status.HTTP_201_CREATED)
+
+ def post_besluittype_1(self):
+ besluittype_list_url = reverse("besluittype-list")
+ data = {
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "omschrijving": "besluittype1",
+ "zaaktypen": [],
+ "omschrijvingGeneriek": "",
+ "besluitcategorie": "",
+ "reactietermijn": "P14D",
+ "publicatieIndicatie": True,
+ "publicatietekst": "",
+ "publicatietermijn": None,
+ "toelichting": "",
+ "informatieobjecttypen": ["document1"],
+ "beginGeldigheid": "2000-01-01",
+ "concept": True,
+ }
+
+ response_besluit_1 = self.client.post(besluittype_list_url, data)
+ self.assertEqual(response_besluit_1.status_code, 201)
+
+ def post_zaaktype_1(self):
+ zaaktype_list_url = get_operation_url("zaaktype_list")
+ data = {
+ "identificatie": "zaaktype1",
+ "doel": "some test",
+ "aanleiding": "some test",
+ "toelichting": "IAM GOING TO CHANGE",
+ "indicatieInternOfExtern": InternExtern.extern,
+ "handelingInitiator": "indienen",
+ "onderwerp": "Klacht",
+ "handelingBehandelaar": "uitvoeren",
+ "doorlooptijd": "P30D",
+ "opschortingEnAanhoudingMogelijk": False,
+ "verlengingMogelijk": True,
+ "verlengingstermijn": "P30D",
+ "publicatieIndicatie": True,
+ "verantwoordingsrelatie": [],
+ "productenOfDiensten": ["https://example.com/product/123"],
+ "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
+ "omschrijving": "some test",
+ "gerelateerdeZaaktypen": [],
+ "referentieproces": {"naam": "ReferentieProces 0", "link": ""},
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "besluittypen": ["besluittype1"],
+ "beginGeldigheid": "2000-01-01",
+ "versiedatum": "2000-01-01",
+ "verantwoordelijke": "Organisatie eenheid X",
+ "concept": True,
+ }
+
+ response_zaaktype_1 = self.client.post(
+ zaaktype_list_url, data, SERVER_NAME="testserver.com"
+ )
+
+ self.assertEqual(response_zaaktype_1.status_code, 201)
+
+ def post_ziot(self):
+ list_url = reverse_lazy(ZaakInformatieobjectType)
+ zaaktype = ZaakType.objects.get()
+ zaaktype_detail_url = get_operation_url(
+ "zaaktype_retrieve", uuid=zaaktype.uuid, SERVER_NAME="testserver.com"
+ )
+
+ data = {
+ "zaaktype": f"http://testserver{zaaktype_detail_url}",
+ "informatieobjecttype": "document1",
+ "volgnummer": 13,
+ "richting": RichtingChoices.inkomend,
+ }
+
+ response = self.client.post(list_url, data)
+ self.assertEqual(response.status_code, 201)
+
+ def post_zaaktype_2(self):
+ zaaktype_list_url = get_operation_url("zaaktype_list")
+ data = {
+ "identificatie": "zaaktype2",
+ "doel": "some test",
+ "aanleiding": "some test",
+ "indicatieInternOfExtern": InternExtern.extern,
+ "handelingInitiator": "indienen",
+ "onderwerp": "Klacht",
+ "handelingBehandelaar": "uitvoeren",
+ "doorlooptijd": "P30D",
+ "opschortingEnAanhoudingMogelijk": False,
+ "verlengingMogelijk": True,
+ "verlengingstermijn": "P30D",
+ "publicatieIndicatie": True,
+ "verantwoordingsrelatie": [],
+ "productenOfDiensten": ["https://example.com/product/123"],
+ "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
+ "omschrijving": "some test",
+ "gerelateerdeZaaktypen": [
+ {
+ "zaaktype": "zaaktype1",
+ "aard_relatie": AardRelatieChoices.bijdrage,
+ "toelichting": "test relations",
+ }
+ ],
+ "referentieproces": {"naam": "ReferentieProces 0", "link": ""},
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "besluittypen": [],
+ "beginGeldigheid": "2000-01-01",
+ "versiedatum": "2000-01-01",
+ "verantwoordelijke": "Organisatie eenheid X",
+ "concept": True,
+ }
+
+ response_zaaktype_2 = self.client.post(
+ zaaktype_list_url, data, SERVER_NAME="testserver.com"
+ )
+
+ self.assertEqual(response_zaaktype_2.status_code, 201)
+
+ def post_zaaktype_3(self):
+ zaaktype_list_url = get_operation_url("zaaktype_list")
+ data = {
+ "identificatie": "zaaktype3",
+ "doel": "some test",
+ "aanleiding": "some test",
+ "indicatieInternOfExtern": InternExtern.extern,
+ "handelingInitiator": "indienen",
+ "onderwerp": "Klacht",
+ "handelingBehandelaar": "uitvoeren",
+ "doorlooptijd": "P30D",
+ "opschortingEnAanhoudingMogelijk": False,
+ "verlengingMogelijk": True,
+ "verlengingstermijn": "P30D",
+ "publicatieIndicatie": True,
+ "verantwoordingsrelatie": [],
+ "productenOfDiensten": ["https://example.com/product/123"],
+ "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
+ "omschrijving": "some test",
+ "gerelateerdeZaaktypen": [
+ {
+ "zaaktype": "zaaktype1",
+ "aard_relatie": AardRelatieChoices.bijdrage,
+ "toelichting": "test relations",
+ }
+ ],
+ "referentieproces": {"naam": "ReferentieProces 0", "link": ""},
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "besluittypen": [],
+ "beginGeldigheid": "2000-01-01",
+ "versiedatum": "2000-01-01",
+ "verantwoordelijke": "Organisatie eenheid X",
+ "concept": True,
+ }
+
+ response_zaaktype_3 = self.client.post(
+ zaaktype_list_url, data, SERVER_NAME="testserver.com"
+ )
+
+ self.assertEqual(response_zaaktype_3.status_code, 201)
+
+ def get_zaaktype_2(self):
+ zaaktype_1 = ZaakType.objects.filter(identificatie="zaaktype1")[0]
+ zaaktype_2 = ZaakType.objects.filter(identificatie="zaaktype2")[0]
+ zaaktype_detail_url = get_operation_url(
+ "zaaktype_retrieve", uuid=zaaktype_2.uuid
+ )
+
+ response = self.client.get(zaaktype_detail_url, SERVER_NAME="testserver.com")
+
+ self.assertEqual(response.status_code, 200)
+ data = response.json()
+ self.assertEqual(
+ data["gerelateerdeZaaktypen"][0]["zaaktype"],
+ f"http://testserver.com{get_operation_url('zaaktype_retrieve', uuid=zaaktype_1.uuid)}",
+ )
+
+ def post_zaaktype_1_V2(self):
+ """Update einde geldigheid zaaktype 1 so we can post a second version of zaaktype 1"""
+ zaaktype_1 = ZaakType.objects.filter(identificatie="zaaktype1")[0]
+ zaaktype_url = reverse(zaaktype_1)
+
+ data = {
+ "eindeGeldigheid": "2003-01-01",
+ }
+
+ response = self.client.patch(zaaktype_url, data)
+ self.assertEqual(response.status_code, 200)
+
+ zaaktype_list_url = get_operation_url("zaaktype_list")
+ data = {
+ "identificatie": "zaaktype1",
+ "doel": "aangepast",
+ "aanleiding": "aangepast",
+ "toelichting": "IAM A CHANGED ZAAKTYPE",
+ "indicatieInternOfExtern": InternExtern.extern,
+ "handelingInitiator": "indienen",
+ "onderwerp": "Klacht",
+ "handelingBehandelaar": "uitvoeren",
+ "doorlooptijd": "P30D",
+ "opschortingEnAanhoudingMogelijk": False,
+ "verlengingMogelijk": True,
+ "verlengingstermijn": "P30D",
+ "publicatieIndicatie": True,
+ "verantwoordingsrelatie": [],
+ "productenOfDiensten": ["https://example.com/product/123"],
+ "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
+ "omschrijving": "some test",
+ "gerelateerdeZaaktypen": [
+ {
+ "zaaktype": "zaaktype2",
+ "aard_relatie": AardRelatieChoices.bijdrage,
+ "toelichting": "test relations",
+ }
+ ],
+ "referentieproces": {"naam": "ReferentieProces 0", "link": ""},
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "besluittypen": [],
+ "beginGeldigheid": "2004-01-01",
+ "versiedatum": "2004-01-01",
+ "verantwoordelijke": "Organisatie eenheid X",
+ "concept": True,
+ }
+
+ response_zaaktype_1_v2 = self.client.post(
+ zaaktype_list_url, data, SERVER_NAME="testserver.com"
+ )
+
+ self.assertEqual(response_zaaktype_1_v2.status_code, 201)
+
+ def publish_besluittype_1(self):
+ besluittype = BesluitType.objects.get()
+
+ besluittype_url_publish = reverse(
+ "besluittype-publish", kwargs={"uuid": besluittype.uuid}
+ )
+ response_besluittype_publish = self.client.post(besluittype_url_publish)
+ self.assertEqual(response_besluittype_publish.status_code, 200)
+
+ def publish_informatieobject_1(self):
+ informatieobjecttype = InformatieObjectType.objects.get()
+
+ informatieobjecttypee_url = get_operation_url(
+ "informatieobjecttype_publish", uuid=informatieobjecttype.uuid
+ )
+
+ response_informatieobjecttypee_url = self.client.post(informatieobjecttypee_url)
+
+ self.assertEqual(
+ response_informatieobjecttypee_url.status_code, status.HTTP_200_OK
+ )
+
+ def publish_zaaktype_1(self):
+ zaaktype_1 = ZaakType.objects.all().first()
+ zaaktype_1_publish = get_operation_url("zaaktype_publish", uuid=zaaktype_1.uuid)
+ response_1_publish = self.client.post(zaaktype_1_publish)
+ self.assertEqual(response_1_publish.status_code, status.HTTP_200_OK)
+
+ def publish_zaaktype_2(self):
+ zaaktype_2 = ZaakType.objects.filter(identificatie="zaaktype2")[0]
+ zaaktype_2_publish = get_operation_url("zaaktype_publish", uuid=zaaktype_2.uuid)
+ response_2_publish = self.client.post(zaaktype_2_publish)
+ self.assertEqual(response_2_publish.status_code, status.HTTP_200_OK)
+
+ def get_zaaktype_2_with_updated_Z1(self):
+ zaaktype_1_v2 = ZaakType.objects.filter(
+ identificatie="zaaktype1", datum_begin_geldigheid="2004-01-01"
+ )[0]
+ zaaktype_2 = ZaakType.objects.filter(identificatie="zaaktype2")[0]
+
+ zaaktype_detail_url = get_operation_url(
+ "zaaktype_retrieve", uuid=zaaktype_2.uuid
+ )
+
+ response = self.client.get(zaaktype_detail_url, SERVER_NAME="testserver.com")
+
+ self.assertEqual(response.status_code, 200)
+ data = response.json()
+
+ self.assertEqual(
+ data["gerelateerdeZaaktypen"][0]["zaaktype"],
+ f"http://testserver.com{get_operation_url('zaaktype_retrieve', uuid=zaaktype_1_v2.uuid)}",
+ )
+
+ def get_zaaktype_list(self):
+ zaaktype_list_url = get_operation_url("zaaktype_list")
+ response = self.client.get(
+ zaaktype_list_url,
+ {"datumGeldigheid": "2002-01-01", "identificatie": "zaaktype2"},
+ SERVER_NAME="testserver.com",
+ )
+
+ self.assertEqual(response.status_code, 200)
+ data_zaaktype_list = response.json()["results"]
+
+ zaaktype_1_v1 = ZaakType.objects.filter(
+ identificatie="zaaktype1", datum_begin_geldigheid="2000-01-01"
+ )[0]
+
+ self.assertEqual(
+ data_zaaktype_list[0]["gerelateerdeZaaktypen"][0]["zaaktype"],
+ f"http://testserver.com{get_operation_url('zaaktype_retrieve', uuid=zaaktype_1_v1.uuid)}",
+ )
+
+
+class HistoryModelMichielScenario2Test(APITestCase):
+ maxDiff = None
+ heeft_alle_autorisaties = False
+ scopes = [SCOPE_CATALOGI_READ, SCOPE_CATALOGI_WRITE, SCOPE_CATALOGI_FORCED_DELETE]
+
+ def test_user_story_new_version_model(self):
+ "====== AANMAKEN OBJECTEN ======"
+ self.post_informatieobjecttype()
+ self.post_besluittype_1()
+ self.post_zaaktype_1()
+ self.post_ziot()
+
+ self.publish_besluittype_1()
+ self.publish_informatieobject_1()
+ self.publish_zaaktype_1()
+
+ "====== SCENARIO ======"
+
+ self.get_zaaktype_1()
+ self.post_besluittype_2()
+ self.publish_besluittype_2()
+ self.get_zaaktype_1_with_besluittype_1_V2()
+ self.get_zaaktype_list()
+
+ def post_informatieobjecttype(self):
+ data = {
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "omschrijving": "document1",
+ "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
+ "beginGeldigheid": "2001-01-01",
+ "informatieobjectcategorie": "test",
+ }
+ informatieobjecttypen_list_url = get_operation_url("informatieobjecttype_list")
+
+ response = self.client.post(informatieobjecttypen_list_url, data)
+
+ self.assertEqual(response.status_code, status.HTTP_201_CREATED)
+
+ def post_besluittype_1(self):
+ besluittype_list_url = reverse("besluittype-list")
+ data = {
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "omschrijving": "besluittype1",
+ "zaaktypen": [],
+ "omschrijvingGeneriek": "",
+ "besluitcategorie": "",
+ "reactietermijn": "P14D",
+ "publicatieIndicatie": True,
+ "publicatietekst": "",
+ "publicatietermijn": None,
+ "toelichting": "",
+ "informatieobjecttypen": ["document1"],
+ "beginGeldigheid": "2000-01-01",
+ "concept": True,
+ }
+
+ response_besluit_1 = self.client.post(besluittype_list_url, data)
+ self.assertEqual(response_besluit_1.status_code, 201)
+
+ def post_zaaktype_1(self):
+ zaaktype_list_url = get_operation_url("zaaktype_list")
+ data = {
+ "identificatie": "zaaktype1",
+ "doel": "some test",
+ "aanleiding": "some test",
+ "toelichting": "IAM GOING TO CHANGE",
+ "indicatieInternOfExtern": InternExtern.extern,
+ "handelingInitiator": "indienen",
+ "onderwerp": "Klacht",
+ "handelingBehandelaar": "uitvoeren",
+ "doorlooptijd": "P30D",
+ "opschortingEnAanhoudingMogelijk": False,
+ "verlengingMogelijk": True,
+ "verlengingstermijn": "P30D",
+ "publicatieIndicatie": True,
+ "verantwoordingsrelatie": [],
+ "productenOfDiensten": ["https://example.com/product/123"],
+ "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
+ "omschrijving": "some test",
+ "gerelateerdeZaaktypen": [],
+ "referentieproces": {"naam": "ReferentieProces 0", "link": ""},
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "besluittypen": ["besluittype1"],
+ "beginGeldigheid": "2000-01-01",
+ "versiedatum": "2000-01-01",
+ "verantwoordelijke": "Organisatie eenheid X",
+ "concept": True,
+ }
+
+ response_zaaktype_1 = self.client.post(
+ zaaktype_list_url, data, SERVER_NAME="testserver.com"
+ )
+
+ self.assertEqual(response_zaaktype_1.status_code, 201)
+
+ def post_ziot(self):
+ list_url = reverse_lazy(ZaakInformatieobjectType)
+ zaaktype = ZaakType.objects.get()
+ zaaktype_detail_url = get_operation_url(
+ "zaaktype_retrieve", uuid=zaaktype.uuid, SERVER_NAME="testserver.com"
+ )
+
+ data = {
+ "zaaktype": f"http://testserver{zaaktype_detail_url}",
+ "informatieobjecttype": "document1",
+ "volgnummer": 13,
+ "richting": RichtingChoices.inkomend,
+ }
+
+ response = self.client.post(list_url, data)
+ self.assertEqual(response.status_code, 201)
+
+ def publish_besluittype_1(self):
+ besluittype = BesluitType.objects.get()
+
+ besluittype_url_publish = reverse(
+ "besluittype-publish", kwargs={"uuid": besluittype.uuid}
+ )
+ response_besluittype_publish = self.client.post(besluittype_url_publish)
+ self.assertEqual(response_besluittype_publish.status_code, 200)
+
+ def publish_informatieobject_1(self):
+ informatieobjecttype = InformatieObjectType.objects.get()
+
+ informatieobjecttypee_url = get_operation_url(
+ "informatieobjecttype_publish", uuid=informatieobjecttype.uuid
+ )
+
+ response_informatieobjecttypee_url = self.client.post(informatieobjecttypee_url)
+
+ self.assertEqual(
+ response_informatieobjecttypee_url.status_code, status.HTTP_200_OK
+ )
+
+ def publish_zaaktype_1(self):
+ zaaktype_1 = ZaakType.objects.all().first()
+ zaaktype_1_publish = get_operation_url("zaaktype_publish", uuid=zaaktype_1.uuid)
+ response_1_publish = self.client.post(zaaktype_1_publish)
+ self.assertEqual(response_1_publish.status_code, status.HTTP_200_OK)
+
+ def get_zaaktype_1(self):
+ zaaktype_1 = ZaakType.objects.filter(identificatie="zaaktype1")[0]
+ besluittype_1 = BesluitType.objects.filter(omschrijving="besluittype1")[0]
+
+ zaaktype_detail_url = get_operation_url(
+ "zaaktype_retrieve", uuid=zaaktype_1.uuid
+ )
+
+ response = self.client.get(zaaktype_detail_url, SERVER_NAME="testserver.com")
+
+ self.assertEqual(response.status_code, 200)
+
+ def post_besluittype_2(self):
+ besluittype_1 = BesluitType.objects.get()
+ besluittype_1_url = reverse(besluittype_1)
+
+ data = {
+ "eindeGeldigheid": "2003-01-01",
+ }
+
+ response = self.client.patch(besluittype_1_url, data)
+ self.assertEqual(response.status_code, 200)
+
+ besluittype_list_url = reverse("besluittype-list")
+
+ data = {
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "omschrijving": "besluittype1",
+ "omschrijvingGeneriek": "",
+ "besluitcategorie": "",
+ "reactietermijn": "P14D",
+ "publicatieIndicatie": True,
+ "publicatietekst": "",
+ "publicatietermijn": None,
+ "toelichting": "",
+ "informatieobjecttypen": ["document1"],
+ "beginGeldigheid": "2003-01-02",
+ "concept": True,
+ }
+
+ response_besluit_1 = self.client.post(besluittype_list_url, data)
+ self.assertEqual(response_besluit_1.status_code, 201)
+
+ def publish_besluittype_2(self):
+ besluittype = BesluitType.objects.filter(
+ omschrijving="besluittype1", datum_begin_geldigheid="2003-01-02"
+ )[0]
+
+ besluittype_url_publish = reverse(
+ "besluittype-publish", kwargs={"uuid": besluittype.uuid}
+ )
+ response_besluittype_publish = self.client.post(besluittype_url_publish)
+ self.assertEqual(response_besluittype_publish.status_code, 200)
+
+ def get_zaaktype_1_with_besluittype_1_V2(self):
+ zaaktype_1 = ZaakType.objects.filter(identificatie="zaaktype1")[0]
+ besluittype_1 = BesluitType.objects.filter(
+ omschrijving="besluittype1", datum_begin_geldigheid="2003-01-02"
+ )[0]
+
+ zaaktype_detail_url = get_operation_url(
+ "zaaktype_retrieve", uuid=zaaktype_1.uuid
+ )
+
+ response = self.client.get(zaaktype_detail_url, SERVER_NAME="testserver.com")
+
+ self.assertEqual(response.status_code, 200)
+
+ def get_zaaktype_1_with_besluittype_1_V1(self):
+ zaaktype_1 = ZaakType.objects.filter(identificatie="zaaktype1")[0]
+ besluittype_1 = BesluitType.objects.filter(
+ omschrijving="besluittype1", datum_begin_geldigheid="2003-01-02"
+ )[0]
+
+ zaaktype_detail_url = get_operation_url(
+ "zaaktype_retrieve", uuid=zaaktype_1.uuid
+ )
+
+ response = self.client.get(zaaktype_detail_url, SERVER_NAME="testserver.com")
+
+ self.assertEqual(response.status_code, 200)
+
+ def get_zaaktype_list(self):
+ zaaktype_list_url = get_operation_url("zaaktype_list")
+ response = self.client.get(
+ zaaktype_list_url,
+ {"datumGeldigheid": "2000-01-02", "identificatie": "zaaktype1"},
+ SERVER_NAME="testserver.com",
+ )
+
+ besluittype_v1 = BesluitType.objects.filter(
+ omschrijving="besluittype1", datum_begin_geldigheid="2000-01-01"
+ )[0]
+
+ self.assertEqual(response.status_code, 200)
+ data_zaaktype_list = response.json()["results"]
+
+ zaaktype_1_v1 = ZaakType.objects.filter(
+ identificatie="zaaktype1", datum_begin_geldigheid="2000-01-01"
+ )[0]
+
+ self.assertEqual(
+ data_zaaktype_list[0]["besluittypen"][0],
+ f"http://testserver.com{get_operation_url('besluittype_retrieve', uuid=besluittype_v1.uuid)}",
+ )
+
+
+class HistoryModelUserStory2256(APITestCase):
+ """https://github.com/VNG-Realisatie/gemma-zaken/issues/2256"""
+
+ maxDiff = None
+ heeft_alle_autorisaties = False
+ scopes = [SCOPE_CATALOGI_READ, SCOPE_CATALOGI_WRITE, SCOPE_CATALOGI_FORCED_DELETE]
+
+ def test_user_story_new_version_model(self):
+ self.post_zaaktype_1()
+ self.publish_zaaktype_1()
+
+ self.post_zaaktype_2()
+ self.publish_zaaktype_2()
+
+ self.post_zaaktype_3()
+ self.publish_zaaktype_3()
+
+ self.get_zaaktype_3()
+
+ def post_zaaktype_1(self):
+ zaaktype_list_url = get_operation_url("zaaktype_list")
+ data = {
+ "identificatie": "zaaktype1",
+ "doel": "some test",
+ "aanleiding": "some test",
+ "toelichting": "IAM GOING TO CHANGE",
+ "indicatieInternOfExtern": InternExtern.extern,
+ "handelingInitiator": "indienen",
+ "onderwerp": "Klacht",
+ "handelingBehandelaar": "uitvoeren",
+ "doorlooptijd": "P30D",
+ "opschortingEnAanhoudingMogelijk": False,
+ "verlengingMogelijk": True,
+ "verlengingstermijn": "P30D",
+ "publicatieIndicatie": True,
+ "verantwoordingsrelatie": [],
+ "productenOfDiensten": ["https://example.com/product/123"],
+ "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
+ "omschrijving": "some test",
+ "gerelateerdeZaaktypen": [],
+ "referentieproces": {"naam": "ReferentieProces 0", "link": ""},
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "besluittypen": [""],
+ "beginGeldigheid": str(
+ (datetime.now() - timedelta(days=30)).strftime("%Y-%m-%d")
+ ),
+ "versiedatum": "2001-02-01",
+ "verantwoordelijke": "Organisatie eenheid X",
+ "concept": True,
+ }
+
+ response_zaaktype_1 = self.client.post(
+ zaaktype_list_url, data, SERVER_NAME="testserver.com"
+ )
+
+ self.assertEqual(response_zaaktype_1.status_code, 201)
+
+ def post_zaaktype_2(self):
+ zaaktype_list_url = get_operation_url("zaaktype_list")
+ data = {
+ "identificatie": "zaaktype2",
+ "doel": "some test",
+ "aanleiding": "some test",
+ "indicatieInternOfExtern": InternExtern.extern,
+ "handelingInitiator": "indienen",
+ "onderwerp": "Klacht",
+ "handelingBehandelaar": "uitvoeren",
+ "doorlooptijd": "P30D",
+ "opschortingEnAanhoudingMogelijk": False,
+ "verlengingMogelijk": True,
+ "verlengingstermijn": "P30D",
+ "publicatieIndicatie": True,
+ "verantwoordingsrelatie": [],
+ "productenOfDiensten": ["https://example.com/product/123"],
+ "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
+ "omschrijving": "some test",
+ "gerelateerdeZaaktypen": [
+ {
+ "zaaktype": "zaaktype1",
+ "aard_relatie": AardRelatieChoices.bijdrage,
+ "toelichting": "test relations Z21",
+ }
+ ],
+ "referentieproces": {"naam": "ReferentieProces 0", "link": ""},
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "besluittypen": [],
+ "beginGeldigheid": str(
+ (datetime.now() - timedelta(days=30)).strftime("%Y-%m-%d")
+ ),
+ "eindeGeldigheid": str(
+ (datetime.now() - timedelta(days=0)).strftime("%Y-%m-%d")
+ ),
+ "versiedatum": "2000-01-01",
+ "verantwoordelijke": "Organisatie eenheid X",
+ "concept": True,
+ }
+
+ response_zaaktype_2 = self.client.post(
+ zaaktype_list_url, data, SERVER_NAME="testserver.com"
+ )
+
+ self.assertEqual(response_zaaktype_2.status_code, 201)
+
+ def post_zaaktype_3(self):
+ zaaktype_list_url = get_operation_url("zaaktype_list")
+ data = {
+ "identificatie": "zaaktype2",
+ "doel": "some test",
+ "aanleiding": "some test",
+ "indicatieInternOfExtern": InternExtern.extern,
+ "handelingInitiator": "indienen",
+ "onderwerp": "Klacht",
+ "handelingBehandelaar": "uitvoeren",
+ "doorlooptijd": "P30D",
+ "opschortingEnAanhoudingMogelijk": False,
+ "verlengingMogelijk": True,
+ "verlengingstermijn": "P30D",
+ "publicatieIndicatie": True,
+ "verantwoordingsrelatie": [],
+ "productenOfDiensten": ["https://example.com/product/123"],
+ "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
+ "omschrijving": "some test",
+ "gerelateerdeZaaktypen": [
+ {
+ "zaaktype": "zaaktype1",
+ "aard_relatie": AardRelatieChoices.bijdrage,
+ "toelichting": "test relations Z22",
+ },
+ ],
+ "referentieproces": {"naam": "ReferentieProces 0", "link": ""},
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "besluittypen": [],
+ "beginGeldigheid": str(
+ (datetime.now() + timedelta(days=1)).strftime("%Y-%m-%d")
+ ),
+ "versiedatum": "2000-01-01",
+ "verantwoordelijke": "Organisatie eenheid X",
+ "concept": True,
+ }
+
+ response_zaaktype_3 = self.client.post(
+ zaaktype_list_url, data, SERVER_NAME="testserver.com"
+ )
+
+ self.assertEqual(response_zaaktype_3.status_code, 201)
+
+ def publish_zaaktype_1(self):
+ zaaktype_1 = ZaakType.objects.all().first()
+ zaaktype_1_publish = get_operation_url("zaaktype_publish", uuid=zaaktype_1.uuid)
+ response_1_publish = self.client.post(zaaktype_1_publish)
+ self.assertEqual(response_1_publish.status_code, status.HTTP_200_OK)
+
+ def publish_zaaktype_2(self):
+ zaaktype_2 = ZaakType.objects.filter(identificatie="zaaktype2")[0]
+ zaaktype_2_publish = get_operation_url("zaaktype_publish", uuid=zaaktype_2.uuid)
+ response_2_publish = self.client.post(zaaktype_2_publish)
+ self.assertEqual(response_2_publish.status_code, status.HTTP_200_OK)
+
+ def publish_zaaktype_3(self):
+ zaaktype_3 = ZaakType.objects.filter(
+ identificatie="zaaktype2", datum_einde_geldigheid=None
+ )[0]
+ zaaktype_3_publish = get_operation_url("zaaktype_publish", uuid=zaaktype_3.uuid)
+ response_3_publish = self.client.post(zaaktype_3_publish)
+ self.assertEqual(response_3_publish.status_code, status.HTTP_200_OK)
+
+ def get_zaaktype_3(self):
+ zaaktype_1 = ZaakType.objects.filter(identificatie="zaaktype1")[0]
+
+ zaaktype_2_2 = ZaakType.objects.filter(
+ identificatie="zaaktype2", datum_einde_geldigheid=None
+ )[0]
+
+ zaaktype_detail_url = get_operation_url(
+ "zaaktype_retrieve", uuid=zaaktype_1.uuid
+ )
+
+ response = self.client.get(
+ zaaktype_detail_url,
+ {
+ "datumGeldigheid": str(
+ (datetime.now() + timedelta(days=1)).strftime("%Y-%m-%d")
+ )
+ },
+ SERVER_NAME="testserver.com",
+ )
+
+ self.assertEqual(response.status_code, 200)
+ data = response.json()
+ self.assertEqual(
+ data["gerelateerdeZaaktypen"][0]["zaaktype"],
+ f"http://testserver.com{get_operation_url('zaaktype_retrieve', uuid=zaaktype_2_2.uuid)}",
+ )
+
+
+class HistoryModelPublishRestrictionsTest(APITestCase):
+ maxDiff = None
+ heeft_alle_autorisaties = False
+ scopes = [SCOPE_CATALOGI_READ, SCOPE_CATALOGI_WRITE, SCOPE_CATALOGI_FORCED_DELETE]
+
+ def test_user_story_new_version_model(self):
+ """
+ In this userstory the following aspects of the new version model are tested:
+ 1. POST zaaktype with a besluittypen array consisted of besluittypen_omschrijvingen (which is conventially an array of URI's)
+ 2. POST besluittypen with a zaaktypen array consisted of zaaktypen_identificatie (which is conventially an array of URI's)
+ 3. GET a specific zaaktype which contains a list of associated besluittypen. Only the most recent and concept = False besluittypen should be shown.
+ """
+
+ self.post_informatieobjecttype()
+ self.post_besluittype_1()
+ self.post_besluittype_2()
+ self.post_zaaktype_1()
+ self.post_ziot()
+
+ self.publish_besluittype_1()
+ self.publish_informatieobject_1()
+ self.publish_zaaktype_1()
+
+ self.publish_besluittype_2()
+
+ def post_informatieobjecttype(self):
+ data = {
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "omschrijving": "test",
+ "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
+ "beginGeldigheid": "2017-01-01",
+ "eindeGeldigheid": "2020-01-01",
+ "informatieobjectcategorie": "test",
+ }
+ informatieobjecttypen_list_url = get_operation_url("informatieobjecttype_list")
+
+ response = self.client.post(informatieobjecttypen_list_url, data)
+
+ self.assertEqual(response.status_code, status.HTTP_201_CREATED)
+
+ def post_besluittype_1(self):
+ informatieobjecttype = InformatieObjectType.objects.filter(omschrijving="test")[
+ 0
+ ]
+ besluittype_list_url = reverse("besluittype-list")
+ data = {
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "omschrijving": "foo",
+ "omschrijvingGeneriek": "",
+ "besluitcategorie": "",
+ "reactietermijn": "P14D",
+ "publicatieIndicatie": True,
+ "publicatietekst": "",
+ "publicatietermijn": None,
+ "toelichting": "",
+ "informatieobjecttypen": [f"{informatieobjecttype.omschrijving}"],
+ "beginGeldigheid": "2000-01-01",
+ "eindeGeldigheid": "2000-01-02",
+ "concept": True,
+ }
+
+ response_besluit_1 = self.client.post(besluittype_list_url, data)
+ self.assertEqual(response_besluit_1.status_code, 201)
+
+ def post_zaaktype_1(self):
+ """
+ test if we can post with ' "besluittypen": ["foo"] '. Where "foo" is converted into a URL in the View.
+ """
+ zaaktype_list_url = get_operation_url("zaaktype_list")
+ data = {
+ "identificatie": "ID",
+ "doel": "some test",
+ "aanleiding": "some test",
+ "indicatieInternOfExtern": InternExtern.extern,
+ "handelingInitiator": "indienen",
+ "onderwerp": "Klacht",
+ "handelingBehandelaar": "uitvoeren",
+ "doorlooptijd": "P30D",
+ "opschortingEnAanhoudingMogelijk": False,
+ "verlengingMogelijk": True,
+ "verlengingstermijn": "P30D",
+ "publicatieIndicatie": True,
+ "verantwoordingsrelatie": [],
+ "productenOfDiensten": ["https://example.com/product/123"],
+ "vertrouwelijkheidaanduiding": VertrouwelijkheidsAanduiding.openbaar,
+ "omschrijving": "some test",
+ "gerelateerdeZaaktypen": [],
+ "referentieproces": {"naam": "ReferentieProces 0", "link": ""},
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "besluittypen": ["foo", "foo2"],
+ "beginGeldigheid": "2000-01-01",
+ "eindeGeldigheid": "2000-01-02",
+ "versiedatum": "2000-01-01",
+ "verantwoordelijke": "Organisatie eenheid X",
+ "concept": True,
+ }
+
+ response_zaaktype_1 = self.client.post(zaaktype_list_url, data)
+
+ self.assertEqual(response_zaaktype_1.status_code, 201)
+
+ def post_ziot(self):
+ list_url = reverse_lazy(ZaakInformatieobjectType)
+ zaaktype = ZaakType.objects.get()
+ zaaktype_detail_url = get_operation_url("zaaktype_retrieve", uuid=zaaktype.uuid)
+
+ data = {
+ "zaaktype": f"http://testserver{zaaktype_detail_url}",
+ "informatieobjecttype": "test",
+ "volgnummer": 13,
+ "richting": RichtingChoices.inkomend,
+ }
+
+ response = self.client.post(list_url, data)
+ self.assertEqual(response.status_code, 201)
+
+ def publish_besluittype_1(self):
+ self.besluittype_1 = BesluitType.objects.all()[0]
+
+ besluittype_url_publish = reverse(
+ "besluittype-publish", kwargs={"uuid": self.besluittype_1.uuid}
+ )
+ response_besluittype_publish = self.client.post(besluittype_url_publish)
+ self.assertEqual(response_besluittype_publish.status_code, 200)
+
+ def publish_besluittype_2(self):
+ besluittype = BesluitType.objects.filter(datum_begin_geldigheid="2016-01-01")[0]
+
+ besluittype_url_publish = reverse(
+ "besluittype-publish", kwargs={"uuid": besluittype.uuid}
+ )
+ response_besluittype_publish = self.client.post(besluittype_url_publish)
+ self.assertEqual(response_besluittype_publish.status_code, 200)
+
+ def publish_informatieobject_1(self):
+ informatieobjecttype = InformatieObjectType.objects.filter(omschrijving="test")[
+ 0
+ ]
+
+ informatieobjecttypee_url = get_operation_url(
+ "informatieobjecttype_publish", uuid=informatieobjecttype.uuid
+ )
+
+ response_informatieobjecttypee_url = self.client.post(informatieobjecttypee_url)
+
+ self.assertEqual(
+ response_informatieobjecttypee_url.status_code, status.HTTP_200_OK
+ )
+
+ def publish_zaaktype_1(self):
+ zaaktype_1 = ZaakType.objects.all().first()
+ zaaktype_1_publish = get_operation_url("zaaktype_publish", uuid=zaaktype_1.uuid)
+ response_1_publish = self.client.post(zaaktype_1_publish)
+ self.assertEqual(response_1_publish.status_code, status.HTTP_200_OK)
+
+ def post_besluittype_2(self):
+ informatieobjecttype = InformatieObjectType.objects.filter(omschrijving="test")[
+ 0
+ ]
+ besluittype_list_url = reverse("besluittype-list")
+ data = {
+ "catalogus": f"http://testserver{self.catalogus_detail_url}",
+ "omschrijving": "foo",
+ "omschrijvingGeneriek": "",
+ "besluitcategorie": "",
+ "reactietermijn": "P14D",
+ "publicatieIndicatie": True,
+ "publicatietekst": "",
+ "publicatietermijn": None,
+ "toelichting": "",
+ "informatieobjecttypen": [f"{informatieobjecttype.omschrijving}"],
+ "beginGeldigheid": "2016-01-01",
+ "concept": True,
+ }
+
+ response_besluit_1 = self.client.post(besluittype_list_url, data)
+ self.assertEqual(response_besluit_1.status_code, 201)