From db3970d51f2d7b6cee42a5d875527089a09818d1 Mon Sep 17 00:00:00 2001 From: MatthijsBekendam <47739550+MatthijsBekendam@users.noreply.github.com> Date: Tue, 29 Aug 2023 15:10:11 +0200 Subject: [PATCH 1/7] Master into Develop (#226) *update develop to 1.4.1 --- .bumpversion.cfg | 2 +- CHANGELOG.rst | 7 + README.rst | 2 + package.json | 2 +- src/drc/__init__.py | 2 +- src/drc/api/serializers/bestandsdeel.py | 6 + .../enkelvoudig_informatieobject.py | 11 +- src/drc/api/tests/test_dso_api_strategy.py | 2 +- src/drc/api/views/bestandsdeel.py | 1 + .../api/views/enkelvoudig_informatieobject.py | 8 +- src/drc/conf/api.py | 2 +- src/openapi.yaml | 309 +++++++++++++++++- 12 files changed, 344 insertions(+), 10 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index fa275660..18284411 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,7 +1,7 @@ [bumpversion] commit = False tag = False -current_version = 1.4.0 +current_version = 1.4.1 parse = (?P\d+)\.(?P\d+)\.(?P\d+)([-](?P(rc|alpha))+(?P\d+))? serialize = {major}.{minor}.{patch}-{release}{build} diff --git a/CHANGELOG.rst b/CHANGELOG.rst index a9a13cc1..13af465b 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,6 +1,13 @@ =========== Wijzigingen =========== +1.4.1 (2023-08-29) +=========== + +- **Changed:** schema generation such that the `lock` attribute shows up in EIO.bestandsdelen GET response. + +Implementation changes +---------------------- 1.4.0 (2023-08-22) =========== diff --git a/README.rst b/README.rst index 2c7c50da..ece4cc7d 100644 --- a/README.rst +++ b/README.rst @@ -24,6 +24,8 @@ Versie Release datum API specificatie master n.v.t. `ReDoc `_, `Scopes `_ `Berichtkenmerken `_ `Swagger `_ (`verschillen `_) +1.4.1 2023-08-29 `ReDoc `_, `Scopes `_ `Berichtkenmerken `_ + `Swagger `_ 1.4.0 2023-08-22 `ReDoc `_, `Scopes `_ `Berichtkenmerken `_ `Swagger `_ 1.3.x 2023-03-29 `ReDoc `_, `Scopes `_ `Berichtkenmerken `_ diff --git a/package.json b/package.json index 1d42d59f..6b311002 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "drc", - "version": "1.4.0", + "version": "1.4.1", "description": "drc referentie implementatie API", "main": "src/index.js", "directories": { diff --git a/src/drc/__init__.py b/src/drc/__init__.py index 836682f3..17a00d60 100644 --- a/src/drc/__init__.py +++ b/src/drc/__init__.py @@ -7,7 +7,7 @@ import re from collections import namedtuple -__version__ = "1.4.0" +__version__ = "1.4.1" __author__ = "VNG Realisatie" __homepage__ = "https://github.com/VNG-Realisatie/documenten-api" __docformat__ = "restructuredtext" diff --git a/src/drc/api/serializers/bestandsdeel.py b/src/drc/api/serializers/bestandsdeel.py index 3218b316..9b46acd1 100644 --- a/src/drc/api/serializers/bestandsdeel.py +++ b/src/drc/api/serializers/bestandsdeel.py @@ -49,3 +49,9 @@ def validate(self, attrs): ) return valid_attrs + + +class SchemaBestandsDeelSerializer(BestandsDeelSerializer): + lock = serializers.CharField( + help_text="Hash string, which represents id of the lock of related informatieobject", + ) diff --git a/src/drc/api/serializers/enkelvoudig_informatieobject.py b/src/drc/api/serializers/enkelvoudig_informatieobject.py index 4c569792..cf18b6d6 100644 --- a/src/drc/api/serializers/enkelvoudig_informatieobject.py +++ b/src/drc/api/serializers/enkelvoudig_informatieobject.py @@ -20,7 +20,10 @@ from drc.api.auth import get_ztc_auth from drc.api.fields import AnyBase64File -from drc.api.serializers.bestandsdeel import BestandsDeelSerializer +from drc.api.serializers.bestandsdeel import ( + BestandsDeelSerializer, + SchemaBestandsDeelSerializer, +) from drc.api.utils import create_filename, merge_files from drc.api.validators import StatusValidator from drc.datamodel.constants import ChecksumAlgoritmes, OndertekeningSoorten, Statussen @@ -497,3 +500,9 @@ class EIOZoekSerializer(serializers.Serializer): child=serializers.UUIDField(), help_text=_("Array of unieke resource identifiers (UUID4)"), ) + + +class SchemaEIOSerializer(EnkelvoudigInformatieObjectSerializer): + bestandsdelen = SchemaBestandsDeelSerializer( + source="canonical.bestandsdelen", many=True, read_only=True + ) diff --git a/src/drc/api/tests/test_dso_api_strategy.py b/src/drc/api/tests/test_dso_api_strategy.py index eaea5f0d..f5f5581e 100644 --- a/src/drc/api/tests/test_dso_api_strategy.py +++ b/src/drc/api/tests/test_dso_api_strategy.py @@ -23,7 +23,7 @@ def test_api_19_documentation_version_yaml(self): @override_settings(ROOT_URLCONF="drc.api.tests.test_urls") def test_api_24_version_header(self): response = self.client.get("/test-view") - self.assertEqual(response["API-version"], "1.4.0") + self.assertEqual(response["API-version"], "1.4.1") class DSOApi50Tests(APITestCase): diff --git a/src/drc/api/views/bestandsdeel.py b/src/drc/api/views/bestandsdeel.py index 17b0f3fa..57f4c871 100644 --- a/src/drc/api/views/bestandsdeel.py +++ b/src/drc/api/views/bestandsdeel.py @@ -9,6 +9,7 @@ from drc.api.schema import BestandsDeelSchema from drc.api.scopes import SCOPE_DOCUMENTEN_BIJWERKEN from drc.api.serializers import BestandsDeelSerializer +from drc.api.serializers.bestandsdeel import SchemaBestandsDeelSerializer from drc.datamodel.models.bestandsdeel import BestandsDeel diff --git a/src/drc/api/views/enkelvoudig_informatieobject.py b/src/drc/api/views/enkelvoudig_informatieobject.py index 7bc5cf62..43d5eb52 100644 --- a/src/drc/api/views/enkelvoudig_informatieobject.py +++ b/src/drc/api/views/enkelvoudig_informatieobject.py @@ -51,7 +51,10 @@ LockEnkelvoudigInformatieObjectSerializer, UnlockEnkelvoudigInformatieObjectSerializer, ) -from drc.api.serializers.enkelvoudig_informatieobject import EIOZoekSerializer +from drc.api.serializers.enkelvoudig_informatieobject import ( + EIOZoekSerializer, + SchemaEIOSerializer, +) from drc.api.views.constants import REGISTRATIE_QUERY_PARAM, VERSIE_QUERY_PARAM from drc.datamodel.models import EnkelvoudigInformatieObject @@ -256,7 +259,8 @@ def get_serializer_class(self, *args, **kwargs): return EnkelvoudigInformatieObjectSerializer @extend_schema( - parameters=[VERSIE_QUERY_PARAM, REGISTRATIE_QUERY_PARAM, EXPAND_QUERY_PARAM] + parameters=[VERSIE_QUERY_PARAM, REGISTRATIE_QUERY_PARAM, EXPAND_QUERY_PARAM], + responses=SchemaEIOSerializer, ) def retrieve(self, request, *args, **kwargs): return super().retrieve(request, *args, **kwargs) diff --git a/src/drc/conf/api.py b/src/drc/conf/api.py index 684eb915..b2956865 100644 --- a/src/drc/conf/api.py +++ b/src/drc/conf/api.py @@ -2,7 +2,7 @@ from vng_api_common.conf.api import * # noqa - imports white-listed -API_VERSION = "1.4.0" +API_VERSION = "1.4.1" REST_FRAMEWORK = BASE_REST_FRAMEWORK.copy() REST_FRAMEWORK["PAGE_SIZE"] = 100 diff --git a/src/openapi.yaml b/src/openapi.yaml index eaedfaa8..ee9c461d 100644 --- a/src/openapi.yaml +++ b/src/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Documenten API - version: 1.4.0 + version: 1.4.1 description: "Een API om een documentregistratiecomponent (DRC) te benaderen.\n\n\ In een documentregistratiecomponent worden INFORMATIEOBJECTen opgeslagen. Een\n\ @@ -981,7 +981,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EnkelvoudigInformatieObject' + $ref: '#/components/schemas/SchemaEIO' description: OK '401': headers: @@ -7965,6 +7965,311 @@ components: - antwoordnummer - postbusnummer type: string + SchemaBestandsDeel: + type: object + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + volgnummer: + type: integer + readOnly: true + description: Een volgnummer dat de volgorde van de bestandsdelen aangeeft. + title: volgnummer + omvang: + type: integer + readOnly: true + description: De grootte van dit specifieke bestandsdeel. + title: omvang + voltooid: + type: boolean + readOnly: true + description: + 'Indicatie of dit bestandsdeel volledig is geupload. Dat wil + zeggen: het aantal bytes dat staat genoemd bij grootte is daadwerkelijk + ontvangen.' + title: voltooid + lock: + type: string + description: Hash string, which represents id of the lock of related informatieobject + title: lock + required: + - lock + - omvang + - url + - volgnummer + - voltooid + SchemaEIO: + type: object + description: Serializer for the EnkelvoudigInformatieObject model + properties: + url: + type: string + format: uri + readOnly: true + title: url + description: + URL-referentie naar dit object. Dit is de unieke identificatie + en locatie van dit object. + minLength: 1 + maxLength: 1000 + identificatie: + type: string + description: + Een binnen een gegeven context ondubbelzinnige referentie naar + het INFORMATIEOBJECT. + title: identificatie + maxLength: 40 + bronorganisatie: + type: string + description: + "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ + \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ + \ eerste in een samenwerkingsketen heeft vastgelegd." + title: bronorganisatie + maxLength: 9 + creatiedatum: + type: string + format: date + description: Een datum of een gebeurtenis in de levenscyclus van het INFORMATIEOBJECT. + title: creatiedatum + titel: + type: string + description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. + title: titel + maxLength: 200 + vertrouwelijkheidaanduiding: + description: + 'Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + + + Uitleg bij mogelijke waarden: + + + * `openbaar` - Openbaar + + * `beperkt_openbaar` - Beperkt openbaar + + * `intern` - Intern + + * `zaakvertrouwelijk` - Zaakvertrouwelijk + + * `vertrouwelijk` - Vertrouwelijk + + * `confidentieel` - Confidentieel + + * `geheim` - Geheim + + * `zeer_geheim` - Zeer geheim' + title: vertrouwelijkheidaanduiding + oneOf: + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' + auteur: + type: string + description: + "De persoon of organisatie die in de eerste plaats verantwoordelijk\ + \ is voor het cre\xEBren van de inhoud van het INFORMATIEOBJECT." + title: auteur + maxLength: 200 + status: + description: + "Aanduiding van de stand van zaken van een INFORMATIEOBJECT. + De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als + het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + + + Uitleg bij mogelijke waarden: + + + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar + moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand + vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar + gemaakt; een gearchiveerd informatie-element." + title: status + oneOf: + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' + formaat: + type: string + description: + 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. + Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml' + title: formaat + maxLength: 255 + taal: + type: string + description: + 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' + title: taal + maxLength: 3 + minLength: 3 + versie: + type: integer + readOnly: true + description: + Het (automatische) versienummer van het INFORMATIEOBJECT. Deze + begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. + title: versie + beginRegistratie: + type: string + format: date-time + readOnly: true + description: + Een datumtijd in ISO8601 formaat waarop deze versie van het + INFORMATIEOBJECT is aangemaakt of gewijzigd. + title: begin registratie + bestandsnaam: + type: string + description: + De naam van het fysieke bestand waarin de inhoud van het informatieobject + is vastgelegd, inclusief extensie. + title: bestandsnaam + maxLength: 255 + inhoud: + type: string + format: uri + description: Download URL van de binaire inhoud. + nullable: true + title: inhoud + bestandsomvang: + type: integer + maximum: 9223372036854775807 + minimum: 0 + format: int64 + nullable: true + description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. + title: bestandsomvang + link: + type: string + format: uri + description: + De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen + is. + title: link + maxLength: 200 + beschrijving: + type: string + description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. + title: beschrijving + maxLength: 1000 + ontvangstdatum: + type: string + format: date + nullable: true + description: + "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + \ \n\n De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te\ + \ registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende\ + \ organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden\ + \ aan documenten die van of naar andere personen ontvangen of verzonden\ + \ zijn waarbij die personen niet deel uit maken van de behandeling van\ + \ de zaak waarin het document een rol speelt." + title: ontvangstdatum + verzenddatum: + type: string + format: date + nullable: true + description: + "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + \ \n\n De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op\ + \ het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als\ + \ uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk\ + \ inkomend en uitgaand zijn. Ontvangst en verzending is voorbehouden aan\ + \ documenten die van of naar andere personen ontvangen of verzonden zijn\ + \ waarbij die personen niet deel uit maken van de behandeling van de zaak\ + \ waarin het document een rol speelt." + title: verzenddatum + indicatieGebruiksrecht: + type: boolean + nullable: true + description: + Indicatie of er beperkingen gelden aangaande het gebruik van + het informatieobject anders dan raadpleging. Dit veld mag `null` zijn + om aan te geven dat de indicatie nog niet bekend is. Als de indicatie + gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen + via de GEBRUIKSRECHTen resource. + title: indicatie gebruiksrecht + verschijningsvorm: + type: string + description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT." + title: verschijningsvorm + ondertekening: + allOf: + - $ref: '#/components/schemas/Ondertekening' + nullable: true + description: + Aanduiding van de rechtskracht van een informatieobject. Mag + niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' + of 'ter vaststelling' heeft. + title: ondertekening + integriteit: + allOf: + - $ref: '#/components/schemas/Integriteit' + nullable: true + description: + Uitdrukking van mate van volledigheid en onbeschadigd zijn + van digitaal bestand. + title: integriteit + informatieobjecttype: + type: string + format: uri + description: + URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi + API). + title: informatieobjecttype + maxLength: 200 + locked: + type: boolean + readOnly: true + description: + Geeft aan of het document gelocked is. Alleen als een document + gelocked is, mogen er aanpassingen gemaakt worden. + title: locked + bestandsdelen: + type: array + items: + $ref: '#/components/schemas/SchemaBestandsDeel' + readOnly: true + title: bestandsdelen + trefwoorden: + type: array + items: + type: string + maxLength: 100 + nullable: true + description: Een lijst van trefwoorden gescheiden door comma's. + title: trefwoorden + required: + - auteur + - beginRegistratie + - bestandsdelen + - bronorganisatie + - creatiedatum + - informatieobjecttype + - locked + - taal + - titel + - url + - versie SoortEnum: enum: - analoog From c9d410c812a03ce2361194092556a5df639ac169 Mon Sep 17 00:00:00 2001 From: matthijsbekendam Date: Wed, 13 Sep 2023 14:44:05 +0200 Subject: [PATCH 2/7] bugfix: lock in EIO_create --- .../api/views/enkelvoudig_informatieobject.py | 5 + src/openapi.yaml | 5355 +++++++---------- 2 files changed, 2200 insertions(+), 3160 deletions(-) diff --git a/src/drc/api/views/enkelvoudig_informatieobject.py b/src/drc/api/views/enkelvoudig_informatieobject.py index 43d5eb52..7f4d785a 100644 --- a/src/drc/api/views/enkelvoudig_informatieobject.py +++ b/src/drc/api/views/enkelvoudig_informatieobject.py @@ -265,6 +265,11 @@ def get_serializer_class(self, *args, **kwargs): def retrieve(self, request, *args, **kwargs): return super().retrieve(request, *args, **kwargs) + @extend_schema( + responses=SchemaEIOSerializer, + ) + def create(self, request, *args, **kwargs): + return super().create(request, *args, **kwargs) @extend_schema( # see https://swagger.io/docs/specification/2-0/describing-responses/ and # https://swagger.io/docs/specification/2-0/mime-types/ diff --git a/src/openapi.yaml b/src/openapi.yaml index ee9c461d..86df0ce7 100644 --- a/src/openapi.yaml +++ b/src/openapi.yaml @@ -2,47 +2,91 @@ openapi: 3.0.3 info: title: Documenten API version: 1.4.1 - description: - "Een API om een documentregistratiecomponent (DRC) te benaderen.\n\n\ - In een documentregistratiecomponent worden INFORMATIEOBJECTen opgeslagen. Een\n\ - INFORMATIEOBJECT is een digitaal document voorzien van meta-gegevens.\nINFORMATIEOBJECTen\ - \ kunnen aan andere objecten zoals zaken en besluiten worden\ngerelateerd (maar\ - \ dat hoeft niet) en kunnen gebruiksrechten hebben.\n\nGEBRUIKSRECHTEN leggen\ - \ voorwaarden op aan het gebruik van het INFORMATIEOBJECT\n(buiten raadpleging).\ - \ Deze GEBRUIKSRECHTEN worden niet door de API gevalideerd\nof gehandhaafd.\n\n\ - De typering van INFORMATIEOBJECTen is in de Catalogi API (ZTC) ondergebracht in\n\ - de vorm van INFORMATIEOBJECTTYPEn.\n\n**Uploaden van bestanden**\n\nBinnen deze\ - \ API bestaan een aantal endpoints die binaire data ontvangen, al\ndan niet base64-encoded.\ - \ Webservers moeten op deze endpoints een minimale\nrequest body size van 4.0\ - \ GiB ondersteunen. Dit omvat de JSON van de\nmetadata EN de base64-encoded bestandsdata.\ - \ Hou hierbij rekening met de\noverhead van base64, die ongeveer 33% bedraagt\ - \ in worst-case scenario's. Dit\nbetekent dat bij een limiet van 4GB het bestand\ - \ maximaal ongeveer 3GB groot\nmag zijn.\n\n_Nieuw in 1.1.0_\n\nBestanden kunnen\ - \ groter zijn dan de minimale die door providers\nondersteund moet worden. De\ - \ consumer moet dan:\n\n1. Het INFORMATIEOBJECT aanmaken in de API, waarbij de\ - \ totale bestandsgrootte\n meegestuurd wordt en de inhoud leeggelaten wordt.\n\ - \ De API antwoordt met een lijst van BESTANDSDEELen, elk met een volgnummer\n\ - \ en bestandsgrootte. De API lockt tegelijkertijd het INFORMATIEOBJECT.\n2.\ - \ Het bestand opsplitsen: ieder BESTANDSDEEL moet de bestandsgrootte hebben\n\ - \ zoals dit aangegeven werd in de response bij 1.\n3. Voor elk stuk van het\ - \ bestand de binaire data naar de overeenkomstige\n BESTANDSDEEL-url gestuurd\ - \ worden, samen met het lock ID.\n4. Het INFORMATIEOBJECT unlocken. De provider\ - \ valideert op dat moment dat alle\n bestandsdelen correct opgestuurd werden,\ - \ en voegt deze samen tot het\n resulterende bestand.\n\nHet bijwerken van een\ - \ INFORMATIEOBJECT heeft een gelijkaardig verloop.\n\nDe 1.0.x manier van uploaden\ - \ is ook beschikbaar voor kleine(re) bestanden die\nniet gesplitst hoeven te worden.\n\ - \n**Afhankelijkheden**\n\nDeze API is afhankelijk van:\n\n* Catalogi API\n* Notificaties\ - \ API\n* Autorisaties API *(optioneel)*\n* Zaken API *(optioneel)*\n\n**Autorisatie**\n\ - \nDeze API vereist autorisatie. Je kan de\n[token-tool](https://zaken-auth.vng.cloud/)\ - \ gebruiken om JWT-tokens te\ngenereren.\n\n### Notificaties\n\nDeze API publiceert\ - \ notificaties op het kanaal `documenten`.\n\n**Main resource**\n\n`enkelvoudiginformatieobject`\n\ - \n\n\n**Kenmerken**\n\n* `bronorganisatie`: Het RSIN van de Niet-natuurlijk persoon\ - \ zijnde de organisatie die het informatieobject heeft gecre\xEBerd of heeft ontvangen\ - \ en als eerste in een samenwerkingsketen heeft vastgelegd.\n* `informatieobjecttype`:\ - \ URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API).\n* `vertrouwelijkheidaanduiding`:\ - \ Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd\ - \ is.\n\n**Resources en acties**\n\n\n**Handige links**\n\n* [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard)\n\ - * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken)\n" + description: | + Een API om een documentregistratiecomponent (DRC) te benaderen. + + In een documentregistratiecomponent worden INFORMATIEOBJECTen opgeslagen. Een + INFORMATIEOBJECT is een digitaal document voorzien van meta-gegevens. + INFORMATIEOBJECTen kunnen aan andere objecten zoals zaken en besluiten worden + gerelateerd (maar dat hoeft niet) en kunnen gebruiksrechten hebben. + + GEBRUIKSRECHTEN leggen voorwaarden op aan het gebruik van het INFORMATIEOBJECT + (buiten raadpleging). Deze GEBRUIKSRECHTEN worden niet door de API gevalideerd + of gehandhaafd. + + De typering van INFORMATIEOBJECTen is in de Catalogi API (ZTC) ondergebracht in + de vorm van INFORMATIEOBJECTTYPEn. + + **Uploaden van bestanden** + + Binnen deze API bestaan een aantal endpoints die binaire data ontvangen, al + dan niet base64-encoded. Webservers moeten op deze endpoints een minimale + request body size van 4.0 GiB ondersteunen. Dit omvat de JSON van de + metadata EN de base64-encoded bestandsdata. Hou hierbij rekening met de + overhead van base64, die ongeveer 33% bedraagt in worst-case scenario's. Dit + betekent dat bij een limiet van 4GB het bestand maximaal ongeveer 3GB groot + mag zijn. + + _Nieuw in 1.1.0_ + + Bestanden kunnen groter zijn dan de minimale die door providers + ondersteund moet worden. De consumer moet dan: + + 1. Het INFORMATIEOBJECT aanmaken in de API, waarbij de totale bestandsgrootte + meegestuurd wordt en de inhoud leeggelaten wordt. + De API antwoordt met een lijst van BESTANDSDEELen, elk met een volgnummer + en bestandsgrootte. De API lockt tegelijkertijd het INFORMATIEOBJECT. + 2. Het bestand opsplitsen: ieder BESTANDSDEEL moet de bestandsgrootte hebben + zoals dit aangegeven werd in de response bij 1. + 3. Voor elk stuk van het bestand de binaire data naar de overeenkomstige + BESTANDSDEEL-url gestuurd worden, samen met het lock ID. + 4. Het INFORMATIEOBJECT unlocken. De provider valideert op dat moment dat alle + bestandsdelen correct opgestuurd werden, en voegt deze samen tot het + resulterende bestand. + + Het bijwerken van een INFORMATIEOBJECT heeft een gelijkaardig verloop. + + De 1.0.x manier van uploaden is ook beschikbaar voor kleine(re) bestanden die + niet gesplitst hoeven te worden. + + **Afhankelijkheden** + + Deze API is afhankelijk van: + + * Catalogi API + * Notificaties API + * Autorisaties API *(optioneel)* + * Zaken API *(optioneel)* + + **Autorisatie** + + Deze API vereist autorisatie. Je kan de + [token-tool](https://zaken-auth.vng.cloud/) gebruiken om JWT-tokens te + genereren. + + ### Notificaties + + Deze API publiceert notificaties op het kanaal `documenten`. + + **Main resource** + + `enkelvoudiginformatieobject` + + + + **Kenmerken** + + * `bronorganisatie`: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste in een samenwerkingsketen heeft vastgelegd. + * `informatieobjecttype`: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). + * `vertrouwelijkheidaanduiding`: Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is. + + **Resources en acties** + + + **Handige links** + + * [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard) + * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken) contact: email: standaarden.ondersteuning@vng.nl url: https://vng-realisatie.github.io/gemma-zaken @@ -56,25 +100,25 @@ paths: description: based on DRF mixin but without partial_update summary: Upload een bestandsdeel. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/x-www-form-urlencoded - - multipart/form-data - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/x-www-form-urlencoded + - multipart/form-data + description: Content type van de verzoekinhoud. + required: true tags: - - bestandsdelen + - bestandsdelen requestBody: content: multipart/form-data: @@ -85,16 +129,15 @@ paths: $ref: '#/components/schemas/BestandsDeelRequest' required: true security: - - JWT-Claims: - - documenten.bijwerken + - JWT-Claims: + - documenten.bijwerken responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -106,11 +149,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -119,11 +161,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -132,11 +173,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -145,11 +185,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -158,11 +197,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -171,11 +209,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -184,11 +221,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -197,11 +233,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -210,11 +245,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -223,77 +257,71 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /enkelvoudiginformatieobjecten: get: operationId: enkelvoudiginformatieobject_list - description: - "Deze lijst kan gefilterd wordt met query-string parameters. \n\ + description: "Deze lijst kan gefilterd wordt met query-string parameters. \n\ De objecten bevatten metadata over de documenten en de downloadlink (`inhoud`)\ \ naar de binary data. Alleen de laatste versie van elk(ENKELVOUDIG) INFORMATIEOBJECT\ \ wordt getoond. Specifieke versies kunnen alleen" summary: Alle (ENKELVOUDIGe) INFORMATIEOBJECTen opvragen. parameters: - - name: identificatie - required: false - in: query - description: - Een binnen een gegeven context ondubbelzinnige referentie naar - het INFORMATIEOBJECT. - schema: - type: string - - name: bronorganisatie - required: false - in: query - description: - "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ - \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ - \ eerste in een samenwerkingsketen heeft vastgelegd." - schema: - type: string - - name: trefwoorden - required: false - in: query - description: Een lijst van trefwoorden gescheiden door comma's. - schema: - type: string - - name: expand - required: false - in: query - description: - "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,\ - \ hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources\ - \ direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze\ - \ scheiden met een komma. Voor het ophalen van resources die een laag dieper\ - \ genest zijn wordt de punt-notatie gebruikt." - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer + - name: identificatie + required: false + in: query + description: Een binnen een gegeven context ondubbelzinnige referentie naar + het INFORMATIEOBJECT. + schema: + type: string + - name: bronorganisatie + required: false + in: query + description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste + in een samenwerkingsketen heeft vastgelegd. + schema: + type: string + - name: trefwoorden + required: false + in: query + description: Een lijst van trefwoorden gescheiden door comma's. + schema: + type: string + - name: expand + required: false + in: query + description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,\ + \ hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources\ + \ direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze\ + \ scheiden met een komma. Voor het ophalen van resources die een laag dieper\ + \ genest zijn wordt de punt-notatie gebruikt." + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten security: - - JWT-Claims: - - documenten.lezen + - JWT-Claims: + - documenten.lezen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -305,11 +333,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -318,11 +345,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -331,11 +357,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -344,11 +369,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -357,11 +381,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -370,11 +393,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -383,11 +405,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -396,11 +417,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -409,43 +429,41 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: enkelvoudiginformatieobject_create - description: - "**Er wordt gevalideerd op** \n - geldigheid `informatieobjecttype`\ + description: "**Er wordt gevalideerd op** \n - geldigheid `informatieobjecttype`\ \ URL - de resource moet opgevraagd kunnen worden uit de catalogi API en de\ \ vorm van een INFORMATIEOBJECTTYPE hebben. \n- publicatie `informatieobjecttype`\ \ - `concept` moet `false` zijn" summary: Maak een (ENKELVOUDIG) INFORMATIEOBJECT aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten requestBody: content: application/json: @@ -453,8 +471,8 @@ paths: $ref: '#/components/schemas/EnkelvoudigInformatieObjectCreateLockRequest' required: true security: - - JWT-Claims: - - documenten.aanmaken + - JWT-Claims: + - documenten.aanmaken responses: '201': headers: @@ -466,24 +484,22 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: - $ref: '#/components/schemas/EnkelvoudigInformatieObjectCreateLock' + $ref: '#/components/schemas/SchemaEIO' description: Created '400': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -492,11 +508,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -505,11 +520,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -518,11 +532,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -531,11 +544,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -544,11 +556,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -557,11 +568,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -570,11 +580,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -583,11 +592,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -597,25 +605,24 @@ paths: description: Alle audit trail regels behorend bij het INFORMATIEOBJECT. summary: Alle audit trail regels behorend bij het INFORMATIEOBJECT. parameters: - - in: path - name: enkelvoudiginformatieobject_uuid - schema: - type: string - description: Unieke resource identifier (UUID4) - required: true + - in: path + name: enkelvoudiginformatieobject_uuid + schema: + type: string + description: Unieke resource identifier (UUID4) + required: true tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten security: - - JWT-Claims: - - audittrails.lezen + - JWT-Claims: + - audittrails.lezen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -629,11 +636,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -642,11 +648,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -655,11 +660,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -668,11 +672,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -681,11 +684,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -694,11 +696,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -707,11 +708,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -720,11 +720,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -734,33 +733,32 @@ paths: description: Een specifieke audit trail regel opvragen. summary: Een specifieke audit trail regel opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke identificatie van de audit regel. - title: uuid - required: true - - in: path - name: enkelvoudiginformatieobject_uuid - schema: - type: string - description: Unieke resource identifier (UUID4) - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke identificatie van de audit regel. + title: uuid + required: true + - in: path + name: enkelvoudiginformatieobject_uuid + schema: + type: string + description: Unieke resource identifier (UUID4) + required: true tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten security: - - JWT-Claims: - - audittrails.lezen + - JWT-Claims: + - audittrails.lezen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -772,11 +770,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -785,11 +782,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -798,11 +794,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -811,11 +806,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -824,11 +818,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -837,11 +830,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -850,11 +842,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -863,11 +854,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -876,107 +866,99 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /enkelvoudiginformatieobjecten/{uuid}: get: operationId: enkelvoudiginformatieobject_retrieve - description: - ' Het object bevat metadata over het document en de downloadlink + description: ' Het object bevat metadata over het document en de downloadlink (`inhoud`) naar de binary data. Dit geeft standaard de laatste versie van het (ENKELVOUDIG) INFORMATIEOBJECT. Specifieke versies kunnen middels query-string parameters worden opgevraagd.' summary: Een specifiek (ENKELVOUDIG) INFORMATIEOBJECT opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: query - name: versie - schema: - type: integer - description: Het (automatische) versienummer van het INFORMATIEOBJECT. - - in: query - name: registratieOp - schema: - type: string - description: - Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT - die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. - - in: query - name: expand - schema: - type: string - description: - Haal details van gelinkte resources direct op. Als je meerdere - resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor - het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie - gebruikt. - examples: - ExpandZaaktype: - value: zaaktype - summary: expand zaaktype - ExpandStatus: - value: status - summary: expand status - ExpandStatus.statustype: - value: status.statustype - summary: expand status.statustype - ExpandHoofdzaak.status.statustype: - value: hoofdzaak.status.statustype - summary: expand hoofdzaak.status.statustype - ExpandHoofdzaak.deelzaken.status.statustype: - value: hoofdzaak.deelzaken.status.statustype - summary: expand hoofdzaak.deelzaken.status.statustype + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: query + name: versie + schema: + type: integer + description: Het (automatische) versienummer van het INFORMATIEOBJECT. + - in: query + name: registratieOp + schema: + type: string + description: Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT + die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. + - in: query + name: expand + schema: + type: string + description: Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor + het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie + gebruikt. + examples: + ExpandZaaktype: + value: zaaktype + summary: expand zaaktype + ExpandStatus: + value: status + summary: expand status + ExpandStatus.statustype: + value: status.statustype + summary: expand status.statustype + ExpandHoofdzaak.status.statustype: + value: hoofdzaak.status.statustype + summary: expand hoofdzaak.status.statustype + ExpandHoofdzaak.deelzaken.status.statustype: + value: hoofdzaak.deelzaken.status.statustype + summary: expand hoofdzaak.deelzaken.status.statustype tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten security: - - JWT-Claims: - - documenten.lezen + - JWT-Claims: + - documenten.lezen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -988,11 +970,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -1001,11 +982,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -1014,11 +994,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -1027,11 +1006,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1040,11 +1018,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1053,11 +1030,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1066,11 +1042,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1079,11 +1054,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1092,50 +1066,48 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: enkelvoudiginformatieobject_update - description: - "Dit cre\xEBert altijd een nieuwe versie van het (ENKELVOUDIG)\ - \ INFORMATIEOBJECT. \n \n**Er wordt gevalideerd op**\n- correcte `lock` waarde\n\ - - status NIET `definitief`" + description: "Dit creëert altijd een nieuwe versie van het (ENKELVOUDIG) INFORMATIEOBJECT.\ + \ \n \n**Er wordt gevalideerd op**\n- correcte `lock` waarde\n- status NIET\ + \ `definitief`" summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT in zijn geheel bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten requestBody: content: application/json: @@ -1143,16 +1115,15 @@ paths: $ref: '#/components/schemas/EnkelvoudigInformatieObjectWithLockRequest' required: true security: - - JWT-Claims: - - (documenten.bijwerken | documenten.geforceerd-bijwerken) + - JWT-Claims: + - (documenten.bijwerken | documenten.geforceerd-bijwerken) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -1164,11 +1135,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -1177,11 +1147,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -1190,11 +1159,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -1203,11 +1171,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -1216,11 +1183,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1229,11 +1195,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1242,11 +1207,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1255,11 +1219,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1268,11 +1231,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1281,66 +1243,63 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: enkelvoudiginformatieobject_partial_update - description: - "Dit cre\xEBert altijd een nieuwe versie van het (ENKELVOUDIG)\ - \ INFORMATIEOBJECT. \n\n**Er wordt gevalideerd op**\n - correcte `lock` waarde\n\ - \ - status NIET `definitief`" + description: "Dit creëert altijd een nieuwe versie van het (ENKELVOUDIG) INFORMATIEOBJECT.\ + \ \n\n**Er wordt gevalideerd op**\n - correcte `lock` waarde\n - status NIET\ + \ `definitief`" summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT deels bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedEnkelvoudigInformatieObjectWithLockRequest' security: - - JWT-Claims: - - (documenten.bijwerken | documenten.geforceerd-bijwerken) + - JWT-Claims: + - (documenten.bijwerken | documenten.geforceerd-bijwerken) responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -1352,11 +1311,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -1365,11 +1323,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -1378,11 +1335,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -1391,11 +1347,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -1404,11 +1359,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1417,11 +1371,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1430,11 +1383,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1443,11 +1395,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1456,11 +1407,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1469,53 +1419,46 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: enkelvoudiginformatieobject_destroy - description: - 'Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT en alle bijbehorende - versies, samen met alle gerelateerde resources binnen deze API. Dit is alleen - mogelijk als er geen OBJECTINFORMATIEOBJECTen relateerd zijn aan het (ENKELVOUDIG) - INFORMATIEOBJECT. - + description: |- + Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT en alle bijbehorende versies, samen met alle gerelateerde resources binnen deze API. Dit is alleen mogelijk als er geen OBJECTINFORMATIEOBJECTen relateerd zijn aan het (ENKELVOUDIG) INFORMATIEOBJECT. **Gerelateerde resources** - - GEBRUIKSRECHTen - - - audit trail regels' + - audit trail regels summary: Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten security: - - JWT-Claims: - - documenten.verwijderen + - JWT-Claims: + - documenten.verwijderen responses: '204': description: No content @@ -1524,11 +1467,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -1537,11 +1479,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -1550,11 +1491,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -1563,11 +1503,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1576,11 +1515,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1589,11 +1527,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1602,11 +1539,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1615,11 +1551,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1628,11 +1563,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -1641,49 +1575,45 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) ENKELVOUDIG INFORMATIE OBJECT opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -1696,39 +1626,37 @@ paths: description: Download de binaire data van het (ENKELVOUDIG) INFORMATIEOBJECT. summary: Download de binaire data van het (ENKELVOUDIG) INFORMATIEOBJECT. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: query - name: versie - schema: - type: integer - description: Het (automatische) versienummer van het INFORMATIEOBJECT. - - in: query - name: registratieOp - schema: - type: string - description: - Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT - die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: query + name: versie + schema: + type: integer + description: Het (automatische) versienummer van het INFORMATIEOBJECT. + - in: query + name: registratieOp + schema: + type: string + description: Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT + die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten security: - - JWT-Claims: - - documenten.lezen + - JWT-Claims: + - documenten.lezen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/octet-stream: @@ -1738,90 +1666,88 @@ paths: description: OK '401': content: - application/problem+json: + application/octet-stream: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': content: - application/problem+json: + application/octet-stream: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': content: - application/problem+json: + application/octet-stream: schema: $ref: '#/components/schemas/Fout' description: Not found '406': content: - application/problem+json: + application/octet-stream: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '410': content: - application/problem+json: + application/octet-stream: schema: $ref: '#/components/schemas/Fout' description: Gone '415': content: - application/problem+json: + application/octet-stream: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': content: - application/problem+json: + application/octet-stream: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': content: - application/problem+json: + application/octet-stream: schema: $ref: '#/components/schemas/Fout' description: Internal server error /enkelvoudiginformatieobjecten/{uuid}/lock: post: operationId: enkelvoudiginformatieobject_lock - description: - Voert een 'checkout' uit waardoor het (ENKELVOUDIG) INFORMATIEOBJECTvergrendeld + description: Voert een 'checkout' uit waardoor het (ENKELVOUDIG) INFORMATIEOBJECTvergrendeld wordt met een `lock` waarde. Alleen met deze waarde kan het(ENKELVOUDIG) INFORMATIEOBJECT bijgewerkt (`PUT`, `PATCH`) en weerontgrendeld worden. summary: Vergrendel een (ENKELVOUDIG) INFORMATIEOBJECT. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten security: - - JWT-Claims: - - documenten.lock + - JWT-Claims: + - documenten.lock responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -1830,179 +1756,176 @@ paths: description: OK '400': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Bad request '401': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '410': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /enkelvoudiginformatieobjecten/{uuid}/unlock: post: operationId: enkelvoudiginformatieobject_unlock - description: - Heft de 'checkout' op waardoor het (ENKELVOUDIG) INFORMATIEOBJECTontgrendeld + description: Heft de 'checkout' op waardoor het (ENKELVOUDIG) INFORMATIEOBJECTontgrendeld wordt. summary: Ontgrendel een (ENKELVOUDIG) INFORMATIEOBJECT. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten requestBody: content: application/json: schema: $ref: '#/components/schemas/UnlockEnkelvoudigInformatieObjectRequest' security: - - JWT-Claims: - - (documenten.lock | documenten.geforceerd-unlock) + - JWT-Claims: + - (documenten.lock | documenten.geforceerd-unlock) responses: '204': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' description: No content '400': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Bad request '401': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '410': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /enkelvoudiginformatieobjecten/_zoek: post: operationId: enkelvoudiginformatieobject__zoek - description: - Zoeken/filteren gaat normaal via de `list` operatie, deze is echter + description: Zoeken/filteren gaat normaal via de `list` operatie, deze is echter niet geschikt voor zoekopdrachten met UUIDs. summary: Voer een zoekopdracht uit op (ENKELVOUDIG) INFORMATIEOBJECTen. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: query - name: page - schema: - type: integer - description: Een pagina binnen de gepagineerde set resultaten. + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: query + name: page + schema: + type: integer + description: Een pagina binnen de gepagineerde set resultaten. tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten requestBody: content: application/json: @@ -2010,16 +1933,15 @@ paths: $ref: '#/components/schemas/EIOZoekRequest' required: true security: - - JWT-Claims: - - documenten.lezen + - JWT-Claims: + - documenten.lezen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -2031,11 +1953,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -2044,11 +1965,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2057,11 +1977,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2070,11 +1989,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2083,11 +2001,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2096,11 +2013,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2109,11 +2025,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2122,11 +2037,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2135,11 +2049,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -2149,105 +2062,95 @@ paths: description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle GEBRUIKSRECHTen opvragen. parameters: - - name: informatieobject - required: false - in: query - description: URL-referentie naar het INFORMATIEOBJECT. - schema: - type: string - format: uri - - name: startdatum__lt - required: false - in: query - description: - Begindatum van de periode waarin de gebruiksrechtvoorwaarden - van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject - de startdatum. - schema: - type: string - - name: startdatum__lte - required: false - in: query - description: - Begindatum van de periode waarin de gebruiksrechtvoorwaarden - van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject - de startdatum. - schema: - type: string - - name: startdatum__gt - required: false - in: query - description: - Begindatum van de periode waarin de gebruiksrechtvoorwaarden - van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject - de startdatum. - schema: - type: string - - name: startdatum__gte - required: false - in: query - description: - Begindatum van de periode waarin de gebruiksrechtvoorwaarden - van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject - de startdatum. - schema: - type: string - - name: einddatum__lt - required: false - in: query - description: - Einddatum van de periode waarin de gebruiksrechtvoorwaarden van - toepassing zijn. - schema: - type: string - - name: einddatum__lte - required: false - in: query - description: - Einddatum van de periode waarin de gebruiksrechtvoorwaarden van - toepassing zijn. - schema: - type: string - - name: einddatum__gt - required: false - in: query - description: - Einddatum van de periode waarin de gebruiksrechtvoorwaarden van - toepassing zijn. - schema: - type: string - - name: einddatum__gte - required: false - in: query - description: - Einddatum van de periode waarin de gebruiksrechtvoorwaarden van - toepassing zijn. - schema: - type: string - - name: expand - required: false - in: query - description: - "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,\ - \ hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources\ - \ direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze\ - \ scheiden met een komma. Voor het ophalen van resources die een laag dieper\ - \ genest zijn wordt de punt-notatie gebruikt." - schema: - type: string + - name: informatieobject + required: false + in: query + description: URL-referentie naar het INFORMATIEOBJECT. + schema: + type: string + format: uri + - name: startdatum__lt + required: false + in: query + description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden + van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject + de startdatum. + schema: + type: string + - name: startdatum__lte + required: false + in: query + description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden + van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject + de startdatum. + schema: + type: string + - name: startdatum__gt + required: false + in: query + description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden + van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject + de startdatum. + schema: + type: string + - name: startdatum__gte + required: false + in: query + description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden + van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject + de startdatum. + schema: + type: string + - name: einddatum__lt + required: false + in: query + description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: einddatum__lte + required: false + in: query + description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: einddatum__gt + required: false + in: query + description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: einddatum__gte + required: false + in: query + description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: expand + required: false + in: query + description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,\ + \ hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources\ + \ direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze\ + \ scheiden met een komma. Voor het ophalen van resources die een laag dieper\ + \ genest zijn wordt de punt-notatie gebruikt." + schema: + type: string tags: - - gebruiksrechten + - gebruiksrechten security: - - JWT-Claims: - - documenten.lezen + - JWT-Claims: + - documenten.lezen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -2261,11 +2164,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -2274,11 +2176,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2287,11 +2188,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2300,11 +2200,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2313,11 +2212,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2326,11 +2224,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2339,11 +2236,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2352,11 +2248,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2365,42 +2260,40 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: gebruiksrechten_create - description: - "Voeg GEBRUIKSRECHTen toe voor een INFORMATIEOBJECT. \n**Opmerkingen**\n\ + description: "Voeg GEBRUIKSRECHTen toe voor een INFORMATIEOBJECT. \n**Opmerkingen**\n\ \ - Het toevoegen van gebruiksrechten zorgt ervoor dat de `indicatieGebruiksrecht`\ \ op het informatieobject op `true` gezet wordt." summary: Maak een GEBRUIKSRECHT aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - - gebruiksrechten + - gebruiksrechten requestBody: content: application/json: @@ -2408,8 +2301,8 @@ paths: $ref: '#/components/schemas/GebruiksrechtenRequest' required: true security: - - JWT-Claims: - - documenten.aanmaken + - JWT-Claims: + - documenten.aanmaken responses: '201': headers: @@ -2421,8 +2314,7 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -2434,11 +2326,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -2447,11 +2338,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2460,11 +2350,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2473,11 +2362,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2486,11 +2374,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2499,11 +2386,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2512,11 +2398,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2525,11 +2410,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2538,11 +2422,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -2552,77 +2435,72 @@ paths: description: Een specifieke GEBRUIKSRECHT opvragen. summary: Een specifieke GEBRUIKSRECHT opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: query - name: expand - schema: - type: string - description: - Haal details van gelinkte resources direct op. Als je meerdere - resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor - het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie - gebruikt. - examples: - ExpandZaaktype: - value: zaaktype - summary: expand zaaktype - ExpandStatus: - value: status - summary: expand status - ExpandStatus.statustype: - value: status.statustype - summary: expand status.statustype - ExpandHoofdzaak.status.statustype: - value: hoofdzaak.status.statustype - summary: expand hoofdzaak.status.statustype - ExpandHoofdzaak.deelzaken.status.statustype: - value: hoofdzaak.deelzaken.status.statustype - summary: expand hoofdzaak.deelzaken.status.statustype + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: query + name: expand + schema: + type: string + description: Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor + het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie + gebruikt. + examples: + ExpandZaaktype: + value: zaaktype + summary: expand zaaktype + ExpandStatus: + value: status + summary: expand status + ExpandStatus.statustype: + value: status.statustype + summary: expand status.statustype + ExpandHoofdzaak.status.statustype: + value: hoofdzaak.status.statustype + summary: expand hoofdzaak.status.statustype + ExpandHoofdzaak.deelzaken.status.statustype: + value: hoofdzaak.deelzaken.status.statustype + summary: expand hoofdzaak.deelzaken.status.statustype tags: - - gebruiksrechten + - gebruiksrechten security: - - JWT-Claims: - - documenten.lezen + - JWT-Claims: + - documenten.lezen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -2634,11 +2512,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2647,11 +2524,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2660,11 +2536,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -2673,11 +2548,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2686,11 +2560,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2699,11 +2572,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2712,11 +2584,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2725,11 +2596,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2738,11 +2608,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -2751,34 +2620,34 @@ paths: description: Werk een GEBRUIKSRECHT in zijn geheel bij. summary: Werk een GEBRUIKSRECHT in zijn geheel bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - - gebruiksrechten + - gebruiksrechten requestBody: content: application/json: @@ -2786,16 +2655,15 @@ paths: $ref: '#/components/schemas/GebruiksrechtenRequest' required: true security: - - JWT-Claims: - - documenten.bijwerken + - JWT-Claims: + - documenten.bijwerken responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -2807,11 +2675,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -2820,11 +2687,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2833,11 +2699,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2846,11 +2711,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -2859,11 +2723,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2872,11 +2735,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2885,11 +2747,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2898,11 +2759,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2911,11 +2771,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2924,11 +2783,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -2937,50 +2795,49 @@ paths: description: Werk een GEBRUIKSRECHT relatie deels bij. summary: Werk een GEBRUIKSRECHT relatie deels bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - - gebruiksrechten + - gebruiksrechten requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedGebruiksrechtenRequest' security: - - JWT-Claims: - - documenten.bijwerken + - JWT-Claims: + - documenten.bijwerken responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -2992,11 +2849,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -3005,11 +2861,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3018,11 +2873,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3031,11 +2885,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -3044,11 +2897,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3057,11 +2909,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3070,11 +2921,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3083,11 +2933,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3096,11 +2945,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3109,45 +2957,44 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: gebruiksrechten_destroy - description: - "\n**Opmerkingen**\n - Indien het laatste GEBRUIKSRECHT van een\ - \ INFORMATIEOBJECT verwijderd wordt, dan wordt de `indicatieGebruiksrecht`\ - \ van het INFORMATIEOBJECT op`null` gezet." + description: |2- + + **Opmerkingen** + - Indien het laatste GEBRUIKSRECHT van een INFORMATIEOBJECT verwijderd wordt, dan wordt de `indicatieGebruiksrecht` van het INFORMATIEOBJECT op`null` gezet. summary: Verwijder een GEBRUIKSRECHT. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - - gebruiksrechten + - gebruiksrechten security: - - JWT-Claims: - - documenten.verwijderen + - JWT-Claims: + - documenten.verwijderen responses: '204': description: No content @@ -3156,11 +3003,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3169,11 +3015,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3182,11 +3027,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -3195,11 +3039,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3208,11 +3051,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3221,11 +3063,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3234,11 +3075,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3247,11 +3087,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3260,11 +3099,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -3273,49 +3111,45 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) GEBRUIKSRECHT INFORMATIEOBJECT opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - gebruiksrechten + - gebruiksrechten responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -3328,46 +3162,43 @@ paths: description: ' Deze lijst kan gefilterd wordt met query-string parameters.' summary: Alle OBJECT-INFORMATIEOBJECT relaties opvragen. parameters: - - name: object - required: false - in: query - description: - URL-referentie naar het gerelateerde OBJECT (in deze of een andere - API). - schema: - type: string - format: uri - - name: informatieobject - required: false - in: query - description: URL-referentie naar het INFORMATIEOBJECT. - schema: - type: string - format: uri - - name: expand - required: false - in: query - description: - "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,\ - \ hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources\ - \ direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze\ - \ scheiden met een komma. Voor het ophalen van resources die een laag dieper\ - \ genest zijn wordt de punt-notatie gebruikt." - schema: - type: string + - name: object + required: false + in: query + description: URL-referentie naar het gerelateerde OBJECT (in deze of een andere + API). + schema: + type: string + format: uri + - name: informatieobject + required: false + in: query + description: URL-referentie naar het INFORMATIEOBJECT. + schema: + type: string + format: uri + - name: expand + required: false + in: query + description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,\ + \ hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources\ + \ direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze\ + \ scheiden met een komma. Voor het ophalen van resources die een laag dieper\ + \ genest zijn wordt de punt-notatie gebruikt." + schema: + type: string tags: - - objectinformatieobjecten + - objectinformatieobjecten security: - - JWT-Claims: - - documenten.lezen + - JWT-Claims: + - documenten.lezen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -3381,11 +3212,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -3394,11 +3224,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3407,11 +3236,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3420,11 +3248,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3433,11 +3260,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3446,11 +3272,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3459,11 +3284,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3472,11 +3296,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3485,34 +3308,32 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: objectinformatieobject_create - description: - "**LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** - Andere API's, zoals de Zaken API en de Besluiten API, gebruiken dit endpoint + description: '**LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** + Andere API''s, zoals de Zaken API en de Besluiten API, gebruiken dit endpoint bij het synchroniseren van relaties. **Er wordt gevalideerd op** - geldigheid `informatieobject` URL - de combinatie `informatieobject` en `object` moet - uniek zijn - bestaan van `object` URL" + uniek zijn - bestaan van `object` URL' summary: Maak een OBJECT-INFORMATIEOBJECT relatie aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - objectinformatieobjecten + - objectinformatieobjecten requestBody: content: application/json: @@ -3520,8 +3341,8 @@ paths: $ref: '#/components/schemas/ObjectInformatieObjectRequest' required: true security: - - JWT-Claims: - - documenten.aanmaken + - JWT-Claims: + - documenten.aanmaken responses: '201': headers: @@ -3533,8 +3354,7 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -3546,11 +3366,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -3559,11 +3378,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3572,11 +3390,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3585,11 +3402,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3598,11 +3414,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3611,11 +3426,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3624,11 +3438,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3637,11 +3450,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3650,11 +3462,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -3664,77 +3475,72 @@ paths: description: Een specifieke OBJECT-INFORMATIEOBJECT relatie opvragen. summary: Een specifieke OBJECT-INFORMATIEOBJECT relatie opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: query - name: expand - schema: - type: string - description: - Haal details van gelinkte resources direct op. Als je meerdere - resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor - het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie - gebruikt. - examples: - ExpandZaaktype: - value: zaaktype - summary: expand zaaktype - ExpandStatus: - value: status - summary: expand status - ExpandStatus.statustype: - value: status.statustype - summary: expand status.statustype - ExpandHoofdzaak.status.statustype: - value: hoofdzaak.status.statustype - summary: expand hoofdzaak.status.statustype - ExpandHoofdzaak.deelzaken.status.statustype: - value: hoofdzaak.deelzaken.status.statustype - summary: expand hoofdzaak.deelzaken.status.statustype + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: query + name: expand + schema: + type: string + description: Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor + het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie + gebruikt. + examples: + ExpandZaaktype: + value: zaaktype + summary: expand zaaktype + ExpandStatus: + value: status + summary: expand status + ExpandStatus.statustype: + value: status.statustype + summary: expand status.statustype + ExpandHoofdzaak.status.statustype: + value: hoofdzaak.status.statustype + summary: expand hoofdzaak.status.statustype + ExpandHoofdzaak.deelzaken.status.statustype: + value: hoofdzaak.deelzaken.status.statustype + summary: expand hoofdzaak.deelzaken.status.statustype tags: - - objectinformatieobjecten + - objectinformatieobjecten security: - - JWT-Claims: - - documenten.lezen + - JWT-Claims: + - documenten.lezen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -3746,11 +3552,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3759,11 +3564,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3772,11 +3576,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -3785,11 +3588,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3798,11 +3600,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3811,11 +3612,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3824,11 +3624,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3837,11 +3636,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3850,35 +3648,33 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: objectinformatieobject_destroy - description: - "**LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** - Andere API's, zoals de Zaken API en de Besluiten API, gebruiken dit endpoint - bij het synchroniseren van relaties." + description: '**LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** + Andere API''s, zoals de Zaken API en de Besluiten API, gebruiken dit endpoint + bij het synchroniseren van relaties.' summary: Verwijder een OBJECT-INFORMATIEOBJECT relatie. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true tags: - - objectinformatieobjecten + - objectinformatieobjecten security: - - JWT-Claims: - - documenten.verwijderen + - JWT-Claims: + - documenten.verwijderen responses: '204': description: No content @@ -3887,11 +3683,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3900,11 +3695,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3913,11 +3707,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -3926,11 +3719,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3939,11 +3731,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3952,11 +3743,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3965,11 +3755,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3978,11 +3767,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3991,11 +3779,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -4004,49 +3791,45 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) OOBJECT-INFORMATIEOBJECT opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - objectinformatieobjecten + - objectinformatieobjecten responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -4059,62 +3842,57 @@ paths: description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle VERZENDINGen opvragen. parameters: - - name: aardRelatie - required: false - in: query - description: - Omschrijving van de aard van de relatie van de BETROKKENE tot - het INFORMATIEOBJECT. - schema: - type: string - enum: - - afzender - - geadresseerde - - name: informatieobject - required: false - in: query - description: - URL-referentie naar het informatieobject dat is ontvangen of - verzonden. - schema: - type: string - format: uri - - name: betrokkene - required: false - in: query - description: - URL-referentie naar de betrokkene waarvan het informatieobject - is ontvangen of waaraan dit is verzonden. - schema: - type: string - format: uri - - name: expand - required: false - in: query - description: - "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,\ - \ hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources\ - \ direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze\ - \ scheiden met een komma. Voor het ophalen van resources die een laag dieper\ - \ genest zijn wordt de punt-notatie gebruikt." - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer + - name: aardRelatie + required: false + in: query + description: Omschrijving van de aard van de relatie van de BETROKKENE tot + het INFORMATIEOBJECT. + schema: + type: string + enum: + - afzender + - geadresseerde + - name: informatieobject + required: false + in: query + description: URL-referentie naar het informatieobject dat is ontvangen of + verzonden. + schema: + type: string + format: uri + - name: betrokkene + required: false + in: query + description: URL-referentie naar de betrokkene waarvan het informatieobject + is ontvangen of waaraan dit is verzonden. + schema: + type: string + format: uri + - name: expand + required: false + in: query + description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,\ + \ hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources\ + \ direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze\ + \ scheiden met een komma. Voor het ophalen van resources die een laag dieper\ + \ genest zijn wordt de punt-notatie gebruikt." + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer tags: - - verzendingen + - verzendingen responses: '200': headers: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -4126,11 +3904,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -4139,11 +3916,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4152,11 +3928,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4165,11 +3940,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4178,11 +3952,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4191,11 +3964,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4204,11 +3976,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4217,11 +3988,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4230,11 +4000,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -4243,16 +4012,16 @@ paths: description: Voeg VERZENDINGen toe voor een INFORMATIEOBJECT en een BETROKKENE. summary: Maak een VERZENDING aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - verzendingen + - verzendingen requestBody: content: application/json: @@ -4270,8 +4039,7 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -4283,11 +4051,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -4296,11 +4063,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4309,11 +4075,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4322,11 +4087,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4335,11 +4099,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4348,11 +4111,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4361,11 +4123,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4374,11 +4135,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4387,11 +4147,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -4401,74 +4160,69 @@ paths: description: Een specifieke VERZENDING opvragen. summary: Een specifieke VERZENDING opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: query - name: expand - schema: - type: string - description: - Haal details van gelinkte resources direct op. Als je meerdere - resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor - het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie - gebruikt. - examples: - ExpandZaaktype: - value: zaaktype - summary: expand zaaktype - ExpandStatus: - value: status - summary: expand status - ExpandStatus.statustype: - value: status.statustype - summary: expand status.statustype - ExpandHoofdzaak.status.statustype: - value: hoofdzaak.status.statustype - summary: expand hoofdzaak.status.statustype - ExpandHoofdzaak.deelzaken.status.statustype: - value: hoofdzaak.deelzaken.status.statustype - summary: expand hoofdzaak.deelzaken.status.statustype + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: query + name: expand + schema: + type: string + description: Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor + het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie + gebruikt. + examples: + ExpandZaaktype: + value: zaaktype + summary: expand zaaktype + ExpandStatus: + value: status + summary: expand status + ExpandStatus.statustype: + value: status.statustype + summary: expand status.statustype + ExpandHoofdzaak.status.statustype: + value: hoofdzaak.status.statustype + summary: expand hoofdzaak.status.statustype + ExpandHoofdzaak.deelzaken.status.statustype: + value: hoofdzaak.deelzaken.status.statustype + summary: expand hoofdzaak.deelzaken.status.statustype tags: - - verzendingen + - verzendingen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -4480,11 +4234,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4493,11 +4246,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4506,11 +4258,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -4519,11 +4270,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4532,11 +4282,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4545,11 +4294,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4558,11 +4306,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4571,11 +4318,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4584,11 +4330,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -4597,24 +4342,24 @@ paths: description: Werk een VERZENDING in zijn geheel bij. summary: Werk een VERZENDING in zijn geheel bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - verzendingen + - verzendingen requestBody: content: application/json: @@ -4627,8 +4372,7 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -4640,11 +4384,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -4653,11 +4396,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4666,11 +4408,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4679,11 +4420,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -4692,11 +4432,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4705,11 +4444,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4718,11 +4456,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4731,11 +4468,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4744,11 +4480,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4757,11 +4492,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -4770,24 +4504,24 @@ paths: description: Werk een VERZENDING relatie deels bij. summary: Werk een VERZENDING relatie deels bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - verzendingen + - verzendingen requestBody: content: application/json: @@ -4799,8 +4533,7 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -4812,11 +4545,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -4825,11 +4557,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4838,11 +4569,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4851,11 +4581,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -4864,11 +4593,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4877,11 +4605,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4890,11 +4617,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4903,11 +4629,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4916,11 +4641,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4929,11 +4653,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -4942,16 +4665,16 @@ paths: description: Verwijder een VERZENDING. summary: Verwijder een VERZENDING parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true tags: - - verzendingen + - verzendingen responses: '204': description: No content @@ -4960,11 +4683,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4973,11 +4695,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4986,11 +4707,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -4999,11 +4719,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -5012,11 +4731,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -5025,11 +4743,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -5038,11 +4755,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -5051,11 +4767,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -5064,11 +4779,10 @@ paths: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -5077,49 +4791,45 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) VERZENDING opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: - "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ - n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ - \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ - \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ - \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ - \ voor meer informatie." - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: "E\xE9n ETag-waarde" - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: Voer een voorwaardelijk verzoek uit. Deze header moet één of + meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. + Indien de waarde van de ETag van de huidige resource voorkomt in deze set, + dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) + voor meer informatie. + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: Eén ETag-waarde + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - verzendingen + - verzendingen responses: '200': headers: ETag: schema: type: string - description: - De ETag berekend op de response body JSON. Indien twee + description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -5133,11 +4843,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -5146,11 +4855,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -5159,11 +4867,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -5172,11 +4879,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -5185,11 +4891,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -5198,11 +4903,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -5211,11 +4915,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -5224,11 +4927,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -5237,11 +4939,10 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -5250,35 +4951,34 @@ components: API-version: schema: type: string - description: - 'Geeft een specifieke API-versie aan in de context van een + description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/problem+json: + application/json: schema: $ref: '#/components/schemas/Fout' description: Internal server error schemas: AardRelatieEnum: enum: - - afzender - - geadresseerde + - afzender + - geadresseerde type: string AlgoritmeEnum: enum: - - crc_16 - - crc_32 - - crc_64 - - fletcher_4 - - fletcher_8 - - fletcher_16 - - fletcher_32 - - hmac - - md5 - - sha_1 - - sha_256 - - sha_512 - - sha_3 + - crc_16 + - crc_32 + - crc_64 + - fletcher_4 + - fletcher_8 + - fletcher_16 + - fletcher_32 + - hmac + - md5 + - sha_1 + - sha_256 + - sha_512 + - sha_3 type: string AuditTrail: type: object @@ -5290,31 +4990,21 @@ components: title: uuid bron: allOf: - - $ref: '#/components/schemas/BronEnum' - description: - 'De naam van het component waar de wijziging in is gedaan. - + - $ref: '#/components/schemas/BronEnum' + description: |- + De naam van het component waar de wijziging in is gedaan. Uitleg bij mogelijke waarden: - * `ac` - Autorisaties API - * `nrc` - Notificaties API - * `zrc` - Zaken API - * `ztc` - Catalogi API - * `drc` - Documenten API - * `brc` - Besluiten API - * `cmc` - Contactmomenten API - * `kc` - Klanten API - - * `vrc` - Verzoeken API' + * `vrc` - Verzoeken API title: bron applicatieId: type: string @@ -5328,8 +5018,7 @@ components: maxLength: 200 gebruikersId: type: string - description: - Unieke identificatie van de gebruiker die binnen de organisatie + description: Unieke identificatie van de gebruiker die binnen de organisatie herleid kan worden naar een persoon. title: gebruikers id maxLength: 255 @@ -5340,27 +5029,19 @@ components: maxLength: 255 actie: type: string - description: 'De uitgevoerde handeling. - - - De bekende waardes voor dit veld zijn hieronder aangegeven, maar - andere waardes zijn ook toegestaan + description: |- + De uitgevoerde handeling. + De bekende waardes voor dit veld zijn hieronder aangegeven, maar andere waardes zijn ook toegestaan Uitleg bij mogelijke waarden: - * `create` - Object aangemaakt - * `list` - Lijst van objecten opgehaald - * `retrieve` - Object opgehaald - * `destroy` - Object verwijderd - * `update` - Object bijgewerkt - - * `partial_update` - Object deels bijgewerkt' + * `partial_update` - Object deels bijgewerkt title: actie maxLength: 50 actieWeergave: @@ -5408,18 +5089,18 @@ components: title: aanmaakdatum wijzigingen: allOf: - - $ref: '#/components/schemas/Wijzigingen' + - $ref: '#/components/schemas/Wijzigingen' title: wijzigingen required: - - aanmaakdatum - - actie - - bron - - hoofdObject - - resource - - resourceUrl - - resourceWeergave - - resultaat - - wijzigingen + - aanmaakdatum + - actie + - bron + - hoofdObject + - resource + - resourceUrl + - resourceWeergave + - resultaat + - wijzigingen BestandsDeel: type: object properties: @@ -5428,8 +5109,7 @@ components: format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 @@ -5446,16 +5126,15 @@ components: voltooid: type: boolean readOnly: true - description: - 'Indicatie of dit bestandsdeel volledig is geupload. Dat wil + description: 'Indicatie of dit bestandsdeel volledig is geupload. Dat wil zeggen: het aantal bytes dat staat genoemd bij grootte is daadwerkelijk ontvangen.' title: voltooid required: - - omvang - - url - - volgnummer - - voltooid + - omvang + - url + - volgnummer + - voltooid BestandsDeelRequest: type: object properties: @@ -5472,7 +5151,7 @@ components: description: Hash string, which represents id of the lock of related informatieobject title: lock required: - - lock + - lock BestandsDeelResponse: type: object properties: @@ -5481,8 +5160,7 @@ components: format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 @@ -5501,8 +5179,7 @@ components: title: inhoud voltooid: type: boolean - description: - 'Indicatie of dit bestandsdeel volledig is geupload. Dat wil + description: 'Indicatie of dit bestandsdeel volledig is geupload. Dat wil zeggen: het aantal bytes dat staat genoemd bij grootte is daadwerkelijk ontvangen.' title: voltooid @@ -5511,20 +5188,18 @@ components: description: Een volgnummer dat de volgorde van de bestandsdelen aangeeft. title: volgnummer required: - - lock - - url + - lock + - url BinnenlandsCorrespondentieadresVerzending: type: object - description: - Het correspondentieadres, betreffende een adresseerbaar object, + description: Het correspondentieadres, betreffende een adresseerbaar object, van de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van het reguliere binnenlandse correspondentieadres van BETROKKENE. properties: huisletter: type: string - description: - Een door of namens het bevoegd gemeentelijk orgaan ten aanzien + description: Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken. title: huisletter @@ -5533,57 +5208,50 @@ components: type: integer maximum: 99999 minimum: 1 - description: - Een door of namens het bevoegd gemeentelijk orgaan ten aanzien + description: Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van een adresseerbaar object toegekende nummering. title: huisnummer huisnummerToevoeging: type: string - description: - Een door of namens het bevoegd gemeentelijk orgaan ten aanzien + description: Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter. title: huisnummer toevoeging maxLength: 4 naamOpenbareRuimte: type: string - description: - Een door het bevoegde gemeentelijke orgaan aan een GEMEENTELIJKE OPENBARE + description: Een door het bevoegde gemeentelijke orgaan aan een GEMEENTELIJKE OPENBARE RUIMTE toegekende benaming. title: naam openbare ruimte maxLength: 80 postcode: type: string - description: - De door TNT Post vastgestelde code behorende bij een bepaalde + description: De door TNT Post vastgestelde code behorende bij een bepaalde combinatie van een naam van een woonplaats, naam van een openbare ruimte en een huisnummer. title: postcode maxLength: 6 woonplaatsnaam: type: string - description: - De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + description: De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS toegekende benaming. title: woonplaatsnaam maxLength: 80 required: - - huisnummer - - naamOpenbareRuimte - - woonplaatsnaam + - huisnummer + - naamOpenbareRuimte + - woonplaatsnaam nullable: true BinnenlandsCorrespondentieadresVerzendingRequest: type: object - description: - Het correspondentieadres, betreffende een adresseerbaar object, + description: Het correspondentieadres, betreffende een adresseerbaar object, van de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van het reguliere binnenlandse correspondentieadres van BETROKKENE. properties: huisletter: type: string - description: - Een door of namens het bevoegd gemeentelijk orgaan ten aanzien + description: Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken. title: huisletter @@ -5592,14 +5260,12 @@ components: type: integer maximum: 99999 minimum: 1 - description: - Een door of namens het bevoegd gemeentelijk orgaan ten aanzien + description: Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van een adresseerbaar object toegekende nummering. title: huisnummer huisnummerToevoeging: type: string - description: - Een door of namens het bevoegd gemeentelijk orgaan ten aanzien + description: Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter. title: huisnummer toevoeging @@ -5607,15 +5273,13 @@ components: naamOpenbareRuimte: type: string minLength: 1 - description: - Een door het bevoegde gemeentelijke orgaan aan een GEMEENTELIJKE OPENBARE + description: Een door het bevoegde gemeentelijke orgaan aan een GEMEENTELIJKE OPENBARE RUIMTE toegekende benaming. title: naam openbare ruimte maxLength: 80 postcode: type: string - description: - De door TNT Post vastgestelde code behorende bij een bepaalde + description: De door TNT Post vastgestelde code behorende bij een bepaalde combinatie van een naam van een woonplaats, naam van een openbare ruimte en een huisnummer. title: postcode @@ -5623,97 +5287,87 @@ components: woonplaatsnaam: type: string minLength: 1 - description: - De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + description: De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS toegekende benaming. title: woonplaatsnaam maxLength: 80 required: - - huisnummer - - naamOpenbareRuimte - - woonplaatsnaam + - huisnummer + - naamOpenbareRuimte + - woonplaatsnaam nullable: true BlankEnum: enum: - - '' + - '' BronEnum: enum: - - ac - - nrc - - zrc - - ztc - - drc - - brc - - cmc - - kc - - vrc + - ac + - nrc + - zrc + - ztc + - drc + - brc + - cmc + - kc + - vrc type: string BuitenlandsCorrespondentieadresVerzending: type: object - description: - De gegevens van het adres in het buitenland van BETROKKENE, zijnde + description: De gegevens van het adres in het buitenland van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. properties: adresBuitenland1: type: string - description: - Het eerste deel dat behoort bij het afwijkend buitenlandse + description: Het eerste deel dat behoort bij het afwijkend buitenlandse correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. title: adres buitenland 1 maxLength: 35 adresBuitenland2: type: string - description: - Het tweede deel dat behoort bij het afwijkend buitenlandse + description: Het tweede deel dat behoort bij het afwijkend buitenlandse correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. title: adres buitenland 2 maxLength: 35 adresBuitenland3: type: string - description: - Het derde deel dat behoort bij het afwijkend buitenlandse correspondentieadres + description: Het derde deel dat behoort bij het afwijkend buitenlandse correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. title: adres buitenland 3 maxLength: 35 landPostadres: type: string format: uri - description: - Het LAND dat behoort bij het afwijkend buitenlandse correspondentieadres + description: Het LAND dat behoort bij het afwijkend buitenlandse correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. title: land postadres maxLength: 200 required: - - adresBuitenland1 - - landPostadres + - adresBuitenland1 + - landPostadres nullable: true BuitenlandsCorrespondentieadresVerzendingRequest: type: object - description: - De gegevens van het adres in het buitenland van BETROKKENE, zijnde + description: De gegevens van het adres in het buitenland van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. properties: adresBuitenland1: type: string minLength: 1 - description: - Het eerste deel dat behoort bij het afwijkend buitenlandse + description: Het eerste deel dat behoort bij het afwijkend buitenlandse correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. title: adres buitenland 1 maxLength: 35 adresBuitenland2: type: string - description: - Het tweede deel dat behoort bij het afwijkend buitenlandse + description: Het tweede deel dat behoort bij het afwijkend buitenlandse correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. title: adres buitenland 2 maxLength: 35 adresBuitenland3: type: string - description: - Het derde deel dat behoort bij het afwijkend buitenlandse correspondentieadres + description: Het derde deel dat behoort bij het afwijkend buitenlandse correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. title: adres buitenland 3 maxLength: 35 @@ -5721,407 +5375,127 @@ components: type: string format: uri minLength: 1 - description: - Het LAND dat behoort bij het afwijkend buitenlandse correspondentieadres + description: Het LAND dat behoort bij het afwijkend buitenlandse correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. title: land postadres maxLength: 200 required: - - adresBuitenland1 - - landPostadres + - adresBuitenland1 + - landPostadres nullable: true BuitenlandsCorrespondentiepostadresVerzending: type: object - description: - De gegevens die tezamen een postbusadres of antwoordnummeradres - vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in - het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere - correspondentiegegevens van BETROKKENE. - properties: - postBusOfAntwoordnummer: - type: integer - maximum: 9999 - minimum: 1 - title: Postbus-of antwoordnummer - description: - De numerieke aanduiding zoals deze door de Nederlandse PTT - is vastgesteld voor postbusadressen en antwoordnummeradressen. - postadresPostcode: - type: string - description: - "De offici\xEBle Nederlandse PTT codering, bestaande uit een\ - \ numerieke woonplaatscode en een alfabetische lettercode." - title: postadres postcode - maxLength: 6 - postadresType: - allOf: - - $ref: '#/components/schemas/PostadresTypeEnum' - title: Postadrestype - description: Aanduiding van het soort postadres. - woonplaatsnaam: - type: string - description: - De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS - toegekende benaming. - title: woonplaatsnaam - maxLength: 80 - required: - - postBusOfAntwoordnummer - - postadresPostcode - - postadresType - - woonplaatsnaam - nullable: true - BuitenlandsCorrespondentiepostadresVerzendingRequest: - type: object - description: - De gegevens die tezamen een postbusadres of antwoordnummeradres + description: De gegevens die tezamen een postbusadres of antwoordnummeradres vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. properties: - postBusOfAntwoordnummer: - type: integer - maximum: 9999 - minimum: 1 - title: Postbus-of antwoordnummer - description: - De numerieke aanduiding zoals deze door de Nederlandse PTT - is vastgesteld voor postbusadressen en antwoordnummeradressen. - postadresPostcode: - type: string - minLength: 1 - description: - "De offici\xEBle Nederlandse PTT codering, bestaande uit een\ - \ numerieke woonplaatscode en een alfabetische lettercode." - title: postadres postcode - maxLength: 6 - postadresType: - allOf: - - $ref: '#/components/schemas/PostadresTypeEnum' - title: Postadrestype - description: Aanduiding van het soort postadres. - woonplaatsnaam: - type: string - minLength: 1 - description: - De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS - toegekende benaming. - title: woonplaatsnaam - maxLength: 80 - required: - - postBusOfAntwoordnummer - - postadresPostcode - - postadresType - - woonplaatsnaam - nullable: true - EIOZoekRequest: - type: object - properties: - uuid_In: - type: array - items: - type: string - format: uuid - title: '' - description: Array of unieke resource identifiers (UUID4) - title: uuid__in - required: - - uuid_In - EnkelvoudigInformatieObject: - type: object - description: Serializer for the EnkelvoudigInformatieObject model - properties: - url: - type: string - format: uri - readOnly: true - title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie - en locatie van dit object. - minLength: 1 - maxLength: 1000 - identificatie: - type: string - description: - Een binnen een gegeven context ondubbelzinnige referentie naar - het INFORMATIEOBJECT. - title: identificatie - maxLength: 40 - bronorganisatie: - type: string - description: - "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ - \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ - \ eerste in een samenwerkingsketen heeft vastgelegd." - title: bronorganisatie - maxLength: 9 - creatiedatum: - type: string - format: date - description: Een datum of een gebeurtenis in de levenscyclus van het INFORMATIEOBJECT. - title: creatiedatum - titel: - type: string - description: De naam waaronder het INFORMATIEOBJECT formeel bekend is. - title: titel - maxLength: 200 - vertrouwelijkheidaanduiding: - description: - 'Aanduiding van de mate waarin het INFORMATIEOBJECT voor de - openbaarheid bestemd is. - - - Uitleg bij mogelijke waarden: - - - * `openbaar` - Openbaar - - * `beperkt_openbaar` - Beperkt openbaar - - * `intern` - Intern - - * `zaakvertrouwelijk` - Zaakvertrouwelijk - - * `vertrouwelijk` - Vertrouwelijk - - * `confidentieel` - Confidentieel - - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' - title: vertrouwelijkheidaanduiding - oneOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - - $ref: '#/components/schemas/BlankEnum' - auteur: - type: string - description: - "De persoon of organisatie die in de eerste plaats verantwoordelijk\ - \ is voor het cre\xEBren van de inhoud van het INFORMATIEOBJECT." - title: auteur - maxLength: 200 - status: - description: - "Aanduiding van de stand van zaken van een INFORMATIEOBJECT. - De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als - het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van - de Status in 'gearchiveerd' impliceert dat het informatieobject een - duurzaam, niet-wijzigbaar Formaat dient te hebben. - - - Uitleg bij mogelijke waarden: - - - * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar - moet nog vastgesteld worden. - - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand - vastgesteld dan wel ontvangen. - - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar - gemaakt; een gearchiveerd informatie-element." - title: status - oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' - formaat: - type: string - description: - 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde - inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. - Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml' - title: formaat - maxLength: 255 - taal: - type: string - description: - 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT - is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' - title: taal - maxLength: 3 - minLength: 3 - versie: - type: integer - readOnly: true - description: - Het (automatische) versienummer van het INFORMATIEOBJECT. Deze - begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. - title: versie - beginRegistratie: - type: string - format: date-time - readOnly: true - description: - Een datumtijd in ISO8601 formaat waarop deze versie van het - INFORMATIEOBJECT is aangemaakt of gewijzigd. - title: begin registratie - bestandsnaam: - type: string - description: - De naam van het fysieke bestand waarin de inhoud van het informatieobject - is vastgelegd, inclusief extensie. - title: bestandsnaam - maxLength: 255 - inhoud: - type: string - format: uri - description: Download URL van de binaire inhoud. - nullable: true - title: inhoud - bestandsomvang: - type: integer - maximum: 9223372036854775807 - minimum: 0 - format: int64 - nullable: true - description: Aantal bytes dat de inhoud van INFORMATIEOBJECT in beslag neemt. - title: bestandsomvang - link: - type: string - format: uri - description: - De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen - is. - title: link - maxLength: 200 - beschrijving: - type: string - description: Een generieke beschrijving van de inhoud van het INFORMATIEOBJECT. - title: beschrijving - maxLength: 1000 - ontvangstdatum: + postBusOfAntwoordnummer: + type: integer + maximum: 9999 + minimum: 1 + title: Postbus-of antwoordnummer + description: De numerieke aanduiding zoals deze door de Nederlandse PTT + is vastgesteld voor postbusadressen en antwoordnummeradressen. + postadresPostcode: type: string - format: date - nullable: true - description: - "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ - \ \n\n De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te\ - \ registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende\ - \ organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden\ - \ aan documenten die van of naar andere personen ontvangen of verzonden\ - \ zijn waarbij die personen niet deel uit maken van de behandeling van\ - \ de zaak waarin het document een rol speelt." - title: ontvangstdatum - verzenddatum: + description: De officiële Nederlandse PTT codering, bestaande uit een numerieke + woonplaatscode en een alfabetische lettercode. + title: postadres postcode + maxLength: 6 + postadresType: + allOf: + - $ref: '#/components/schemas/PostadresTypeEnum' + title: Postadrestype + description: Aanduiding van het soort postadres. + woonplaatsnaam: type: string - format: date - nullable: true - description: - "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ - \ \n\n De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op\ - \ het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als\ - \ uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk\ - \ inkomend en uitgaand zijn. Ontvangst en verzending is voorbehouden aan\ - \ documenten die van of naar andere personen ontvangen of verzonden zijn\ - \ waarbij die personen niet deel uit maken van de behandeling van de zaak\ - \ waarin het document een rol speelt." - title: verzenddatum - indicatieGebruiksrecht: - type: boolean - nullable: true - description: - Indicatie of er beperkingen gelden aangaande het gebruik van - het informatieobject anders dan raadpleging. Dit veld mag `null` zijn - om aan te geven dat de indicatie nog niet bekend is. Als de indicatie - gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen - via de GEBRUIKSRECHTen resource. - title: indicatie gebruiksrecht - verschijningsvorm: + description: De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + toegekende benaming. + title: woonplaatsnaam + maxLength: 80 + required: + - postBusOfAntwoordnummer + - postadresPostcode + - postadresType + - woonplaatsnaam + nullable: true + BuitenlandsCorrespondentiepostadresVerzendingRequest: + type: object + description: De gegevens die tezamen een postbusadres of antwoordnummeradres + vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in + het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere + correspondentiegegevens van BETROKKENE. + properties: + postBusOfAntwoordnummer: + type: integer + maximum: 9999 + minimum: 1 + title: Postbus-of antwoordnummer + description: De numerieke aanduiding zoals deze door de Nederlandse PTT + is vastgesteld voor postbusadressen en antwoordnummeradressen. + postadresPostcode: type: string - description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT." - title: verschijningsvorm - ondertekening: - allOf: - - $ref: '#/components/schemas/Ondertekening' - nullable: true - description: - Aanduiding van de rechtskracht van een informatieobject. Mag - niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' - of 'ter vaststelling' heeft. - title: ondertekening - integriteit: + minLength: 1 + description: De officiële Nederlandse PTT codering, bestaande uit een numerieke + woonplaatscode en een alfabetische lettercode. + title: postadres postcode + maxLength: 6 + postadresType: allOf: - - $ref: '#/components/schemas/Integriteit' - nullable: true - description: - Uitdrukking van mate van volledigheid en onbeschadigd zijn - van digitaal bestand. - title: integriteit - informatieobjecttype: + - $ref: '#/components/schemas/PostadresTypeEnum' + title: Postadrestype + description: Aanduiding van het soort postadres. + woonplaatsnaam: type: string - format: uri - description: - URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi - API). - title: informatieobjecttype - maxLength: 200 - locked: - type: boolean - readOnly: true - description: - Geeft aan of het document gelocked is. Alleen als een document - gelocked is, mogen er aanpassingen gemaakt worden. - title: locked - bestandsdelen: - type: array - items: - $ref: '#/components/schemas/BestandsDeel' - readOnly: true - title: bestandsdelen - trefwoorden: + minLength: 1 + description: De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + toegekende benaming. + title: woonplaatsnaam + maxLength: 80 + required: + - postBusOfAntwoordnummer + - postadresPostcode + - postadresType + - woonplaatsnaam + nullable: true + EIOZoekRequest: + type: object + properties: + uuid_In: type: array items: type: string - maxLength: 100 - nullable: true - description: Een lijst van trefwoorden gescheiden door comma's. - title: trefwoorden + format: uuid + title: '' + description: Array of unieke resource identifiers (UUID4) + title: uuid__in required: - - auteur - - beginRegistratie - - bestandsdelen - - bronorganisatie - - creatiedatum - - informatieobjecttype - - locked - - taal - - titel - - url - - versie - EnkelvoudigInformatieObjectCreateLock: + - uuid_In + EnkelvoudigInformatieObject: type: object - description: - 'This serializer class is used by EnkelvoudigInformatieObjectViewSet - for - - create operation for large files' + description: Serializer for the EnkelvoudigInformatieObject model properties: url: type: string format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 identificatie: type: string - description: - Een binnen een gegeven context ondubbelzinnige referentie naar + description: Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string - description: - "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ - \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ - \ eerste in een samenwerkingsketen heeft vastgelegd." + description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste + in een samenwerkingsketen heeft vastgelegd. title: bronorganisatie maxLength: 9 creatiedatum: @@ -6135,78 +5509,53 @@ components: title: titel maxLength: 200 vertrouwelijkheidaanduiding: - description: - 'Aanduiding van de mate waarin het INFORMATIEOBJECT voor de - openbaarheid bestemd is. - + description: |- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is. Uitleg bij mogelijke waarden: - * `openbaar` - Openbaar - * `beperkt_openbaar` - Beperkt openbaar - * `intern` - Intern - * `zaakvertrouwelijk` - Zaakvertrouwelijk - * `vertrouwelijk` - Vertrouwelijk - * `confidentieel` - Confidentieel - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' + * `zeer_geheim` - Zeer geheim title: vertrouwelijkheidaanduiding oneOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' auteur: type: string - description: - "De persoon of organisatie die in de eerste plaats verantwoordelijk\ - \ is voor het cre\xEBren van de inhoud van het INFORMATIEOBJECT." + description: De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. title: auteur maxLength: 200 status: - description: - "Aanduiding van de stand van zaken van een INFORMATIEOBJECT. - De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als - het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van - de Status in 'gearchiveerd' impliceert dat het informatieobject een - duurzaam, niet-wijzigbaar Formaat dient te hebben. - + description: |- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. Uitleg bij mogelijke waarden: - * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar - moet nog vastgesteld worden. - - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand - vastgesteld dan wel ontvangen. - - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar - gemaakt; een gearchiveerd informatie-element." + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element. title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' formaat: type: string - description: - 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + description: 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml' title: formaat maxLength: 255 taal: type: string - description: - 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 @@ -6214,22 +5563,19 @@ components: versie: type: integer readOnly: true - description: - Het (automatische) versienummer van het INFORMATIEOBJECT. Deze + description: Het (automatische) versienummer van het INFORMATIEOBJECT. Deze begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. title: versie beginRegistratie: type: string format: date-time readOnly: true - description: - Een datumtijd in ISO8601 formaat waarop deze versie van het + description: Een datumtijd in ISO8601 formaat waarop deze versie van het INFORMATIEOBJECT is aangemaakt of gewijzigd. title: begin registratie bestandsnaam: type: string - description: - De naam van het fysieke bestand waarin de inhoud van het informatieobject + description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 @@ -6250,8 +5596,7 @@ components: link: type: string format: uri - description: - De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 @@ -6264,8 +5609,7 @@ components: type: string format: date nullable: true - description: - "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te\ \ registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende\ \ organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden\ @@ -6277,8 +5621,7 @@ components: type: string format: date nullable: true - description: - "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op\ \ het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als\ \ uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk\ @@ -6290,8 +5633,7 @@ components: indicatieGebruiksrecht: type: boolean nullable: true - description: - Indicatie of er beperkingen gelden aangaande het gebruik van + description: Indicatie of er beperkingen gelden aangaande het gebruik van het informatieobject anders dan raadpleging. Dit veld mag `null` zijn om aan te geven dat de indicatie nog niet bekend is. Als de indicatie gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen @@ -6299,38 +5641,34 @@ components: title: indicatie gebruiksrecht verschijningsvorm: type: string - description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT." + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. title: verschijningsvorm ondertekening: allOf: - - $ref: '#/components/schemas/Ondertekening' + - $ref: '#/components/schemas/Ondertekening' nullable: true - description: - Aanduiding van de rechtskracht van een informatieobject. Mag + description: Aanduiding van de rechtskracht van een informatieobject. Mag niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' of 'ter vaststelling' heeft. title: ondertekening integriteit: allOf: - - $ref: '#/components/schemas/Integriteit' + - $ref: '#/components/schemas/Integriteit' nullable: true - description: - Uitdrukking van mate van volledigheid en onbeschadigd zijn + description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri - description: - URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 locked: type: boolean readOnly: true - description: - Geeft aan of het document gelocked is. Alleen als een document + description: Geeft aan of het document gelocked is. Alleen als een document gelocked is, mogen er aanpassingen gemaakt worden. title: locked bestandsdelen: @@ -6347,49 +5685,36 @@ components: nullable: true description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden - lock: - type: string - readOnly: true - description: - Lock id generated if the large file is created and should be - used while updating the document. Documents with base64 encoded files - are created without lock - title: lock required: - - auteur - - beginRegistratie - - bestandsdelen - - bronorganisatie - - creatiedatum - - informatieobjecttype - - lock - - locked - - taal - - titel - - url - - versie + - auteur + - beginRegistratie + - bestandsdelen + - bronorganisatie + - creatiedatum + - informatieobjecttype + - locked + - taal + - titel + - url + - versie EnkelvoudigInformatieObjectCreateLockRequest: type: object - description: - 'This serializer class is used by EnkelvoudigInformatieObjectViewSet - for - - create operation for large files' + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + create operation for large files properties: identificatie: type: string - description: - Een binnen een gegeven context ondubbelzinnige referentie naar + description: Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string minLength: 1 - description: - "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ - \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ - \ eerste in een samenwerkingsketen heeft vastgelegd." + description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste + in een samenwerkingsketen heeft vastgelegd. title: bronorganisatie maxLength: 9 creatiedatum: @@ -6404,71 +5729,47 @@ components: title: titel maxLength: 200 vertrouwelijkheidaanduiding: - description: - 'Aanduiding van de mate waarin het INFORMATIEOBJECT voor de - openbaarheid bestemd is. - + description: |- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is. Uitleg bij mogelijke waarden: - * `openbaar` - Openbaar - * `beperkt_openbaar` - Beperkt openbaar - * `intern` - Intern - * `zaakvertrouwelijk` - Zaakvertrouwelijk - * `vertrouwelijk` - Vertrouwelijk - * `confidentieel` - Confidentieel - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' + * `zeer_geheim` - Zeer geheim title: vertrouwelijkheidaanduiding oneOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' auteur: type: string minLength: 1 - description: - "De persoon of organisatie die in de eerste plaats verantwoordelijk\ - \ is voor het cre\xEBren van de inhoud van het INFORMATIEOBJECT." + description: De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. title: auteur maxLength: 200 status: - description: - "Aanduiding van de stand van zaken van een INFORMATIEOBJECT. - De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als - het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van - de Status in 'gearchiveerd' impliceert dat het informatieobject een - duurzaam, niet-wijzigbaar Formaat dient te hebben. - + description: |- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. Uitleg bij mogelijke waarden: - * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar - moet nog vastgesteld worden. - - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand - vastgesteld dan wel ontvangen. - - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar - gemaakt; een gearchiveerd informatie-element." + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element. title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' formaat: type: string - description: - 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + description: 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml' title: formaat @@ -6476,22 +5777,20 @@ components: taal: type: string minLength: 3 - description: - 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 bestandsnaam: type: string - description: - De naam van het fysieke bestand waarin de inhoud van het informatieobject + description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 inhoud: type: string format: byte - description: "Binaire inhoud, in base64 ge\xEBncodeerd." + description: Binaire inhoud, in base64 geëncodeerd. nullable: true title: inhoud bestandsomvang: @@ -6505,8 +5804,7 @@ components: link: type: string format: uri - description: - De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 @@ -6519,8 +5817,7 @@ components: type: string format: date nullable: true - description: - "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te\ \ registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende\ \ organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden\ @@ -6532,8 +5829,7 @@ components: type: string format: date nullable: true - description: - "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op\ \ het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als\ \ uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk\ @@ -6545,8 +5841,7 @@ components: indicatieGebruiksrecht: type: boolean nullable: true - description: - Indicatie of er beperkingen gelden aangaande het gebruik van + description: Indicatie of er beperkingen gelden aangaande het gebruik van het informatieobject anders dan raadpleging. Dit veld mag `null` zijn om aan te geven dat de indicatie nog niet bekend is. Als de indicatie gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen @@ -6554,31 +5849,28 @@ components: title: indicatie gebruiksrecht verschijningsvorm: type: string - description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT." + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. title: verschijningsvorm ondertekening: allOf: - - $ref: '#/components/schemas/OndertekeningRequest' + - $ref: '#/components/schemas/OndertekeningRequest' nullable: true - description: - Aanduiding van de rechtskracht van een informatieobject. Mag + description: Aanduiding van de rechtskracht van een informatieobject. Mag niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' of 'ter vaststelling' heeft. title: ondertekening integriteit: allOf: - - $ref: '#/components/schemas/IntegriteitRequest' + - $ref: '#/components/schemas/IntegriteitRequest' nullable: true - description: - Uitdrukking van mate van volledigheid en onbeschadigd zijn + description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri minLength: 1 - description: - URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 @@ -6592,43 +5884,38 @@ components: description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden required: - - auteur - - bronorganisatie - - creatiedatum - - informatieobjecttype - - taal - - titel + - auteur + - bronorganisatie + - creatiedatum + - informatieobjecttype + - taal + - titel EnkelvoudigInformatieObjectWithLock: type: object - description: - 'This serializer class is used by EnkelvoudigInformatieObjectViewSet - for - - update and partial_update operations' + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + update and partial_update operations properties: url: type: string format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 identificatie: type: string - description: - Een binnen een gegeven context ondubbelzinnige referentie naar + description: Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string - description: - "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ - \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ - \ eerste in een samenwerkingsketen heeft vastgelegd." + description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste + in een samenwerkingsketen heeft vastgelegd. title: bronorganisatie maxLength: 9 creatiedatum: @@ -6642,78 +5929,53 @@ components: title: titel maxLength: 200 vertrouwelijkheidaanduiding: - description: - 'Aanduiding van de mate waarin het INFORMATIEOBJECT voor de - openbaarheid bestemd is. - + description: |- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is. Uitleg bij mogelijke waarden: - * `openbaar` - Openbaar - * `beperkt_openbaar` - Beperkt openbaar - * `intern` - Intern - * `zaakvertrouwelijk` - Zaakvertrouwelijk - * `vertrouwelijk` - Vertrouwelijk - * `confidentieel` - Confidentieel - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' + * `zeer_geheim` - Zeer geheim title: vertrouwelijkheidaanduiding oneOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' auteur: type: string - description: - "De persoon of organisatie die in de eerste plaats verantwoordelijk\ - \ is voor het cre\xEBren van de inhoud van het INFORMATIEOBJECT." + description: De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. title: auteur maxLength: 200 status: - description: - "Aanduiding van de stand van zaken van een INFORMATIEOBJECT. - De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als - het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van - de Status in 'gearchiveerd' impliceert dat het informatieobject een - duurzaam, niet-wijzigbaar Formaat dient te hebben. - + description: |- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. Uitleg bij mogelijke waarden: - * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar - moet nog vastgesteld worden. - - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand - vastgesteld dan wel ontvangen. - - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar - gemaakt; een gearchiveerd informatie-element." + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element. title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' formaat: type: string - description: - 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + description: 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml' title: formaat maxLength: 255 taal: type: string - description: - 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 @@ -6721,22 +5983,19 @@ components: versie: type: integer readOnly: true - description: - Het (automatische) versienummer van het INFORMATIEOBJECT. Deze + description: Het (automatische) versienummer van het INFORMATIEOBJECT. Deze begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. title: versie beginRegistratie: type: string format: date-time readOnly: true - description: - Een datumtijd in ISO8601 formaat waarop deze versie van het + description: Een datumtijd in ISO8601 formaat waarop deze versie van het INFORMATIEOBJECT is aangemaakt of gewijzigd. title: begin registratie bestandsnaam: type: string - description: - De naam van het fysieke bestand waarin de inhoud van het informatieobject + description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 @@ -6757,8 +6016,7 @@ components: link: type: string format: uri - description: - De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 @@ -6771,8 +6029,7 @@ components: type: string format: date nullable: true - description: - "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te\ \ registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende\ \ organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden\ @@ -6784,8 +6041,7 @@ components: type: string format: date nullable: true - description: - "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op\ \ het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als\ \ uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk\ @@ -6797,8 +6053,7 @@ components: indicatieGebruiksrecht: type: boolean nullable: true - description: - Indicatie of er beperkingen gelden aangaande het gebruik van + description: Indicatie of er beperkingen gelden aangaande het gebruik van het informatieobject anders dan raadpleging. Dit veld mag `null` zijn om aan te geven dat de indicatie nog niet bekend is. Als de indicatie gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen @@ -6806,38 +6061,34 @@ components: title: indicatie gebruiksrecht verschijningsvorm: type: string - description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT." + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. title: verschijningsvorm ondertekening: allOf: - - $ref: '#/components/schemas/Ondertekening' + - $ref: '#/components/schemas/Ondertekening' nullable: true - description: - Aanduiding van de rechtskracht van een informatieobject. Mag + description: Aanduiding van de rechtskracht van een informatieobject. Mag niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' of 'ter vaststelling' heeft. title: ondertekening integriteit: allOf: - - $ref: '#/components/schemas/Integriteit' + - $ref: '#/components/schemas/Integriteit' nullable: true - description: - Uitdrukking van mate van volledigheid en onbeschadigd zijn + description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri - description: - URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 locked: type: boolean readOnly: true - description: - Geeft aan of het document gelocked is. Alleen als een document + description: Geeft aan of het document gelocked is. Alleen als een document gelocked is, mogen er aanpassingen gemaakt worden. title: locked bestandsdelen: @@ -6855,39 +6106,35 @@ components: description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden required: - - auteur - - beginRegistratie - - bestandsdelen - - bronorganisatie - - creatiedatum - - informatieobjecttype - - locked - - taal - - titel - - url - - versie + - auteur + - beginRegistratie + - bestandsdelen + - bronorganisatie + - creatiedatum + - informatieobjecttype + - locked + - taal + - titel + - url + - versie EnkelvoudigInformatieObjectWithLockRequest: type: object - description: - 'This serializer class is used by EnkelvoudigInformatieObjectViewSet - for - - update and partial_update operations' + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + update and partial_update operations properties: identificatie: type: string - description: - Een binnen een gegeven context ondubbelzinnige referentie naar + description: Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string minLength: 1 - description: - "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ - \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ - \ eerste in een samenwerkingsketen heeft vastgelegd." + description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste + in een samenwerkingsketen heeft vastgelegd. title: bronorganisatie maxLength: 9 creatiedatum: @@ -6902,71 +6149,47 @@ components: title: titel maxLength: 200 vertrouwelijkheidaanduiding: - description: - 'Aanduiding van de mate waarin het INFORMATIEOBJECT voor de - openbaarheid bestemd is. - + description: |- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is. Uitleg bij mogelijke waarden: - * `openbaar` - Openbaar - * `beperkt_openbaar` - Beperkt openbaar - * `intern` - Intern - * `zaakvertrouwelijk` - Zaakvertrouwelijk - * `vertrouwelijk` - Vertrouwelijk - * `confidentieel` - Confidentieel - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' + * `zeer_geheim` - Zeer geheim title: vertrouwelijkheidaanduiding oneOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' auteur: type: string minLength: 1 - description: - "De persoon of organisatie die in de eerste plaats verantwoordelijk\ - \ is voor het cre\xEBren van de inhoud van het INFORMATIEOBJECT." + description: De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. title: auteur maxLength: 200 status: - description: - "Aanduiding van de stand van zaken van een INFORMATIEOBJECT. - De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als - het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van - de Status in 'gearchiveerd' impliceert dat het informatieobject een - duurzaam, niet-wijzigbaar Formaat dient te hebben. - + description: |- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. Uitleg bij mogelijke waarden: - * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar - moet nog vastgesteld worden. - - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand - vastgesteld dan wel ontvangen. - - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar - gemaakt; een gearchiveerd informatie-element." + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element. title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' formaat: type: string - description: - 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + description: 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml' title: formaat @@ -6974,22 +6197,20 @@ components: taal: type: string minLength: 3 - description: - 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 bestandsnaam: type: string - description: - De naam van het fysieke bestand waarin de inhoud van het informatieobject + description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 inhoud: type: string format: byte - description: "Binaire inhoud, in base64 ge\xEBncodeerd." + description: Binaire inhoud, in base64 geëncodeerd. nullable: true title: inhoud bestandsomvang: @@ -7003,8 +6224,7 @@ components: link: type: string format: uri - description: - De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 @@ -7017,8 +6237,7 @@ components: type: string format: date nullable: true - description: - "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te\ \ registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende\ \ organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden\ @@ -7030,8 +6249,7 @@ components: type: string format: date nullable: true - description: - "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op\ \ het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als\ \ uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk\ @@ -7043,8 +6261,7 @@ components: indicatieGebruiksrecht: type: boolean nullable: true - description: - Indicatie of er beperkingen gelden aangaande het gebruik van + description: Indicatie of er beperkingen gelden aangaande het gebruik van het informatieobject anders dan raadpleging. Dit veld mag `null` zijn om aan te geven dat de indicatie nog niet bekend is. Als de indicatie gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen @@ -7052,31 +6269,28 @@ components: title: indicatie gebruiksrecht verschijningsvorm: type: string - description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT." + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. title: verschijningsvorm ondertekening: allOf: - - $ref: '#/components/schemas/OndertekeningRequest' + - $ref: '#/components/schemas/OndertekeningRequest' nullable: true - description: - Aanduiding van de rechtskracht van een informatieobject. Mag + description: Aanduiding van de rechtskracht van een informatieobject. Mag niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' of 'ter vaststelling' heeft. title: ondertekening integriteit: allOf: - - $ref: '#/components/schemas/IntegriteitRequest' + - $ref: '#/components/schemas/IntegriteitRequest' nullable: true - description: - Uitdrukking van mate van volledigheid en onbeschadigd zijn + description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri minLength: 1 - description: - URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 @@ -7093,19 +6307,18 @@ components: type: string writeOnly: true minLength: 1 - description: - Tijdens het updaten van een document (PATCH, PUT) moet het + description: Tijdens het updaten van een document (PATCH, PUT) moet het `lock` veld opgegeven worden. Bij het aanmaken (POST) mag het geen waarde hebben. title: lock required: - - auteur - - bronorganisatie - - creatiedatum - - informatieobjecttype - - lock - - taal - - titel + - auteur + - bronorganisatie + - creatiedatum + - informatieobjecttype + - lock + - taal + - titel FieldValidationError: type: object description: Formaat van validatiefouten. @@ -7123,9 +6336,9 @@ components: description: Uitleg wat er precies fout is met de gegevens title: reason required: - - code - - name - - reason + - code + - name + - reason Fout: type: object description: Formaat van HTTP 4xx en 5xx fouten. @@ -7152,16 +6365,15 @@ components: title: detail instance: type: string - description: - URI met referentie naar dit specifiek voorkomen van de fout. + description: URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. title: instance required: - - code - - detail - - instance - - status - - title + - code + - detail + - instance + - status + - title Gebruiksrechten: type: object properties: @@ -7170,8 +6382,7 @@ components: format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 @@ -7183,8 +6394,7 @@ components: startdatum: type: string format: date-time - description: - Begindatum van de periode waarin de gebruiksrechtvoorwaarden + description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject de startdatum. title: startdatum @@ -7193,20 +6403,18 @@ components: format: date-time nullable: true title: Startdatum - description: - Einddatum van de periode waarin de gebruiksrechtvoorwaarden + description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. omschrijvingVoorwaarden: type: string - description: - Omschrijving van de van toepassing zijnde voorwaarden aan het + description: Omschrijving van de van toepassing zijnde voorwaarden aan het gebruik anders dan raadpleging title: omschrijving voorwaarden required: - - informatieobject - - omschrijvingVoorwaarden - - startdatum - - url + - informatieobject + - omschrijvingVoorwaarden + - startdatum + - url GebruiksrechtenRequest: type: object properties: @@ -7218,8 +6426,7 @@ components: startdatum: type: string format: date-time - description: - Begindatum van de periode waarin de gebruiksrechtvoorwaarden + description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject de startdatum. title: startdatum @@ -7228,61 +6435,44 @@ components: format: date-time nullable: true title: Startdatum - description: - Einddatum van de periode waarin de gebruiksrechtvoorwaarden + description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. omschrijvingVoorwaarden: type: string minLength: 1 - description: - Omschrijving van de van toepassing zijnde voorwaarden aan het + description: Omschrijving van de van toepassing zijnde voorwaarden aan het gebruik anders dan raadpleging title: omschrijving voorwaarden required: - - informatieobject - - omschrijvingVoorwaarden - - startdatum + - informatieobject + - omschrijvingVoorwaarden + - startdatum Integriteit: type: object - description: - Uitdrukking van mate van volledigheid en onbeschadigd zijn van + description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. properties: algoritme: allOf: - - $ref: '#/components/schemas/AlgoritmeEnum' - description: - 'Aanduiding van algoritme, gebruikt om de checksum te maken. - + - $ref: '#/components/schemas/AlgoritmeEnum' + description: |- + Aanduiding van algoritme, gebruikt om de checksum te maken. Uitleg bij mogelijke waarden: - * `crc_16` - CRC-16 - * `crc_32` - CRC-32 - * `crc_64` - CRC-64 - * `fletcher_4` - Fletcher-4 - * `fletcher_8` - Fletcher-8 - * `fletcher_16` - Fletcher-16 - * `fletcher_32` - Fletcher-32 - * `hmac` - HMAC - * `md5` - MD5 - * `sha_1` - SHA-1 - * `sha_256` - SHA-256 - * `sha_512` - SHA-512 - - * `sha_3` - SHA-3' + * `sha_3` - SHA-3 title: integriteit algoritme waarde: type: string @@ -7295,51 +6485,36 @@ components: description: Datum waarop de checksum is gemaakt. title: integriteit datum required: - - algoritme - - datum - - waarde + - algoritme + - datum + - waarde nullable: true IntegriteitRequest: type: object - description: - Uitdrukking van mate van volledigheid en onbeschadigd zijn van + description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. properties: algoritme: allOf: - - $ref: '#/components/schemas/AlgoritmeEnum' - description: - 'Aanduiding van algoritme, gebruikt om de checksum te maken. - + - $ref: '#/components/schemas/AlgoritmeEnum' + description: |- + Aanduiding van algoritme, gebruikt om de checksum te maken. Uitleg bij mogelijke waarden: - * `crc_16` - CRC-16 - * `crc_32` - CRC-32 - * `crc_64` - CRC-64 - * `fletcher_4` - Fletcher-4 - * `fletcher_8` - Fletcher-8 - * `fletcher_16` - Fletcher-16 - * `fletcher_32` - Fletcher-32 - * `hmac` - HMAC - * `md5` - MD5 - * `sha_1` - SHA-1 - * `sha_256` - SHA-256 - * `sha_512` - SHA-512 - - * `sha_3` - SHA-3' + * `sha_3` - SHA-3 title: integriteit algoritme waarde: type: string @@ -7353,16 +6528,15 @@ components: description: Datum waarop de checksum is gemaakt. title: integriteit datum required: - - algoritme - - datum - - waarde + - algoritme + - datum + - waarde nullable: true LockEnkelvoudigInformatieObject: type: object - description: - 'Serializer for the lock action of EnkelvoudigInformatieObjectCanonical - - model' + description: |- + Serializer for the lock action of EnkelvoudigInformatieObjectCanonical + model properties: lock: type: string @@ -7370,7 +6544,7 @@ components: description: Hash string, wordt gebruikt als ID voor de lock title: lock required: - - lock + - lock ObjectInformatieObject: type: object properties: @@ -7379,8 +6553,7 @@ components: format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 @@ -7392,29 +6565,26 @@ components: object: type: string format: uri - description: - URL-referentie naar het gerelateerde OBJECT (in deze of een + description: URL-referentie naar het gerelateerde OBJECT (in deze of een andere API). title: object maxLength: 1000 objectType: allOf: - - $ref: '#/components/schemas/ObjectTypeEnum' + - $ref: '#/components/schemas/ObjectTypeEnum' title: Objecttype - description: 'Het type van het gerelateerde OBJECT. - + description: |- + Het type van het gerelateerde OBJECT. Uitleg bij mogelijke waarden: - * `besluit` - Besluit - - * `zaak` - Zaak' + * `zaak` - Zaak required: - - informatieobject - - object - - objectType - - url + - informatieobject + - object + - objectType + - url ObjectInformatieObjectRequest: type: object properties: @@ -7427,101 +6597,86 @@ components: type: string format: uri minLength: 1 - description: - URL-referentie naar het gerelateerde OBJECT (in deze of een + description: URL-referentie naar het gerelateerde OBJECT (in deze of een andere API). title: object maxLength: 1000 objectType: allOf: - - $ref: '#/components/schemas/ObjectTypeEnum' + - $ref: '#/components/schemas/ObjectTypeEnum' title: Objecttype - description: 'Het type van het gerelateerde OBJECT. - + description: |- + Het type van het gerelateerde OBJECT. Uitleg bij mogelijke waarden: - * `besluit` - Besluit - - * `zaak` - Zaak' + * `zaak` - Zaak required: - - informatieobject - - object - - objectType + - informatieobject + - object + - objectType ObjectTypeEnum: enum: - - besluit - - zaak - - verzoek + - besluit + - zaak + - verzoek type: string Ondertekening: type: object - description: - Aanduiding van de rechtskracht van een informatieobject. Mag niet + description: Aanduiding van de rechtskracht van een informatieobject. Mag niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' of 'ter vaststelling' heeft. properties: soort: allOf: - - $ref: '#/components/schemas/SoortEnum' + - $ref: '#/components/schemas/SoortEnum' title: Ondertekeningsoort - description: - 'Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT - + description: |- + Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT Uitleg bij mogelijke waarden: - * `analoog` - Analoog - * `digitaal` - Digitaal - - * `pki` - PKI' + * `pki` - PKI datum: type: string format: date title: Ondertekeningdatum - description: - De datum waarop de ondertekening van het INFORMATIEOBJECT heeft + description: De datum waarop de ondertekening van het INFORMATIEOBJECT heeft plaatsgevonden. required: - - datum - - soort + - datum + - soort nullable: true OndertekeningRequest: type: object - description: - Aanduiding van de rechtskracht van een informatieobject. Mag niet + description: Aanduiding van de rechtskracht van een informatieobject. Mag niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' of 'ter vaststelling' heeft. properties: soort: allOf: - - $ref: '#/components/schemas/SoortEnum' + - $ref: '#/components/schemas/SoortEnum' title: Ondertekeningsoort - description: - 'Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT - + description: |- + Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT Uitleg bij mogelijke waarden: - * `analoog` - Analoog - * `digitaal` - Digitaal - - * `pki` - PKI' + * `pki` - PKI datum: type: string format: date title: Ondertekeningdatum - description: - De datum waarop de ondertekening van het INFORMATIEOBJECT heeft + description: De datum waarop de ondertekening van het INFORMATIEOBJECT heeft plaatsgevonden. required: - - datum - - soort + - datum + - soort nullable: true PaginatedEnkelvoudigInformatieObjectList: type: object @@ -7565,26 +6720,22 @@ components: $ref: '#/components/schemas/Verzending' PatchedEnkelvoudigInformatieObjectWithLockRequest: type: object - description: - 'This serializer class is used by EnkelvoudigInformatieObjectViewSet - for - - update and partial_update operations' + description: |- + This serializer class is used by EnkelvoudigInformatieObjectViewSet for + update and partial_update operations properties: identificatie: type: string - description: - Een binnen een gegeven context ondubbelzinnige referentie naar + description: Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string minLength: 1 - description: - "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ - \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ - \ eerste in een samenwerkingsketen heeft vastgelegd." + description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste + in een samenwerkingsketen heeft vastgelegd. title: bronorganisatie maxLength: 9 creatiedatum: @@ -7599,71 +6750,47 @@ components: title: titel maxLength: 200 vertrouwelijkheidaanduiding: - description: - 'Aanduiding van de mate waarin het INFORMATIEOBJECT voor de - openbaarheid bestemd is. - + description: |- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is. Uitleg bij mogelijke waarden: - * `openbaar` - Openbaar - * `beperkt_openbaar` - Beperkt openbaar - * `intern` - Intern - * `zaakvertrouwelijk` - Zaakvertrouwelijk - * `vertrouwelijk` - Vertrouwelijk - * `confidentieel` - Confidentieel - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' + * `zeer_geheim` - Zeer geheim title: vertrouwelijkheidaanduiding oneOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' auteur: type: string minLength: 1 - description: - "De persoon of organisatie die in de eerste plaats verantwoordelijk\ - \ is voor het cre\xEBren van de inhoud van het INFORMATIEOBJECT." + description: De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. title: auteur maxLength: 200 status: - description: - "Aanduiding van de stand van zaken van een INFORMATIEOBJECT. - De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als - het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van - de Status in 'gearchiveerd' impliceert dat het informatieobject een - duurzaam, niet-wijzigbaar Formaat dient te hebben. - + description: |- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. Uitleg bij mogelijke waarden: - * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar - moet nog vastgesteld worden. - - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand - vastgesteld dan wel ontvangen. - - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar - gemaakt; een gearchiveerd informatie-element." + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element. title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' formaat: type: string - description: - 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + description: 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml' title: formaat @@ -7671,22 +6798,20 @@ components: taal: type: string minLength: 3 - description: - 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 bestandsnaam: type: string - description: - De naam van het fysieke bestand waarin de inhoud van het informatieobject + description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 inhoud: type: string format: byte - description: "Binaire inhoud, in base64 ge\xEBncodeerd." + description: Binaire inhoud, in base64 geëncodeerd. nullable: true title: inhoud bestandsomvang: @@ -7700,8 +6825,7 @@ components: link: type: string format: uri - description: - De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 @@ -7714,8 +6838,7 @@ components: type: string format: date nullable: true - description: - "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te\ \ registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende\ \ organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden\ @@ -7727,8 +6850,7 @@ components: type: string format: date nullable: true - description: - "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op\ \ het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als\ \ uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk\ @@ -7740,8 +6862,7 @@ components: indicatieGebruiksrecht: type: boolean nullable: true - description: - Indicatie of er beperkingen gelden aangaande het gebruik van + description: Indicatie of er beperkingen gelden aangaande het gebruik van het informatieobject anders dan raadpleging. Dit veld mag `null` zijn om aan te geven dat de indicatie nog niet bekend is. Als de indicatie gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen @@ -7749,31 +6870,28 @@ components: title: indicatie gebruiksrecht verschijningsvorm: type: string - description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT." + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. title: verschijningsvorm ondertekening: allOf: - - $ref: '#/components/schemas/OndertekeningRequest' + - $ref: '#/components/schemas/OndertekeningRequest' nullable: true - description: - Aanduiding van de rechtskracht van een informatieobject. Mag + description: Aanduiding van de rechtskracht van een informatieobject. Mag niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' of 'ter vaststelling' heeft. title: ondertekening integriteit: allOf: - - $ref: '#/components/schemas/IntegriteitRequest' + - $ref: '#/components/schemas/IntegriteitRequest' nullable: true - description: - Uitdrukking van mate van volledigheid en onbeschadigd zijn + description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri minLength: 1 - description: - URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 @@ -7790,8 +6908,7 @@ components: type: string writeOnly: true minLength: 1 - description: - Tijdens het updaten van een document (PATCH, PUT) moet het + description: Tijdens het updaten van een document (PATCH, PUT) moet het `lock` veld opgegeven worden. Bij het aanmaken (POST) mag het geen waarde hebben. title: lock @@ -7806,8 +6923,7 @@ components: startdatum: type: string format: date-time - description: - Begindatum van de periode waarin de gebruiksrechtvoorwaarden + description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject de startdatum. title: startdatum @@ -7816,44 +6932,39 @@ components: format: date-time nullable: true title: Startdatum - description: - Einddatum van de periode waarin de gebruiksrechtvoorwaarden + description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. omschrijvingVoorwaarden: type: string minLength: 1 - description: - Omschrijving van de van toepassing zijnde voorwaarden aan het + description: Omschrijving van de van toepassing zijnde voorwaarden aan het gebruik anders dan raadpleging title: omschrijving voorwaarden PatchedVerzendingRequest: type: object - description: 'Set gegevensgroepdata from validated nested data. + description: |- + Set gegevensgroepdata from validated nested data. - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + Usage: include the mixin on the ModelSerializer that has gegevensgroepen. properties: betrokkene: type: string format: uri minLength: 1 - description: - URL-referentie naar de betrokkene waarvan het informatieobject + description: URL-referentie naar de betrokkene waarvan het informatieobject is ontvangen of waaraan dit is verzonden. title: betrokkene maxLength: 200 informatieobject: type: string format: uri - description: - URL-referentie naar het informatieobject dat is ontvangen of + description: URL-referentie naar het informatieobject dat is ontvangen of verzonden. title: informatieobject aardRelatie: allOf: - - $ref: '#/components/schemas/AardRelatieEnum' - description: - Omschrijving van de aard van de relatie van de BETROKKENE tot + - $ref: '#/components/schemas/AardRelatieEnum' + description: Omschrijving van de aard van de relatie van de BETROKKENE tot het INFORMATIEOBJECT. title: aard relatie toelichting: @@ -7865,8 +6976,7 @@ components: type: string format: date nullable: true - description: - De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht + description: De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden aan documenten die van of naar andere personen ontvangen of verzonden @@ -7879,8 +6989,7 @@ components: type: string format: date nullable: true - description: - De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze + description: De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is voorbehouden aan @@ -7895,43 +7004,38 @@ components: format: uri minLength: 1 title: Contactpersoon - description: - URL-referentie naar de persoon die als aanspreekpunt fungeert + description: URL-referentie naar de persoon die als aanspreekpunt fungeert voor de BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. maxLength: 1000 contactpersoonnaam: type: string - description: - De opgemaakte naam van de persoon die als aanspreekpunt fungeert + description: De opgemaakte naam van de persoon die als aanspreekpunt fungeert voorde BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. title: contactpersoonnaam maxLength: 40 binnenlandsCorrespondentieadres: allOf: - - $ref: '#/components/schemas/BinnenlandsCorrespondentieadresVerzendingRequest' + - $ref: '#/components/schemas/BinnenlandsCorrespondentieadresVerzendingRequest' nullable: true - description: - Het correspondentieadres, betreffende een adresseerbaar object, + description: Het correspondentieadres, betreffende een adresseerbaar object, van de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van het reguliere binnenlandse correspondentieadres van BETROKKENE. title: binnenlandsCorrespondentieadres buitenlandsCorrespondentieadres: allOf: - - $ref: '#/components/schemas/BuitenlandsCorrespondentieadresVerzendingRequest' + - $ref: '#/components/schemas/BuitenlandsCorrespondentieadresVerzendingRequest' nullable: true - description: - De gegevens van het adres in het buitenland van BETROKKENE, + description: De gegevens van het adres in het buitenland van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. title: buitenlandsCorrespondentieadres correspondentiePostadres: allOf: - - $ref: '#/components/schemas/BuitenlandsCorrespondentiepostadresVerzendingRequest' + - $ref: '#/components/schemas/BuitenlandsCorrespondentiepostadresVerzendingRequest' nullable: true - description: - De gegevens die tezamen een postbusadres of antwoordnummeradres + description: De gegevens die tezamen een postbusadres of antwoordnummeradres vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. @@ -7950,8 +7054,7 @@ components: maxLength: 100 mijnOverheid: type: boolean - description: - is het informatieobject verzonden via mijnOverheid naar de + description: is het informatieobject verzonden via mijnOverheid naar de ontvanger. title: mijn overheid telefoonnummer: @@ -7962,8 +7065,8 @@ components: maxLength: 15 PostadresTypeEnum: enum: - - antwoordnummer - - postbusnummer + - antwoordnummer + - postbusnummer type: string SchemaBestandsDeel: type: object @@ -7973,8 +7076,7 @@ components: format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 @@ -7991,8 +7093,7 @@ components: voltooid: type: boolean readOnly: true - description: - 'Indicatie of dit bestandsdeel volledig is geupload. Dat wil + description: 'Indicatie of dit bestandsdeel volledig is geupload. Dat wil zeggen: het aantal bytes dat staat genoemd bij grootte is daadwerkelijk ontvangen.' title: voltooid @@ -8001,11 +7102,11 @@ components: description: Hash string, which represents id of the lock of related informatieobject title: lock required: - - lock - - omvang - - url - - volgnummer - - voltooid + - lock + - omvang + - url + - volgnummer + - voltooid SchemaEIO: type: object description: Serializer for the EnkelvoudigInformatieObject model @@ -8015,24 +7116,21 @@ components: format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 identificatie: type: string - description: - Een binnen een gegeven context ondubbelzinnige referentie naar + description: Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string - description: - "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ - \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ - \ eerste in een samenwerkingsketen heeft vastgelegd." + description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie + die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste + in een samenwerkingsketen heeft vastgelegd. title: bronorganisatie maxLength: 9 creatiedatum: @@ -8046,78 +7144,53 @@ components: title: titel maxLength: 200 vertrouwelijkheidaanduiding: - description: - 'Aanduiding van de mate waarin het INFORMATIEOBJECT voor de - openbaarheid bestemd is. - + description: |- + Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is. Uitleg bij mogelijke waarden: - * `openbaar` - Openbaar - * `beperkt_openbaar` - Beperkt openbaar - * `intern` - Intern - * `zaakvertrouwelijk` - Zaakvertrouwelijk - * `vertrouwelijk` - Vertrouwelijk - * `confidentieel` - Confidentieel - * `geheim` - Geheim - - * `zeer_geheim` - Zeer geheim' + * `zeer_geheim` - Zeer geheim title: vertrouwelijkheidaanduiding oneOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' auteur: type: string - description: - "De persoon of organisatie die in de eerste plaats verantwoordelijk\ - \ is voor het cre\xEBren van de inhoud van het INFORMATIEOBJECT." + description: De persoon of organisatie die in de eerste plaats verantwoordelijk + is voor het creëren van de inhoud van het INFORMATIEOBJECT. title: auteur maxLength: 200 status: - description: - "Aanduiding van de stand van zaken van een INFORMATIEOBJECT. - De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als - het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van - de Status in 'gearchiveerd' impliceert dat het informatieobject een - duurzaam, niet-wijzigbaar Formaat dient te hebben. - + description: |- + Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. Uitleg bij mogelijke waarden: - * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar - moet nog vastgesteld worden. - - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand - vastgesteld dan wel ontvangen. - - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar - gemaakt; een gearchiveerd informatie-element." + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element. title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' formaat: type: string - description: - 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + description: 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml' title: formaat maxLength: 255 taal: type: string - description: - 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 @@ -8125,22 +7198,19 @@ components: versie: type: integer readOnly: true - description: - Het (automatische) versienummer van het INFORMATIEOBJECT. Deze + description: Het (automatische) versienummer van het INFORMATIEOBJECT. Deze begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. title: versie beginRegistratie: type: string format: date-time readOnly: true - description: - Een datumtijd in ISO8601 formaat waarop deze versie van het + description: Een datumtijd in ISO8601 formaat waarop deze versie van het INFORMATIEOBJECT is aangemaakt of gewijzigd. title: begin registratie bestandsnaam: type: string - description: - De naam van het fysieke bestand waarin de inhoud van het informatieobject + description: De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 @@ -8161,8 +7231,7 @@ components: link: type: string format: uri - description: - De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen + description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 @@ -8175,8 +7244,7 @@ components: type: string format: date nullable: true - description: - "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te\ \ registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende\ \ organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden\ @@ -8188,8 +7256,7 @@ components: type: string format: date nullable: true - description: - "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op\ \ het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als\ \ uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk\ @@ -8201,8 +7268,7 @@ components: indicatieGebruiksrecht: type: boolean nullable: true - description: - Indicatie of er beperkingen gelden aangaande het gebruik van + description: Indicatie of er beperkingen gelden aangaande het gebruik van het informatieobject anders dan raadpleging. Dit veld mag `null` zijn om aan te geven dat de indicatie nog niet bekend is. Als de indicatie gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen @@ -8210,38 +7276,34 @@ components: title: indicatie gebruiksrecht verschijningsvorm: type: string - description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT." + description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. title: verschijningsvorm ondertekening: allOf: - - $ref: '#/components/schemas/Ondertekening' + - $ref: '#/components/schemas/Ondertekening' nullable: true - description: - Aanduiding van de rechtskracht van een informatieobject. Mag + description: Aanduiding van de rechtskracht van een informatieobject. Mag niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' of 'ter vaststelling' heeft. title: ondertekening integriteit: allOf: - - $ref: '#/components/schemas/Integriteit' + - $ref: '#/components/schemas/Integriteit' nullable: true - description: - Uitdrukking van mate van volledigheid en onbeschadigd zijn + description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri - description: - URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi + description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 locked: type: boolean readOnly: true - description: - Geeft aan of het document gelocked is. Alleen als een document + description: Geeft aan of het document gelocked is. Alleen als een document gelocked is, mogen er aanpassingen gemaakt worden. title: locked bestandsdelen: @@ -8259,36 +7321,35 @@ components: description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden required: - - auteur - - beginRegistratie - - bestandsdelen - - bronorganisatie - - creatiedatum - - informatieobjecttype - - locked - - taal - - titel - - url - - versie + - auteur + - beginRegistratie + - bestandsdelen + - bronorganisatie + - creatiedatum + - informatieobjecttype + - locked + - taal + - titel + - url + - versie SoortEnum: enum: - - analoog - - digitaal - - pki + - analoog + - digitaal + - pki type: string StatusEnum: enum: - - in_bewerking - - ter_vaststelling - - definitief - - gearchiveerd + - in_bewerking + - ter_vaststelling + - definitief + - gearchiveerd type: string UnlockEnkelvoudigInformatieObjectRequest: type: object - description: - 'Serializer for the unlock action of EnkelvoudigInformatieObjectCanonical - - model' + description: |- + Serializer for the unlock action of EnkelvoudigInformatieObjectCanonical + model properties: lock: type: string @@ -8321,8 +7382,7 @@ components: title: detail instance: type: string - description: - URI met referentie naar dit specifiek voorkomen van de fout. + description: URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. title: instance invalidParams: @@ -8331,60 +7391,56 @@ components: $ref: '#/components/schemas/FieldValidationError' title: invalidParams required: - - code - - detail - - instance - - invalidParams - - status - - title + - code + - detail + - instance + - invalidParams + - status + - title VertrouwelijkheidaanduidingEnum: enum: - - openbaar - - beperkt_openbaar - - intern - - zaakvertrouwelijk - - vertrouwelijk - - confidentieel - - geheim - - zeer_geheim + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim type: string Verzending: type: object - description: 'Set gegevensgroepdata from validated nested data. + description: |- + Set gegevensgroepdata from validated nested data. - - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + Usage: include the mixin on the ModelSerializer that has gegevensgroepen. properties: url: type: string format: uri readOnly: true title: url - description: - URL-referentie naar dit object. Dit is de unieke identificatie + description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 betrokkene: type: string format: uri - description: - URL-referentie naar de betrokkene waarvan het informatieobject + description: URL-referentie naar de betrokkene waarvan het informatieobject is ontvangen of waaraan dit is verzonden. title: betrokkene maxLength: 200 informatieobject: type: string format: uri - description: - URL-referentie naar het informatieobject dat is ontvangen of + description: URL-referentie naar het informatieobject dat is ontvangen of verzonden. title: informatieobject aardRelatie: allOf: - - $ref: '#/components/schemas/AardRelatieEnum' - description: - Omschrijving van de aard van de relatie van de BETROKKENE tot + - $ref: '#/components/schemas/AardRelatieEnum' + description: Omschrijving van de aard van de relatie van de BETROKKENE tot het INFORMATIEOBJECT. title: aard relatie toelichting: @@ -8396,8 +7452,7 @@ components: type: string format: date nullable: true - description: - De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht + description: De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden aan documenten die van of naar andere personen ontvangen of verzonden @@ -8410,8 +7465,7 @@ components: type: string format: date nullable: true - description: - De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze + description: De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is voorbehouden aan @@ -8425,43 +7479,38 @@ components: type: string format: uri title: Contactpersoon - description: - URL-referentie naar de persoon die als aanspreekpunt fungeert + description: URL-referentie naar de persoon die als aanspreekpunt fungeert voor de BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. maxLength: 1000 contactpersoonnaam: type: string - description: - De opgemaakte naam van de persoon die als aanspreekpunt fungeert + description: De opgemaakte naam van de persoon die als aanspreekpunt fungeert voorde BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. title: contactpersoonnaam maxLength: 40 binnenlandsCorrespondentieadres: allOf: - - $ref: '#/components/schemas/BinnenlandsCorrespondentieadresVerzending' + - $ref: '#/components/schemas/BinnenlandsCorrespondentieadresVerzending' nullable: true - description: - Het correspondentieadres, betreffende een adresseerbaar object, + description: Het correspondentieadres, betreffende een adresseerbaar object, van de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van het reguliere binnenlandse correspondentieadres van BETROKKENE. title: binnenlandsCorrespondentieadres buitenlandsCorrespondentieadres: allOf: - - $ref: '#/components/schemas/BuitenlandsCorrespondentieadresVerzending' + - $ref: '#/components/schemas/BuitenlandsCorrespondentieadresVerzending' nullable: true - description: - De gegevens van het adres in het buitenland van BETROKKENE, + description: De gegevens van het adres in het buitenland van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. title: buitenlandsCorrespondentieadres correspondentiePostadres: allOf: - - $ref: '#/components/schemas/BuitenlandsCorrespondentiepostadresVerzending' + - $ref: '#/components/schemas/BuitenlandsCorrespondentiepostadresVerzending' nullable: true - description: - De gegevens die tezamen een postbusadres of antwoordnummeradres + description: De gegevens die tezamen een postbusadres of antwoordnummeradres vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. @@ -8480,8 +7529,7 @@ components: maxLength: 100 mijnOverheid: type: boolean - description: - is het informatieobject verzonden via mijnOverheid naar de + description: is het informatieobject verzonden via mijnOverheid naar de ontvanger. title: mijn overheid telefoonnummer: @@ -8491,39 +7539,36 @@ components: title: telefoonnummer maxLength: 15 required: - - aardRelatie - - betrokkene - - contactPersoon - - informatieobject - - url + - aardRelatie + - betrokkene + - contactPersoon + - informatieobject + - url VerzendingRequest: type: object - description: 'Set gegevensgroepdata from validated nested data. - + description: |- + Set gegevensgroepdata from validated nested data. - Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' + Usage: include the mixin on the ModelSerializer that has gegevensgroepen. properties: betrokkene: type: string format: uri minLength: 1 - description: - URL-referentie naar de betrokkene waarvan het informatieobject + description: URL-referentie naar de betrokkene waarvan het informatieobject is ontvangen of waaraan dit is verzonden. title: betrokkene maxLength: 200 informatieobject: type: string format: uri - description: - URL-referentie naar het informatieobject dat is ontvangen of + description: URL-referentie naar het informatieobject dat is ontvangen of verzonden. title: informatieobject aardRelatie: allOf: - - $ref: '#/components/schemas/AardRelatieEnum' - description: - Omschrijving van de aard van de relatie van de BETROKKENE tot + - $ref: '#/components/schemas/AardRelatieEnum' + description: Omschrijving van de aard van de relatie van de BETROKKENE tot het INFORMATIEOBJECT. title: aard relatie toelichting: @@ -8535,8 +7580,7 @@ components: type: string format: date nullable: true - description: - De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht + description: De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden aan documenten die van of naar andere personen ontvangen of verzonden @@ -8549,8 +7593,7 @@ components: type: string format: date nullable: true - description: - De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze + description: De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is voorbehouden aan @@ -8565,43 +7608,38 @@ components: format: uri minLength: 1 title: Contactpersoon - description: - URL-referentie naar de persoon die als aanspreekpunt fungeert + description: URL-referentie naar de persoon die als aanspreekpunt fungeert voor de BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. maxLength: 1000 contactpersoonnaam: type: string - description: - De opgemaakte naam van de persoon die als aanspreekpunt fungeert + description: De opgemaakte naam van de persoon die als aanspreekpunt fungeert voorde BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. title: contactpersoonnaam maxLength: 40 binnenlandsCorrespondentieadres: allOf: - - $ref: '#/components/schemas/BinnenlandsCorrespondentieadresVerzendingRequest' + - $ref: '#/components/schemas/BinnenlandsCorrespondentieadresVerzendingRequest' nullable: true - description: - Het correspondentieadres, betreffende een adresseerbaar object, + description: Het correspondentieadres, betreffende een adresseerbaar object, van de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van het reguliere binnenlandse correspondentieadres van BETROKKENE. title: binnenlandsCorrespondentieadres buitenlandsCorrespondentieadres: allOf: - - $ref: '#/components/schemas/BuitenlandsCorrespondentieadresVerzendingRequest' + - $ref: '#/components/schemas/BuitenlandsCorrespondentieadresVerzendingRequest' nullable: true - description: - De gegevens van het adres in het buitenland van BETROKKENE, + description: De gegevens van het adres in het buitenland van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. title: buitenlandsCorrespondentieadres correspondentiePostadres: allOf: - - $ref: '#/components/schemas/BuitenlandsCorrespondentiepostadresVerzendingRequest' + - $ref: '#/components/schemas/BuitenlandsCorrespondentiepostadresVerzendingRequest' nullable: true - description: - De gegevens die tezamen een postbusadres of antwoordnummeradres + description: De gegevens die tezamen een postbusadres of antwoordnummeradres vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. @@ -8620,8 +7658,7 @@ components: maxLength: 100 mijnOverheid: type: boolean - description: - is het informatieobject verzonden via mijnOverheid naar de + description: is het informatieobject verzonden via mijnOverheid naar de ontvanger. title: mijn overheid telefoonnummer: @@ -8631,18 +7668,17 @@ components: title: telefoonnummer maxLength: 15 required: - - aardRelatie - - betrokkene - - contactPersoon - - informatieobject + - aardRelatie + - betrokkene + - contactPersoon + - informatieobject Wijzigingen: type: object properties: oud: type: object additionalProperties: {} - description: - Volledige JSON body van het object zoals dat bestond voordat + description: Volledige JSON body van het object zoals dat bestond voordat de actie heeft plaatsgevonden. title: oud nieuw: @@ -8656,17 +7692,16 @@ components: bearerFormat: JWT scheme: bearer servers: - - url: https://documenten-api.vng.cloud/api/v1 - description: Productie Omgeving +- url: https://documenten-api.vng.cloud/api/v1 + description: Productie Omgeving tags: - - name: enkelvoudiginformatieobjecten - description: Opvragen en bewerken van (ENKELVOUDIG) INFORMATIEOBJECTen (documenten). - - name: gebruiksrechten - description: Opvragen en bewerken van GEBRUIKSRECHTen bij een INFORMATIEOBJECT. - - name: objectinformatieobjecten - description: - Opvragen en verwijderen van OBJECT-INFORMATIEOBJECT relaties. Het betreft - een relatie tussen een willekeurig OBJECT, bijvoorbeeld een ZAAK in de Zaken API, - en een INFORMATIEOBJECT. - - name: verzendingen - description: Opvragen en bewerken van VERZENDINGen. +- name: enkelvoudiginformatieobjecten + description: Opvragen en bewerken van (ENKELVOUDIG) INFORMATIEOBJECTen (documenten). +- name: gebruiksrechten + description: Opvragen en bewerken van GEBRUIKSRECHTen bij een INFORMATIEOBJECT. +- name: objectinformatieobjecten + description: Opvragen en verwijderen van OBJECT-INFORMATIEOBJECT relaties. Het betreft + een relatie tussen een willekeurig OBJECT, bijvoorbeeld een ZAAK in de Zaken API, + en een INFORMATIEOBJECT. +- name: verzendingen + description: Opvragen en bewerken van VERZENDINGen. From b7b8a9bc597a4ed8e984fae1b58082ee110329aa Mon Sep 17 00:00:00 2001 From: Michiel Verhoef <34736717+michielverhoef@users.noreply.github.com> Date: Thu, 14 Sep 2023 10:44:45 +0200 Subject: [PATCH 3/7] Update README.rst https://github.com/VNG-Realisatie/gemma-zaken/issues/2301 versienummers concreet gemaakt (ipv 1.2.x etc.) --- README.rst | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.rst b/README.rst index ece4cc7d..db60b9dd 100644 --- a/README.rst +++ b/README.rst @@ -28,16 +28,16 @@ master n.v.t. `ReDoc `_ 1.4.0 2023-08-22 `ReDoc `_, `Scopes `_ `Berichtkenmerken `_ `Swagger `_ -1.3.x 2023-03-29 `ReDoc `_, `Scopes `_ `Berichtkenmerken `_ +1.3.0 2023-03-29 `ReDoc `_, `Scopes `_ `Berichtkenmerken `_ `Swagger `_ (`verschillen `_) -1.2.x 2022-12-19 `ReDoc `_, `Scopes `_ `Berichtkenmerken `_ +1.2.0 2022-12-19 `ReDoc `_, `Scopes `_ `Berichtkenmerken `_ `Swagger `_ (`verschillen `_) -1.1.x 2022-06-30 `ReDoc `_, `Scopes `_ `Berichtkenmerken `_ +1.1.0 2022-06-30 `ReDoc `_, `Scopes `_ `Berichtkenmerken `_ `Swagger `_ (`verschillen `_) -1.0.x n.v.t. `ReDoc `_, `Scopes `_ `Berichtkenmerken `_ +1.0.0 n.v.t. `ReDoc `_, `Scopes `_ `Berichtkenmerken `_ `Swagger `_ (`verschillen `_) 1.0.1 2019-12-16 `ReDoc `_, `Scopes `_ `Berichtkenmerken `_ From 3808104197a51febad67c0a1c063f7d9c6dadb51 Mon Sep 17 00:00:00 2001 From: MatthijsBekendam <47739550+MatthijsBekendam@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:03:24 +0200 Subject: [PATCH 4/7] Feature/expand to zoek (#230) * feature : exclusions to zoek and bugfix to exclusions * update : openapi --- src/drc/api/exclusions.py | 5 +- .../enkelvoudig_informatieobject.py | 8 + .../tests/test_enkelvoudiginformatieobject.py | 13 + .../api/views/enkelvoudig_informatieobject.py | 9 +- src/openapi.yaml | 4976 ++++++++++------- 5 files changed, 2870 insertions(+), 2141 deletions(-) diff --git a/src/drc/api/exclusions.py b/src/drc/api/exclusions.py index 11234cf1..f5b7373a 100644 --- a/src/drc/api/exclusions.py +++ b/src/drc/api/exclusions.py @@ -185,6 +185,7 @@ def build_expand_schema( ): """Build the expand schema for the response. First, the fields to expand are split on the "." character. Then, the first part of the split is used to get the urls from the result. The urls are then used to get the corresponding data from the external api or from the local database. The data is then gathered/collected inside a list consisted of namedtuples. When all data is collected, it calls the _build_json method which builds the json response.""" expansion = {"_expand": {}} + self.expanded_fields_all = [] for exp_field in fields_to_expand: loop_id = str(uuid.uuid4()) @@ -509,9 +510,11 @@ def remove_key(self, data, target_key): def inclusions(self, response): expand_filter = self.request.query_params.get("expand", "") + if self.action == "_zoek": + expand_filter = self.get_search_input().get("expand", "") if expand_filter: fields_to_expand = expand_filter.split(",") - if self.action == "list": + if self.action == "list" or self.action == "_zoek": for response_data in ( response.data if isinstance(response.data, list) diff --git a/src/drc/api/serializers/enkelvoudig_informatieobject.py b/src/drc/api/serializers/enkelvoudig_informatieobject.py index cf18b6d6..4d17de29 100644 --- a/src/drc/api/serializers/enkelvoudig_informatieobject.py +++ b/src/drc/api/serializers/enkelvoudig_informatieobject.py @@ -500,6 +500,14 @@ class EIOZoekSerializer(serializers.Serializer): child=serializers.UUIDField(), help_text=_("Array of unieke resource identifiers (UUID4)"), ) + expand = serializers.CharField( + help_text=_( + "Examples: \n" + "`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype`\n" + "Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt.", + ), + required=False, + ) class SchemaEIOSerializer(EnkelvoudigInformatieObjectSerializer): diff --git a/src/drc/api/tests/test_enkelvoudiginformatieobject.py b/src/drc/api/tests/test_enkelvoudiginformatieobject.py index c8debc32..c6cecf2c 100644 --- a/src/drc/api/tests/test_enkelvoudiginformatieobject.py +++ b/src/drc/api/tests/test_enkelvoudiginformatieobject.py @@ -696,6 +696,19 @@ def test_zoek_uuid_in(self): self.assertEqual(data[0]["url"], f"http://testserver{reverse(eio1)}") self.assertEqual(data[1]["url"], f"http://testserver{reverse(eio2)}") + def test_zoek_expand(self): + eio1, eio2, eio3 = EnkelvoudigInformatieObjectFactory.create_batch(3) + url = get_operation_url("enkelvoudiginformatieobject__zoek") + data = {"uuid__in": [eio1.uuid, eio2.uuid], "expand": "url"} + response = self.client.post(url, data) + + self.assertEqual(response.status_code, status.HTTP_200_OK) + + data = response.json()["results"] + data = sorted(data, key=lambda eio: eio["identificatie"]) + self.assertEqual(len(data), 2) + self.assertTrue(bool(data[0]["_expand"])) + def test_zoek_without_params(self): url = get_operation_url("enkelvoudiginformatieobject__zoek") response = self.client.post(url, {}) diff --git a/src/drc/api/views/enkelvoudig_informatieobject.py b/src/drc/api/views/enkelvoudig_informatieobject.py index 7f4d785a..8da96a10 100644 --- a/src/drc/api/views/enkelvoudig_informatieobject.py +++ b/src/drc/api/views/enkelvoudig_informatieobject.py @@ -1,4 +1,4 @@ -from django.db import transaction +from django.db import models, transaction from django.utils.translation import gettext as _ from drf_spectacular.types import OpenApiTypes @@ -214,12 +214,18 @@ def _zoek(self, request, *args, **kwargs): search_input = self.get_search_input() queryset = self.filter_queryset(self.get_queryset()) for name, value in search_input.items(): + if name == "expand": + continue queryset = queryset.filter(**{name: value}) return self.get_search_output(queryset) _zoek.is_search_action = True + def get_search_output(self, queryset: models.QuerySet): + response = super().get_search_output(queryset) + return self.inclusions(response) + @transaction.atomic def perform_destroy(self, instance): if instance.canonical.objectinformatieobject_set.exists(): @@ -270,6 +276,7 @@ def retrieve(self, request, *args, **kwargs): ) def create(self, request, *args, **kwargs): return super().create(request, *args, **kwargs) + @extend_schema( # see https://swagger.io/docs/specification/2-0/describing-responses/ and # https://swagger.io/docs/specification/2-0/mime-types/ diff --git a/src/openapi.yaml b/src/openapi.yaml index 86df0ce7..420c2ed7 100644 --- a/src/openapi.yaml +++ b/src/openapi.yaml @@ -2,91 +2,47 @@ openapi: 3.0.3 info: title: Documenten API version: 1.4.1 - description: | - Een API om een documentregistratiecomponent (DRC) te benaderen. - - In een documentregistratiecomponent worden INFORMATIEOBJECTen opgeslagen. Een - INFORMATIEOBJECT is een digitaal document voorzien van meta-gegevens. - INFORMATIEOBJECTen kunnen aan andere objecten zoals zaken en besluiten worden - gerelateerd (maar dat hoeft niet) en kunnen gebruiksrechten hebben. - - GEBRUIKSRECHTEN leggen voorwaarden op aan het gebruik van het INFORMATIEOBJECT - (buiten raadpleging). Deze GEBRUIKSRECHTEN worden niet door de API gevalideerd - of gehandhaafd. - - De typering van INFORMATIEOBJECTen is in de Catalogi API (ZTC) ondergebracht in - de vorm van INFORMATIEOBJECTTYPEn. - - **Uploaden van bestanden** - - Binnen deze API bestaan een aantal endpoints die binaire data ontvangen, al - dan niet base64-encoded. Webservers moeten op deze endpoints een minimale - request body size van 4.0 GiB ondersteunen. Dit omvat de JSON van de - metadata EN de base64-encoded bestandsdata. Hou hierbij rekening met de - overhead van base64, die ongeveer 33% bedraagt in worst-case scenario's. Dit - betekent dat bij een limiet van 4GB het bestand maximaal ongeveer 3GB groot - mag zijn. - - _Nieuw in 1.1.0_ - - Bestanden kunnen groter zijn dan de minimale die door providers - ondersteund moet worden. De consumer moet dan: - - 1. Het INFORMATIEOBJECT aanmaken in de API, waarbij de totale bestandsgrootte - meegestuurd wordt en de inhoud leeggelaten wordt. - De API antwoordt met een lijst van BESTANDSDEELen, elk met een volgnummer - en bestandsgrootte. De API lockt tegelijkertijd het INFORMATIEOBJECT. - 2. Het bestand opsplitsen: ieder BESTANDSDEEL moet de bestandsgrootte hebben - zoals dit aangegeven werd in de response bij 1. - 3. Voor elk stuk van het bestand de binaire data naar de overeenkomstige - BESTANDSDEEL-url gestuurd worden, samen met het lock ID. - 4. Het INFORMATIEOBJECT unlocken. De provider valideert op dat moment dat alle - bestandsdelen correct opgestuurd werden, en voegt deze samen tot het - resulterende bestand. - - Het bijwerken van een INFORMATIEOBJECT heeft een gelijkaardig verloop. - - De 1.0.x manier van uploaden is ook beschikbaar voor kleine(re) bestanden die - niet gesplitst hoeven te worden. - - **Afhankelijkheden** - - Deze API is afhankelijk van: - - * Catalogi API - * Notificaties API - * Autorisaties API *(optioneel)* - * Zaken API *(optioneel)* - - **Autorisatie** - - Deze API vereist autorisatie. Je kan de - [token-tool](https://zaken-auth.vng.cloud/) gebruiken om JWT-tokens te - genereren. - - ### Notificaties - - Deze API publiceert notificaties op het kanaal `documenten`. - - **Main resource** - - `enkelvoudiginformatieobject` - - - - **Kenmerken** - - * `bronorganisatie`: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste in een samenwerkingsketen heeft vastgelegd. - * `informatieobjecttype`: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). - * `vertrouwelijkheidaanduiding`: Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is. - - **Resources en acties** - - - **Handige links** - - * [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard) - * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken) + description: + "Een API om een documentregistratiecomponent (DRC) te benaderen.\n\n\ + In een documentregistratiecomponent worden INFORMATIEOBJECTen opgeslagen. Een\n\ + INFORMATIEOBJECT is een digitaal document voorzien van meta-gegevens.\nINFORMATIEOBJECTen\ + \ kunnen aan andere objecten zoals zaken en besluiten worden\ngerelateerd (maar\ + \ dat hoeft niet) en kunnen gebruiksrechten hebben.\n\nGEBRUIKSRECHTEN leggen\ + \ voorwaarden op aan het gebruik van het INFORMATIEOBJECT\n(buiten raadpleging).\ + \ Deze GEBRUIKSRECHTEN worden niet door de API gevalideerd\nof gehandhaafd.\n\n\ + De typering van INFORMATIEOBJECTen is in de Catalogi API (ZTC) ondergebracht in\n\ + de vorm van INFORMATIEOBJECTTYPEn.\n\n**Uploaden van bestanden**\n\nBinnen deze\ + \ API bestaan een aantal endpoints die binaire data ontvangen, al\ndan niet base64-encoded.\ + \ Webservers moeten op deze endpoints een minimale\nrequest body size van 4.0\ + \ GiB ondersteunen. Dit omvat de JSON van de\nmetadata EN de base64-encoded bestandsdata.\ + \ Hou hierbij rekening met de\noverhead van base64, die ongeveer 33% bedraagt\ + \ in worst-case scenario's. Dit\nbetekent dat bij een limiet van 4GB het bestand\ + \ maximaal ongeveer 3GB groot\nmag zijn.\n\n_Nieuw in 1.1.0_\n\nBestanden kunnen\ + \ groter zijn dan de minimale die door providers\nondersteund moet worden. De\ + \ consumer moet dan:\n\n1. Het INFORMATIEOBJECT aanmaken in de API, waarbij de\ + \ totale bestandsgrootte\n meegestuurd wordt en de inhoud leeggelaten wordt.\n\ + \ De API antwoordt met een lijst van BESTANDSDEELen, elk met een volgnummer\n\ + \ en bestandsgrootte. De API lockt tegelijkertijd het INFORMATIEOBJECT.\n2.\ + \ Het bestand opsplitsen: ieder BESTANDSDEEL moet de bestandsgrootte hebben\n\ + \ zoals dit aangegeven werd in de response bij 1.\n3. Voor elk stuk van het\ + \ bestand de binaire data naar de overeenkomstige\n BESTANDSDEEL-url gestuurd\ + \ worden, samen met het lock ID.\n4. Het INFORMATIEOBJECT unlocken. De provider\ + \ valideert op dat moment dat alle\n bestandsdelen correct opgestuurd werden,\ + \ en voegt deze samen tot het\n resulterende bestand.\n\nHet bijwerken van een\ + \ INFORMATIEOBJECT heeft een gelijkaardig verloop.\n\nDe 1.0.x manier van uploaden\ + \ is ook beschikbaar voor kleine(re) bestanden die\nniet gesplitst hoeven te worden.\n\ + \n**Afhankelijkheden**\n\nDeze API is afhankelijk van:\n\n* Catalogi API\n* Notificaties\ + \ API\n* Autorisaties API *(optioneel)*\n* Zaken API *(optioneel)*\n\n**Autorisatie**\n\ + \nDeze API vereist autorisatie. Je kan de\n[token-tool](https://zaken-auth.vng.cloud/)\ + \ gebruiken om JWT-tokens te\ngenereren.\n\n### Notificaties\n\nDeze API publiceert\ + \ notificaties op het kanaal `documenten`.\n\n**Main resource**\n\n`enkelvoudiginformatieobject`\n\ + \n\n\n**Kenmerken**\n\n* `bronorganisatie`: Het RSIN van de Niet-natuurlijk persoon\ + \ zijnde de organisatie die het informatieobject heeft gecre\xEBerd of heeft ontvangen\ + \ en als eerste in een samenwerkingsketen heeft vastgelegd.\n* `informatieobjecttype`:\ + \ URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API).\n* `vertrouwelijkheidaanduiding`:\ + \ Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd\ + \ is.\n\n**Resources en acties**\n\n\n**Handige links**\n\n* [Documentatie](https://vng-realisatie.github.io/gemma-zaken/standaard)\n\ + * [Zaakgericht werken](https://vng-realisatie.github.io/gemma-zaken)\n" contact: email: standaarden.ondersteuning@vng.nl url: https://vng-realisatie.github.io/gemma-zaken @@ -100,25 +56,25 @@ paths: description: based on DRF mixin but without partial_update summary: Upload een bestandsdeel. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/x-www-form-urlencoded - - multipart/form-data - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/x-www-form-urlencoded + - multipart/form-data + description: Content type van de verzoekinhoud. + required: true tags: - - bestandsdelen + - bestandsdelen requestBody: content: multipart/form-data: @@ -129,15 +85,16 @@ paths: $ref: '#/components/schemas/BestandsDeelRequest' required: true security: - - JWT-Claims: - - documenten.bijwerken + - JWT-Claims: + - documenten.bijwerken responses: '200': headers: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -149,10 +106,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -161,10 +119,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -173,10 +132,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -185,10 +145,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -197,10 +158,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -209,10 +171,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -221,10 +184,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -233,10 +197,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -245,10 +210,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -257,71 +223,77 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /enkelvoudiginformatieobjecten: get: operationId: enkelvoudiginformatieobject_list - description: "Deze lijst kan gefilterd wordt met query-string parameters. \n\ + description: + "Deze lijst kan gefilterd wordt met query-string parameters. \n\ De objecten bevatten metadata over de documenten en de downloadlink (`inhoud`)\ \ naar de binary data. Alleen de laatste versie van elk(ENKELVOUDIG) INFORMATIEOBJECT\ \ wordt getoond. Specifieke versies kunnen alleen" summary: Alle (ENKELVOUDIGe) INFORMATIEOBJECTen opvragen. parameters: - - name: identificatie - required: false - in: query - description: Een binnen een gegeven context ondubbelzinnige referentie naar - het INFORMATIEOBJECT. - schema: - type: string - - name: bronorganisatie - required: false - in: query - description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste - in een samenwerkingsketen heeft vastgelegd. - schema: - type: string - - name: trefwoorden - required: false - in: query - description: Een lijst van trefwoorden gescheiden door comma's. - schema: - type: string - - name: expand - required: false - in: query - description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,\ - \ hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources\ - \ direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze\ - \ scheiden met een komma. Voor het ophalen van resources die een laag dieper\ - \ genest zijn wordt de punt-notatie gebruikt." - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer + - name: identificatie + required: false + in: query + description: + Een binnen een gegeven context ondubbelzinnige referentie naar + het INFORMATIEOBJECT. + schema: + type: string + - name: bronorganisatie + required: false + in: query + description: + "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ + \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ + \ eerste in een samenwerkingsketen heeft vastgelegd." + schema: + type: string + - name: trefwoorden + required: false + in: query + description: Een lijst van trefwoorden gescheiden door comma's. + schema: + type: string + - name: expand + required: false + in: query + description: + "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,\ + \ hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources\ + \ direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze\ + \ scheiden met een komma. Voor het ophalen van resources die een laag dieper\ + \ genest zijn wordt de punt-notatie gebruikt." + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten security: - - JWT-Claims: - - documenten.lezen + - JWT-Claims: + - documenten.lezen responses: '200': headers: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -333,10 +305,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -345,10 +318,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -357,10 +331,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -369,10 +344,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -381,10 +357,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -393,10 +370,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -405,10 +383,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -417,10 +396,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -429,41 +409,43 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: enkelvoudiginformatieobject_create - description: "**Er wordt gevalideerd op** \n - geldigheid `informatieobjecttype`\ + description: + "**Er wordt gevalideerd op** \n - geldigheid `informatieobjecttype`\ \ URL - de resource moet opgevraagd kunnen worden uit de catalogi API en de\ \ vorm van een INFORMATIEOBJECTTYPE hebben. \n- publicatie `informatieobjecttype`\ \ - `concept` moet `false` zijn" summary: Maak een (ENKELVOUDIG) INFORMATIEOBJECT aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten requestBody: content: application/json: @@ -471,8 +453,8 @@ paths: $ref: '#/components/schemas/EnkelvoudigInformatieObjectCreateLockRequest' required: true security: - - JWT-Claims: - - documenten.aanmaken + - JWT-Claims: + - documenten.aanmaken responses: '201': headers: @@ -484,7 +466,8 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -496,10 +479,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -508,10 +492,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -520,10 +505,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -532,10 +518,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -544,10 +531,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -556,10 +544,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -568,10 +557,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -580,10 +570,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -592,10 +583,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -605,24 +597,25 @@ paths: description: Alle audit trail regels behorend bij het INFORMATIEOBJECT. summary: Alle audit trail regels behorend bij het INFORMATIEOBJECT. parameters: - - in: path - name: enkelvoudiginformatieobject_uuid - schema: - type: string - description: Unieke resource identifier (UUID4) - required: true + - in: path + name: enkelvoudiginformatieobject_uuid + schema: + type: string + description: Unieke resource identifier (UUID4) + required: true tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten security: - - JWT-Claims: - - audittrails.lezen + - JWT-Claims: + - audittrails.lezen responses: '200': headers: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -636,10 +629,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -648,10 +642,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -660,10 +655,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -672,10 +668,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -684,10 +681,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -696,10 +694,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -708,10 +707,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -720,10 +720,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -733,32 +734,33 @@ paths: description: Een specifieke audit trail regel opvragen. summary: Een specifieke audit trail regel opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke identificatie van de audit regel. - title: uuid - required: true - - in: path - name: enkelvoudiginformatieobject_uuid - schema: - type: string - description: Unieke resource identifier (UUID4) - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke identificatie van de audit regel. + title: uuid + required: true + - in: path + name: enkelvoudiginformatieobject_uuid + schema: + type: string + description: Unieke resource identifier (UUID4) + required: true tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten security: - - JWT-Claims: - - audittrails.lezen + - JWT-Claims: + - audittrails.lezen responses: '200': headers: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -770,10 +772,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -782,10 +785,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -794,10 +798,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -806,10 +811,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -818,10 +824,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -830,10 +837,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -842,10 +850,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -854,10 +863,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -866,99 +876,107 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /enkelvoudiginformatieobjecten/{uuid}: get: operationId: enkelvoudiginformatieobject_retrieve - description: ' Het object bevat metadata over het document en de downloadlink + description: + ' Het object bevat metadata over het document en de downloadlink (`inhoud`) naar de binary data. Dit geeft standaard de laatste versie van het (ENKELVOUDIG) INFORMATIEOBJECT. Specifieke versies kunnen middels query-string parameters worden opgevraagd.' summary: Een specifiek (ENKELVOUDIG) INFORMATIEOBJECT opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: Voer een voorwaardelijk verzoek uit. Deze header moet één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: query - name: versie - schema: - type: integer - description: Het (automatische) versienummer van het INFORMATIEOBJECT. - - in: query - name: registratieOp - schema: - type: string - description: Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT - die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. - - in: query - name: expand - schema: - type: string - description: Haal details van gelinkte resources direct op. Als je meerdere - resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor - het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie - gebruikt. - examples: - ExpandZaaktype: - value: zaaktype - summary: expand zaaktype - ExpandStatus: - value: status - summary: expand status - ExpandStatus.statustype: - value: status.statustype - summary: expand status.statustype - ExpandHoofdzaak.status.statustype: - value: hoofdzaak.status.statustype - summary: expand hoofdzaak.status.statustype - ExpandHoofdzaak.deelzaken.status.statustype: - value: hoofdzaak.deelzaken.status.statustype - summary: expand hoofdzaak.deelzaken.status.statustype + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: query + name: versie + schema: + type: integer + description: Het (automatische) versienummer van het INFORMATIEOBJECT. + - in: query + name: registratieOp + schema: + type: string + description: + Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT + die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. + - in: query + name: expand + schema: + type: string + description: + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor + het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie + gebruikt. + examples: + ExpandZaaktype: + value: zaaktype + summary: expand zaaktype + ExpandStatus: + value: status + summary: expand status + ExpandStatus.statustype: + value: status.statustype + summary: expand status.statustype + ExpandHoofdzaak.status.statustype: + value: hoofdzaak.status.statustype + summary: expand hoofdzaak.status.statustype + ExpandHoofdzaak.deelzaken.status.statustype: + value: hoofdzaak.deelzaken.status.statustype + summary: expand hoofdzaak.deelzaken.status.statustype tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten security: - - JWT-Claims: - - documenten.lezen + - JWT-Claims: + - documenten.lezen responses: '200': headers: ETag: schema: type: string - description: De ETag berekend op de response body JSON. Indien twee + description: + De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -970,10 +988,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -982,10 +1001,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -994,10 +1014,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -1006,10 +1027,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1018,10 +1040,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1030,10 +1053,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1042,10 +1066,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1054,10 +1079,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1066,48 +1092,50 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: enkelvoudiginformatieobject_update - description: "Dit creëert altijd een nieuwe versie van het (ENKELVOUDIG) INFORMATIEOBJECT.\ - \ \n \n**Er wordt gevalideerd op**\n- correcte `lock` waarde\n- status NIET\ - \ `definitief`" + description: + "Dit cre\xEBert altijd een nieuwe versie van het (ENKELVOUDIG)\ + \ INFORMATIEOBJECT. \n \n**Er wordt gevalideerd op**\n- correcte `lock` waarde\n\ + - status NIET `definitief`" summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT in zijn geheel bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten requestBody: content: application/json: @@ -1115,15 +1143,16 @@ paths: $ref: '#/components/schemas/EnkelvoudigInformatieObjectWithLockRequest' required: true security: - - JWT-Claims: - - (documenten.bijwerken | documenten.geforceerd-bijwerken) + - JWT-Claims: + - (documenten.bijwerken | documenten.geforceerd-bijwerken) responses: '200': headers: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -1135,10 +1164,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -1147,10 +1177,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -1159,10 +1190,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -1171,10 +1203,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -1183,10 +1216,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1195,10 +1229,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1207,10 +1242,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1219,10 +1255,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1231,10 +1268,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1243,63 +1281,66 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: enkelvoudiginformatieobject_partial_update - description: "Dit creëert altijd een nieuwe versie van het (ENKELVOUDIG) INFORMATIEOBJECT.\ - \ \n\n**Er wordt gevalideerd op**\n - correcte `lock` waarde\n - status NIET\ - \ `definitief`" + description: + "Dit cre\xEBert altijd een nieuwe versie van het (ENKELVOUDIG)\ + \ INFORMATIEOBJECT. \n\n**Er wordt gevalideerd op**\n - correcte `lock` waarde\n\ + \ - status NIET `definitief`" summary: Werk een (ENKELVOUDIG) INFORMATIEOBJECT deels bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedEnkelvoudigInformatieObjectWithLockRequest' security: - - JWT-Claims: - - (documenten.bijwerken | documenten.geforceerd-bijwerken) + - JWT-Claims: + - (documenten.bijwerken | documenten.geforceerd-bijwerken) responses: '200': headers: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -1311,10 +1352,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -1323,10 +1365,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -1335,10 +1378,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -1347,10 +1391,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -1359,10 +1404,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1371,10 +1417,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1383,10 +1430,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1395,10 +1443,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1407,10 +1456,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1419,46 +1469,53 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: enkelvoudiginformatieobject_destroy - description: |- - Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT en alle bijbehorende versies, samen met alle gerelateerde resources binnen deze API. Dit is alleen mogelijk als er geen OBJECTINFORMATIEOBJECTen relateerd zijn aan het (ENKELVOUDIG) INFORMATIEOBJECT. + description: + 'Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT en alle bijbehorende + versies, samen met alle gerelateerde resources binnen deze API. Dit is alleen + mogelijk als er geen OBJECTINFORMATIEOBJECTen relateerd zijn aan het (ENKELVOUDIG) + INFORMATIEOBJECT. + **Gerelateerde resources** + - GEBRUIKSRECHTen - - audit trail regels + + - audit trail regels' summary: Verwijder een (ENKELVOUDIG) INFORMATIEOBJECT. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten security: - - JWT-Claims: - - documenten.verwijderen + - JWT-Claims: + - documenten.verwijderen responses: '204': description: No content @@ -1467,10 +1524,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -1479,10 +1537,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -1491,10 +1550,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -1503,10 +1563,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -1515,10 +1576,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -1527,10 +1589,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -1539,10 +1602,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -1551,10 +1615,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -1563,10 +1628,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -1575,45 +1641,49 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) ENKELVOUDIG INFORMATIE OBJECT opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: Voer een voorwaardelijk verzoek uit. Deze header moet één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten responses: '200': headers: ETag: schema: type: string - description: De ETag berekend op de response body JSON. Indien twee + description: + De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -1626,37 +1696,39 @@ paths: description: Download de binaire data van het (ENKELVOUDIG) INFORMATIEOBJECT. summary: Download de binaire data van het (ENKELVOUDIG) INFORMATIEOBJECT. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: query - name: versie - schema: - type: integer - description: Het (automatische) versienummer van het INFORMATIEOBJECT. - - in: query - name: registratieOp - schema: - type: string - description: Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT - die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: query + name: versie + schema: + type: integer + description: Het (automatische) versienummer van het INFORMATIEOBJECT. + - in: query + name: registratieOp + schema: + type: string + description: + Een datumtijd in ISO8601 formaat. De versie van het INFORMATIEOBJECT + die qua `begin_registratie` het kortst hiervoor zit wordt opgehaald. tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten security: - - JWT-Claims: - - documenten.lezen + - JWT-Claims: + - documenten.lezen responses: '200': headers: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/octet-stream: @@ -1666,88 +1738,90 @@ paths: description: OK '401': content: - application/octet-stream: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': content: - application/octet-stream: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': content: - application/octet-stream: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': content: - application/octet-stream: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '410': content: - application/octet-stream: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': content: - application/octet-stream: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': content: - application/octet-stream: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': content: - application/octet-stream: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /enkelvoudiginformatieobjecten/{uuid}/lock: post: operationId: enkelvoudiginformatieobject_lock - description: Voert een 'checkout' uit waardoor het (ENKELVOUDIG) INFORMATIEOBJECTvergrendeld + description: + Voert een 'checkout' uit waardoor het (ENKELVOUDIG) INFORMATIEOBJECTvergrendeld wordt met een `lock` waarde. Alleen met deze waarde kan het(ENKELVOUDIG) INFORMATIEOBJECT bijgewerkt (`PUT`, `PATCH`) en weerontgrendeld worden. summary: Vergrendel een (ENKELVOUDIG) INFORMATIEOBJECT. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten security: - - JWT-Claims: - - documenten.lock + - JWT-Claims: + - documenten.lock responses: '200': headers: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -1756,176 +1830,179 @@ paths: description: OK '400': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Bad request '401': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '410': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /enkelvoudiginformatieobjecten/{uuid}/unlock: post: operationId: enkelvoudiginformatieobject_unlock - description: Heft de 'checkout' op waardoor het (ENKELVOUDIG) INFORMATIEOBJECTontgrendeld + description: + Heft de 'checkout' op waardoor het (ENKELVOUDIG) INFORMATIEOBJECTontgrendeld wordt. summary: Ontgrendel een (ENKELVOUDIG) INFORMATIEOBJECT. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten requestBody: content: application/json: schema: $ref: '#/components/schemas/UnlockEnkelvoudigInformatieObjectRequest' security: - - JWT-Claims: - - (documenten.lock | documenten.geforceerd-unlock) + - JWT-Claims: + - (documenten.lock | documenten.geforceerd-unlock) responses: '204': headers: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' description: No content '400': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Bad request '401': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '410': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error /enkelvoudiginformatieobjecten/_zoek: post: operationId: enkelvoudiginformatieobject__zoek - description: Zoeken/filteren gaat normaal via de `list` operatie, deze is echter + description: + Zoeken/filteren gaat normaal via de `list` operatie, deze is echter niet geschikt voor zoekopdrachten met UUIDs. summary: Voer een zoekopdracht uit op (ENKELVOUDIG) INFORMATIEOBJECTen. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: query - name: page - schema: - type: integer - description: Een pagina binnen de gepagineerde set resultaten. + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: query + name: page + schema: + type: integer + description: Een pagina binnen de gepagineerde set resultaten. tags: - - enkelvoudiginformatieobjecten + - enkelvoudiginformatieobjecten requestBody: content: application/json: @@ -1933,15 +2010,16 @@ paths: $ref: '#/components/schemas/EIOZoekRequest' required: true security: - - JWT-Claims: - - documenten.lezen + - JWT-Claims: + - documenten.lezen responses: '200': headers: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -1953,10 +2031,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -1965,10 +2044,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -1977,10 +2057,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -1989,10 +2070,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2001,10 +2083,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2013,10 +2096,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2025,10 +2109,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2037,10 +2122,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2049,10 +2135,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -2062,95 +2149,105 @@ paths: description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle GEBRUIKSRECHTen opvragen. parameters: - - name: informatieobject - required: false - in: query - description: URL-referentie naar het INFORMATIEOBJECT. - schema: - type: string - format: uri - - name: startdatum__lt - required: false - in: query - description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden - van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject - de startdatum. - schema: - type: string - - name: startdatum__lte - required: false - in: query - description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden - van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject - de startdatum. - schema: - type: string - - name: startdatum__gt - required: false - in: query - description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden - van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject - de startdatum. - schema: - type: string - - name: startdatum__gte - required: false - in: query - description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden - van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject - de startdatum. - schema: - type: string - - name: einddatum__lt - required: false - in: query - description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden van - toepassing zijn. - schema: - type: string - - name: einddatum__lte - required: false - in: query - description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden van - toepassing zijn. - schema: - type: string - - name: einddatum__gt - required: false - in: query - description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden van - toepassing zijn. - schema: - type: string - - name: einddatum__gte - required: false - in: query - description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden van - toepassing zijn. - schema: - type: string - - name: expand - required: false - in: query - description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,\ - \ hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources\ - \ direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze\ - \ scheiden met een komma. Voor het ophalen van resources die een laag dieper\ - \ genest zijn wordt de punt-notatie gebruikt." - schema: - type: string + - name: informatieobject + required: false + in: query + description: URL-referentie naar het INFORMATIEOBJECT. + schema: + type: string + format: uri + - name: startdatum__lt + required: false + in: query + description: + Begindatum van de periode waarin de gebruiksrechtvoorwaarden + van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject + de startdatum. + schema: + type: string + - name: startdatum__lte + required: false + in: query + description: + Begindatum van de periode waarin de gebruiksrechtvoorwaarden + van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject + de startdatum. + schema: + type: string + - name: startdatum__gt + required: false + in: query + description: + Begindatum van de periode waarin de gebruiksrechtvoorwaarden + van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject + de startdatum. + schema: + type: string + - name: startdatum__gte + required: false + in: query + description: + Begindatum van de periode waarin de gebruiksrechtvoorwaarden + van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject + de startdatum. + schema: + type: string + - name: einddatum__lt + required: false + in: query + description: + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: einddatum__lte + required: false + in: query + description: + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: einddatum__gt + required: false + in: query + description: + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: einddatum__gte + required: false + in: query + description: + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van + toepassing zijn. + schema: + type: string + - name: expand + required: false + in: query + description: + "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,\ + \ hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources\ + \ direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze\ + \ scheiden met een komma. Voor het ophalen van resources die een laag dieper\ + \ genest zijn wordt de punt-notatie gebruikt." + schema: + type: string tags: - - gebruiksrechten + - gebruiksrechten security: - - JWT-Claims: - - documenten.lezen + - JWT-Claims: + - documenten.lezen responses: '200': headers: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -2164,10 +2261,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -2176,10 +2274,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2188,10 +2287,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2200,10 +2300,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2212,10 +2313,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2224,10 +2326,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2236,10 +2339,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2248,10 +2352,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2260,40 +2365,42 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: gebruiksrechten_create - description: "Voeg GEBRUIKSRECHTen toe voor een INFORMATIEOBJECT. \n**Opmerkingen**\n\ + description: + "Voeg GEBRUIKSRECHTen toe voor een INFORMATIEOBJECT. \n**Opmerkingen**\n\ \ - Het toevoegen van gebruiksrechten zorgt ervoor dat de `indicatieGebruiksrecht`\ \ op het informatieobject op `true` gezet wordt." summary: Maak een GEBRUIKSRECHT aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - - gebruiksrechten + - gebruiksrechten requestBody: content: application/json: @@ -2301,8 +2408,8 @@ paths: $ref: '#/components/schemas/GebruiksrechtenRequest' required: true security: - - JWT-Claims: - - documenten.aanmaken + - JWT-Claims: + - documenten.aanmaken responses: '201': headers: @@ -2314,7 +2421,8 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -2326,10 +2434,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -2338,10 +2447,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2350,10 +2460,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2362,10 +2473,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2374,10 +2486,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2386,10 +2499,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2398,10 +2512,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2410,10 +2525,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2422,10 +2538,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -2435,72 +2552,77 @@ paths: description: Een specifieke GEBRUIKSRECHT opvragen. summary: Een specifieke GEBRUIKSRECHT opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: Voer een voorwaardelijk verzoek uit. Deze header moet één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: query - name: expand - schema: - type: string - description: Haal details van gelinkte resources direct op. Als je meerdere - resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor - het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie - gebruikt. - examples: - ExpandZaaktype: - value: zaaktype - summary: expand zaaktype - ExpandStatus: - value: status - summary: expand status - ExpandStatus.statustype: - value: status.statustype - summary: expand status.statustype - ExpandHoofdzaak.status.statustype: - value: hoofdzaak.status.statustype - summary: expand hoofdzaak.status.statustype - ExpandHoofdzaak.deelzaken.status.statustype: - value: hoofdzaak.deelzaken.status.statustype - summary: expand hoofdzaak.deelzaken.status.statustype + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: query + name: expand + schema: + type: string + description: + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor + het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie + gebruikt. + examples: + ExpandZaaktype: + value: zaaktype + summary: expand zaaktype + ExpandStatus: + value: status + summary: expand status + ExpandStatus.statustype: + value: status.statustype + summary: expand status.statustype + ExpandHoofdzaak.status.statustype: + value: hoofdzaak.status.statustype + summary: expand hoofdzaak.status.statustype + ExpandHoofdzaak.deelzaken.status.statustype: + value: hoofdzaak.deelzaken.status.statustype + summary: expand hoofdzaak.deelzaken.status.statustype tags: - - gebruiksrechten + - gebruiksrechten security: - - JWT-Claims: - - documenten.lezen + - JWT-Claims: + - documenten.lezen responses: '200': headers: ETag: schema: type: string - description: De ETag berekend op de response body JSON. Indien twee + description: + De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -2512,10 +2634,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2524,10 +2647,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2536,10 +2660,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -2548,10 +2673,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2560,10 +2686,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2572,10 +2699,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2584,10 +2712,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2596,10 +2725,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2608,10 +2738,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -2620,34 +2751,34 @@ paths: description: Werk een GEBRUIKSRECHT in zijn geheel bij. summary: Werk een GEBRUIKSRECHT in zijn geheel bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - - gebruiksrechten + - gebruiksrechten requestBody: content: application/json: @@ -2655,15 +2786,16 @@ paths: $ref: '#/components/schemas/GebruiksrechtenRequest' required: true security: - - JWT-Claims: - - documenten.bijwerken + - JWT-Claims: + - documenten.bijwerken responses: '200': headers: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -2675,10 +2807,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -2687,10 +2820,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2699,10 +2833,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2711,10 +2846,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -2723,10 +2859,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2735,10 +2872,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2747,10 +2885,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2759,10 +2898,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2771,10 +2911,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2783,10 +2924,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -2795,49 +2937,50 @@ paths: description: Werk een GEBRUIKSRECHT relatie deels bij. summary: Werk een GEBRUIKSRECHT relatie deels bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - - gebruiksrechten + - gebruiksrechten requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedGebruiksrechtenRequest' security: - - JWT-Claims: - - documenten.bijwerken + - JWT-Claims: + - documenten.bijwerken responses: '200': headers: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -2849,10 +2992,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -2861,10 +3005,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -2873,10 +3018,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -2885,10 +3031,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -2897,10 +3044,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -2909,10 +3057,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -2921,10 +3070,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -2933,10 +3083,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -2945,10 +3096,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -2957,44 +3109,45 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: gebruiksrechten_destroy - description: |2- - - **Opmerkingen** - - Indien het laatste GEBRUIKSRECHT van een INFORMATIEOBJECT verwijderd wordt, dan wordt de `indicatieGebruiksrecht` van het INFORMATIEOBJECT op`null` gezet. + description: + "\n**Opmerkingen**\n - Indien het laatste GEBRUIKSRECHT van een\ + \ INFORMATIEOBJECT verwijderd wordt, dan wordt de `indicatieGebruiksrecht`\ + \ van het INFORMATIEOBJECT op`null` gezet." summary: Verwijder een GEBRUIKSRECHT. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: X-NLX-Logrecord-ID - schema: - type: string - description: Identifier of the request, traceable throughout the network - - in: header - name: X-Audit-Toelichting - schema: - type: string - description: Toelichting waarom een bepaald verzoek wordt gedaan + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: X-NLX-Logrecord-ID + schema: + type: string + description: Identifier of the request, traceable throughout the network + - in: header + name: X-Audit-Toelichting + schema: + type: string + description: Toelichting waarom een bepaald verzoek wordt gedaan tags: - - gebruiksrechten + - gebruiksrechten security: - - JWT-Claims: - - documenten.verwijderen + - JWT-Claims: + - documenten.verwijderen responses: '204': description: No content @@ -3003,10 +3156,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3015,10 +3169,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3027,10 +3182,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -3039,10 +3195,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3051,10 +3208,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3063,10 +3221,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3075,10 +3234,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3087,10 +3247,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3099,10 +3260,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -3111,45 +3273,49 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) GEBRUIKSRECHT INFORMATIEOBJECT opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: Voer een voorwaardelijk verzoek uit. Deze header moet één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - gebruiksrechten + - gebruiksrechten responses: '200': headers: ETag: schema: type: string - description: De ETag berekend op de response body JSON. Indien twee + description: + De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -3162,43 +3328,46 @@ paths: description: ' Deze lijst kan gefilterd wordt met query-string parameters.' summary: Alle OBJECT-INFORMATIEOBJECT relaties opvragen. parameters: - - name: object - required: false - in: query - description: URL-referentie naar het gerelateerde OBJECT (in deze of een andere - API). - schema: - type: string - format: uri - - name: informatieobject - required: false - in: query - description: URL-referentie naar het INFORMATIEOBJECT. - schema: - type: string - format: uri - - name: expand - required: false - in: query - description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,\ - \ hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources\ - \ direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze\ - \ scheiden met een komma. Voor het ophalen van resources die een laag dieper\ - \ genest zijn wordt de punt-notatie gebruikt." - schema: - type: string + - name: object + required: false + in: query + description: + URL-referentie naar het gerelateerde OBJECT (in deze of een andere + API). + schema: + type: string + format: uri + - name: informatieobject + required: false + in: query + description: URL-referentie naar het INFORMATIEOBJECT. + schema: + type: string + format: uri + - name: expand + required: false + in: query + description: + "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,\ + \ hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources\ + \ direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze\ + \ scheiden met een komma. Voor het ophalen van resources die een laag dieper\ + \ genest zijn wordt de punt-notatie gebruikt." + schema: + type: string tags: - - objectinformatieobjecten + - objectinformatieobjecten security: - - JWT-Claims: - - documenten.lezen + - JWT-Claims: + - documenten.lezen responses: '200': headers: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -3212,10 +3381,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -3224,10 +3394,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3236,10 +3407,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3248,10 +3420,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3260,10 +3433,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3272,10 +3446,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3284,10 +3459,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3296,10 +3472,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3308,32 +3485,34 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: objectinformatieobject_create - description: '**LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** - Andere API''s, zoals de Zaken API en de Besluiten API, gebruiken dit endpoint + description: + "**LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** + Andere API's, zoals de Zaken API en de Besluiten API, gebruiken dit endpoint bij het synchroniseren van relaties. **Er wordt gevalideerd op** - geldigheid `informatieobject` URL - de combinatie `informatieobject` en `object` moet - uniek zijn - bestaan van `object` URL' + uniek zijn - bestaan van `object` URL" summary: Maak een OBJECT-INFORMATIEOBJECT relatie aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - objectinformatieobjecten + - objectinformatieobjecten requestBody: content: application/json: @@ -3341,8 +3520,8 @@ paths: $ref: '#/components/schemas/ObjectInformatieObjectRequest' required: true security: - - JWT-Claims: - - documenten.aanmaken + - JWT-Claims: + - documenten.aanmaken responses: '201': headers: @@ -3354,7 +3533,8 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -3366,10 +3546,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -3378,10 +3559,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3390,10 +3572,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3402,10 +3585,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3414,10 +3598,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3426,10 +3611,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3438,10 +3624,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3450,10 +3637,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3462,10 +3650,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -3475,72 +3664,77 @@ paths: description: Een specifieke OBJECT-INFORMATIEOBJECT relatie opvragen. summary: Een specifieke OBJECT-INFORMATIEOBJECT relatie opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: Voer een voorwaardelijk verzoek uit. Deze header moet één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: query - name: expand - schema: - type: string - description: Haal details van gelinkte resources direct op. Als je meerdere - resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor - het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie - gebruikt. - examples: - ExpandZaaktype: - value: zaaktype - summary: expand zaaktype - ExpandStatus: - value: status - summary: expand status - ExpandStatus.statustype: - value: status.statustype - summary: expand status.statustype - ExpandHoofdzaak.status.statustype: - value: hoofdzaak.status.statustype - summary: expand hoofdzaak.status.statustype - ExpandHoofdzaak.deelzaken.status.statustype: - value: hoofdzaak.deelzaken.status.statustype - summary: expand hoofdzaak.deelzaken.status.statustype + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: query + name: expand + schema: + type: string + description: + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor + het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie + gebruikt. + examples: + ExpandZaaktype: + value: zaaktype + summary: expand zaaktype + ExpandStatus: + value: status + summary: expand status + ExpandStatus.statustype: + value: status.statustype + summary: expand status.statustype + ExpandHoofdzaak.status.statustype: + value: hoofdzaak.status.statustype + summary: expand hoofdzaak.status.statustype + ExpandHoofdzaak.deelzaken.status.statustype: + value: hoofdzaak.deelzaken.status.statustype + summary: expand hoofdzaak.deelzaken.status.statustype tags: - - objectinformatieobjecten + - objectinformatieobjecten security: - - JWT-Claims: - - documenten.lezen + - JWT-Claims: + - documenten.lezen responses: '200': headers: ETag: schema: type: string - description: De ETag berekend op de response body JSON. Indien twee + description: + De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -3552,10 +3746,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3564,10 +3759,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3576,10 +3772,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -3588,10 +3785,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3600,10 +3798,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3612,10 +3811,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3624,10 +3824,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3636,10 +3837,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3648,33 +3850,35 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: objectinformatieobject_destroy - description: '**LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** - Andere API''s, zoals de Zaken API en de Besluiten API, gebruiken dit endpoint - bij het synchroniseren van relaties.' + description: + "**LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** + Andere API's, zoals de Zaken API en de Besluiten API, gebruiken dit endpoint + bij het synchroniseren van relaties." summary: Verwijder een OBJECT-INFORMATIEOBJECT relatie. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true tags: - - objectinformatieobjecten + - objectinformatieobjecten security: - - JWT-Claims: - - documenten.verwijderen + - JWT-Claims: + - documenten.verwijderen responses: '204': description: No content @@ -3683,10 +3887,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3695,10 +3900,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3707,10 +3913,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -3719,10 +3926,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3731,10 +3939,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3743,10 +3952,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3755,10 +3965,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3767,10 +3978,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -3779,10 +3991,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -3791,45 +4004,49 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) OOBJECT-INFORMATIEOBJECT opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: Voer een voorwaardelijk verzoek uit. Deze header moet één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - objectinformatieobjecten + - objectinformatieobjecten responses: '200': headers: ETag: schema: type: string - description: De ETag berekend op de response body JSON. Indien twee + description: + De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -3842,57 +4059,62 @@ paths: description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle VERZENDINGen opvragen. parameters: - - name: aardRelatie - required: false - in: query - description: Omschrijving van de aard van de relatie van de BETROKKENE tot - het INFORMATIEOBJECT. - schema: - type: string - enum: - - afzender - - geadresseerde - - name: informatieobject - required: false - in: query - description: URL-referentie naar het informatieobject dat is ontvangen of - verzonden. - schema: - type: string - format: uri - - name: betrokkene - required: false - in: query - description: URL-referentie naar de betrokkene waarvan het informatieobject - is ontvangen of waaraan dit is verzonden. - schema: - type: string - format: uri - - name: expand - required: false - in: query - description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,\ - \ hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources\ - \ direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze\ - \ scheiden met een komma. Voor het ophalen van resources die een laag dieper\ - \ genest zijn wordt de punt-notatie gebruikt." - schema: - type: string - - name: page - required: false - in: query - description: Een pagina binnen de gepagineerde set resultaten. - schema: - type: integer + - name: aardRelatie + required: false + in: query + description: + Omschrijving van de aard van de relatie van de BETROKKENE tot + het INFORMATIEOBJECT. + schema: + type: string + enum: + - afzender + - geadresseerde + - name: informatieobject + required: false + in: query + description: + URL-referentie naar het informatieobject dat is ontvangen of + verzonden. + schema: + type: string + format: uri + - name: betrokkene + required: false + in: query + description: + URL-referentie naar de betrokkene waarvan het informatieobject + is ontvangen of waaraan dit is verzonden. + schema: + type: string + format: uri + - name: expand + required: false + in: query + description: + "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,\ + \ hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources\ + \ direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze\ + \ scheiden met een komma. Voor het ophalen van resources die een laag dieper\ + \ genest zijn wordt de punt-notatie gebruikt." + schema: + type: string + - name: page + required: false + in: query + description: Een pagina binnen de gepagineerde set resultaten. + schema: + type: integer tags: - - verzendingen + - verzendingen responses: '200': headers: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -3904,10 +4126,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -3916,10 +4139,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -3928,10 +4152,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -3940,10 +4165,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -3952,10 +4178,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -3964,10 +4191,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -3976,10 +4204,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -3988,10 +4217,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4000,10 +4230,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -4012,16 +4243,16 @@ paths: description: Voeg VERZENDINGen toe voor een INFORMATIEOBJECT en een BETROKKENE. summary: Maak een VERZENDING aan. parameters: - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - verzendingen + - verzendingen requestBody: content: application/json: @@ -4039,7 +4270,8 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -4051,10 +4283,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -4063,10 +4296,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4075,10 +4309,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4087,10 +4322,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4099,10 +4335,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4111,10 +4348,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4123,10 +4361,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4135,10 +4374,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4147,10 +4387,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -4160,69 +4401,74 @@ paths: description: Een specifieke VERZENDING opvragen. summary: Een specifieke VERZENDING opvragen. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: Voer een voorwaardelijk verzoek uit. Deze header moet één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes - - in: query - name: expand - schema: - type: string - description: Haal details van gelinkte resources direct op. Als je meerdere - resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor - het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie - gebruikt. - examples: - ExpandZaaktype: - value: zaaktype - summary: expand zaaktype - ExpandStatus: - value: status - summary: expand status - ExpandStatus.statustype: - value: status.statustype - summary: expand status.statustype - ExpandHoofdzaak.status.statustype: - value: hoofdzaak.status.statustype - summary: expand hoofdzaak.status.statustype - ExpandHoofdzaak.deelzaken.status.statustype: - value: hoofdzaak.deelzaken.status.statustype - summary: expand hoofdzaak.deelzaken.status.statustype + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes + - in: query + name: expand + schema: + type: string + description: + Haal details van gelinkte resources direct op. Als je meerdere + resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor + het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie + gebruikt. + examples: + ExpandZaaktype: + value: zaaktype + summary: expand zaaktype + ExpandStatus: + value: status + summary: expand status + ExpandStatus.statustype: + value: status.statustype + summary: expand status.statustype + ExpandHoofdzaak.status.statustype: + value: hoofdzaak.status.statustype + summary: expand hoofdzaak.status.statustype + ExpandHoofdzaak.deelzaken.status.statustype: + value: hoofdzaak.deelzaken.status.statustype + summary: expand hoofdzaak.deelzaken.status.statustype tags: - - verzendingen + - verzendingen responses: '200': headers: ETag: schema: type: string - description: De ETag berekend op de response body JSON. Indien twee + description: + De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -4234,10 +4480,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4246,10 +4493,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4258,10 +4506,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -4270,10 +4519,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4282,10 +4532,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4294,10 +4545,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4306,10 +4558,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4318,10 +4571,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4330,10 +4584,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -4342,24 +4597,24 @@ paths: description: Werk een VERZENDING in zijn geheel bij. summary: Werk een VERZENDING in zijn geheel bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - verzendingen + - verzendingen requestBody: content: application/json: @@ -4372,7 +4627,8 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -4384,10 +4640,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -4396,10 +4653,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4408,10 +4666,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4420,10 +4679,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -4432,10 +4692,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4444,10 +4705,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4456,10 +4718,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4468,10 +4731,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4480,10 +4744,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4492,10 +4757,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -4504,24 +4770,24 @@ paths: description: Werk een VERZENDING relatie deels bij. summary: Werk een VERZENDING relatie deels bij. parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: Content-Type - schema: - type: string - enum: - - application/json - description: Content type van de verzoekinhoud. - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: Content-Type + schema: + type: string + enum: + - application/json + description: Content type van de verzoekinhoud. + required: true tags: - - verzendingen + - verzendingen requestBody: content: application/json: @@ -4533,7 +4799,8 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -4545,10 +4812,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -4557,10 +4825,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4569,10 +4838,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4581,10 +4851,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -4593,10 +4864,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4605,10 +4877,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4617,10 +4890,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4629,10 +4903,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4641,10 +4916,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4653,10 +4929,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -4665,16 +4942,16 @@ paths: description: Verwijder een VERZENDING. summary: Verwijder een VERZENDING parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true tags: - - verzendingen + - verzendingen responses: '204': description: No content @@ -4683,10 +4960,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4695,10 +4973,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4707,10 +4986,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -4719,10 +4999,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4731,10 +5012,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4743,10 +5025,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4755,10 +5038,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4767,10 +5051,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4779,10 +5064,11 @@ paths: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error @@ -4791,45 +5077,49 @@ paths: description: Vraag de headers op die je bij een GET request zou krijgen. summary: 'De headers voor een specifiek(e) VERZENDING opvragen ' parameters: - - in: path - name: uuid - schema: - type: string - format: uuid - description: Unieke resource identifier (UUID4) - title: uuid - required: true - - in: header - name: If-None-Match - schema: - type: string - description: Voer een voorwaardelijk verzoek uit. Deze header moet één of - meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. - Indien de waarde van de ETag van de huidige resource voorkomt in deze set, - dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) - voor meer informatie. - examples: - OneValue: - value: '"79054025255fb1a26e4bc422aef54eb4"' - summary: Eén ETag-waarde - MultipleValues: - value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' - summary: Meerdere ETag-waardes + - in: path + name: uuid + schema: + type: string + format: uuid + description: Unieke resource identifier (UUID4) + title: uuid + required: true + - in: header + name: If-None-Match + schema: + type: string + description: + "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ + n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ + \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ + \ deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie\ + \ [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match)\ + \ voor meer informatie." + examples: + OneValue: + value: '"79054025255fb1a26e4bc422aef54eb4"' + summary: "E\xE9n ETag-waarde" + MultipleValues: + value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' + summary: Meerdere ETag-waardes tags: - - verzendingen + - verzendingen responses: '200': headers: ETag: schema: type: string - description: De ETag berekend op de response body JSON. Indien twee + description: + De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: @@ -4843,10 +5133,11 @@ components: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van een + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request @@ -4855,10 +5146,11 @@ components: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van een + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized @@ -4867,10 +5159,11 @@ components: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van een + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden @@ -4879,10 +5172,11 @@ components: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van een + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found @@ -4891,10 +5185,11 @@ components: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van een + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable @@ -4903,10 +5198,11 @@ components: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van een + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict @@ -4915,10 +5211,11 @@ components: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van een + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone @@ -4927,10 +5224,11 @@ components: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van een + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type @@ -4939,10 +5237,11 @@ components: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van een + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests @@ -4951,34 +5250,35 @@ components: API-version: schema: type: string - description: 'Geeft een specifieke API-versie aan in de context van een + description: + 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: - application/json: + application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error schemas: AardRelatieEnum: enum: - - afzender - - geadresseerde + - afzender + - geadresseerde type: string AlgoritmeEnum: enum: - - crc_16 - - crc_32 - - crc_64 - - fletcher_4 - - fletcher_8 - - fletcher_16 - - fletcher_32 - - hmac - - md5 - - sha_1 - - sha_256 - - sha_512 - - sha_3 + - crc_16 + - crc_32 + - crc_64 + - fletcher_4 + - fletcher_8 + - fletcher_16 + - fletcher_32 + - hmac + - md5 + - sha_1 + - sha_256 + - sha_512 + - sha_3 type: string AuditTrail: type: object @@ -4990,21 +5290,31 @@ components: title: uuid bron: allOf: - - $ref: '#/components/schemas/BronEnum' - description: |- - De naam van het component waar de wijziging in is gedaan. + - $ref: '#/components/schemas/BronEnum' + description: + 'De naam van het component waar de wijziging in is gedaan. + Uitleg bij mogelijke waarden: + * `ac` - Autorisaties API + * `nrc` - Notificaties API + * `zrc` - Zaken API + * `ztc` - Catalogi API + * `drc` - Documenten API + * `brc` - Besluiten API + * `cmc` - Contactmomenten API + * `kc` - Klanten API - * `vrc` - Verzoeken API + + * `vrc` - Verzoeken API' title: bron applicatieId: type: string @@ -5018,7 +5328,8 @@ components: maxLength: 200 gebruikersId: type: string - description: Unieke identificatie van de gebruiker die binnen de organisatie + description: + Unieke identificatie van de gebruiker die binnen de organisatie herleid kan worden naar een persoon. title: gebruikers id maxLength: 255 @@ -5029,19 +5340,27 @@ components: maxLength: 255 actie: type: string - description: |- - De uitgevoerde handeling. + description: 'De uitgevoerde handeling. + + + De bekende waardes voor dit veld zijn hieronder aangegeven, maar + andere waardes zijn ook toegestaan - De bekende waardes voor dit veld zijn hieronder aangegeven, maar andere waardes zijn ook toegestaan Uitleg bij mogelijke waarden: + * `create` - Object aangemaakt + * `list` - Lijst van objecten opgehaald + * `retrieve` - Object opgehaald + * `destroy` - Object verwijderd + * `update` - Object bijgewerkt - * `partial_update` - Object deels bijgewerkt + + * `partial_update` - Object deels bijgewerkt' title: actie maxLength: 50 actieWeergave: @@ -5089,18 +5408,18 @@ components: title: aanmaakdatum wijzigingen: allOf: - - $ref: '#/components/schemas/Wijzigingen' + - $ref: '#/components/schemas/Wijzigingen' title: wijzigingen required: - - aanmaakdatum - - actie - - bron - - hoofdObject - - resource - - resourceUrl - - resourceWeergave - - resultaat - - wijzigingen + - aanmaakdatum + - actie + - bron + - hoofdObject + - resource + - resourceUrl + - resourceWeergave + - resultaat + - wijzigingen BestandsDeel: type: object properties: @@ -5109,7 +5428,8 @@ components: format: uri readOnly: true title: url - description: URL-referentie naar dit object. Dit is de unieke identificatie + description: + URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 @@ -5126,15 +5446,16 @@ components: voltooid: type: boolean readOnly: true - description: 'Indicatie of dit bestandsdeel volledig is geupload. Dat wil + description: + 'Indicatie of dit bestandsdeel volledig is geupload. Dat wil zeggen: het aantal bytes dat staat genoemd bij grootte is daadwerkelijk ontvangen.' title: voltooid required: - - omvang - - url - - volgnummer - - voltooid + - omvang + - url + - volgnummer + - voltooid BestandsDeelRequest: type: object properties: @@ -5151,7 +5472,7 @@ components: description: Hash string, which represents id of the lock of related informatieobject title: lock required: - - lock + - lock BestandsDeelResponse: type: object properties: @@ -5160,7 +5481,8 @@ components: format: uri readOnly: true title: url - description: URL-referentie naar dit object. Dit is de unieke identificatie + description: + URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 @@ -5179,7 +5501,8 @@ components: title: inhoud voltooid: type: boolean - description: 'Indicatie of dit bestandsdeel volledig is geupload. Dat wil + description: + 'Indicatie of dit bestandsdeel volledig is geupload. Dat wil zeggen: het aantal bytes dat staat genoemd bij grootte is daadwerkelijk ontvangen.' title: voltooid @@ -5188,18 +5511,20 @@ components: description: Een volgnummer dat de volgorde van de bestandsdelen aangeeft. title: volgnummer required: - - lock - - url + - lock + - url BinnenlandsCorrespondentieadresVerzending: type: object - description: Het correspondentieadres, betreffende een adresseerbaar object, + description: + Het correspondentieadres, betreffende een adresseerbaar object, van de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van het reguliere binnenlandse correspondentieadres van BETROKKENE. properties: huisletter: type: string - description: Een door of namens het bevoegd gemeentelijk orgaan ten aanzien + description: + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken. title: huisletter @@ -5208,50 +5533,57 @@ components: type: integer maximum: 99999 minimum: 1 - description: Een door of namens het bevoegd gemeentelijk orgaan ten aanzien + description: + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van een adresseerbaar object toegekende nummering. title: huisnummer huisnummerToevoeging: type: string - description: Een door of namens het bevoegd gemeentelijk orgaan ten aanzien + description: + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter. title: huisnummer toevoeging maxLength: 4 naamOpenbareRuimte: type: string - description: Een door het bevoegde gemeentelijke orgaan aan een GEMEENTELIJKE OPENBARE + description: + Een door het bevoegde gemeentelijke orgaan aan een GEMEENTELIJKE OPENBARE RUIMTE toegekende benaming. title: naam openbare ruimte maxLength: 80 postcode: type: string - description: De door TNT Post vastgestelde code behorende bij een bepaalde + description: + De door TNT Post vastgestelde code behorende bij een bepaalde combinatie van een naam van een woonplaats, naam van een openbare ruimte en een huisnummer. title: postcode maxLength: 6 woonplaatsnaam: type: string - description: De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + description: + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS toegekende benaming. title: woonplaatsnaam maxLength: 80 required: - - huisnummer - - naamOpenbareRuimte - - woonplaatsnaam + - huisnummer + - naamOpenbareRuimte + - woonplaatsnaam nullable: true BinnenlandsCorrespondentieadresVerzendingRequest: type: object - description: Het correspondentieadres, betreffende een adresseerbaar object, + description: + Het correspondentieadres, betreffende een adresseerbaar object, van de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van het reguliere binnenlandse correspondentieadres van BETROKKENE. properties: huisletter: type: string - description: Een door of namens het bevoegd gemeentelijk orgaan ten aanzien + description: + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken. title: huisletter @@ -5260,12 +5592,14 @@ components: type: integer maximum: 99999 minimum: 1 - description: Een door of namens het bevoegd gemeentelijk orgaan ten aanzien + description: + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van een adresseerbaar object toegekende nummering. title: huisnummer huisnummerToevoeging: type: string - description: Een door of namens het bevoegd gemeentelijk orgaan ten aanzien + description: + Een door of namens het bevoegd gemeentelijk orgaan ten aanzien van een adresseerbaar object toegekende nadere toevoeging aan een huisnummer of een combinatie van huisnummer en huisletter. title: huisnummer toevoeging @@ -5273,13 +5607,15 @@ components: naamOpenbareRuimte: type: string minLength: 1 - description: Een door het bevoegde gemeentelijke orgaan aan een GEMEENTELIJKE OPENBARE + description: + Een door het bevoegde gemeentelijke orgaan aan een GEMEENTELIJKE OPENBARE RUIMTE toegekende benaming. title: naam openbare ruimte maxLength: 80 postcode: type: string - description: De door TNT Post vastgestelde code behorende bij een bepaalde + description: + De door TNT Post vastgestelde code behorende bij een bepaalde combinatie van een naam van een woonplaats, naam van een openbare ruimte en een huisnummer. title: postcode @@ -5287,87 +5623,97 @@ components: woonplaatsnaam: type: string minLength: 1 - description: De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + description: + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS toegekende benaming. title: woonplaatsnaam maxLength: 80 required: - - huisnummer - - naamOpenbareRuimte - - woonplaatsnaam + - huisnummer + - naamOpenbareRuimte + - woonplaatsnaam nullable: true BlankEnum: enum: - - '' + - '' BronEnum: enum: - - ac - - nrc - - zrc - - ztc - - drc - - brc - - cmc - - kc - - vrc + - ac + - nrc + - zrc + - ztc + - drc + - brc + - cmc + - kc + - vrc type: string BuitenlandsCorrespondentieadresVerzending: type: object - description: De gegevens van het adres in het buitenland van BETROKKENE, zijnde + description: + De gegevens van het adres in het buitenland van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. properties: adresBuitenland1: type: string - description: Het eerste deel dat behoort bij het afwijkend buitenlandse + description: + Het eerste deel dat behoort bij het afwijkend buitenlandse correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. title: adres buitenland 1 maxLength: 35 adresBuitenland2: type: string - description: Het tweede deel dat behoort bij het afwijkend buitenlandse + description: + Het tweede deel dat behoort bij het afwijkend buitenlandse correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. title: adres buitenland 2 maxLength: 35 adresBuitenland3: type: string - description: Het derde deel dat behoort bij het afwijkend buitenlandse correspondentieadres + description: + Het derde deel dat behoort bij het afwijkend buitenlandse correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. title: adres buitenland 3 maxLength: 35 landPostadres: type: string format: uri - description: Het LAND dat behoort bij het afwijkend buitenlandse correspondentieadres + description: + Het LAND dat behoort bij het afwijkend buitenlandse correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. title: land postadres maxLength: 200 required: - - adresBuitenland1 - - landPostadres + - adresBuitenland1 + - landPostadres nullable: true BuitenlandsCorrespondentieadresVerzendingRequest: type: object - description: De gegevens van het adres in het buitenland van BETROKKENE, zijnde + description: + De gegevens van het adres in het buitenland van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. properties: adresBuitenland1: type: string minLength: 1 - description: Het eerste deel dat behoort bij het afwijkend buitenlandse + description: + Het eerste deel dat behoort bij het afwijkend buitenlandse correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. title: adres buitenland 1 maxLength: 35 adresBuitenland2: type: string - description: Het tweede deel dat behoort bij het afwijkend buitenlandse + description: + Het tweede deel dat behoort bij het afwijkend buitenlandse correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. title: adres buitenland 2 maxLength: 35 adresBuitenland3: type: string - description: Het derde deel dat behoort bij het afwijkend buitenlandse correspondentieadres + description: + Het derde deel dat behoort bij het afwijkend buitenlandse correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. title: adres buitenland 3 maxLength: 35 @@ -5375,17 +5721,19 @@ components: type: string format: uri minLength: 1 - description: Het LAND dat behoort bij het afwijkend buitenlandse correspondentieadres + description: + Het LAND dat behoort bij het afwijkend buitenlandse correspondentieadres van de betrokkene in zijn/haar rol bij de zaak. title: land postadres maxLength: 200 required: - - adresBuitenland1 - - landPostadres + - adresBuitenland1 + - landPostadres nullable: true BuitenlandsCorrespondentiepostadresVerzending: type: object - description: De gegevens die tezamen een postbusadres of antwoordnummeradres + description: + De gegevens die tezamen een postbusadres of antwoordnummeradres vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. @@ -5395,34 +5743,38 @@ components: maximum: 9999 minimum: 1 title: Postbus-of antwoordnummer - description: De numerieke aanduiding zoals deze door de Nederlandse PTT + description: + De numerieke aanduiding zoals deze door de Nederlandse PTT is vastgesteld voor postbusadressen en antwoordnummeradressen. postadresPostcode: type: string - description: De officiële Nederlandse PTT codering, bestaande uit een numerieke - woonplaatscode en een alfabetische lettercode. + description: + "De offici\xEBle Nederlandse PTT codering, bestaande uit een\ + \ numerieke woonplaatscode en een alfabetische lettercode." title: postadres postcode maxLength: 6 postadresType: allOf: - - $ref: '#/components/schemas/PostadresTypeEnum' + - $ref: '#/components/schemas/PostadresTypeEnum' title: Postadrestype description: Aanduiding van het soort postadres. woonplaatsnaam: type: string - description: De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + description: + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS toegekende benaming. title: woonplaatsnaam maxLength: 80 required: - - postBusOfAntwoordnummer - - postadresPostcode - - postadresType - - woonplaatsnaam + - postBusOfAntwoordnummer + - postadresPostcode + - postadresType + - woonplaatsnaam nullable: true BuitenlandsCorrespondentiepostadresVerzendingRequest: type: object - description: De gegevens die tezamen een postbusadres of antwoordnummeradres + description: + De gegevens die tezamen een postbusadres of antwoordnummeradres vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. @@ -5432,32 +5784,35 @@ components: maximum: 9999 minimum: 1 title: Postbus-of antwoordnummer - description: De numerieke aanduiding zoals deze door de Nederlandse PTT + description: + De numerieke aanduiding zoals deze door de Nederlandse PTT is vastgesteld voor postbusadressen en antwoordnummeradressen. postadresPostcode: type: string minLength: 1 - description: De officiële Nederlandse PTT codering, bestaande uit een numerieke - woonplaatscode en een alfabetische lettercode. + description: + "De offici\xEBle Nederlandse PTT codering, bestaande uit een\ + \ numerieke woonplaatscode en een alfabetische lettercode." title: postadres postcode maxLength: 6 postadresType: allOf: - - $ref: '#/components/schemas/PostadresTypeEnum' + - $ref: '#/components/schemas/PostadresTypeEnum' title: Postadrestype description: Aanduiding van het soort postadres. woonplaatsnaam: type: string minLength: 1 - description: De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS + description: + De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS toegekende benaming. title: woonplaatsnaam maxLength: 80 required: - - postBusOfAntwoordnummer - - postadresPostcode - - postadresType - - woonplaatsnaam + - postBusOfAntwoordnummer + - postadresPostcode + - postadresType + - woonplaatsnaam nullable: true EIOZoekRequest: type: object @@ -5470,8 +5825,18 @@ components: title: '' description: Array of unieke resource identifiers (UUID4) title: uuid__in + expand: + type: string + minLength: 1 + description: + "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype,\ + \ hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources\ + \ direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze\ + \ scheiden met een komma. Voor het ophalen van resources die een laag\ + \ dieper genest zijn wordt de punt-notatie gebruikt." + title: expand required: - - uuid_In + - uuid_In EnkelvoudigInformatieObject: type: object description: Serializer for the EnkelvoudigInformatieObject model @@ -5481,21 +5846,24 @@ components: format: uri readOnly: true title: url - description: URL-referentie naar dit object. Dit is de unieke identificatie + description: + URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 identificatie: type: string - description: Een binnen een gegeven context ondubbelzinnige referentie naar + description: + Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string - description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste - in een samenwerkingsketen heeft vastgelegd. + description: + "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ + \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ + \ eerste in een samenwerkingsketen heeft vastgelegd." title: bronorganisatie maxLength: 9 creatiedatum: @@ -5509,53 +5877,78 @@ components: title: titel maxLength: 200 vertrouwelijkheidaanduiding: - description: |- - Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is. + description: + 'Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + Uitleg bij mogelijke waarden: + * `openbaar` - Openbaar + * `beperkt_openbaar` - Beperkt openbaar + * `intern` - Intern + * `zaakvertrouwelijk` - Zaakvertrouwelijk + * `vertrouwelijk` - Vertrouwelijk + * `confidentieel` - Confidentieel + * `geheim` - Geheim - * `zeer_geheim` - Zeer geheim + + * `zeer_geheim` - Zeer geheim' title: vertrouwelijkheidaanduiding oneOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' auteur: type: string - description: De persoon of organisatie die in de eerste plaats verantwoordelijk - is voor het creëren van de inhoud van het INFORMATIEOBJECT. + description: + "De persoon of organisatie die in de eerste plaats verantwoordelijk\ + \ is voor het cre\xEBren van de inhoud van het INFORMATIEOBJECT." title: auteur maxLength: 200 status: - description: |- - Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. + description: + "Aanduiding van de stand van zaken van een INFORMATIEOBJECT. + De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als + het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + Uitleg bij mogelijke waarden: + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar + moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand + vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar + gemaakt; een gearchiveerd informatie-element." title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' formaat: type: string - description: 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + description: + 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml' title: formaat maxLength: 255 taal: type: string - description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + description: + 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 @@ -5563,19 +5956,22 @@ components: versie: type: integer readOnly: true - description: Het (automatische) versienummer van het INFORMATIEOBJECT. Deze + description: + Het (automatische) versienummer van het INFORMATIEOBJECT. Deze begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. title: versie beginRegistratie: type: string format: date-time readOnly: true - description: Een datumtijd in ISO8601 formaat waarop deze versie van het + description: + Een datumtijd in ISO8601 formaat waarop deze versie van het INFORMATIEOBJECT is aangemaakt of gewijzigd. title: begin registratie bestandsnaam: type: string - description: De naam van het fysieke bestand waarin de inhoud van het informatieobject + description: + De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 @@ -5596,7 +5992,8 @@ components: link: type: string format: uri - description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen + description: + De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 @@ -5609,7 +6006,8 @@ components: type: string format: date nullable: true - description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: + "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te\ \ registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende\ \ organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden\ @@ -5621,7 +6019,8 @@ components: type: string format: date nullable: true - description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: + "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op\ \ het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als\ \ uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk\ @@ -5633,7 +6032,8 @@ components: indicatieGebruiksrecht: type: boolean nullable: true - description: Indicatie of er beperkingen gelden aangaande het gebruik van + description: + Indicatie of er beperkingen gelden aangaande het gebruik van het informatieobject anders dan raadpleging. Dit veld mag `null` zijn om aan te geven dat de indicatie nog niet bekend is. Als de indicatie gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen @@ -5641,34 +6041,38 @@ components: title: indicatie gebruiksrecht verschijningsvorm: type: string - description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT." title: verschijningsvorm ondertekening: allOf: - - $ref: '#/components/schemas/Ondertekening' + - $ref: '#/components/schemas/Ondertekening' nullable: true - description: Aanduiding van de rechtskracht van een informatieobject. Mag + description: + Aanduiding van de rechtskracht van een informatieobject. Mag niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' of 'ter vaststelling' heeft. title: ondertekening integriteit: allOf: - - $ref: '#/components/schemas/Integriteit' + - $ref: '#/components/schemas/Integriteit' nullable: true - description: Uitdrukking van mate van volledigheid en onbeschadigd zijn + description: + Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri - description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi + description: + URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 locked: type: boolean readOnly: true - description: Geeft aan of het document gelocked is. Alleen als een document + description: + Geeft aan of het document gelocked is. Alleen als een document gelocked is, mogen er aanpassingen gemaakt worden. title: locked bestandsdelen: @@ -5686,35 +6090,39 @@ components: description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden required: - - auteur - - beginRegistratie - - bestandsdelen - - bronorganisatie - - creatiedatum - - informatieobjecttype - - locked - - taal - - titel - - url - - versie + - auteur + - beginRegistratie + - bestandsdelen + - bronorganisatie + - creatiedatum + - informatieobjecttype + - locked + - taal + - titel + - url + - versie EnkelvoudigInformatieObjectCreateLockRequest: type: object - description: |- - This serializer class is used by EnkelvoudigInformatieObjectViewSet for - create operation for large files + description: + 'This serializer class is used by EnkelvoudigInformatieObjectViewSet + for + + create operation for large files' properties: identificatie: type: string - description: Een binnen een gegeven context ondubbelzinnige referentie naar + description: + Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string minLength: 1 - description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste - in een samenwerkingsketen heeft vastgelegd. + description: + "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ + \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ + \ eerste in een samenwerkingsketen heeft vastgelegd." title: bronorganisatie maxLength: 9 creatiedatum: @@ -5729,47 +6137,71 @@ components: title: titel maxLength: 200 vertrouwelijkheidaanduiding: - description: |- - Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is. + description: + 'Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + Uitleg bij mogelijke waarden: + * `openbaar` - Openbaar + * `beperkt_openbaar` - Beperkt openbaar + * `intern` - Intern + * `zaakvertrouwelijk` - Zaakvertrouwelijk + * `vertrouwelijk` - Vertrouwelijk + * `confidentieel` - Confidentieel + * `geheim` - Geheim - * `zeer_geheim` - Zeer geheim + + * `zeer_geheim` - Zeer geheim' title: vertrouwelijkheidaanduiding oneOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' auteur: type: string minLength: 1 - description: De persoon of organisatie die in de eerste plaats verantwoordelijk - is voor het creëren van de inhoud van het INFORMATIEOBJECT. + description: + "De persoon of organisatie die in de eerste plaats verantwoordelijk\ + \ is voor het cre\xEBren van de inhoud van het INFORMATIEOBJECT." title: auteur maxLength: 200 status: - description: |- - Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. + description: + "Aanduiding van de stand van zaken van een INFORMATIEOBJECT. + De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als + het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + Uitleg bij mogelijke waarden: + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar + moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand + vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar + gemaakt; een gearchiveerd informatie-element." title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' formaat: type: string - description: 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + description: + 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml' title: formaat @@ -5777,20 +6209,22 @@ components: taal: type: string minLength: 3 - description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + description: + 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 bestandsnaam: type: string - description: De naam van het fysieke bestand waarin de inhoud van het informatieobject + description: + De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 inhoud: type: string format: byte - description: Binaire inhoud, in base64 geëncodeerd. + description: "Binaire inhoud, in base64 ge\xEBncodeerd." nullable: true title: inhoud bestandsomvang: @@ -5804,7 +6238,8 @@ components: link: type: string format: uri - description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen + description: + De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 @@ -5817,7 +6252,8 @@ components: type: string format: date nullable: true - description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: + "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te\ \ registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende\ \ organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden\ @@ -5829,7 +6265,8 @@ components: type: string format: date nullable: true - description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: + "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op\ \ het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als\ \ uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk\ @@ -5841,7 +6278,8 @@ components: indicatieGebruiksrecht: type: boolean nullable: true - description: Indicatie of er beperkingen gelden aangaande het gebruik van + description: + Indicatie of er beperkingen gelden aangaande het gebruik van het informatieobject anders dan raadpleging. Dit veld mag `null` zijn om aan te geven dat de indicatie nog niet bekend is. Als de indicatie gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen @@ -5849,28 +6287,31 @@ components: title: indicatie gebruiksrecht verschijningsvorm: type: string - description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT." title: verschijningsvorm ondertekening: allOf: - - $ref: '#/components/schemas/OndertekeningRequest' + - $ref: '#/components/schemas/OndertekeningRequest' nullable: true - description: Aanduiding van de rechtskracht van een informatieobject. Mag + description: + Aanduiding van de rechtskracht van een informatieobject. Mag niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' of 'ter vaststelling' heeft. title: ondertekening integriteit: allOf: - - $ref: '#/components/schemas/IntegriteitRequest' + - $ref: '#/components/schemas/IntegriteitRequest' nullable: true - description: Uitdrukking van mate van volledigheid en onbeschadigd zijn + description: + Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri minLength: 1 - description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi + description: + URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 @@ -5884,38 +6325,43 @@ components: description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden required: - - auteur - - bronorganisatie - - creatiedatum - - informatieobjecttype - - taal - - titel + - auteur + - bronorganisatie + - creatiedatum + - informatieobjecttype + - taal + - titel EnkelvoudigInformatieObjectWithLock: type: object - description: |- - This serializer class is used by EnkelvoudigInformatieObjectViewSet for - update and partial_update operations + description: + 'This serializer class is used by EnkelvoudigInformatieObjectViewSet + for + + update and partial_update operations' properties: url: type: string format: uri readOnly: true title: url - description: URL-referentie naar dit object. Dit is de unieke identificatie + description: + URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 identificatie: type: string - description: Een binnen een gegeven context ondubbelzinnige referentie naar + description: + Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string - description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste - in een samenwerkingsketen heeft vastgelegd. + description: + "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ + \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ + \ eerste in een samenwerkingsketen heeft vastgelegd." title: bronorganisatie maxLength: 9 creatiedatum: @@ -5929,53 +6375,78 @@ components: title: titel maxLength: 200 vertrouwelijkheidaanduiding: - description: |- - Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is. + description: + 'Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + Uitleg bij mogelijke waarden: + * `openbaar` - Openbaar + * `beperkt_openbaar` - Beperkt openbaar + * `intern` - Intern + * `zaakvertrouwelijk` - Zaakvertrouwelijk + * `vertrouwelijk` - Vertrouwelijk + * `confidentieel` - Confidentieel + * `geheim` - Geheim - * `zeer_geheim` - Zeer geheim + + * `zeer_geheim` - Zeer geheim' title: vertrouwelijkheidaanduiding oneOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' auteur: type: string - description: De persoon of organisatie die in de eerste plaats verantwoordelijk - is voor het creëren van de inhoud van het INFORMATIEOBJECT. + description: + "De persoon of organisatie die in de eerste plaats verantwoordelijk\ + \ is voor het cre\xEBren van de inhoud van het INFORMATIEOBJECT." title: auteur maxLength: 200 status: - description: |- - Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. + description: + "Aanduiding van de stand van zaken van een INFORMATIEOBJECT. + De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als + het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + Uitleg bij mogelijke waarden: + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar + moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand + vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar + gemaakt; een gearchiveerd informatie-element." title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' formaat: type: string - description: 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + description: + 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml' title: formaat maxLength: 255 taal: type: string - description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + description: + 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 @@ -5983,19 +6454,22 @@ components: versie: type: integer readOnly: true - description: Het (automatische) versienummer van het INFORMATIEOBJECT. Deze + description: + Het (automatische) versienummer van het INFORMATIEOBJECT. Deze begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. title: versie beginRegistratie: type: string format: date-time readOnly: true - description: Een datumtijd in ISO8601 formaat waarop deze versie van het + description: + Een datumtijd in ISO8601 formaat waarop deze versie van het INFORMATIEOBJECT is aangemaakt of gewijzigd. title: begin registratie bestandsnaam: type: string - description: De naam van het fysieke bestand waarin de inhoud van het informatieobject + description: + De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 @@ -6016,7 +6490,8 @@ components: link: type: string format: uri - description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen + description: + De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 @@ -6029,7 +6504,8 @@ components: type: string format: date nullable: true - description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: + "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te\ \ registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende\ \ organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden\ @@ -6041,7 +6517,8 @@ components: type: string format: date nullable: true - description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: + "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op\ \ het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als\ \ uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk\ @@ -6053,7 +6530,8 @@ components: indicatieGebruiksrecht: type: boolean nullable: true - description: Indicatie of er beperkingen gelden aangaande het gebruik van + description: + Indicatie of er beperkingen gelden aangaande het gebruik van het informatieobject anders dan raadpleging. Dit veld mag `null` zijn om aan te geven dat de indicatie nog niet bekend is. Als de indicatie gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen @@ -6061,34 +6539,38 @@ components: title: indicatie gebruiksrecht verschijningsvorm: type: string - description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT." title: verschijningsvorm ondertekening: allOf: - - $ref: '#/components/schemas/Ondertekening' + - $ref: '#/components/schemas/Ondertekening' nullable: true - description: Aanduiding van de rechtskracht van een informatieobject. Mag + description: + Aanduiding van de rechtskracht van een informatieobject. Mag niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' of 'ter vaststelling' heeft. title: ondertekening integriteit: allOf: - - $ref: '#/components/schemas/Integriteit' + - $ref: '#/components/schemas/Integriteit' nullable: true - description: Uitdrukking van mate van volledigheid en onbeschadigd zijn + description: + Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri - description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi + description: + URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 locked: type: boolean readOnly: true - description: Geeft aan of het document gelocked is. Alleen als een document + description: + Geeft aan of het document gelocked is. Alleen als een document gelocked is, mogen er aanpassingen gemaakt worden. title: locked bestandsdelen: @@ -6106,35 +6588,39 @@ components: description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden required: - - auteur - - beginRegistratie - - bestandsdelen - - bronorganisatie - - creatiedatum - - informatieobjecttype - - locked - - taal - - titel - - url - - versie + - auteur + - beginRegistratie + - bestandsdelen + - bronorganisatie + - creatiedatum + - informatieobjecttype + - locked + - taal + - titel + - url + - versie EnkelvoudigInformatieObjectWithLockRequest: type: object - description: |- - This serializer class is used by EnkelvoudigInformatieObjectViewSet for - update and partial_update operations + description: + 'This serializer class is used by EnkelvoudigInformatieObjectViewSet + for + + update and partial_update operations' properties: identificatie: type: string - description: Een binnen een gegeven context ondubbelzinnige referentie naar + description: + Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string minLength: 1 - description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste - in een samenwerkingsketen heeft vastgelegd. + description: + "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ + \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ + \ eerste in een samenwerkingsketen heeft vastgelegd." title: bronorganisatie maxLength: 9 creatiedatum: @@ -6149,47 +6635,71 @@ components: title: titel maxLength: 200 vertrouwelijkheidaanduiding: - description: |- - Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is. + description: + 'Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + Uitleg bij mogelijke waarden: + * `openbaar` - Openbaar + * `beperkt_openbaar` - Beperkt openbaar + * `intern` - Intern + * `zaakvertrouwelijk` - Zaakvertrouwelijk + * `vertrouwelijk` - Vertrouwelijk + * `confidentieel` - Confidentieel + * `geheim` - Geheim - * `zeer_geheim` - Zeer geheim + + * `zeer_geheim` - Zeer geheim' title: vertrouwelijkheidaanduiding oneOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' auteur: type: string minLength: 1 - description: De persoon of organisatie die in de eerste plaats verantwoordelijk - is voor het creëren van de inhoud van het INFORMATIEOBJECT. + description: + "De persoon of organisatie die in de eerste plaats verantwoordelijk\ + \ is voor het cre\xEBren van de inhoud van het INFORMATIEOBJECT." title: auteur maxLength: 200 status: - description: |- - Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. + description: + "Aanduiding van de stand van zaken van een INFORMATIEOBJECT. + De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als + het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + Uitleg bij mogelijke waarden: + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar + moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand + vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar + gemaakt; een gearchiveerd informatie-element." title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' formaat: type: string - description: 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + description: + 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml' title: formaat @@ -6197,20 +6707,22 @@ components: taal: type: string minLength: 3 - description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + description: + 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 bestandsnaam: type: string - description: De naam van het fysieke bestand waarin de inhoud van het informatieobject + description: + De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 inhoud: type: string format: byte - description: Binaire inhoud, in base64 geëncodeerd. + description: "Binaire inhoud, in base64 ge\xEBncodeerd." nullable: true title: inhoud bestandsomvang: @@ -6224,7 +6736,8 @@ components: link: type: string format: uri - description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen + description: + De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 @@ -6237,7 +6750,8 @@ components: type: string format: date nullable: true - description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: + "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te\ \ registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende\ \ organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden\ @@ -6249,7 +6763,8 @@ components: type: string format: date nullable: true - description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: + "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op\ \ het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als\ \ uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk\ @@ -6261,7 +6776,8 @@ components: indicatieGebruiksrecht: type: boolean nullable: true - description: Indicatie of er beperkingen gelden aangaande het gebruik van + description: + Indicatie of er beperkingen gelden aangaande het gebruik van het informatieobject anders dan raadpleging. Dit veld mag `null` zijn om aan te geven dat de indicatie nog niet bekend is. Als de indicatie gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen @@ -6269,28 +6785,31 @@ components: title: indicatie gebruiksrecht verschijningsvorm: type: string - description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT." title: verschijningsvorm ondertekening: allOf: - - $ref: '#/components/schemas/OndertekeningRequest' + - $ref: '#/components/schemas/OndertekeningRequest' nullable: true - description: Aanduiding van de rechtskracht van een informatieobject. Mag + description: + Aanduiding van de rechtskracht van een informatieobject. Mag niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' of 'ter vaststelling' heeft. title: ondertekening integriteit: allOf: - - $ref: '#/components/schemas/IntegriteitRequest' + - $ref: '#/components/schemas/IntegriteitRequest' nullable: true - description: Uitdrukking van mate van volledigheid en onbeschadigd zijn + description: + Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri minLength: 1 - description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi + description: + URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 @@ -6307,18 +6826,19 @@ components: type: string writeOnly: true minLength: 1 - description: Tijdens het updaten van een document (PATCH, PUT) moet het + description: + Tijdens het updaten van een document (PATCH, PUT) moet het `lock` veld opgegeven worden. Bij het aanmaken (POST) mag het geen waarde hebben. title: lock required: - - auteur - - bronorganisatie - - creatiedatum - - informatieobjecttype - - lock - - taal - - titel + - auteur + - bronorganisatie + - creatiedatum + - informatieobjecttype + - lock + - taal + - titel FieldValidationError: type: object description: Formaat van validatiefouten. @@ -6336,9 +6856,9 @@ components: description: Uitleg wat er precies fout is met de gegevens title: reason required: - - code - - name - - reason + - code + - name + - reason Fout: type: object description: Formaat van HTTP 4xx en 5xx fouten. @@ -6365,15 +6885,16 @@ components: title: detail instance: type: string - description: URI met referentie naar dit specifiek voorkomen van de fout. + description: + URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. title: instance required: - - code - - detail - - instance - - status - - title + - code + - detail + - instance + - status + - title Gebruiksrechten: type: object properties: @@ -6382,7 +6903,8 @@ components: format: uri readOnly: true title: url - description: URL-referentie naar dit object. Dit is de unieke identificatie + description: + URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 @@ -6394,7 +6916,8 @@ components: startdatum: type: string format: date-time - description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden + description: + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject de startdatum. title: startdatum @@ -6403,18 +6926,20 @@ components: format: date-time nullable: true title: Startdatum - description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden + description: + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. omschrijvingVoorwaarden: type: string - description: Omschrijving van de van toepassing zijnde voorwaarden aan het + description: + Omschrijving van de van toepassing zijnde voorwaarden aan het gebruik anders dan raadpleging title: omschrijving voorwaarden required: - - informatieobject - - omschrijvingVoorwaarden - - startdatum - - url + - informatieobject + - omschrijvingVoorwaarden + - startdatum + - url GebruiksrechtenRequest: type: object properties: @@ -6426,7 +6951,8 @@ components: startdatum: type: string format: date-time - description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden + description: + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject de startdatum. title: startdatum @@ -6435,44 +6961,61 @@ components: format: date-time nullable: true title: Startdatum - description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden + description: + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. omschrijvingVoorwaarden: type: string minLength: 1 - description: Omschrijving van de van toepassing zijnde voorwaarden aan het + description: + Omschrijving van de van toepassing zijnde voorwaarden aan het gebruik anders dan raadpleging title: omschrijving voorwaarden required: - - informatieobject - - omschrijvingVoorwaarden - - startdatum + - informatieobject + - omschrijvingVoorwaarden + - startdatum Integriteit: type: object - description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van + description: + Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. properties: algoritme: allOf: - - $ref: '#/components/schemas/AlgoritmeEnum' - description: |- - Aanduiding van algoritme, gebruikt om de checksum te maken. + - $ref: '#/components/schemas/AlgoritmeEnum' + description: + 'Aanduiding van algoritme, gebruikt om de checksum te maken. + Uitleg bij mogelijke waarden: + * `crc_16` - CRC-16 + * `crc_32` - CRC-32 + * `crc_64` - CRC-64 + * `fletcher_4` - Fletcher-4 + * `fletcher_8` - Fletcher-8 + * `fletcher_16` - Fletcher-16 + * `fletcher_32` - Fletcher-32 + * `hmac` - HMAC + * `md5` - MD5 + * `sha_1` - SHA-1 + * `sha_256` - SHA-256 + * `sha_512` - SHA-512 - * `sha_3` - SHA-3 + + * `sha_3` - SHA-3' title: integriteit algoritme waarde: type: string @@ -6485,36 +7028,51 @@ components: description: Datum waarop de checksum is gemaakt. title: integriteit datum required: - - algoritme - - datum - - waarde + - algoritme + - datum + - waarde nullable: true IntegriteitRequest: type: object - description: Uitdrukking van mate van volledigheid en onbeschadigd zijn van + description: + Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. properties: algoritme: allOf: - - $ref: '#/components/schemas/AlgoritmeEnum' - description: |- - Aanduiding van algoritme, gebruikt om de checksum te maken. + - $ref: '#/components/schemas/AlgoritmeEnum' + description: + 'Aanduiding van algoritme, gebruikt om de checksum te maken. + Uitleg bij mogelijke waarden: + * `crc_16` - CRC-16 + * `crc_32` - CRC-32 + * `crc_64` - CRC-64 + * `fletcher_4` - Fletcher-4 + * `fletcher_8` - Fletcher-8 + * `fletcher_16` - Fletcher-16 + * `fletcher_32` - Fletcher-32 + * `hmac` - HMAC + * `md5` - MD5 + * `sha_1` - SHA-1 + * `sha_256` - SHA-256 + * `sha_512` - SHA-512 - * `sha_3` - SHA-3 + + * `sha_3` - SHA-3' title: integriteit algoritme waarde: type: string @@ -6528,15 +7086,16 @@ components: description: Datum waarop de checksum is gemaakt. title: integriteit datum required: - - algoritme - - datum - - waarde + - algoritme + - datum + - waarde nullable: true LockEnkelvoudigInformatieObject: type: object - description: |- - Serializer for the lock action of EnkelvoudigInformatieObjectCanonical - model + description: + 'Serializer for the lock action of EnkelvoudigInformatieObjectCanonical + + model' properties: lock: type: string @@ -6544,7 +7103,7 @@ components: description: Hash string, wordt gebruikt als ID voor de lock title: lock required: - - lock + - lock ObjectInformatieObject: type: object properties: @@ -6553,7 +7112,8 @@ components: format: uri readOnly: true title: url - description: URL-referentie naar dit object. Dit is de unieke identificatie + description: + URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 @@ -6565,26 +7125,29 @@ components: object: type: string format: uri - description: URL-referentie naar het gerelateerde OBJECT (in deze of een + description: + URL-referentie naar het gerelateerde OBJECT (in deze of een andere API). title: object maxLength: 1000 objectType: allOf: - - $ref: '#/components/schemas/ObjectTypeEnum' + - $ref: '#/components/schemas/ObjectTypeEnum' title: Objecttype - description: |- - Het type van het gerelateerde OBJECT. + description: 'Het type van het gerelateerde OBJECT. + Uitleg bij mogelijke waarden: + * `besluit` - Besluit - * `zaak` - Zaak + + * `zaak` - Zaak' required: - - informatieobject - - object - - objectType - - url + - informatieobject + - object + - objectType + - url ObjectInformatieObjectRequest: type: object properties: @@ -6597,86 +7160,101 @@ components: type: string format: uri minLength: 1 - description: URL-referentie naar het gerelateerde OBJECT (in deze of een + description: + URL-referentie naar het gerelateerde OBJECT (in deze of een andere API). title: object maxLength: 1000 objectType: allOf: - - $ref: '#/components/schemas/ObjectTypeEnum' + - $ref: '#/components/schemas/ObjectTypeEnum' title: Objecttype - description: |- - Het type van het gerelateerde OBJECT. + description: 'Het type van het gerelateerde OBJECT. + Uitleg bij mogelijke waarden: + * `besluit` - Besluit - * `zaak` - Zaak + + * `zaak` - Zaak' required: - - informatieobject - - object - - objectType + - informatieobject + - object + - objectType ObjectTypeEnum: enum: - - besluit - - zaak - - verzoek + - besluit + - zaak + - verzoek type: string Ondertekening: type: object - description: Aanduiding van de rechtskracht van een informatieobject. Mag niet + description: + Aanduiding van de rechtskracht van een informatieobject. Mag niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' of 'ter vaststelling' heeft. properties: soort: allOf: - - $ref: '#/components/schemas/SoortEnum' + - $ref: '#/components/schemas/SoortEnum' title: Ondertekeningsoort - description: |- - Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT + description: + 'Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT + Uitleg bij mogelijke waarden: + * `analoog` - Analoog + * `digitaal` - Digitaal - * `pki` - PKI + + * `pki` - PKI' datum: type: string format: date title: Ondertekeningdatum - description: De datum waarop de ondertekening van het INFORMATIEOBJECT heeft + description: + De datum waarop de ondertekening van het INFORMATIEOBJECT heeft plaatsgevonden. required: - - datum - - soort + - datum + - soort nullable: true OndertekeningRequest: type: object - description: Aanduiding van de rechtskracht van een informatieobject. Mag niet + description: + Aanduiding van de rechtskracht van een informatieobject. Mag niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' of 'ter vaststelling' heeft. properties: soort: allOf: - - $ref: '#/components/schemas/SoortEnum' + - $ref: '#/components/schemas/SoortEnum' title: Ondertekeningsoort - description: |- - Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT + description: + 'Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT + Uitleg bij mogelijke waarden: + * `analoog` - Analoog + * `digitaal` - Digitaal - * `pki` - PKI + + * `pki` - PKI' datum: type: string format: date title: Ondertekeningdatum - description: De datum waarop de ondertekening van het INFORMATIEOBJECT heeft + description: + De datum waarop de ondertekening van het INFORMATIEOBJECT heeft plaatsgevonden. required: - - datum - - soort + - datum + - soort nullable: true PaginatedEnkelvoudigInformatieObjectList: type: object @@ -6720,22 +7298,26 @@ components: $ref: '#/components/schemas/Verzending' PatchedEnkelvoudigInformatieObjectWithLockRequest: type: object - description: |- - This serializer class is used by EnkelvoudigInformatieObjectViewSet for - update and partial_update operations + description: + 'This serializer class is used by EnkelvoudigInformatieObjectViewSet + for + + update and partial_update operations' properties: identificatie: type: string - description: Een binnen een gegeven context ondubbelzinnige referentie naar + description: + Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string minLength: 1 - description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste - in een samenwerkingsketen heeft vastgelegd. + description: + "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ + \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ + \ eerste in een samenwerkingsketen heeft vastgelegd." title: bronorganisatie maxLength: 9 creatiedatum: @@ -6750,47 +7332,71 @@ components: title: titel maxLength: 200 vertrouwelijkheidaanduiding: - description: |- - Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is. + description: + 'Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + Uitleg bij mogelijke waarden: + * `openbaar` - Openbaar + * `beperkt_openbaar` - Beperkt openbaar + * `intern` - Intern + * `zaakvertrouwelijk` - Zaakvertrouwelijk + * `vertrouwelijk` - Vertrouwelijk + * `confidentieel` - Confidentieel + * `geheim` - Geheim - * `zeer_geheim` - Zeer geheim + + * `zeer_geheim` - Zeer geheim' title: vertrouwelijkheidaanduiding oneOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' auteur: type: string minLength: 1 - description: De persoon of organisatie die in de eerste plaats verantwoordelijk - is voor het creëren van de inhoud van het INFORMATIEOBJECT. + description: + "De persoon of organisatie die in de eerste plaats verantwoordelijk\ + \ is voor het cre\xEBren van de inhoud van het INFORMATIEOBJECT." title: auteur maxLength: 200 status: - description: |- - Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. + description: + "Aanduiding van de stand van zaken van een INFORMATIEOBJECT. + De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als + het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + Uitleg bij mogelijke waarden: + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar + moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand + vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar + gemaakt; een gearchiveerd informatie-element." title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' formaat: type: string - description: 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + description: + 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml' title: formaat @@ -6798,20 +7404,22 @@ components: taal: type: string minLength: 3 - description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + description: + 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 bestandsnaam: type: string - description: De naam van het fysieke bestand waarin de inhoud van het informatieobject + description: + De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 inhoud: type: string format: byte - description: Binaire inhoud, in base64 geëncodeerd. + description: "Binaire inhoud, in base64 ge\xEBncodeerd." nullable: true title: inhoud bestandsomvang: @@ -6825,7 +7433,8 @@ components: link: type: string format: uri - description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen + description: + De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 @@ -6838,7 +7447,8 @@ components: type: string format: date nullable: true - description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: + "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te\ \ registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende\ \ organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden\ @@ -6850,7 +7460,8 @@ components: type: string format: date nullable: true - description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: + "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op\ \ het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als\ \ uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk\ @@ -6862,7 +7473,8 @@ components: indicatieGebruiksrecht: type: boolean nullable: true - description: Indicatie of er beperkingen gelden aangaande het gebruik van + description: + Indicatie of er beperkingen gelden aangaande het gebruik van het informatieobject anders dan raadpleging. Dit veld mag `null` zijn om aan te geven dat de indicatie nog niet bekend is. Als de indicatie gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen @@ -6870,28 +7482,31 @@ components: title: indicatie gebruiksrecht verschijningsvorm: type: string - description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT." title: verschijningsvorm ondertekening: allOf: - - $ref: '#/components/schemas/OndertekeningRequest' + - $ref: '#/components/schemas/OndertekeningRequest' nullable: true - description: Aanduiding van de rechtskracht van een informatieobject. Mag + description: + Aanduiding van de rechtskracht van een informatieobject. Mag niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' of 'ter vaststelling' heeft. title: ondertekening integriteit: allOf: - - $ref: '#/components/schemas/IntegriteitRequest' + - $ref: '#/components/schemas/IntegriteitRequest' nullable: true - description: Uitdrukking van mate van volledigheid en onbeschadigd zijn + description: + Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri minLength: 1 - description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi + description: + URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 @@ -6908,7 +7523,8 @@ components: type: string writeOnly: true minLength: 1 - description: Tijdens het updaten van een document (PATCH, PUT) moet het + description: + Tijdens het updaten van een document (PATCH, PUT) moet het `lock` veld opgegeven worden. Bij het aanmaken (POST) mag het geen waarde hebben. title: lock @@ -6923,7 +7539,8 @@ components: startdatum: type: string format: date-time - description: Begindatum van de periode waarin de gebruiksrechtvoorwaarden + description: + Begindatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject de startdatum. title: startdatum @@ -6932,39 +7549,44 @@ components: format: date-time nullable: true title: Startdatum - description: Einddatum van de periode waarin de gebruiksrechtvoorwaarden + description: + Einddatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. omschrijvingVoorwaarden: type: string minLength: 1 - description: Omschrijving van de van toepassing zijnde voorwaarden aan het + description: + Omschrijving van de van toepassing zijnde voorwaarden aan het gebruik anders dan raadpleging title: omschrijving voorwaarden PatchedVerzendingRequest: type: object - description: |- - Set gegevensgroepdata from validated nested data. + description: 'Set gegevensgroepdata from validated nested data. - Usage: include the mixin on the ModelSerializer that has gegevensgroepen. + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' properties: betrokkene: type: string format: uri minLength: 1 - description: URL-referentie naar de betrokkene waarvan het informatieobject + description: + URL-referentie naar de betrokkene waarvan het informatieobject is ontvangen of waaraan dit is verzonden. title: betrokkene maxLength: 200 informatieobject: type: string format: uri - description: URL-referentie naar het informatieobject dat is ontvangen of + description: + URL-referentie naar het informatieobject dat is ontvangen of verzonden. title: informatieobject aardRelatie: allOf: - - $ref: '#/components/schemas/AardRelatieEnum' - description: Omschrijving van de aard van de relatie van de BETROKKENE tot + - $ref: '#/components/schemas/AardRelatieEnum' + description: + Omschrijving van de aard van de relatie van de BETROKKENE tot het INFORMATIEOBJECT. title: aard relatie toelichting: @@ -6976,7 +7598,8 @@ components: type: string format: date nullable: true - description: De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht + description: + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden aan documenten die van of naar andere personen ontvangen of verzonden @@ -6989,7 +7612,8 @@ components: type: string format: date nullable: true - description: De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze + description: + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is voorbehouden aan @@ -7004,38 +7628,43 @@ components: format: uri minLength: 1 title: Contactpersoon - description: URL-referentie naar de persoon die als aanspreekpunt fungeert + description: + URL-referentie naar de persoon die als aanspreekpunt fungeert voor de BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. maxLength: 1000 contactpersoonnaam: type: string - description: De opgemaakte naam van de persoon die als aanspreekpunt fungeert + description: + De opgemaakte naam van de persoon die als aanspreekpunt fungeert voorde BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. title: contactpersoonnaam maxLength: 40 binnenlandsCorrespondentieadres: allOf: - - $ref: '#/components/schemas/BinnenlandsCorrespondentieadresVerzendingRequest' + - $ref: '#/components/schemas/BinnenlandsCorrespondentieadresVerzendingRequest' nullable: true - description: Het correspondentieadres, betreffende een adresseerbaar object, + description: + Het correspondentieadres, betreffende een adresseerbaar object, van de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van het reguliere binnenlandse correspondentieadres van BETROKKENE. title: binnenlandsCorrespondentieadres buitenlandsCorrespondentieadres: allOf: - - $ref: '#/components/schemas/BuitenlandsCorrespondentieadresVerzendingRequest' + - $ref: '#/components/schemas/BuitenlandsCorrespondentieadresVerzendingRequest' nullable: true - description: De gegevens van het adres in het buitenland van BETROKKENE, + description: + De gegevens van het adres in het buitenland van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. title: buitenlandsCorrespondentieadres correspondentiePostadres: allOf: - - $ref: '#/components/schemas/BuitenlandsCorrespondentiepostadresVerzendingRequest' + - $ref: '#/components/schemas/BuitenlandsCorrespondentiepostadresVerzendingRequest' nullable: true - description: De gegevens die tezamen een postbusadres of antwoordnummeradres + description: + De gegevens die tezamen een postbusadres of antwoordnummeradres vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. @@ -7054,7 +7683,8 @@ components: maxLength: 100 mijnOverheid: type: boolean - description: is het informatieobject verzonden via mijnOverheid naar de + description: + is het informatieobject verzonden via mijnOverheid naar de ontvanger. title: mijn overheid telefoonnummer: @@ -7065,8 +7695,8 @@ components: maxLength: 15 PostadresTypeEnum: enum: - - antwoordnummer - - postbusnummer + - antwoordnummer + - postbusnummer type: string SchemaBestandsDeel: type: object @@ -7076,7 +7706,8 @@ components: format: uri readOnly: true title: url - description: URL-referentie naar dit object. Dit is de unieke identificatie + description: + URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 @@ -7093,7 +7724,8 @@ components: voltooid: type: boolean readOnly: true - description: 'Indicatie of dit bestandsdeel volledig is geupload. Dat wil + description: + 'Indicatie of dit bestandsdeel volledig is geupload. Dat wil zeggen: het aantal bytes dat staat genoemd bij grootte is daadwerkelijk ontvangen.' title: voltooid @@ -7102,11 +7734,11 @@ components: description: Hash string, which represents id of the lock of related informatieobject title: lock required: - - lock - - omvang - - url - - volgnummer - - voltooid + - lock + - omvang + - url + - volgnummer + - voltooid SchemaEIO: type: object description: Serializer for the EnkelvoudigInformatieObject model @@ -7116,21 +7748,24 @@ components: format: uri readOnly: true title: url - description: URL-referentie naar dit object. Dit is de unieke identificatie + description: + URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 identificatie: type: string - description: Een binnen een gegeven context ondubbelzinnige referentie naar + description: + Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT. title: identificatie maxLength: 40 bronorganisatie: type: string - description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie - die het informatieobject heeft gecreëerd of heeft ontvangen en als eerste - in een samenwerkingsketen heeft vastgelegd. + description: + "Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie\ + \ die het informatieobject heeft gecre\xEBerd of heeft ontvangen en als\ + \ eerste in een samenwerkingsketen heeft vastgelegd." title: bronorganisatie maxLength: 9 creatiedatum: @@ -7144,53 +7779,78 @@ components: title: titel maxLength: 200 vertrouwelijkheidaanduiding: - description: |- - Aanduiding van de mate waarin het INFORMATIEOBJECT voor de openbaarheid bestemd is. + description: + 'Aanduiding van de mate waarin het INFORMATIEOBJECT voor de + openbaarheid bestemd is. + Uitleg bij mogelijke waarden: + * `openbaar` - Openbaar + * `beperkt_openbaar` - Beperkt openbaar + * `intern` - Intern + * `zaakvertrouwelijk` - Zaakvertrouwelijk + * `vertrouwelijk` - Vertrouwelijk + * `confidentieel` - Confidentieel + * `geheim` - Geheim - * `zeer_geheim` - Zeer geheim + + * `zeer_geheim` - Zeer geheim' title: vertrouwelijkheidaanduiding oneOf: - - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/VertrouwelijkheidaanduidingEnum' + - $ref: '#/components/schemas/BlankEnum' auteur: type: string - description: De persoon of organisatie die in de eerste plaats verantwoordelijk - is voor het creëren van de inhoud van het INFORMATIEOBJECT. + description: + "De persoon of organisatie die in de eerste plaats verantwoordelijk\ + \ is voor het cre\xEBren van de inhoud van het INFORMATIEOBJECT." title: auteur maxLength: 200 status: - description: |- - Aanduiding van de stand van zaken van een INFORMATIEOBJECT. De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van de Status in 'gearchiveerd' impliceert dat het informatieobject een duurzaam, niet-wijzigbaar Formaat dient te hebben. + description: + "Aanduiding van de stand van zaken van een INFORMATIEOBJECT. + De waarden 'in bewerking' en 'ter vaststelling' komen niet voor als + het attribuut `ontvangstdatum` van een waarde is voorzien. Wijziging van + de Status in 'gearchiveerd' impliceert dat het informatieobject een + duurzaam, niet-wijzigbaar Formaat dient te hebben. + Uitleg bij mogelijke waarden: + * `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt. - * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden. - * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen. - * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element. + + * `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar + moet nog vastgesteld worden. + + * `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand + vastgesteld dan wel ontvangen. + + * `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar + gemaakt; een gearchiveerd informatie-element." title: status oneOf: - - $ref: '#/components/schemas/StatusEnum' - - $ref: '#/components/schemas/BlankEnum' + - $ref: '#/components/schemas/StatusEnum' + - $ref: '#/components/schemas/BlankEnum' formaat: type: string - description: 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde + description: + 'Het "Media Type" (voorheen "MIME type") voor de wijze waaropde inhoud van het INFORMATIEOBJECT is vastgelegd in een computerbestand. Voorbeeld: `application/msword`. Zie: https://www.iana.org/assignments/media-types/media-types.xhtml' title: formaat maxLength: 255 taal: type: string - description: 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT + description: + 'Een ISO 639-2/B taalcode waarin de inhoud van het INFORMATIEOBJECT is vastgelegd. Voorbeeld: `dut`. Zie: https://www.iso.org/standard/4767.html' title: taal maxLength: 3 @@ -7198,19 +7858,22 @@ components: versie: type: integer readOnly: true - description: Het (automatische) versienummer van het INFORMATIEOBJECT. Deze + description: + Het (automatische) versienummer van het INFORMATIEOBJECT. Deze begint bij 1 als het INFORMATIEOBJECT aangemaakt wordt. title: versie beginRegistratie: type: string format: date-time readOnly: true - description: Een datumtijd in ISO8601 formaat waarop deze versie van het + description: + Een datumtijd in ISO8601 formaat waarop deze versie van het INFORMATIEOBJECT is aangemaakt of gewijzigd. title: begin registratie bestandsnaam: type: string - description: De naam van het fysieke bestand waarin de inhoud van het informatieobject + description: + De naam van het fysieke bestand waarin de inhoud van het informatieobject is vastgelegd, inclusief extensie. title: bestandsnaam maxLength: 255 @@ -7231,7 +7894,8 @@ components: link: type: string format: uri - description: De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen + description: + De URL waarmee de inhoud van het INFORMATIEOBJECT op te vragen is. title: link maxLength: 200 @@ -7244,7 +7908,8 @@ components: type: string format: date nullable: true - description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: + "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te\ \ registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende\ \ organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden\ @@ -7256,7 +7921,8 @@ components: type: string format: date nullable: true - description: "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ + description: + "**DEPRECATED** Dit attribuut is verplaatst naar resource Verzending.\ \ \n\n De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op\ \ het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als\ \ uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk\ @@ -7268,7 +7934,8 @@ components: indicatieGebruiksrecht: type: boolean nullable: true - description: Indicatie of er beperkingen gelden aangaande het gebruik van + description: + Indicatie of er beperkingen gelden aangaande het gebruik van het informatieobject anders dan raadpleging. Dit veld mag `null` zijn om aan te geven dat de indicatie nog niet bekend is. Als de indicatie gezet is, dan kan je de gebruiksrechten die van toepassing zijn raadplegen @@ -7276,34 +7943,38 @@ components: title: indicatie gebruiksrecht verschijningsvorm: type: string - description: De essentiële opmaakaspecten van een INFORMATIEOBJECT. + description: "De essenti\xEBle opmaakaspecten van een INFORMATIEOBJECT." title: verschijningsvorm ondertekening: allOf: - - $ref: '#/components/schemas/Ondertekening' + - $ref: '#/components/schemas/Ondertekening' nullable: true - description: Aanduiding van de rechtskracht van een informatieobject. Mag + description: + Aanduiding van de rechtskracht van een informatieobject. Mag niet van een waarde zijn voorzien als de `status` de waarde 'in bewerking' of 'ter vaststelling' heeft. title: ondertekening integriteit: allOf: - - $ref: '#/components/schemas/Integriteit' + - $ref: '#/components/schemas/Integriteit' nullable: true - description: Uitdrukking van mate van volledigheid en onbeschadigd zijn + description: + Uitdrukking van mate van volledigheid en onbeschadigd zijn van digitaal bestand. title: integriteit informatieobjecttype: type: string format: uri - description: URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi + description: + URL-referentie naar het INFORMATIEOBJECTTYPE (in de Catalogi API). title: informatieobjecttype maxLength: 200 locked: type: boolean readOnly: true - description: Geeft aan of het document gelocked is. Alleen als een document + description: + Geeft aan of het document gelocked is. Alleen als een document gelocked is, mogen er aanpassingen gemaakt worden. title: locked bestandsdelen: @@ -7321,35 +7992,36 @@ components: description: Een lijst van trefwoorden gescheiden door comma's. title: trefwoorden required: - - auteur - - beginRegistratie - - bestandsdelen - - bronorganisatie - - creatiedatum - - informatieobjecttype - - locked - - taal - - titel - - url - - versie + - auteur + - beginRegistratie + - bestandsdelen + - bronorganisatie + - creatiedatum + - informatieobjecttype + - locked + - taal + - titel + - url + - versie SoortEnum: enum: - - analoog - - digitaal - - pki + - analoog + - digitaal + - pki type: string StatusEnum: enum: - - in_bewerking - - ter_vaststelling - - definitief - - gearchiveerd + - in_bewerking + - ter_vaststelling + - definitief + - gearchiveerd type: string UnlockEnkelvoudigInformatieObjectRequest: type: object - description: |- - Serializer for the unlock action of EnkelvoudigInformatieObjectCanonical - model + description: + 'Serializer for the unlock action of EnkelvoudigInformatieObjectCanonical + + model' properties: lock: type: string @@ -7382,7 +8054,8 @@ components: title: detail instance: type: string - description: URI met referentie naar dit specifiek voorkomen van de fout. + description: + URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. title: instance invalidParams: @@ -7391,56 +8064,60 @@ components: $ref: '#/components/schemas/FieldValidationError' title: invalidParams required: - - code - - detail - - instance - - invalidParams - - status - - title + - code + - detail + - instance + - invalidParams + - status + - title VertrouwelijkheidaanduidingEnum: enum: - - openbaar - - beperkt_openbaar - - intern - - zaakvertrouwelijk - - vertrouwelijk - - confidentieel - - geheim - - zeer_geheim + - openbaar + - beperkt_openbaar + - intern + - zaakvertrouwelijk + - vertrouwelijk + - confidentieel + - geheim + - zeer_geheim type: string Verzending: type: object - description: |- - Set gegevensgroepdata from validated nested data. + description: 'Set gegevensgroepdata from validated nested data. - Usage: include the mixin on the ModelSerializer that has gegevensgroepen. + + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' properties: url: type: string format: uri readOnly: true title: url - description: URL-referentie naar dit object. Dit is de unieke identificatie + description: + URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 betrokkene: type: string format: uri - description: URL-referentie naar de betrokkene waarvan het informatieobject + description: + URL-referentie naar de betrokkene waarvan het informatieobject is ontvangen of waaraan dit is verzonden. title: betrokkene maxLength: 200 informatieobject: type: string format: uri - description: URL-referentie naar het informatieobject dat is ontvangen of + description: + URL-referentie naar het informatieobject dat is ontvangen of verzonden. title: informatieobject aardRelatie: allOf: - - $ref: '#/components/schemas/AardRelatieEnum' - description: Omschrijving van de aard van de relatie van de BETROKKENE tot + - $ref: '#/components/schemas/AardRelatieEnum' + description: + Omschrijving van de aard van de relatie van de BETROKKENE tot het INFORMATIEOBJECT. title: aard relatie toelichting: @@ -7452,7 +8129,8 @@ components: type: string format: date nullable: true - description: De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht + description: + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden aan documenten die van of naar andere personen ontvangen of verzonden @@ -7465,7 +8143,8 @@ components: type: string format: date nullable: true - description: De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze + description: + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is voorbehouden aan @@ -7479,38 +8158,43 @@ components: type: string format: uri title: Contactpersoon - description: URL-referentie naar de persoon die als aanspreekpunt fungeert + description: + URL-referentie naar de persoon die als aanspreekpunt fungeert voor de BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. maxLength: 1000 contactpersoonnaam: type: string - description: De opgemaakte naam van de persoon die als aanspreekpunt fungeert + description: + De opgemaakte naam van de persoon die als aanspreekpunt fungeert voorde BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. title: contactpersoonnaam maxLength: 40 binnenlandsCorrespondentieadres: allOf: - - $ref: '#/components/schemas/BinnenlandsCorrespondentieadresVerzending' + - $ref: '#/components/schemas/BinnenlandsCorrespondentieadresVerzending' nullable: true - description: Het correspondentieadres, betreffende een adresseerbaar object, + description: + Het correspondentieadres, betreffende een adresseerbaar object, van de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van het reguliere binnenlandse correspondentieadres van BETROKKENE. title: binnenlandsCorrespondentieadres buitenlandsCorrespondentieadres: allOf: - - $ref: '#/components/schemas/BuitenlandsCorrespondentieadresVerzending' + - $ref: '#/components/schemas/BuitenlandsCorrespondentieadresVerzending' nullable: true - description: De gegevens van het adres in het buitenland van BETROKKENE, + description: + De gegevens van het adres in het buitenland van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. title: buitenlandsCorrespondentieadres correspondentiePostadres: allOf: - - $ref: '#/components/schemas/BuitenlandsCorrespondentiepostadresVerzending' + - $ref: '#/components/schemas/BuitenlandsCorrespondentiepostadresVerzending' nullable: true - description: De gegevens die tezamen een postbusadres of antwoordnummeradres + description: + De gegevens die tezamen een postbusadres of antwoordnummeradres vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. @@ -7529,7 +8213,8 @@ components: maxLength: 100 mijnOverheid: type: boolean - description: is het informatieobject verzonden via mijnOverheid naar de + description: + is het informatieobject verzonden via mijnOverheid naar de ontvanger. title: mijn overheid telefoonnummer: @@ -7539,36 +8224,39 @@ components: title: telefoonnummer maxLength: 15 required: - - aardRelatie - - betrokkene - - contactPersoon - - informatieobject - - url + - aardRelatie + - betrokkene + - contactPersoon + - informatieobject + - url VerzendingRequest: type: object - description: |- - Set gegevensgroepdata from validated nested data. + description: 'Set gegevensgroepdata from validated nested data. + - Usage: include the mixin on the ModelSerializer that has gegevensgroepen. + Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' properties: betrokkene: type: string format: uri minLength: 1 - description: URL-referentie naar de betrokkene waarvan het informatieobject + description: + URL-referentie naar de betrokkene waarvan het informatieobject is ontvangen of waaraan dit is verzonden. title: betrokkene maxLength: 200 informatieobject: type: string format: uri - description: URL-referentie naar het informatieobject dat is ontvangen of + description: + URL-referentie naar het informatieobject dat is ontvangen of verzonden. title: informatieobject aardRelatie: allOf: - - $ref: '#/components/schemas/AardRelatieEnum' - description: Omschrijving van de aard van de relatie van de BETROKKENE tot + - $ref: '#/components/schemas/AardRelatieEnum' + description: + Omschrijving van de aard van de relatie van de BETROKKENE tot het INFORMATIEOBJECT. title: aard relatie toelichting: @@ -7580,7 +8268,8 @@ components: type: string format: date nullable: true - description: De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht + description: + De datum waarop het INFORMATIEOBJECT ontvangen is. Verplicht te registreren voor INFORMATIEOBJECTen die van buiten de zaakbehandelende organisatie(s) ontvangen zijn. Ontvangst en verzending is voorbehouden aan documenten die van of naar andere personen ontvangen of verzonden @@ -7593,7 +8282,8 @@ components: type: string format: date nullable: true - description: De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze + description: + De datum waarop het INFORMATIEOBJECT verzonden is, zoals deze op het INFORMATIEOBJECT vermeld is. Dit geldt voor zowel inkomende als uitgaande INFORMATIEOBJECTen. Eenzelfde informatieobject kan niet tegelijk inkomend en uitgaand zijn. Ontvangst en verzending is voorbehouden aan @@ -7608,38 +8298,43 @@ components: format: uri minLength: 1 title: Contactpersoon - description: URL-referentie naar de persoon die als aanspreekpunt fungeert + description: + URL-referentie naar de persoon die als aanspreekpunt fungeert voor de BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. maxLength: 1000 contactpersoonnaam: type: string - description: De opgemaakte naam van de persoon die als aanspreekpunt fungeert + description: + De opgemaakte naam van de persoon die als aanspreekpunt fungeert voorde BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT. title: contactpersoonnaam maxLength: 40 binnenlandsCorrespondentieadres: allOf: - - $ref: '#/components/schemas/BinnenlandsCorrespondentieadresVerzendingRequest' + - $ref: '#/components/schemas/BinnenlandsCorrespondentieadresVerzendingRequest' nullable: true - description: Het correspondentieadres, betreffende een adresseerbaar object, + description: + Het correspondentieadres, betreffende een adresseerbaar object, van de BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT indien dat afwijkt van het reguliere binnenlandse correspondentieadres van BETROKKENE. title: binnenlandsCorrespondentieadres buitenlandsCorrespondentieadres: allOf: - - $ref: '#/components/schemas/BuitenlandsCorrespondentieadresVerzendingRequest' + - $ref: '#/components/schemas/BuitenlandsCorrespondentieadresVerzendingRequest' nullable: true - description: De gegevens van het adres in het buitenland van BETROKKENE, + description: + De gegevens van het adres in het buitenland van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. title: buitenlandsCorrespondentieadres correspondentiePostadres: allOf: - - $ref: '#/components/schemas/BuitenlandsCorrespondentiepostadresVerzendingRequest' + - $ref: '#/components/schemas/BuitenlandsCorrespondentiepostadresVerzendingRequest' nullable: true - description: De gegevens die tezamen een postbusadres of antwoordnummeradres + description: + De gegevens die tezamen een postbusadres of antwoordnummeradres vormen van BETROKKENE, zijnde afzender of geadresseerde, zoals vermeld in het ontvangen of verzonden INFORMATIEOBJECT en dat afwijkt van de reguliere correspondentiegegevens van BETROKKENE. @@ -7658,7 +8353,8 @@ components: maxLength: 100 mijnOverheid: type: boolean - description: is het informatieobject verzonden via mijnOverheid naar de + description: + is het informatieobject verzonden via mijnOverheid naar de ontvanger. title: mijn overheid telefoonnummer: @@ -7668,17 +8364,18 @@ components: title: telefoonnummer maxLength: 15 required: - - aardRelatie - - betrokkene - - contactPersoon - - informatieobject + - aardRelatie + - betrokkene + - contactPersoon + - informatieobject Wijzigingen: type: object properties: oud: type: object additionalProperties: {} - description: Volledige JSON body van het object zoals dat bestond voordat + description: + Volledige JSON body van het object zoals dat bestond voordat de actie heeft plaatsgevonden. title: oud nieuw: @@ -7692,16 +8389,17 @@ components: bearerFormat: JWT scheme: bearer servers: -- url: https://documenten-api.vng.cloud/api/v1 - description: Productie Omgeving + - url: https://documenten-api.vng.cloud/api/v1 + description: Productie Omgeving tags: -- name: enkelvoudiginformatieobjecten - description: Opvragen en bewerken van (ENKELVOUDIG) INFORMATIEOBJECTen (documenten). -- name: gebruiksrechten - description: Opvragen en bewerken van GEBRUIKSRECHTen bij een INFORMATIEOBJECT. -- name: objectinformatieobjecten - description: Opvragen en verwijderen van OBJECT-INFORMATIEOBJECT relaties. Het betreft - een relatie tussen een willekeurig OBJECT, bijvoorbeeld een ZAAK in de Zaken API, - en een INFORMATIEOBJECT. -- name: verzendingen - description: Opvragen en bewerken van VERZENDINGen. + - name: enkelvoudiginformatieobjecten + description: Opvragen en bewerken van (ENKELVOUDIG) INFORMATIEOBJECTen (documenten). + - name: gebruiksrechten + description: Opvragen en bewerken van GEBRUIKSRECHTen bij een INFORMATIEOBJECT. + - name: objectinformatieobjecten + description: + Opvragen en verwijderen van OBJECT-INFORMATIEOBJECT relaties. Het betreft + een relatie tussen een willekeurig OBJECT, bijvoorbeeld een ZAAK in de Zaken API, + en een INFORMATIEOBJECT. + - name: verzendingen + description: Opvragen en bewerken van VERZENDINGen. From 2509bae9c254aca33a3c617929f59212577c79dc Mon Sep 17 00:00:00 2001 From: MatthijsBekendam <47739550+MatthijsBekendam@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:03:38 +0200 Subject: [PATCH 5/7] format (#229) From 0c5a573c8045d7df32a9659ff67960604fda3aaf Mon Sep 17 00:00:00 2001 From: matthijsbekendam Date: Mon, 25 Sep 2023 10:13:25 +0200 Subject: [PATCH 6/7] bumo : version to 1.4.2 --- .bumpversion.cfg | 2 +- CHANGELOG.rst | 7 +++++++ README.rst | 2 +- package.json | 2 +- src/drc/__init__.py | 2 +- src/drc/api/tests/test_dso_api_strategy.py | 2 +- src/drc/conf/api.py | 2 +- src/openapi.yaml | 2 +- 8 files changed, 14 insertions(+), 7 deletions(-) diff --git a/.bumpversion.cfg b/.bumpversion.cfg index 18284411..9f9a4d11 100644 --- a/.bumpversion.cfg +++ b/.bumpversion.cfg @@ -1,7 +1,7 @@ [bumpversion] commit = False tag = False -current_version = 1.4.1 +current_version = 1.4.2 parse = (?P\d+)\.(?P\d+)\.(?P\d+)([-](?P(rc|alpha))+(?P\d+))? serialize = {major}.{minor}.{patch}-{release}{build} diff --git a/CHANGELOG.rst b/CHANGELOG.rst index 13af465b..2958f9e4 100644 --- a/CHANGELOG.rst +++ b/CHANGELOG.rst @@ -1,6 +1,13 @@ =========== Wijzigingen =========== +1.4.2 (2023-09-25) +=========== + +- **Changed:** added expand queryparameter to /zoek +- **Changed:** bestandsdeel serializer to include lock attribute + + 1.4.1 (2023-08-29) =========== diff --git a/README.rst b/README.rst index db60b9dd..3c94fcb1 100644 --- a/README.rst +++ b/README.rst @@ -2,7 +2,7 @@ Documenten API ============== -:Version: 1.4.0 +:Version: 1.4.2 :Source: https://github.com/VNG-Realisatie/documenten-api :Keywords: zaken, zaakgericht werken, GEMMA, RGBZ, DRC diff --git a/package.json b/package.json index 6b311002..b7a4c1dd 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "drc", - "version": "1.4.1", + "version": "1.4.2", "description": "drc referentie implementatie API", "main": "src/index.js", "directories": { diff --git a/src/drc/__init__.py b/src/drc/__init__.py index 17a00d60..1264f0ce 100644 --- a/src/drc/__init__.py +++ b/src/drc/__init__.py @@ -7,7 +7,7 @@ import re from collections import namedtuple -__version__ = "1.4.1" +__version__ = "1.4.2" __author__ = "VNG Realisatie" __homepage__ = "https://github.com/VNG-Realisatie/documenten-api" __docformat__ = "restructuredtext" diff --git a/src/drc/api/tests/test_dso_api_strategy.py b/src/drc/api/tests/test_dso_api_strategy.py index f5f5581e..a5b2a31f 100644 --- a/src/drc/api/tests/test_dso_api_strategy.py +++ b/src/drc/api/tests/test_dso_api_strategy.py @@ -23,7 +23,7 @@ def test_api_19_documentation_version_yaml(self): @override_settings(ROOT_URLCONF="drc.api.tests.test_urls") def test_api_24_version_header(self): response = self.client.get("/test-view") - self.assertEqual(response["API-version"], "1.4.1") + self.assertEqual(response["API-version"], "1.4.2") class DSOApi50Tests(APITestCase): diff --git a/src/drc/conf/api.py b/src/drc/conf/api.py index b2956865..f479616d 100644 --- a/src/drc/conf/api.py +++ b/src/drc/conf/api.py @@ -2,7 +2,7 @@ from vng_api_common.conf.api import * # noqa - imports white-listed -API_VERSION = "1.4.1" +API_VERSION = "1.4.2" REST_FRAMEWORK = BASE_REST_FRAMEWORK.copy() REST_FRAMEWORK["PAGE_SIZE"] = 100 diff --git a/src/openapi.yaml b/src/openapi.yaml index 420c2ed7..97060041 100644 --- a/src/openapi.yaml +++ b/src/openapi.yaml @@ -1,7 +1,7 @@ openapi: 3.0.3 info: title: Documenten API - version: 1.4.1 + version: 1.4.2 description: "Een API om een documentregistratiecomponent (DRC) te benaderen.\n\n\ In een documentregistratiecomponent worden INFORMATIEOBJECTen opgeslagen. Een\n\ From 596e80ed83f8cd2bab51c087fadc73b823b07f6a Mon Sep 17 00:00:00 2001 From: MatthijsBekendam <47739550+MatthijsBekendam@users.noreply.github.com> Date: Mon, 25 Sep 2023 10:30:26 +0200 Subject: [PATCH 7/7] formating (#232) --- src/drc/api/serializers/enkelvoudig_informatieobject.py | 1 - 1 file changed, 1 deletion(-) diff --git a/src/drc/api/serializers/enkelvoudig_informatieobject.py b/src/drc/api/serializers/enkelvoudig_informatieobject.py index 398b856c..4d17de29 100644 --- a/src/drc/api/serializers/enkelvoudig_informatieobject.py +++ b/src/drc/api/serializers/enkelvoudig_informatieobject.py @@ -510,7 +510,6 @@ class EIOZoekSerializer(serializers.Serializer): ) - class SchemaEIOSerializer(EnkelvoudigInformatieObjectSerializer): bestandsdelen = SchemaBestandsDeelSerializer( source="canonical.bestandsdelen", many=True, read_only=True