From 098023841ad7db227c6bf033c666187c32436ea5 Mon Sep 17 00:00:00 2001 From: Chris Wesseling Date: Thu, 21 Dec 2023 20:40:23 +0100 Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Add=20schema?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Removes pagination as per the reference openapi spec. --- .../referentielijsten/api/schema.py | 20 + .../api/tests/test_externe_registers.py | 3 +- .../api/tests/test_kanalen.py | 2 +- .../api/tests/test_landen.py | 2 +- .../api/tests/test_soorten_digitaal_adres.py | 2 +- .../api/tests/test_soorten_object.py | 2 +- .../api/tests/test_soorten_objectid.py | 2 +- .../referentielijsten/api/tests/test_talen.py | 2 +- .../components/referentielijsten/api/urls.py | 25 +- .../api/viewsets/externe_registers.py | 4 +- .../referentielijsten/api/viewsets/kanalen.py | 4 +- .../referentielijsten/api/viewsets/landen.py | 5 +- .../api/viewsets/soorten_digitaal_adres.py | 4 +- .../api/viewsets/soorten_object.py | 4 +- .../api/viewsets/soorten_objectid.py | 4 +- .../referentielijsten/api/viewsets/talen.py | 4 +- .../components/referentielijsten/openapi.yaml | 2423 ++++++++++++ .../referentielijsten/swagger2.0.json | 3244 +++++++++++++++++ src/openklant/conf/api.py | 1 + src/openklant/conf/base.py | 8 + 20 files changed, 5737 insertions(+), 28 deletions(-) create mode 100644 src/openklant/components/referentielijsten/api/schema.py create mode 100644 src/openklant/components/referentielijsten/openapi.yaml create mode 100644 src/openklant/components/referentielijsten/swagger2.0.json diff --git a/src/openklant/components/referentielijsten/api/schema.py b/src/openklant/components/referentielijsten/api/schema.py new file mode 100644 index 00000000..086ae4ba --- /dev/null +++ b/src/openklant/components/referentielijsten/api/schema.py @@ -0,0 +1,20 @@ +from django.conf import settings + +from drf_yasg import openapi + +description = """ +Een API om de referentielijsten in het domein klantinteracties te raadplegen en beheren. +""".strip() + +info = openapi.Info( + title="Klantinteracties Referentielijsten", + default_version=settings.REFERENTIELIJSTEN_API_VERSION, + description=description, + contact=openapi.Contact( + email="standaarden.ondersteuning@vng.nl", + url="https://vng-realisatie.github.io/klantinteracties/", + ), + license=openapi.License( + name="EUPL 1.2", url="https://opensource.org/licenses/EUPL-1.2" + ), +) diff --git a/src/openklant/components/referentielijsten/api/tests/test_externe_registers.py b/src/openklant/components/referentielijsten/api/tests/test_externe_registers.py index 0deed199..ea77b95b 100644 --- a/src/openklant/components/referentielijsten/api/tests/test_externe_registers.py +++ b/src/openklant/components/referentielijsten/api/tests/test_externe_registers.py @@ -13,8 +13,7 @@ def test_getexterneregisters(self): response = self.client.get(url) self.assertEqual(response.status_code, status.HTTP_200_OK) response_data = response.json() - self.assertEqual(response_data["count"], 1000) - self.assertLess(len(response_data["results"]), 1000) + self.assertEqual(len(response_data), 1000) def test_postregister(self): url = reverse("referentielijsten:externregister-list") diff --git a/src/openklant/components/referentielijsten/api/tests/test_kanalen.py b/src/openklant/components/referentielijsten/api/tests/test_kanalen.py index 67266e2d..e8eea422 100644 --- a/src/openklant/components/referentielijsten/api/tests/test_kanalen.py +++ b/src/openklant/components/referentielijsten/api/tests/test_kanalen.py @@ -13,7 +13,7 @@ def test_getkanalen(self): response = self.client.get(url) self.assertEqual(response.status_code, status.HTTP_200_OK) response_data = response.json() - self.assertEqual(response_data["count"], 6) + self.assertEqual(len(response_data), 6) def test_postkanaal(self): url = reverse("referentielijsten:kanaal-list") diff --git a/src/openklant/components/referentielijsten/api/tests/test_landen.py b/src/openklant/components/referentielijsten/api/tests/test_landen.py index d5647d41..7bb910ef 100644 --- a/src/openklant/components/referentielijsten/api/tests/test_landen.py +++ b/src/openklant/components/referentielijsten/api/tests/test_landen.py @@ -13,7 +13,7 @@ def test_getlanden(self): response = self.client.get(url) self.assertEqual(response.status_code, status.HTTP_200_OK) response_data = response.json() - self.assertEqual(response_data["count"], 6) + self.assertEqual(len(response_data), 6) def test_postland(self): url = reverse("referentielijsten:land-list") diff --git a/src/openklant/components/referentielijsten/api/tests/test_soorten_digitaal_adres.py b/src/openklant/components/referentielijsten/api/tests/test_soorten_digitaal_adres.py index 8ab0c8e5..762abb0c 100644 --- a/src/openklant/components/referentielijsten/api/tests/test_soorten_digitaal_adres.py +++ b/src/openklant/components/referentielijsten/api/tests/test_soorten_digitaal_adres.py @@ -13,7 +13,7 @@ def test_getsoortendigitaaladres(self): response = self.client.get(url) self.assertEqual(response.status_code, status.HTTP_200_OK) response_data = response.json() - self.assertEqual(response_data["count"], 6) + self.assertEqual(len(response_data), 6) def test_postsoortdigitaaladres(self): url = reverse("referentielijsten:soortdigitaaladres-list") diff --git a/src/openklant/components/referentielijsten/api/tests/test_soorten_object.py b/src/openklant/components/referentielijsten/api/tests/test_soorten_object.py index c6f89037..7d2beaab 100644 --- a/src/openklant/components/referentielijsten/api/tests/test_soorten_object.py +++ b/src/openklant/components/referentielijsten/api/tests/test_soorten_object.py @@ -13,7 +13,7 @@ def test_getsoortenobject(self): response = self.client.get(url) self.assertEqual(response.status_code, status.HTTP_200_OK) response_data = response.json() - self.assertEqual(response_data["count"], 6) + self.assertEqual(len(response_data), 6) def test_postsoortobject(self): url = reverse("referentielijsten:soortobject-list") diff --git a/src/openklant/components/referentielijsten/api/tests/test_soorten_objectid.py b/src/openklant/components/referentielijsten/api/tests/test_soorten_objectid.py index 187a28cc..6b374a24 100644 --- a/src/openklant/components/referentielijsten/api/tests/test_soorten_objectid.py +++ b/src/openklant/components/referentielijsten/api/tests/test_soorten_objectid.py @@ -13,7 +13,7 @@ def test_getsoortenobjectid(self): response = self.client.get(url) self.assertEqual(response.status_code, status.HTTP_200_OK) response_data = response.json() - self.assertEqual(response_data["count"], 6) + self.assertEqual(len(response_data), 6) def test_postsoortobjectid(self): url = reverse("referentielijsten:soortobjectid-list") diff --git a/src/openklant/components/referentielijsten/api/tests/test_talen.py b/src/openklant/components/referentielijsten/api/tests/test_talen.py index 3080d112..01fca3f0 100644 --- a/src/openklant/components/referentielijsten/api/tests/test_talen.py +++ b/src/openklant/components/referentielijsten/api/tests/test_talen.py @@ -13,7 +13,7 @@ def test_gettalen(self): response = self.client.get(url) self.assertEqual(response.status_code, status.HTTP_200_OK) response_data = response.json() - self.assertEqual(response_data["count"], 6) + self.assertEqual(len(response_data), 6) def test_posttaal(self): url = reverse("referentielijsten:taal-list") diff --git a/src/openklant/components/referentielijsten/api/urls.py b/src/openklant/components/referentielijsten/api/urls.py index ddeb89d5..97321713 100644 --- a/src/openklant/components/referentielijsten/api/urls.py +++ b/src/openklant/components/referentielijsten/api/urls.py @@ -1,9 +1,10 @@ from django.conf import settings -from django.urls import include, path +from django.urls import include, path, re_path -from vng_api_common import routers +from vng_api_common import routers, schema from . import viewsets +from .schema import info app_name = "referentielijsten" @@ -17,13 +18,27 @@ router.register("talen", viewsets.TaalViewSet) +class SchemaView(schema.SchemaView): + schema_path = settings.SPEC_URL["referentielijsten"] + info = info + + urlpatterns = [ path( - "v/", + "v/", include( [ - # TODO API documentation - # re_path(r"^schema/openapi(?P\.json|\.yaml)$", + # API documentation + re_path( + r"^schema/openapi(?P\.json|\.yaml)$", + SchemaView.without_ui(cache_timeout=None), + name="schema-json-referentielijsten", + ), + path( + "schema/", + SchemaView.with_ui("redoc", cache_timeout=None), + name="schema-redoc-klantinteracties", + ), path("", include(router.urls)), ] ), diff --git a/src/openklant/components/referentielijsten/api/viewsets/externe_registers.py b/src/openklant/components/referentielijsten/api/viewsets/externe_registers.py index d04681b5..9180ce2e 100644 --- a/src/openklant/components/referentielijsten/api/viewsets/externe_registers.py +++ b/src/openklant/components/referentielijsten/api/viewsets/externe_registers.py @@ -1,12 +1,12 @@ from rest_framework import viewsets -from rest_framework.pagination import PageNumberPagination from ...models import ExternRegister from ..serializers import ExternRegisterSerializer class ExternRegisterViewSet(viewsets.ModelViewSet): + __doc__ = ExternRegister.__doc__ lookup_field = "code" - pagination_class = PageNumberPagination + pagination_class = None queryset = ExternRegister.objects.order_by("-pk") serializer_class = ExternRegisterSerializer diff --git a/src/openklant/components/referentielijsten/api/viewsets/kanalen.py b/src/openklant/components/referentielijsten/api/viewsets/kanalen.py index 47cd1ca2..6686f5f0 100644 --- a/src/openklant/components/referentielijsten/api/viewsets/kanalen.py +++ b/src/openklant/components/referentielijsten/api/viewsets/kanalen.py @@ -1,12 +1,12 @@ from rest_framework import viewsets -from rest_framework.pagination import PageNumberPagination from ...models import Kanaal from ..serializers import KanaalSerializer class KanaalViewSet(viewsets.ModelViewSet): + __doc__ = Kanaal.__doc__ lookup_field = "code" - pagination_class = PageNumberPagination + pagination_class = None queryset = Kanaal.objects.order_by("-pk") serializer_class = KanaalSerializer diff --git a/src/openklant/components/referentielijsten/api/viewsets/landen.py b/src/openklant/components/referentielijsten/api/viewsets/landen.py index 3b337130..ed9e4d10 100644 --- a/src/openklant/components/referentielijsten/api/viewsets/landen.py +++ b/src/openklant/components/referentielijsten/api/viewsets/landen.py @@ -1,13 +1,12 @@ from rest_framework import viewsets -from rest_framework.pagination import PageNumberPagination from ...models import Land from ..serializers import LandSerializer class LandViewSet(viewsets.ModelViewSet): - # TODO? filterset_class filter vigerend? + __doc__ = Land.__doc__ lookup_field = "landcode" - pagination_class = PageNumberPagination + pagination_class = None queryset = Land.objects.order_by("-pk") serializer_class = LandSerializer diff --git a/src/openklant/components/referentielijsten/api/viewsets/soorten_digitaal_adres.py b/src/openklant/components/referentielijsten/api/viewsets/soorten_digitaal_adres.py index 01049b19..82acedd9 100644 --- a/src/openklant/components/referentielijsten/api/viewsets/soorten_digitaal_adres.py +++ b/src/openklant/components/referentielijsten/api/viewsets/soorten_digitaal_adres.py @@ -1,12 +1,12 @@ from rest_framework import viewsets -from rest_framework.pagination import PageNumberPagination from ...models import SoortDigitaalAdres from ..serializers import SoortDigitaalAdresSerializer class SoortDigitaalAdresViewSet(viewsets.ModelViewSet): + __doc__ = SoortDigitaalAdres.__doc__ lookup_field = "code" - pagination_class = PageNumberPagination + pagination_class = None queryset = SoortDigitaalAdres.objects.order_by("-pk") serializer_class = SoortDigitaalAdresSerializer diff --git a/src/openklant/components/referentielijsten/api/viewsets/soorten_object.py b/src/openklant/components/referentielijsten/api/viewsets/soorten_object.py index b792a47a..012d8864 100644 --- a/src/openklant/components/referentielijsten/api/viewsets/soorten_object.py +++ b/src/openklant/components/referentielijsten/api/viewsets/soorten_object.py @@ -1,12 +1,12 @@ from rest_framework import viewsets -from rest_framework.pagination import PageNumberPagination from ...models import SoortObject from ..serializers import SoortObjectSerializer class SoortObjectViewSet(viewsets.ModelViewSet): + __doc__ = SoortObject.__doc__ lookup_field = "code" - pagination_class = PageNumberPagination + pagination_class = None queryset = SoortObject.objects.order_by("-pk") serializer_class = SoortObjectSerializer diff --git a/src/openklant/components/referentielijsten/api/viewsets/soorten_objectid.py b/src/openklant/components/referentielijsten/api/viewsets/soorten_objectid.py index 66b8a2b5..b97a5fb2 100644 --- a/src/openklant/components/referentielijsten/api/viewsets/soorten_objectid.py +++ b/src/openklant/components/referentielijsten/api/viewsets/soorten_objectid.py @@ -1,12 +1,12 @@ from rest_framework import viewsets -from rest_framework.pagination import PageNumberPagination from ...models import SoortObjectid from ..serializers import SoortObjectidSerializer class SoortObjectidViewSet(viewsets.ModelViewSet): + __doc__ = SoortObjectid.__doc__ lookup_field = "code" - pagination_class = PageNumberPagination + pagination_class = None queryset = SoortObjectid.objects.order_by("-pk") serializer_class = SoortObjectidSerializer diff --git a/src/openklant/components/referentielijsten/api/viewsets/talen.py b/src/openklant/components/referentielijsten/api/viewsets/talen.py index 6da79a18..baaacddb 100644 --- a/src/openklant/components/referentielijsten/api/viewsets/talen.py +++ b/src/openklant/components/referentielijsten/api/viewsets/talen.py @@ -1,12 +1,12 @@ from rest_framework import viewsets -from rest_framework.pagination import PageNumberPagination from ...models import Taal from ..serializers import TaalSerializer class TaalViewSet(viewsets.ModelViewSet): + __doc__ = Taal.__doc__ lookup_field = "code" - pagination_class = PageNumberPagination + pagination_class = None queryset = Taal.objects.order_by("-pk") serializer_class = TaalSerializer diff --git a/src/openklant/components/referentielijsten/openapi.yaml b/src/openklant/components/referentielijsten/openapi.yaml new file mode 100644 index 00000000..33a02c70 --- /dev/null +++ b/src/openklant/components/referentielijsten/openapi.yaml @@ -0,0 +1,2423 @@ +openapi: 3.0.0 +info: + title: Klantinteracties Referentielijsten + description: Een API om de referentielijsten in het domein klantinteracties te raadplegen + en beheren. + contact: + url: https://vng-realisatie.github.io/klantinteracties/ + email: standaarden.ondersteuning@vng.nl + license: + name: EUPL 1.2 + url: https://opensource.org/licenses/EUPL-1.2 + version: 00.00.06 +security: +- JWT-Claims: [] +paths: + /externeregisters: + get: + operationId: externregister_list + description: 'Registers buiten het domein van klantinteracties + + waarin objecten zijn geregistreerd die binnen het domein van klantinteracties + een rol (kunnen) spelen.' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/ExternRegister' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - externeregisters + post: + operationId: externregister_create + description: 'Registers buiten het domein van klantinteracties + + waarin objecten zijn geregistreerd die binnen het domein van klantinteracties + een rol (kunnen) spelen.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/ExternRegister' + responses: + '201': + description: Created + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + content: + application/json: + schema: + $ref: '#/components/schemas/ExternRegister' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - externeregisters + parameters: [] + /externeregisters/{code}: + get: + operationId: externregister_read + description: 'Registers buiten het domein van klantinteracties + + waarin objecten zijn geregistreerd die binnen het domein van klantinteracties + een rol (kunnen) spelen.' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ExternRegister' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - externeregisters + put: + operationId: externregister_update + description: 'Registers buiten het domein van klantinteracties + + waarin objecten zijn geregistreerd die binnen het domein van klantinteracties + een rol (kunnen) spelen.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/ExternRegister' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ExternRegister' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - externeregisters + patch: + operationId: externregister_partial_update + description: 'Registers buiten het domein van klantinteracties + + waarin objecten zijn geregistreerd die binnen het domein van klantinteracties + een rol (kunnen) spelen.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/ExternRegister' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/ExternRegister' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - externeregisters + delete: + operationId: externregister_delete + description: 'Registers buiten het domein van klantinteracties + + waarin objecten zijn geregistreerd die binnen het domein van klantinteracties + een rol (kunnen) spelen.' + responses: + '204': + description: No content + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - externeregisters + parameters: + - name: code + in: path + description: Unieke technische identificerende code, primair bedoeld voor gebruik + bij interacties tussen IT-systemen. + required: true + schema: + type: string + /kanalen: + get: + operationId: kanaal_list + description: 'Kanalen die personen en organisaties kunnen gebruiken + + voor contact met de gemeente en vice versa.' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Kanaal' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - kanalen + post: + operationId: kanaal_create + description: 'Kanalen die personen en organisaties kunnen gebruiken + + voor contact met de gemeente en vice versa.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/Kanaal' + responses: + '201': + description: Created + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + content: + application/json: + schema: + $ref: '#/components/schemas/Kanaal' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - kanalen + parameters: [] + /kanalen/{code}: + get: + operationId: kanaal_read + description: 'Kanalen die personen en organisaties kunnen gebruiken + + voor contact met de gemeente en vice versa.' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Kanaal' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - kanalen + put: + operationId: kanaal_update + description: 'Kanalen die personen en organisaties kunnen gebruiken + + voor contact met de gemeente en vice versa.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/Kanaal' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Kanaal' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - kanalen + patch: + operationId: kanaal_partial_update + description: 'Kanalen die personen en organisaties kunnen gebruiken + + voor contact met de gemeente en vice versa.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/Kanaal' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Kanaal' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - kanalen + delete: + operationId: kanaal_delete + description: 'Kanalen die personen en organisaties kunnen gebruiken + + voor contact met de gemeente en vice versa.' + responses: + '204': + description: No content + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - kanalen + parameters: + - name: code + in: path + description: Unieke technische identificerende code, primair bedoeld voor gebruik + bij interacties tussen IT-systemen. + required: true + schema: + type: string + /landen: + get: + operationId: land_list + description: Alle huidige en voormalige landen met hun codes, namen en geldigheidsinformatie. + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Land' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - landen + post: + operationId: land_create + description: Alle huidige en voormalige landen met hun codes, namen en geldigheidsinformatie. + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/Land' + responses: + '201': + description: Created + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + content: + application/json: + schema: + $ref: '#/components/schemas/Land' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - landen + parameters: [] + /landen/{landcode}: + get: + operationId: land_read + description: Alle huidige en voormalige landen met hun codes, namen en geldigheidsinformatie. + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Land' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - landen + put: + operationId: land_update + description: Alle huidige en voormalige landen met hun codes, namen en geldigheidsinformatie. + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/Land' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Land' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - landen + patch: + operationId: land_partial_update + description: Alle huidige en voormalige landen met hun codes, namen en geldigheidsinformatie. + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/Land' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Land' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - landen + delete: + operationId: land_delete + description: Alle huidige en voormalige landen met hun codes, namen en geldigheidsinformatie. + responses: + '204': + description: No content + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - landen + parameters: + - name: landcode + in: path + description: Unieke technische identificerende code, primair bedoeld voor gebruik + bij interacties tussen IT-systemen. + required: true + schema: + type: string + /soortendigitaaladres: + get: + operationId: soortdigitaaladres_list + description: 'Soorten digitale adressen die personen en organisaties kunnen + gebruiken + + voor contact met de gemeente en vice versa.' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SoortDigitaalAdres' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortendigitaaladres + post: + operationId: soortdigitaaladres_create + description: 'Soorten digitale adressen die personen en organisaties kunnen + gebruiken + + voor contact met de gemeente en vice versa.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/SoortDigitaalAdres' + responses: + '201': + description: Created + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + content: + application/json: + schema: + $ref: '#/components/schemas/SoortDigitaalAdres' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortendigitaaladres + parameters: [] + /soortendigitaaladres/{code}: + get: + operationId: soortdigitaaladres_read + description: 'Soorten digitale adressen die personen en organisaties kunnen + gebruiken + + voor contact met de gemeente en vice versa.' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/SoortDigitaalAdres' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortendigitaaladres + put: + operationId: soortdigitaaladres_update + description: 'Soorten digitale adressen die personen en organisaties kunnen + gebruiken + + voor contact met de gemeente en vice versa.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/SoortDigitaalAdres' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/SoortDigitaalAdres' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortendigitaaladres + patch: + operationId: soortdigitaaladres_partial_update + description: 'Soorten digitale adressen die personen en organisaties kunnen + gebruiken + + voor contact met de gemeente en vice versa.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/SoortDigitaalAdres' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/SoortDigitaalAdres' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortendigitaaladres + delete: + operationId: soortdigitaaladres_delete + description: 'Soorten digitale adressen die personen en organisaties kunnen + gebruiken + + voor contact met de gemeente en vice versa.' + responses: + '204': + description: No content + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortendigitaaladres + parameters: + - name: code + in: path + description: Unieke technische identificerende code, primair bedoeld voor gebruik + bij interacties tussen IT-systemen. + required: true + schema: + type: string + /soortenobject: + get: + operationId: soortobject_list + description: 'Typen objecten waarnaar vanuit het klantinteractiesregister + + relaties kunnen worden gelegd.' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SoortObject' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortenobject + post: + operationId: soortobject_create + description: 'Typen objecten waarnaar vanuit het klantinteractiesregister + + relaties kunnen worden gelegd.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/SoortObject' + responses: + '201': + description: Created + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + content: + application/json: + schema: + $ref: '#/components/schemas/SoortObject' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortenobject + parameters: [] + /soortenobject/{code}: + get: + operationId: soortobject_read + description: 'Typen objecten waarnaar vanuit het klantinteractiesregister + + relaties kunnen worden gelegd.' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/SoortObject' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortenobject + put: + operationId: soortobject_update + description: 'Typen objecten waarnaar vanuit het klantinteractiesregister + + relaties kunnen worden gelegd.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/SoortObject' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/SoortObject' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortenobject + patch: + operationId: soortobject_partial_update + description: 'Typen objecten waarnaar vanuit het klantinteractiesregister + + relaties kunnen worden gelegd.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/SoortObject' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/SoortObject' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortenobject + delete: + operationId: soortobject_delete + description: 'Typen objecten waarnaar vanuit het klantinteractiesregister + + relaties kunnen worden gelegd.' + responses: + '204': + description: No content + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortenobject + parameters: + - name: code + in: path + description: Unieke technische identificerende code, primair bedoeld voor gebruik + bij interacties tussen IT-systemen. + required: true + schema: + type: string + /soortenobjectid: + get: + operationId: soortobjectid_list + description: 'Identificatiesystemen en de registers waarin volgens deze systemen + + te identificeren objecten gevonden kunnen worden.' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/SoortObjectid' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortenobjectid + post: + operationId: soortobjectid_create + description: 'Identificatiesystemen en de registers waarin volgens deze systemen + + te identificeren objecten gevonden kunnen worden.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/SoortObjectid' + responses: + '201': + description: Created + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + content: + application/json: + schema: + $ref: '#/components/schemas/SoortObjectid' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortenobjectid + parameters: [] + /soortenobjectid/{code}: + get: + operationId: soortobjectid_read + description: 'Identificatiesystemen en de registers waarin volgens deze systemen + + te identificeren objecten gevonden kunnen worden.' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/SoortObjectid' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortenobjectid + put: + operationId: soortobjectid_update + description: 'Identificatiesystemen en de registers waarin volgens deze systemen + + te identificeren objecten gevonden kunnen worden.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/SoortObjectid' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/SoortObjectid' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortenobjectid + patch: + operationId: soortobjectid_partial_update + description: 'Identificatiesystemen en de registers waarin volgens deze systemen + + te identificeren objecten gevonden kunnen worden.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/SoortObjectid' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/SoortObjectid' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortenobjectid + delete: + operationId: soortobjectid_delete + description: 'Identificatiesystemen en de registers waarin volgens deze systemen + + te identificeren objecten gevonden kunnen worden.' + responses: + '204': + description: No content + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - soortenobjectid + parameters: + - name: code + in: path + description: Unieke technische identificerende code, primair bedoeld voor gebruik + bij interacties tussen IT-systemen. + required: true + schema: + type: string + /talen: + get: + operationId: taal_list + description: 'Talen die personen en organisaties kunnen gebruiken + + bij contact met de gemeente en vice versa.' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/Taal' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - talen + post: + operationId: taal_create + description: 'Talen die personen en organisaties kunnen gebruiken + + bij contact met de gemeente en vice versa.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/Taal' + responses: + '201': + description: Created + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + Location: + schema: + type: string + format: uri + description: URL waar de resource leeft. + content: + application/json: + schema: + $ref: '#/components/schemas/Taal' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - talen + parameters: [] + /talen/{code}: + get: + operationId: taal_read + description: 'Talen die personen en organisaties kunnen gebruiken + + bij contact met de gemeente en vice versa.' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Taal' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - talen + put: + operationId: taal_update + description: 'Talen die personen en organisaties kunnen gebruiken + + bij contact met de gemeente en vice versa.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/Taal' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Taal' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - talen + patch: + operationId: taal_partial_update + description: 'Talen die personen en organisaties kunnen gebruiken + + bij contact met de gemeente en vice versa.' + parameters: + - name: Content-Type + in: header + description: Content type van de verzoekinhoud. + required: true + schema: + type: string + enum: + - application/json + requestBody: + $ref: '#/components/requestBodies/Taal' + responses: + '200': + description: OK + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/json: + schema: + $ref: '#/components/schemas/Taal' + '400': + $ref: '#/components/responses/400' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - talen + delete: + operationId: taal_delete + description: 'Talen die personen en organisaties kunnen gebruiken + + bij contact met de gemeente en vice versa.' + responses: + '204': + description: No content + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van + een specifieke aanroep. Voorbeeld: 1.2.1.' + '401': + $ref: '#/components/responses/401' + '403': + $ref: '#/components/responses/403' + '404': + $ref: '#/components/responses/404' + '406': + $ref: '#/components/responses/406' + '409': + $ref: '#/components/responses/409' + '410': + $ref: '#/components/responses/410' + '415': + $ref: '#/components/responses/415' + '429': + $ref: '#/components/responses/429' + '500': + $ref: '#/components/responses/500' + tags: + - talen + parameters: + - name: code + in: path + description: Unieke technische identificerende code, primair bedoeld voor gebruik + bij interacties tussen IT-systemen. + required: true + schema: + type: string +servers: +- url: /referentielijsten/api/v00 +components: + responses: + '400': + description: Bad request + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ValidatieFout' + '401': + description: Unauthorized + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '403': + description: Forbidden + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '404': + description: Not found + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '406': + description: Not acceptable + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '409': + description: Conflict + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '410': + description: Gone + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '412': + description: Precondition failed + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '415': + description: Unsupported media type + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '429': + description: Too many requests + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + '500': + description: Internal server error + headers: + API-version: + schema: + type: string + description: 'Geeft een specifieke API-versie aan in de context van een + specifieke aanroep. Voorbeeld: 1.2.1.' + content: + application/problem+json: + schema: + $ref: '#/components/schemas/Fout' + requestBodies: + SoortObject: + content: + application/json: + schema: + $ref: '#/components/schemas/SoortObject' + required: true + Taal: + content: + application/json: + schema: + $ref: '#/components/schemas/Taal' + required: true + SoortDigitaalAdres: + content: + application/json: + schema: + $ref: '#/components/schemas/SoortDigitaalAdres' + required: true + ExternRegister: + content: + application/json: + schema: + $ref: '#/components/schemas/ExternRegister' + required: true + Kanaal: + content: + application/json: + schema: + $ref: '#/components/schemas/Kanaal' + required: true + Land: + content: + application/json: + schema: + $ref: '#/components/schemas/Land' + required: true + SoortObjectid: + content: + application/json: + schema: + $ref: '#/components/schemas/SoortObjectid' + required: true + securitySchemes: + JWT-Claims: + type: http + scheme: bearer + bearerFormat: JWT + schemas: + ExternRegister: + required: + - code + - locatie + - naam + type: object + properties: + code: + title: Code + description: Unieke technische identificerende code, primair bedoeld voor + gebruik bij interacties tussen IT-systemen. + type: string + maxLength: 40 + minLength: 1 + locatie: + title: Locatie + description: Kort (40 karakters) tekstveld voor een omschrijving. + type: string + maxLength: 40 + minLength: 1 + naam: + title: Naam + description: Kort (80 karakters) tekstveld voor een naam. + type: string + maxLength: 80 + minLength: 1 + Fout: + required: + - code + - title + - status + - detail + - instance + type: object + properties: + type: + title: Type + description: URI referentie naar het type fout, bedoeld voor developers + type: string + code: + title: Code + description: Systeemcode die het type fout aangeeft + type: string + minLength: 1 + title: + title: Title + description: Generieke titel voor het type fout + type: string + minLength: 1 + status: + title: Status + description: De HTTP status code + type: integer + detail: + title: Detail + description: Extra informatie bij de fout, indien beschikbaar + type: string + minLength: 1 + instance: + title: Instance + description: URI met referentie naar dit specifiek voorkomen van de fout. + Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + type: string + minLength: 1 + FieldValidationError: + required: + - name + - code + - reason + type: object + properties: + name: + title: Name + description: Naam van het veld met ongeldige gegevens + type: string + minLength: 1 + code: + title: Code + description: Systeemcode die het type fout aangeeft + type: string + minLength: 1 + reason: + title: Reason + description: Uitleg wat er precies fout is met de gegevens + type: string + minLength: 1 + ValidatieFout: + required: + - code + - title + - status + - detail + - instance + - invalidParams + type: object + properties: + type: + title: Type + description: URI referentie naar het type fout, bedoeld voor developers + type: string + code: + title: Code + description: Systeemcode die het type fout aangeeft + type: string + minLength: 1 + title: + title: Title + description: Generieke titel voor het type fout + type: string + minLength: 1 + status: + title: Status + description: De HTTP status code + type: integer + detail: + title: Detail + description: Extra informatie bij de fout, indien beschikbaar + type: string + minLength: 1 + instance: + title: Instance + description: URI met referentie naar dit specifiek voorkomen van de fout. + Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. + type: string + minLength: 1 + invalidParams: + type: array + items: + $ref: '#/components/schemas/FieldValidationError' + Kanaal: + required: + - code + - indicatieActief + - naam + type: object + properties: + code: + title: Code + description: Unieke technische identificerende code, primair bedoeld voor + gebruik bij interacties tussen IT-systemen. + type: string + maxLength: 40 + minLength: 1 + indicatieActief: + title: Indicatie actief + description: Indicatie voor een waarde `Ja` of een waarde `Nee`. + type: boolean + naam: + title: Naam + description: Kort (80 karakters) tekstveld voor een naam. + type: string + maxLength: 80 + minLength: 1 + Land: + required: + - landcode + - landnaam + - ingangsdatumLand + - einddatumLand + type: object + properties: + landcode: + title: Landcode + description: Unieke technische identificerende code, primair bedoeld voor + gebruik bij interacties tussen IT-systemen. + type: string + maxLength: 40 + minLength: 1 + landnaam: + title: Landnaam + description: Kort (80 karakters) tekstveld voor een naam. + type: string + maxLength: 80 + minLength: 1 + ingangsdatumLand: + title: Ingangsdatum land + description: 'Aanduiding van datum volgens de NEN-ISO 8601:2019-standaard. + Een datum wordt genoteerd van het meest naar het minst significante onderdeel. + Een voorbeeld: 2022-02-21 representeert 21 februari 2022.' + type: string + format: date + einddatumLand: + title: Einddatum land + description: 'Aanduiding van datum volgens de NEN-ISO 8601:2019-standaard. + Een datum wordt genoteerd van het meest naar het minst significante onderdeel. + Een voorbeeld: 2022-02-21 representeert 21 februari 2022.' + type: string + format: date + SoortDigitaalAdres: + required: + - code + - indicatieActief + - naam + type: object + properties: + code: + title: Code + description: Unieke technische identificerende code, primair bedoeld voor + gebruik bij interacties tussen IT-systemen. + type: string + maxLength: 40 + minLength: 1 + indicatieActief: + title: Indicatie actief + description: Indicatie voor een waarde `Ja` of een waarde `Nee`. + type: boolean + naam: + title: Naam + description: Kort (80 karakters) tekstveld voor een naam. + type: string + maxLength: 80 + minLength: 1 + SoortObject: + required: + - code + - indicatieActief + - naam + type: object + properties: + code: + title: Code + description: Unieke technische identificerende code, primair bedoeld voor + gebruik bij interacties tussen IT-systemen. + type: string + maxLength: 40 + minLength: 1 + indicatieActief: + title: Indicatie actief + description: Indicatie voor een waarde `Ja` of een waarde `Nee`. + type: boolean + naam: + title: Naam + description: Kort (80 karakters) tekstveld voor een naam. + type: string + maxLength: 80 + minLength: 1 + SoortObjectid: + required: + - code + - indicatieActief + - naam + type: object + properties: + code: + title: Code + description: Unieke technische identificerende code, primair bedoeld voor + gebruik bij interacties tussen IT-systemen. + type: string + maxLength: 40 + minLength: 1 + indicatieActief: + title: Indicatie actief + description: Indicatie voor een waarde `Ja` of een waarde `Nee`. + type: boolean + naam: + title: Naam + description: Kort (80 karakters) tekstveld voor een naam. + type: string + maxLength: 80 + minLength: 1 + Taal: + required: + - code + - indicatieActief + - naam + type: object + properties: + code: + title: Code + description: Unieke technische identificerende code, primair bedoeld voor + gebruik bij interacties tussen IT-systemen. + type: string + maxLength: 40 + minLength: 1 + indicatieActief: + title: Indicatie actief + description: Indicatie voor een waarde `Ja` of een waarde `Nee`. + type: boolean + naam: + title: Naam + description: Kort (80 karakters) tekstveld voor een naam. + type: string + maxLength: 80 + minLength: 1 diff --git a/src/openklant/components/referentielijsten/swagger2.0.json b/src/openklant/components/referentielijsten/swagger2.0.json new file mode 100644 index 00000000..6deedcd9 --- /dev/null +++ b/src/openklant/components/referentielijsten/swagger2.0.json @@ -0,0 +1,3244 @@ +{ + "swagger": "2.0", + "info": { + "title": "Klantinteracties Referentielijsten", + "description": "Een API om de referentielijsten in het domein klantinteracties te raadplegen en beheren.", + "contact": { + "url": "https://vng-realisatie.github.io/klantinteracties/", + "email": "standaarden.ondersteuning@vng.nl" + }, + "license": { + "name": "EUPL 1.2", + "url": "https://opensource.org/licenses/EUPL-1.2" + }, + "version": "00.00.06" + }, + "basePath": "/referentielijsten/api/v00", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "JWT-Claims": { + "type": "http", + "scheme": "bearer", + "bearerFormat": "JWT" + } + }, + "security": [ + { + "JWT-Claims": [] + } + ], + "paths": { + "/externeregisters": { + "get": { + "operationId": "externregister_list", + "description": "Registers buiten het domein van klantinteracties\nwaarin objecten zijn geregistreerd die binnen het domein van klantinteracties een rol (kunnen) spelen.", + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ExternRegister" + } + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "externeregisters" + ] + }, + "post": { + "operationId": "externregister_create", + "description": "Registers buiten het domein van klantinteracties\nwaarin objecten zijn geregistreerd die binnen het domein van klantinteracties een rol (kunnen) spelen.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExternRegister" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ExternRegister" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + }, + "Location": { + "schema": { + "type": "string", + "format": "uri" + }, + "description": "URL waar de resource leeft." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "externeregisters" + ] + }, + "parameters": [] + }, + "/externeregisters/{code}": { + "get": { + "operationId": "externregister_read", + "description": "Registers buiten het domein van klantinteracties\nwaarin objecten zijn geregistreerd die binnen het domein van klantinteracties een rol (kunnen) spelen.", + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExternRegister" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "externeregisters" + ] + }, + "put": { + "operationId": "externregister_update", + "description": "Registers buiten het domein van klantinteracties\nwaarin objecten zijn geregistreerd die binnen het domein van klantinteracties een rol (kunnen) spelen.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExternRegister" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExternRegister" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "externeregisters" + ] + }, + "patch": { + "operationId": "externregister_partial_update", + "description": "Registers buiten het domein van klantinteracties\nwaarin objecten zijn geregistreerd die binnen het domein van klantinteracties een rol (kunnen) spelen.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExternRegister" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ExternRegister" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "externeregisters" + ] + }, + "delete": { + "operationId": "externregister_delete", + "description": "Registers buiten het domein van klantinteracties\nwaarin objecten zijn geregistreerd die binnen het domein van klantinteracties een rol (kunnen) spelen.", + "parameters": [], + "responses": { + "204": { + "description": "No content", + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "externeregisters" + ] + }, + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Unieke technische identificerende code, primair bedoeld voor gebruik bij interacties tussen IT-systemen.", + "required": true, + "type": "string" + } + ] + }, + "/kanalen": { + "get": { + "operationId": "kanaal_list", + "description": "Kanalen die personen en organisaties kunnen gebruiken\nvoor contact met de gemeente en vice versa.", + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Kanaal" + } + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "kanalen" + ] + }, + "post": { + "operationId": "kanaal_create", + "description": "Kanalen die personen en organisaties kunnen gebruiken\nvoor contact met de gemeente en vice versa.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Kanaal" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Kanaal" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + }, + "Location": { + "schema": { + "type": "string", + "format": "uri" + }, + "description": "URL waar de resource leeft." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "kanalen" + ] + }, + "parameters": [] + }, + "/kanalen/{code}": { + "get": { + "operationId": "kanaal_read", + "description": "Kanalen die personen en organisaties kunnen gebruiken\nvoor contact met de gemeente en vice versa.", + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Kanaal" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "kanalen" + ] + }, + "put": { + "operationId": "kanaal_update", + "description": "Kanalen die personen en organisaties kunnen gebruiken\nvoor contact met de gemeente en vice versa.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Kanaal" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Kanaal" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "kanalen" + ] + }, + "patch": { + "operationId": "kanaal_partial_update", + "description": "Kanalen die personen en organisaties kunnen gebruiken\nvoor contact met de gemeente en vice versa.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Kanaal" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Kanaal" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "kanalen" + ] + }, + "delete": { + "operationId": "kanaal_delete", + "description": "Kanalen die personen en organisaties kunnen gebruiken\nvoor contact met de gemeente en vice versa.", + "parameters": [], + "responses": { + "204": { + "description": "No content", + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "kanalen" + ] + }, + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Unieke technische identificerende code, primair bedoeld voor gebruik bij interacties tussen IT-systemen.", + "required": true, + "type": "string" + } + ] + }, + "/landen": { + "get": { + "operationId": "land_list", + "description": "Alle huidige en voormalige landen met hun codes, namen en geldigheidsinformatie.", + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Land" + } + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "landen" + ] + }, + "post": { + "operationId": "land_create", + "description": "Alle huidige en voormalige landen met hun codes, namen en geldigheidsinformatie.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Land" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Land" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + }, + "Location": { + "schema": { + "type": "string", + "format": "uri" + }, + "description": "URL waar de resource leeft." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "landen" + ] + }, + "parameters": [] + }, + "/landen/{landcode}": { + "get": { + "operationId": "land_read", + "description": "Alle huidige en voormalige landen met hun codes, namen en geldigheidsinformatie.", + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Land" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "landen" + ] + }, + "put": { + "operationId": "land_update", + "description": "Alle huidige en voormalige landen met hun codes, namen en geldigheidsinformatie.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Land" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Land" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "landen" + ] + }, + "patch": { + "operationId": "land_partial_update", + "description": "Alle huidige en voormalige landen met hun codes, namen en geldigheidsinformatie.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Land" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Land" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "landen" + ] + }, + "delete": { + "operationId": "land_delete", + "description": "Alle huidige en voormalige landen met hun codes, namen en geldigheidsinformatie.", + "parameters": [], + "responses": { + "204": { + "description": "No content", + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "landen" + ] + }, + "parameters": [ + { + "name": "landcode", + "in": "path", + "description": "Unieke technische identificerende code, primair bedoeld voor gebruik bij interacties tussen IT-systemen.", + "required": true, + "type": "string" + } + ] + }, + "/soortendigitaaladres": { + "get": { + "operationId": "soortdigitaaladres_list", + "description": "Soorten digitale adressen die personen en organisaties kunnen gebruiken\nvoor contact met de gemeente en vice versa.", + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/SoortDigitaalAdres" + } + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortendigitaaladres" + ] + }, + "post": { + "operationId": "soortdigitaaladres_create", + "description": "Soorten digitale adressen die personen en organisaties kunnen gebruiken\nvoor contact met de gemeente en vice versa.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SoortDigitaalAdres" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SoortDigitaalAdres" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + }, + "Location": { + "schema": { + "type": "string", + "format": "uri" + }, + "description": "URL waar de resource leeft." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortendigitaaladres" + ] + }, + "parameters": [] + }, + "/soortendigitaaladres/{code}": { + "get": { + "operationId": "soortdigitaaladres_read", + "description": "Soorten digitale adressen die personen en organisaties kunnen gebruiken\nvoor contact met de gemeente en vice versa.", + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SoortDigitaalAdres" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortendigitaaladres" + ] + }, + "put": { + "operationId": "soortdigitaaladres_update", + "description": "Soorten digitale adressen die personen en organisaties kunnen gebruiken\nvoor contact met de gemeente en vice versa.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SoortDigitaalAdres" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SoortDigitaalAdres" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortendigitaaladres" + ] + }, + "patch": { + "operationId": "soortdigitaaladres_partial_update", + "description": "Soorten digitale adressen die personen en organisaties kunnen gebruiken\nvoor contact met de gemeente en vice versa.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SoortDigitaalAdres" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SoortDigitaalAdres" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortendigitaaladres" + ] + }, + "delete": { + "operationId": "soortdigitaaladres_delete", + "description": "Soorten digitale adressen die personen en organisaties kunnen gebruiken\nvoor contact met de gemeente en vice versa.", + "parameters": [], + "responses": { + "204": { + "description": "No content", + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortendigitaaladres" + ] + }, + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Unieke technische identificerende code, primair bedoeld voor gebruik bij interacties tussen IT-systemen.", + "required": true, + "type": "string" + } + ] + }, + "/soortenobject": { + "get": { + "operationId": "soortobject_list", + "description": "Typen objecten waarnaar vanuit het klantinteractiesregister\nrelaties kunnen worden gelegd.", + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/SoortObject" + } + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortenobject" + ] + }, + "post": { + "operationId": "soortobject_create", + "description": "Typen objecten waarnaar vanuit het klantinteractiesregister\nrelaties kunnen worden gelegd.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SoortObject" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SoortObject" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + }, + "Location": { + "schema": { + "type": "string", + "format": "uri" + }, + "description": "URL waar de resource leeft." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortenobject" + ] + }, + "parameters": [] + }, + "/soortenobject/{code}": { + "get": { + "operationId": "soortobject_read", + "description": "Typen objecten waarnaar vanuit het klantinteractiesregister\nrelaties kunnen worden gelegd.", + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SoortObject" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortenobject" + ] + }, + "put": { + "operationId": "soortobject_update", + "description": "Typen objecten waarnaar vanuit het klantinteractiesregister\nrelaties kunnen worden gelegd.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SoortObject" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SoortObject" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortenobject" + ] + }, + "patch": { + "operationId": "soortobject_partial_update", + "description": "Typen objecten waarnaar vanuit het klantinteractiesregister\nrelaties kunnen worden gelegd.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SoortObject" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SoortObject" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortenobject" + ] + }, + "delete": { + "operationId": "soortobject_delete", + "description": "Typen objecten waarnaar vanuit het klantinteractiesregister\nrelaties kunnen worden gelegd.", + "parameters": [], + "responses": { + "204": { + "description": "No content", + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortenobject" + ] + }, + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Unieke technische identificerende code, primair bedoeld voor gebruik bij interacties tussen IT-systemen.", + "required": true, + "type": "string" + } + ] + }, + "/soortenobjectid": { + "get": { + "operationId": "soortobjectid_list", + "description": "Identificatiesystemen en de registers waarin volgens deze systemen\nte identificeren objecten gevonden kunnen worden.", + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/SoortObjectid" + } + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortenobjectid" + ] + }, + "post": { + "operationId": "soortobjectid_create", + "description": "Identificatiesystemen en de registers waarin volgens deze systemen\nte identificeren objecten gevonden kunnen worden.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SoortObjectid" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SoortObjectid" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + }, + "Location": { + "schema": { + "type": "string", + "format": "uri" + }, + "description": "URL waar de resource leeft." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortenobjectid" + ] + }, + "parameters": [] + }, + "/soortenobjectid/{code}": { + "get": { + "operationId": "soortobjectid_read", + "description": "Identificatiesystemen en de registers waarin volgens deze systemen\nte identificeren objecten gevonden kunnen worden.", + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SoortObjectid" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortenobjectid" + ] + }, + "put": { + "operationId": "soortobjectid_update", + "description": "Identificatiesystemen en de registers waarin volgens deze systemen\nte identificeren objecten gevonden kunnen worden.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SoortObjectid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SoortObjectid" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortenobjectid" + ] + }, + "patch": { + "operationId": "soortobjectid_partial_update", + "description": "Identificatiesystemen en de registers waarin volgens deze systemen\nte identificeren objecten gevonden kunnen worden.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SoortObjectid" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SoortObjectid" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortenobjectid" + ] + }, + "delete": { + "operationId": "soortobjectid_delete", + "description": "Identificatiesystemen en de registers waarin volgens deze systemen\nte identificeren objecten gevonden kunnen worden.", + "parameters": [], + "responses": { + "204": { + "description": "No content", + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "soortenobjectid" + ] + }, + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Unieke technische identificerende code, primair bedoeld voor gebruik bij interacties tussen IT-systemen.", + "required": true, + "type": "string" + } + ] + }, + "/talen": { + "get": { + "operationId": "taal_list", + "description": "Talen die personen en organisaties kunnen gebruiken\nbij contact met de gemeente en vice versa.", + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Taal" + } + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "talen" + ] + }, + "post": { + "operationId": "taal_create", + "description": "Talen die personen en organisaties kunnen gebruiken\nbij contact met de gemeente en vice versa.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Taal" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Taal" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + }, + "Location": { + "schema": { + "type": "string", + "format": "uri" + }, + "description": "URL waar de resource leeft." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "talen" + ] + }, + "parameters": [] + }, + "/talen/{code}": { + "get": { + "operationId": "taal_read", + "description": "Talen die personen en organisaties kunnen gebruiken\nbij contact met de gemeente en vice versa.", + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Taal" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "talen" + ] + }, + "put": { + "operationId": "taal_update", + "description": "Talen die personen en organisaties kunnen gebruiken\nbij contact met de gemeente en vice versa.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Taal" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Taal" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "talen" + ] + }, + "patch": { + "operationId": "taal_partial_update", + "description": "Talen die personen en organisaties kunnen gebruiken\nbij contact met de gemeente en vice versa.", + "parameters": [ + { + "name": "Content-Type", + "in": "header", + "description": "Content type van de verzoekinhoud.", + "required": true, + "type": "string", + "enum": [ + "application/json" + ] + }, + { + "name": "data", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Taal" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Taal" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "400": { + "$ref": "#/responses/400" + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "talen" + ] + }, + "delete": { + "operationId": "taal_delete", + "description": "Talen die personen en organisaties kunnen gebruiken\nbij contact met de gemeente en vice versa.", + "parameters": [], + "responses": { + "204": { + "description": "No content", + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "$ref": "#/responses/401" + }, + "403": { + "$ref": "#/responses/403" + }, + "404": { + "$ref": "#/responses/404" + }, + "406": { + "$ref": "#/responses/406" + }, + "409": { + "$ref": "#/responses/409" + }, + "410": { + "$ref": "#/responses/410" + }, + "415": { + "$ref": "#/responses/415" + }, + "429": { + "$ref": "#/responses/429" + }, + "500": { + "$ref": "#/responses/500" + } + }, + "tags": [ + "talen" + ] + }, + "parameters": [ + { + "name": "code", + "in": "path", + "description": "Unieke technische identificerende code, primair bedoeld voor gebruik bij interacties tussen IT-systemen.", + "required": true, + "type": "string" + } + ] + } + }, + "definitions": { + "ExternRegister": { + "required": [ + "code", + "locatie", + "naam" + ], + "type": "object", + "properties": { + "code": { + "title": "Code", + "description": "Unieke technische identificerende code, primair bedoeld voor gebruik bij interacties tussen IT-systemen.", + "type": "string", + "maxLength": 40, + "minLength": 1 + }, + "locatie": { + "title": "Locatie", + "description": "Kort (40 karakters) tekstveld voor een omschrijving.", + "type": "string", + "maxLength": 40, + "minLength": 1 + }, + "naam": { + "title": "Naam", + "description": "Kort (80 karakters) tekstveld voor een naam.", + "type": "string", + "maxLength": 80, + "minLength": 1 + } + } + }, + "Fout": { + "required": [ + "code", + "title", + "status", + "detail", + "instance" + ], + "type": "object", + "properties": { + "type": { + "title": "Type", + "description": "URI referentie naar het type fout, bedoeld voor developers", + "type": "string" + }, + "code": { + "title": "Code", + "description": "Systeemcode die het type fout aangeeft", + "type": "string", + "minLength": 1 + }, + "title": { + "title": "Title", + "description": "Generieke titel voor het type fout", + "type": "string", + "minLength": 1 + }, + "status": { + "title": "Status", + "description": "De HTTP status code", + "type": "integer" + }, + "detail": { + "title": "Detail", + "description": "Extra informatie bij de fout, indien beschikbaar", + "type": "string", + "minLength": 1 + }, + "instance": { + "title": "Instance", + "description": "URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld.", + "type": "string", + "minLength": 1 + } + } + }, + "FieldValidationError": { + "required": [ + "name", + "code", + "reason" + ], + "type": "object", + "properties": { + "name": { + "title": "Name", + "description": "Naam van het veld met ongeldige gegevens", + "type": "string", + "minLength": 1 + }, + "code": { + "title": "Code", + "description": "Systeemcode die het type fout aangeeft", + "type": "string", + "minLength": 1 + }, + "reason": { + "title": "Reason", + "description": "Uitleg wat er precies fout is met de gegevens", + "type": "string", + "minLength": 1 + } + } + }, + "ValidatieFout": { + "required": [ + "code", + "title", + "status", + "detail", + "instance", + "invalidParams" + ], + "type": "object", + "properties": { + "type": { + "title": "Type", + "description": "URI referentie naar het type fout, bedoeld voor developers", + "type": "string" + }, + "code": { + "title": "Code", + "description": "Systeemcode die het type fout aangeeft", + "type": "string", + "minLength": 1 + }, + "title": { + "title": "Title", + "description": "Generieke titel voor het type fout", + "type": "string", + "minLength": 1 + }, + "status": { + "title": "Status", + "description": "De HTTP status code", + "type": "integer" + }, + "detail": { + "title": "Detail", + "description": "Extra informatie bij de fout, indien beschikbaar", + "type": "string", + "minLength": 1 + }, + "instance": { + "title": "Instance", + "description": "URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld.", + "type": "string", + "minLength": 1 + }, + "invalidParams": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldValidationError" + } + } + } + }, + "Kanaal": { + "required": [ + "code", + "indicatieActief", + "naam" + ], + "type": "object", + "properties": { + "code": { + "title": "Code", + "description": "Unieke technische identificerende code, primair bedoeld voor gebruik bij interacties tussen IT-systemen.", + "type": "string", + "maxLength": 40, + "minLength": 1 + }, + "indicatieActief": { + "title": "Indicatie actief", + "description": "Indicatie voor een waarde `Ja` of een waarde `Nee`.", + "type": "boolean" + }, + "naam": { + "title": "Naam", + "description": "Kort (80 karakters) tekstveld voor een naam.", + "type": "string", + "maxLength": 80, + "minLength": 1 + } + } + }, + "Land": { + "required": [ + "landcode", + "landnaam", + "ingangsdatumLand", + "einddatumLand" + ], + "type": "object", + "properties": { + "landcode": { + "title": "Landcode", + "description": "Unieke technische identificerende code, primair bedoeld voor gebruik bij interacties tussen IT-systemen.", + "type": "string", + "maxLength": 40, + "minLength": 1 + }, + "landnaam": { + "title": "Landnaam", + "description": "Kort (80 karakters) tekstveld voor een naam.", + "type": "string", + "maxLength": 80, + "minLength": 1 + }, + "ingangsdatumLand": { + "title": "Ingangsdatum land", + "description": "Aanduiding van datum volgens de NEN-ISO 8601:2019-standaard. Een datum wordt genoteerd van het meest naar het minst significante onderdeel. Een voorbeeld: 2022-02-21 representeert 21 februari 2022.", + "type": "string", + "format": "date" + }, + "einddatumLand": { + "title": "Einddatum land", + "description": "Aanduiding van datum volgens de NEN-ISO 8601:2019-standaard. Een datum wordt genoteerd van het meest naar het minst significante onderdeel. Een voorbeeld: 2022-02-21 representeert 21 februari 2022.", + "type": "string", + "format": "date" + } + } + }, + "SoortDigitaalAdres": { + "required": [ + "code", + "indicatieActief", + "naam" + ], + "type": "object", + "properties": { + "code": { + "title": "Code", + "description": "Unieke technische identificerende code, primair bedoeld voor gebruik bij interacties tussen IT-systemen.", + "type": "string", + "maxLength": 40, + "minLength": 1 + }, + "indicatieActief": { + "title": "Indicatie actief", + "description": "Indicatie voor een waarde `Ja` of een waarde `Nee`.", + "type": "boolean" + }, + "naam": { + "title": "Naam", + "description": "Kort (80 karakters) tekstveld voor een naam.", + "type": "string", + "maxLength": 80, + "minLength": 1 + } + } + }, + "SoortObject": { + "required": [ + "code", + "indicatieActief", + "naam" + ], + "type": "object", + "properties": { + "code": { + "title": "Code", + "description": "Unieke technische identificerende code, primair bedoeld voor gebruik bij interacties tussen IT-systemen.", + "type": "string", + "maxLength": 40, + "minLength": 1 + }, + "indicatieActief": { + "title": "Indicatie actief", + "description": "Indicatie voor een waarde `Ja` of een waarde `Nee`.", + "type": "boolean" + }, + "naam": { + "title": "Naam", + "description": "Kort (80 karakters) tekstveld voor een naam.", + "type": "string", + "maxLength": 80, + "minLength": 1 + } + } + }, + "SoortObjectid": { + "required": [ + "code", + "indicatieActief", + "naam" + ], + "type": "object", + "properties": { + "code": { + "title": "Code", + "description": "Unieke technische identificerende code, primair bedoeld voor gebruik bij interacties tussen IT-systemen.", + "type": "string", + "maxLength": 40, + "minLength": 1 + }, + "indicatieActief": { + "title": "Indicatie actief", + "description": "Indicatie voor een waarde `Ja` of een waarde `Nee`.", + "type": "boolean" + }, + "naam": { + "title": "Naam", + "description": "Kort (80 karakters) tekstveld voor een naam.", + "type": "string", + "maxLength": 80, + "minLength": 1 + } + } + }, + "Taal": { + "required": [ + "code", + "indicatieActief", + "naam" + ], + "type": "object", + "properties": { + "code": { + "title": "Code", + "description": "Unieke technische identificerende code, primair bedoeld voor gebruik bij interacties tussen IT-systemen.", + "type": "string", + "maxLength": 40, + "minLength": 1 + }, + "indicatieActief": { + "title": "Indicatie actief", + "description": "Indicatie voor een waarde `Ja` of een waarde `Nee`.", + "type": "boolean" + }, + "naam": { + "title": "Naam", + "description": "Kort (80 karakters) tekstveld voor een naam.", + "type": "string", + "maxLength": 80, + "minLength": 1 + } + } + } + }, + "responses": { + "400": { + "description": "Bad request", + "schema": { + "$ref": "#/definitions/ValidatieFout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "401": { + "description": "Unauthorized", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "403": { + "description": "Forbidden", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "406": { + "description": "Not acceptable", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "409": { + "description": "Conflict", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "410": { + "description": "Gone", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "412": { + "description": "Precondition failed", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "415": { + "description": "Unsupported media type", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + }, + "500": { + "description": "Internal server error", + "schema": { + "$ref": "#/definitions/Fout" + }, + "headers": { + "API-version": { + "schema": { + "type": "string" + }, + "description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1." + } + } + } + } +} diff --git a/src/openklant/conf/api.py b/src/openklant/conf/api.py index 5887da05..38eabf0e 100644 --- a/src/openklant/conf/api.py +++ b/src/openklant/conf/api.py @@ -7,6 +7,7 @@ CONTACTMOMENTEN_API_VERSION = "1.0.0" KLANTINTERACTIES_API_VERSION = "1.0.0" CONTACTGEGEVENS_API_VERSION = "1.0.0" +REFERENTIELIJSTEN_API_VERSION = "00.00.06" REST_FRAMEWORK = BASE_REST_FRAMEWORK.copy() REST_FRAMEWORK["PAGE_SIZE"] = 100 diff --git a/src/openklant/conf/base.py b/src/openklant/conf/base.py index 2cf3b3df..351f8887 100644 --- a/src/openklant/conf/base.py +++ b/src/openklant/conf/base.py @@ -401,6 +401,14 @@ "contactgegevens", "openapi.yaml", ), + "referentielijsten": os.path.join( + BASE_DIR, + "src", + "openklant", + "components", + "referentielijsten", + "openapi.yaml", + ), } # settings for sending notifications