{
"openapi": "3.0.3",
"info": {
"title": "Documenten API",
"version": "1.5.0",
"description": "Een API om een documentregistratiecomponent (DRC) te benaderen.\n\nIn een documentregistratiecomponent worden INFORMATIEOBJECTen opgeslagen. Een\nINFORMATIEOBJECT 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\nDe typering van INFORMATIEOBJECTen is in de Catalogi API (ZTC) ondergebracht in\nde 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.5.0_\n1. Het optionele attribuut \"inhoudIsVervallen\" is toegevoegd aan de resource `enkelvoudiginformatieobjecten`.\n2. De voorwaarde \"status NIET definitief\" is verwijderd uit de beschrijvingen van de PUT- en PATCH-operatie op `enkelvoudiginformatieobjecten`. Dit is een correctie van een fout in de OAS, want deze voorwaarde was al geschrapt in de aanvullende specificatie van versie 1.4.0.\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ëerd 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"
},
"license": {
"name": "EUPL 1.2",
"url": "https://opensource.org/licenses/EUPL-1.2"
}
},
"paths": {
"/bestandsdelen/{uuid}": {
"put": {
"operationId": "bestandsdeel_update",
"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
}
],
"tags": [
"bestandsdelen"
],
"requestBody": {
"content": {
"multipart/form-data": {
"schema": {
"$ref": "#/components/schemas/BestandsDeelRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/BestandsDeelRequest"
}
}
},
"required": true
},
"security": [
{
"JWT-Claims": [
"documenten.bijwerken"
]
}
],
"responses": {
"200": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/BestandsDeelResponse"
}
}
},
"description": "OK"
},
"400": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidatieFout"
}
}
},
"description": "Bad request"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
}
},
"/enkelvoudiginformatieobjecten": {
"get": {
"operationId": "enkelvoudiginformatieobject_list",
"description": "Deze lijst kan gefilterd wordt met query-string parameters. \nDe 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": "array",
"items": {
"type": "string"
},
"example": [
"bouwtekening",
"vergunning",
"aanvraag"
]
},
"style": "form",
"explode": false
},
{
"name": "expand",
"in": "query",
"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.",
"schema": {
"type": "string",
"example": "informatieobjecttype"
}
},
{
"name": "page",
"required": false,
"in": "query",
"description": "Een pagina binnen de gepagineerde set resultaten.",
"schema": {
"type": "integer"
}
}
],
"tags": [
"enkelvoudiginformatieobjecten"
],
"security": [
{
"JWT-Claims": [
"documenten.lezen"
]
}
],
"responses": {
"200": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedEnkelvoudigInformatieObjectList"
}
}
},
"description": "OK"
},
"400": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidatieFout"
}
}
},
"description": "Bad request"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"post": {
"operationId": "enkelvoudiginformatieobject_create",
"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"
}
],
"tags": [
"enkelvoudiginformatieobjecten"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnkelvoudigInformatieObjectCreateLockRequest"
}
}
},
"required": true
},
"security": [
{
"JWT-Claims": [
"documenten.aanmaken"
]
}
],
"responses": {
"201": {
"headers": {
"Location": {
"schema": {
"type": "string",
"format": "uri"
},
"description": "URL waar de resource leeft."
},
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnkelvoudigInformatieObjectCreateLock"
}
}
},
"description": "Created"
},
"400": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidatieFout"
}
}
},
"description": "Bad request"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
}
},
"/enkelvoudiginformatieobjecten/{enkelvoudiginformatieobject_uuid}/audittrail": {
"get": {
"operationId": "audittrail_list",
"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
}
],
"tags": [
"enkelvoudiginformatieobjecten"
],
"security": [
{
"JWT-Claims": [
"audittrails.lezen"
]
}
],
"responses": {
"200": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/AuditTrail"
}
}
}
},
"description": "OK"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
}
},
"/enkelvoudiginformatieobjecten/{enkelvoudiginformatieobject_uuid}/audittrail/{uuid}": {
"get": {
"operationId": "audittrail_retrieve",
"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
}
],
"tags": [
"enkelvoudiginformatieobjecten"
],
"security": [
{
"JWT-Claims": [
"audittrails.lezen"
]
}
],
"responses": {
"200": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AuditTrail"
}
}
},
"description": "OK"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
}
},
"/enkelvoudiginformatieobjecten/{uuid}": {
"get": {
"operationId": "enkelvoudiginformatieobject_retrieve",
"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."
},
{
"name": "expand",
"in": "query",
"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.",
"schema": {
"type": "string",
"example": "informatieobjecttype"
}
}
],
"tags": [
"enkelvoudiginformatieobjecten"
],
"security": [
{
"JWT-Claims": [
"documenten.lezen"
]
}
],
"responses": {
"200": {
"headers": {
"ETag": {
"schema": {
"type": "string"
},
"description": "De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren."
},
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnkelvoudigInformatieObjectExpanded"
}
}
},
"description": "OK"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"put": {
"operationId": "enkelvoudiginformatieobject_update",
"description": "Dit creëert altijd een nieuwe versie van het (ENKELVOUDIG) INFORMATIEOBJECT. \n \n**Er wordt gevalideerd op**\n- correcte `lock` waarde",
"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"
}
],
"tags": [
"enkelvoudiginformatieobjecten"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnkelvoudigInformatieObjectWithLockRequest"
}
}
},
"required": true
},
"security": [
{
"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 een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnkelvoudigInformatieObjectWithLock"
}
}
},
"description": "OK"
},
"400": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidatieFout"
}
}
},
"description": "Bad request"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"patch": {
"operationId": "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",
"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"
}
],
"tags": [
"enkelvoudiginformatieobjecten"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedEnkelvoudigInformatieObjectWithLockRequest"
}
}
}
},
"security": [
{
"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 een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EnkelvoudigInformatieObjectWithLock"
}
}
},
"description": "OK"
},
"400": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidatieFout"
}
}
},
"description": "Bad request"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"delete": {
"operationId": "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.\n\n**Gerelateerde resources**\n- GEBRUIKSRECHTen\n- 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"
}
],
"tags": [
"enkelvoudiginformatieobjecten"
],
"security": [
{
"JWT-Claims": [
"documenten.verwijderen"
]
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"head": {
"operationId": "enkelvoudiginformatieobject_headers",
"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"
}
}
}
],
"tags": [
"enkelvoudiginformatieobjecten"
],
"responses": {
"200": {
"headers": {
"ETag": {
"schema": {
"type": "string"
},
"description": "De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren."
},
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"description": "OK"
}
}
}
},
"/enkelvoudiginformatieobjecten/{uuid}/download": {
"get": {
"operationId": "enkelvoudiginformatieobject_download",
"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."
}
],
"tags": [
"enkelvoudiginformatieobjecten"
],
"security": [
{
"JWT-Claims": [
"documenten.lezen"
]
}
],
"responses": {
"200": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/octet-stream": {
"schema": {
"type": "string",
"format": "binary"
}
}
},
"description": "OK"
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"410": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
}
},
"/enkelvoudiginformatieobjecten/{uuid}/lock": {
"post": {
"operationId": "enkelvoudiginformatieobject_lock",
"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
}
],
"tags": [
"enkelvoudiginformatieobjecten"
],
"security": [
{
"JWT-Claims": [
"documenten.lock"
]
}
],
"responses": {
"200": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/LockEnkelvoudigInformatieObject"
}
}
},
"description": "OK"
},
"400": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"410": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
}
},
"/enkelvoudiginformatieobjecten/{uuid}/unlock": {
"post": {
"operationId": "enkelvoudiginformatieobject_unlock",
"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
}
],
"tags": [
"enkelvoudiginformatieobjecten"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/UnlockEnkelvoudigInformatieObjectRequest"
}
}
}
},
"security": [
{
"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 een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"description": "No content"
},
"400": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Bad request"
},
"401": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"410": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
}
},
"/enkelvoudiginformatieobjecten/_zoek": {
"post": {
"operationId": "enkelvoudiginformatieobject__zoek",
"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."
}
],
"tags": [
"enkelvoudiginformatieobjecten"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/EIOZoekRequest"
}
}
},
"required": true
},
"security": [
{
"JWT-Claims": [
"documenten.lezen"
]
}
],
"responses": {
"200": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedEnkelvoudigInformatieObjectList"
}
}
},
"description": "OK"
},
"400": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidatieFout"
}
}
},
"description": "Bad request"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
}
},
"/gebruiksrechten": {
"get": {
"operationId": "gebruiksrechten_list",
"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",
"in": "query",
"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.",
"schema": {
"type": "string",
"example": "informatieobject"
}
}
],
"tags": [
"gebruiksrechten"
],
"security": [
{
"JWT-Claims": [
"documenten.lezen"
]
}
],
"responses": {
"200": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/GebruiksrechtenExpanded"
}
}
}
},
"description": "OK"
},
"400": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidatieFout"
}
}
},
"description": "Bad request"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"post": {
"operationId": "gebruiksrechten_create",
"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"
}
],
"tags": [
"gebruiksrechten"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GebruiksrechtenRequest"
}
}
},
"required": true
},
"security": [
{
"JWT-Claims": [
"documenten.aanmaken"
]
}
],
"responses": {
"201": {
"headers": {
"Location": {
"schema": {
"type": "string",
"format": "uri"
},
"description": "URL waar de resource leeft."
},
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Gebruiksrechten"
}
}
},
"description": "Created"
},
"400": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidatieFout"
}
}
},
"description": "Bad request"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
}
},
"/gebruiksrechten/{uuid}": {
"get": {
"operationId": "gebruiksrechten_retrieve",
"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"
}
}
},
{
"name": "expand",
"in": "query",
"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.",
"schema": {
"type": "string",
"example": "informatieobject"
}
}
],
"tags": [
"gebruiksrechten"
],
"security": [
{
"JWT-Claims": [
"documenten.lezen"
]
}
],
"responses": {
"200": {
"headers": {
"ETag": {
"schema": {
"type": "string"
},
"description": "De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren."
},
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GebruiksrechtenExpanded"
}
}
},
"description": "OK"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"put": {
"operationId": "gebruiksrechten_update",
"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"
}
],
"tags": [
"gebruiksrechten"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/GebruiksrechtenRequest"
}
}
},
"required": true
},
"security": [
{
"JWT-Claims": [
"documenten.bijwerken"
]
}
],
"responses": {
"200": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Gebruiksrechten"
}
}
},
"description": "OK"
},
"400": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidatieFout"
}
}
},
"description": "Bad request"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"patch": {
"operationId": "gebruiksrechten_partial_update",
"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"
}
],
"tags": [
"gebruiksrechten"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedGebruiksrechtenRequest"
}
}
}
},
"security": [
{
"JWT-Claims": [
"documenten.bijwerken"
]
}
],
"responses": {
"200": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Gebruiksrechten"
}
}
},
"description": "OK"
},
"400": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidatieFout"
}
}
},
"description": "Bad request"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"delete": {
"operationId": "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.",
"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"
}
],
"tags": [
"gebruiksrechten"
],
"security": [
{
"JWT-Claims": [
"documenten.verwijderen"
]
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"head": {
"operationId": "gebruiksrechten_headers",
"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"
}
}
}
],
"tags": [
"gebruiksrechten"
],
"responses": {
"200": {
"headers": {
"ETag": {
"schema": {
"type": "string"
},
"description": "De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren."
},
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"description": "OK"
}
}
}
},
"/objectinformatieobjecten": {
"get": {
"operationId": "objectinformatieobject_list",
"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"
}
}
],
"tags": [
"objectinformatieobjecten"
],
"security": [
{
"JWT-Claims": [
"documenten.lezen"
]
}
],
"responses": {
"200": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"$ref": "#/components/schemas/ObjectInformatieObject"
}
}
}
},
"description": "OK"
},
"400": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidatieFout"
}
}
},
"description": "Bad request"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"post": {
"operationId": "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 bij het synchroniseren van relaties. **Er wordt gevalideerd op** - geldigheid `informatieobject` URL - de combinatie `informatieobject` en `object` moet 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
}
],
"tags": [
"objectinformatieobjecten"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectInformatieObjectRequest"
}
}
},
"required": true
},
"security": [
{
"JWT-Claims": [
"documenten.aanmaken"
]
}
],
"responses": {
"201": {
"headers": {
"Location": {
"schema": {
"type": "string",
"format": "uri"
},
"description": "URL waar de resource leeft."
},
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectInformatieObject"
}
}
},
"description": "Created"
},
"400": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidatieFout"
}
}
},
"description": "Bad request"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
}
},
"/objectinformatieobjecten/{uuid}": {
"get": {
"operationId": "objectinformatieobject_retrieve",
"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"
}
}
}
],
"tags": [
"objectinformatieobjecten"
],
"security": [
{
"JWT-Claims": [
"documenten.lezen"
]
}
],
"responses": {
"200": {
"headers": {
"ETag": {
"schema": {
"type": "string"
},
"description": "De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren."
},
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ObjectInformatieObject"
}
}
},
"description": "OK"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"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.",
"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
}
],
"tags": [
"objectinformatieobjecten"
],
"security": [
{
"JWT-Claims": [
"documenten.verwijderen"
]
}
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"head": {
"operationId": "objectinformatieobject_headers",
"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"
}
}
}
],
"tags": [
"objectinformatieobjecten"
],
"responses": {
"200": {
"headers": {
"ETag": {
"schema": {
"type": "string"
},
"description": "De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren."
},
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"description": "OK"
}
}
}
},
"/verzendingen": {
"get": {
"operationId": "verzending_list",
"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",
"in": "query",
"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.",
"schema": {
"type": "string",
"example": "informatieobject"
}
},
{
"name": "page",
"required": false,
"in": "query",
"description": "Een pagina binnen de gepagineerde set resultaten.",
"schema": {
"type": "integer"
}
}
],
"tags": [
"verzendingen"
],
"responses": {
"200": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PaginatedVerzendingList"
}
}
},
"description": "OK"
},
"400": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidatieFout"
}
}
},
"description": "Bad request"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"post": {
"operationId": "verzending_create",
"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
}
],
"tags": [
"verzendingen"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerzendingRequest"
}
}
},
"required": true
},
"responses": {
"201": {
"headers": {
"Location": {
"schema": {
"type": "string",
"format": "uri"
},
"description": "URL waar de resource leeft."
},
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Verzending"
}
}
},
"description": "Created"
},
"400": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidatieFout"
}
}
},
"description": "Bad request"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
}
},
"/verzendingen/{uuid}": {
"get": {
"operationId": "verzending_retrieve",
"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"
}
}
},
{
"name": "expand",
"in": "query",
"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.",
"schema": {
"type": "string",
"example": "informatieobject"
}
}
],
"tags": [
"verzendingen"
],
"responses": {
"200": {
"headers": {
"ETag": {
"schema": {
"type": "string"
},
"description": "De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren."
},
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerzendingExpanded"
}
}
},
"description": "OK"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"put": {
"operationId": "verzending_update",
"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
}
],
"tags": [
"verzendingen"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerzendingRequest"
}
}
},
"required": true
},
"responses": {
"200": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Verzending"
}
}
},
"description": "OK"
},
"400": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidatieFout"
}
}
},
"description": "Bad request"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"patch": {
"operationId": "verzending_partial_update",
"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
}
],
"tags": [
"verzendingen"
],
"requestBody": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/PatchedVerzendingRequest"
}
}
}
},
"responses": {
"200": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Verzending"
}
}
},
"description": "OK"
},
"400": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidatieFout"
}
}
},
"description": "Bad request"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"delete": {
"operationId": "verzending_destroy",
"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
}
],
"tags": [
"verzendingen"
],
"responses": {
"204": {
"description": "No content"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
}
},
"head": {
"operationId": "verzending_headers",
"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"
}
}
}
],
"tags": [
"verzendingen"
],
"responses": {
"200": {
"headers": {
"ETag": {
"schema": {
"type": "string"
},
"description": "De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren."
},
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"description": "OK"
}
}
}
}
},
"components": {
"responses": {
"400": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/ValidatieFout"
}
}
},
"description": "Bad request"
},
"401": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unauthorized"
},
"403": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Forbidden"
},
"404": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not found"
},
"406": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Not acceptable"
},
"409": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Conflict"
},
"410": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Gone"
},
"415": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Unsupported media type"
},
"429": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Too many requests"
},
"500": {
"headers": {
"API-version": {
"schema": {
"type": "string"
},
"description": "Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1."
}
},
"content": {
"application/problem+json": {
"schema": {
"$ref": "#/components/schemas/Fout"
}
}
},
"description": "Internal server error"
}
},
"schemas": {
"AardRelatieEnum": {
"enum": [
"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"
],
"type": "string"
},
"AuditTrail": {
"type": "object",
"properties": {
"uuid": {
"type": "string",
"format": "uuid",
"description": "Unieke identificatie van de audit regel.",
"title": "uuid"
},
"bron": {
"allOf": [
{
"$ref": "#/components/schemas/BronEnum"
}
],
"description": "De naam van het component waar de wijziging in is gedaan.\n\nUitleg bij mogelijke waarden:\n\n* `ac` - Autorisaties API\n* `nrc` - Notificaties API\n* `zrc` - Zaken API\n* `ztc` - Catalogi API\n* `drc` - Documenten API\n* `brc` - Besluiten API\n* `cmc` - Contactmomenten API\n* `kc` - Klanten API\n* `vrc` - Verzoeken API",
"title": "bron"
},
"applicatieId": {
"type": "string",
"description": "Unieke identificatie van de applicatie, binnen de organisatie.",
"title": "applicatie id",
"maxLength": 100
},
"applicatieWeergave": {
"type": "string",
"description": "Vriendelijke naam van de applicatie.",
"title": "applicatie weergave",
"maxLength": 200
},
"gebruikersId": {
"type": "string",
"description": "Unieke identificatie van de gebruiker die binnen de organisatie herleid kan worden naar een persoon.",
"title": "gebruikers id",
"maxLength": 255
},
"gebruikersWeergave": {
"type": "string",
"description": "Vriendelijke naam van de gebruiker.",
"title": "gebruikers weergave",
"maxLength": 255
},
"actie": {
"type": "string",
"description": "De uitgevoerde handeling.\n\nDe bekende waardes voor dit veld zijn hieronder aangegeven, maar andere waardes zijn ook toegestaan\n\nUitleg bij mogelijke waarden:\n\n* `create` - Object aangemaakt\n* `list` - Lijst van objecten opgehaald\n* `retrieve` - Object opgehaald\n* `destroy` - Object verwijderd\n* `update` - Object bijgewerkt\n* `partial_update` - Object deels bijgewerkt",
"title": "actie",
"maxLength": 50
},
"actieWeergave": {
"type": "string",
"description": "Vriendelijke naam van de actie.",
"title": "actie weergave",
"maxLength": 200
},
"resultaat": {
"type": "integer",
"maximum": 599,
"minimum": 100,
"description": "HTTP status code van de API response van de uitgevoerde handeling.",
"title": "resultaat"
},
"hoofdObject": {
"type": "string",
"format": "uri",
"description": "De URL naar het hoofdobject van een component.",
"title": "hoofd object",
"maxLength": 1000
},
"resource": {
"type": "string",
"description": "Het type resource waarop de actie gebeurde.",
"title": "resource",
"maxLength": 50
},
"resourceUrl": {
"type": "string",
"format": "uri",
"description": "De URL naar het object.",
"title": "resource url",
"maxLength": 1000
},
"toelichting": {
"type": "string",
"description": "Toelichting waarom de handeling is uitgevoerd.",
"title": "toelichting"
},
"resourceWeergave": {
"type": "string",
"description": "Vriendelijke identificatie van het object.",
"title": "resource weergave",
"maxLength": 200
},
"aanmaakdatum": {
"type": "string",
"format": "date-time",
"readOnly": true,
"description": "De datum waarop de handeling is gedaan.",
"title": "aanmaakdatum"
},
"wijzigingen": {
"allOf": [
{
"$ref": "#/components/schemas/Wijzigingen"
}
],
"title": "wijzigingen"
}
},
"required": [
"aanmaakdatum",
"actie",
"bron",
"hoofdObject",
"resource",
"resourceUrl",
"resourceWeergave",
"resultaat",
"wijzigingen"
]
},
"BestandsDeel": {
"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"
]
},
"BestandsDeelRequest": {
"type": "object",
"properties": {
"inhoud": {
"type": "string",
"format": "binary",
"writeOnly": true,
"description": "De (binaire) bestandsinhoud van dit specifieke bestandsdeel.",
"title": "inhoud"
},
"lock": {
"type": "string",
"writeOnly": true,
"minLength": 1,
"description": "Hash string, which represents id of the lock of related informatieobject",
"title": "lock"
}
},
"required": [
"lock"
]
},
"BestandsDeelResponse": {
"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
},
"lock": {
"type": "string",
"description": "Hash string, which represents id of the lock of related informatieobject",
"title": "lock"
},
"omvang": {
"type": "integer",
"description": "De grootte van dit specifieke bestandsdeel.",
"title": "omvang"
},
"inhoud": {
"type": "string",
"format": "uri",
"description": "De URL naar de bestandsinhoud van dit specifieke bestandsdeel.",
"title": "inhoud"
},
"voltooid": {
"type": "boolean",
"description": "Indicatie of dit bestandsdeel volledig is geupload. Dat wil zeggen: het aantal bytes dat staat genoemd bij grootte is daadwerkelijk ontvangen.",
"title": "voltooid"
},
"volgnummer": {
"type": "integer",
"description": "Een volgnummer dat de volgorde van de bestandsdelen aangeeft.",
"title": "volgnummer"
}
},
"required": [
"lock",
"url"
]
},
"BinnenlandsCorrespondentieadresVerzending": {
"type": "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 van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.",
"title": "huisletter",
"maxLength": 1
},
"huisnummer": {
"type": "integer",
"maximum": 99999,
"minimum": 1,
"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 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 RUIMTE toegekende benaming.",
"title": "naam openbare ruimte",
"maxLength": 80
},
"postcode": {
"type": "string",
"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 toegekende benaming.",
"title": "woonplaatsnaam",
"maxLength": 80
}
},
"required": [
"huisnummer",
"naamOpenbareRuimte",
"woonplaatsnaam"
],
"nullable": true
},
"BinnenlandsCorrespondentieadresVerzendingRequest": {
"type": "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 van een adresseerbaar object toegekende toevoeging aan een huisnummer in de vorm van een alfanumeriek teken.",
"title": "huisletter",
"maxLength": 1
},
"huisnummer": {
"type": "integer",
"maximum": 99999,
"minimum": 1,
"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 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",
"minLength": 1,
"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 combinatie van een naam van een woonplaats, naam van een openbare ruimte en een huisnummer.",
"title": "postcode",
"maxLength": 6
},
"woonplaatsnaam": {
"type": "string",
"minLength": 1,
"description": "De door het bevoegde gemeentelijke orgaan aan een WOONPLAATS toegekende benaming.",
"title": "woonplaatsnaam",
"maxLength": 80
}
},
"required": [
"huisnummer",
"naamOpenbareRuimte",
"woonplaatsnaam"
],
"nullable": true
},
"BlankEnum": {
"enum": [
""
]
},
"BronEnum": {
"enum": [
"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 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 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 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 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 van de betrokkene in zijn/haar rol bij de zaak.",
"title": "land postadres",
"maxLength": 200
}
},
"required": [
"adresBuitenland1",
"landPostadres"
],
"nullable": true
},
"BuitenlandsCorrespondentieadresVerzendingRequest": {
"type": "object",
"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 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 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 van de betrokkene in zijn/haar rol bij de zaak.",
"title": "adres buitenland 3",
"maxLength": 35
},
"landPostadres": {
"type": "string",
"format": "uri",
"minLength": 1,
"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"
],
"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ë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",
"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",
"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/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"
},
"identificatie": {
"title": "Identificatie",
"description": "Een binnen een gegeven context ondubbelzinnige referentie naar het INFORMATIEOBJECT.",
"type": "string",
"example": "Document123"
},
"bronorganisatie": {
"title": "Bronorganisatie",
"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.",
"type": "string",
"example": "000000000"
},
"expand": {
"description": "Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt.",
"type": "string",
"example": "informatieobjecttype"
}
},
"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ëerd 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.\n\nUitleg bij mogelijke waarden:\n\n* `openbaar` - Openbaar\n* `beperkt_openbaar` - Beperkt openbaar\n* `intern` - Intern\n* `zaakvertrouwelijk` - Zaakvertrouwelijk\n* `vertrouwelijk` - Vertrouwelijk\n* `confidentieel` - Confidentieel\n* `geheim` - Geheim\n* `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ë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.\n\nUitleg bij mogelijke waarden:\n\n* `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt.\n* `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden.\n* `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen.\n* `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.",
"title": "status",
"oneOf": [
{
"$ref": "#/components/schemas/StatusEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
]
},
"inhoudIsVervallen": {
"description": "Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet vervallen, dus niet langer geldig is.\n* `true` De inhoud van het INFORMATIEOBJECT is vervallen.\n* `false` De inhoud van het INFORMATIEOBJECT is niet vervallen.",
"title": "inhoud is vervallen",
"type": "boolean",
"nullable": true
},
"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": 9223372036854776000,
"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. 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. 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ële 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/BestandsDeel"
},
"readOnly": true,
"title": "bestandsdelen"
},
"trefwoorden": {
"description": "Een lijst van één of meer trefwoorden.",
"type": "array",
"items": {
"type": "string"
},
"example": [
"bouwtekening",
"vergunning",
"aanvraag"
]
}
},
"required": [
"auteur",
"beginRegistratie",
"bestandsdelen",
"bronorganisatie",
"creatiedatum",
"informatieobjecttype",
"locked",
"taal",
"titel",
"url",
"versie"
]
},
"EnkelvoudigInformatieObjectCreateLock": {
"type": "object",
"description": "This serializer class is used by EnkelvoudigInformatieObjectViewSet for\ncreate operation for large files",
"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ëerd 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.\n\nUitleg bij mogelijke waarden:\n\n* `openbaar` - Openbaar\n* `beperkt_openbaar` - Beperkt openbaar\n* `intern` - Intern\n* `zaakvertrouwelijk` - Zaakvertrouwelijk\n* `vertrouwelijk` - Vertrouwelijk\n* `confidentieel` - Confidentieel\n* `geheim` - Geheim\n* `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ë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.\n\nUitleg bij mogelijke waarden:\n\n* `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt.\n* `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden.\n* `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen.\n* `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.",
"title": "status",
"oneOf": [
{
"$ref": "#/components/schemas/StatusEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
]
},
"inhoudIsVervallen": {
"description": "Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet vervallen, dus niet langer geldig is.\n* `true` De inhoud van het INFORMATIEOBJECT is vervallen.\n* `false` De inhoud van het INFORMATIEOBJECT is niet vervallen.",
"title": "inhoud is vervallen",
"type": "boolean",
"nullable": true
},
"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": 9223372036854776000,
"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": "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": "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ële 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/BestandsDeel"
},
"readOnly": true,
"title": "bestandsdelen"
},
"trefwoorden": {
"description": "Een lijst van één of meer trefwoorden.",
"type": "array",
"items": {
"type": "string"
},
"example": [
"bouwtekening",
"vergunning",
"aanvraag"
]
},
"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"
]
},
"EnkelvoudigInformatieObjectCreateLockRequest": {
"type": "object",
"description": "This serializer class is used by EnkelvoudigInformatieObjectViewSet for\ncreate operation for large files",
"properties": {
"identificatie": {
"type": "string",
"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.",
"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",
"minLength": 1,
"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.\n\nUitleg bij mogelijke waarden:\n\n* `openbaar` - Openbaar\n* `beperkt_openbaar` - Beperkt openbaar\n* `intern` - Intern\n* `zaakvertrouwelijk` - Zaakvertrouwelijk\n* `vertrouwelijk` - Vertrouwelijk\n* `confidentieel` - Confidentieel\n* `geheim` - Geheim\n* `zeer_geheim` - Zeer geheim",
"title": "vertrouwelijkheidaanduiding",
"oneOf": [
{
"$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.",
"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.\n\nUitleg bij mogelijke waarden:\n\n* `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt.\n* `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden.\n* `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen.\n* `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.",
"title": "status",
"oneOf": [
{
"$ref": "#/components/schemas/StatusEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
]
},
"inhoudIsVervallen": {
"description": "Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet vervallen, dus niet langer geldig is.\n* `true` De inhoud van het INFORMATIEOBJECT is vervallen.\n* `false` De inhoud van het INFORMATIEOBJECT is niet vervallen.",
"title": "inhoud is vervallen",
"type": "boolean",
"nullable": true
},
"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",
"minLength": 3,
"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 is vastgelegd, inclusief extensie.",
"title": "bestandsnaam",
"maxLength": 255
},
"inhoud": {
"type": "string",
"format": "byte",
"description": "Binaire inhoud, in base64 geëncodeerd.",
"nullable": true,
"title": "inhoud"
},
"bestandsomvang": {
"type": "integer",
"maximum": 9223372036854776000,
"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": "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": "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ële opmaakaspecten van een INFORMATIEOBJECT.",
"title": "verschijningsvorm"
},
"ondertekening": {
"allOf": [
{
"$ref": "#/components/schemas/OndertekeningRequest"
}
],
"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/IntegriteitRequest"
}
],
"nullable": true,
"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 API).",
"title": "informatieobjecttype",
"maxLength": 200
},
"trefwoorden": {
"description": "Een lijst van één of meer trefwoorden.",
"type": "array",
"items": {
"type": "string"
},
"example": [
"bouwtekening",
"vergunning",
"aanvraag"
]
}
},
"required": [
"auteur",
"bronorganisatie",
"creatiedatum",
"informatieobjecttype",
"taal",
"titel"
]
},
"EnkelvoudigInformatieObjectWithLock": {
"type": "object",
"description": "This serializer class is used by EnkelvoudigInformatieObjectViewSet for\nupdate 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 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ëerd 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.\n\nUitleg bij mogelijke waarden:\n\n* `openbaar` - Openbaar\n* `beperkt_openbaar` - Beperkt openbaar\n* `intern` - Intern\n* `zaakvertrouwelijk` - Zaakvertrouwelijk\n* `vertrouwelijk` - Vertrouwelijk\n* `confidentieel` - Confidentieel\n* `geheim` - Geheim\n* `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ë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.\n\nUitleg bij mogelijke waarden:\n\n* `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt.\n* `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden.\n* `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen.\n* `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.",
"title": "status",
"oneOf": [
{
"$ref": "#/components/schemas/StatusEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
]
},
"inhoudIsVervallen": {
"description": "Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet vervallen, dus niet langer geldig is.\n* `true` De inhoud van het INFORMATIEOBJECT is vervallen.\n* `false` De inhoud van het INFORMATIEOBJECT is niet vervallen.",
"title": "inhoud is vervallen",
"type": "boolean",
"nullable": true
},
"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": 9223372036854776000,
"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": "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": "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ële 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/BestandsDeel"
},
"readOnly": true,
"title": "bestandsdelen"
},
"trefwoorden": {
"description": "Een lijst van één of meer trefwoorden.",
"type": "array",
"items": {
"type": "string"
},
"example": [
"bouwtekening",
"vergunning",
"aanvraag"
]
}
},
"required": [
"auteur",
"beginRegistratie",
"bestandsdelen",
"bronorganisatie",
"creatiedatum",
"informatieobjecttype",
"locked",
"taal",
"titel",
"url",
"versie"
]
},
"EnkelvoudigInformatieObjectWithLockRequest": {
"type": "object",
"description": "This serializer class is used by EnkelvoudigInformatieObjectViewSet for\nupdate and partial_update operations",
"properties": {
"identificatie": {
"type": "string",
"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.",
"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",
"minLength": 1,
"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.\n\nUitleg bij mogelijke waarden:\n\n* `openbaar` - Openbaar\n* `beperkt_openbaar` - Beperkt openbaar\n* `intern` - Intern\n* `zaakvertrouwelijk` - Zaakvertrouwelijk\n* `vertrouwelijk` - Vertrouwelijk\n* `confidentieel` - Confidentieel\n* `geheim` - Geheim\n* `zeer_geheim` - Zeer geheim",
"title": "vertrouwelijkheidaanduiding",
"oneOf": [
{
"$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.",
"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.\n\nUitleg bij mogelijke waarden:\n\n* `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt.\n* `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden.\n* `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen.\n* `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.",
"title": "status",
"oneOf": [
{
"$ref": "#/components/schemas/StatusEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
]
},
"inhoudIsVervallen": {
"description": "Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet vervallen, dus niet langer geldig is.\n* `true` De inhoud van het INFORMATIEOBJECT is vervallen.\n* `false` De inhoud van het INFORMATIEOBJECT is niet vervallen.",
"title": "inhoud is vervallen",
"type": "boolean",
"nullable": true
},
"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",
"minLength": 3,
"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 is vastgelegd, inclusief extensie.",
"title": "bestandsnaam",
"maxLength": 255
},
"inhoud": {
"type": "string",
"format": "byte",
"description": "Binaire inhoud, in base64 geëncodeerd.",
"nullable": true,
"title": "inhoud"
},
"bestandsomvang": {
"type": "integer",
"maximum": 9223372036854776000,
"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": "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": "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ële opmaakaspecten van een INFORMATIEOBJECT.",
"title": "verschijningsvorm"
},
"ondertekening": {
"allOf": [
{
"$ref": "#/components/schemas/OndertekeningRequest"
}
],
"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/IntegriteitRequest"
}
],
"nullable": true,
"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 API).",
"title": "informatieobjecttype",
"maxLength": 200
},
"trefwoorden": {
"description": "Een lijst van één of meer trefwoorden.",
"type": "array",
"items": {
"type": "string"
},
"example": [
"bouwtekening",
"vergunning",
"aanvraag"
]
},
"lock": {
"type": "string",
"writeOnly": true,
"minLength": 1,
"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"
]
},
"EnkelvoudigInformatieObjectExpanded": {
"allOf": [
{
"$ref": "#/components/schemas/EnkelvoudigInformatieObject"
},
{
"properties": {
"_expand": {
"$ref": "#/components/schemas/EnkelvoudigInformatieObjectEmbedded"
}
}
}
]
},
"EnkelvoudigInformatieObjectEmbedded": {
"type": "object",
"properties": {
"informatieobjecttype": {
"$ref": "https://raw.githubusercontent.com/VNG-Realisatie/gemma-zaken/master/api-specificatie/ztc/current_version/openapi.yaml#/components/schemas/InformatieObjectType"
}
}
},
"FieldValidationError": {
"type": "object",
"description": "Formaat van validatiefouten.",
"properties": {
"name": {
"type": "string",
"description": "Naam van het veld met ongeldige gegevens",
"title": "name"
},
"code": {
"type": "string",
"description": "Systeemcode die het type fout aangeeft",
"title": "code"
},
"reason": {
"type": "string",
"description": "Uitleg wat er precies fout is met de gegevens",
"title": "reason"
}
},
"required": [
"code",
"name",
"reason"
]
},
"Fout": {
"type": "object",
"description": "Formaat van HTTP 4xx en 5xx fouten.",
"properties": {
"type": {
"type": "string",
"description": "URI referentie naar het type fout, bedoeld voor developers",
"title": "type"
},
"code": {
"type": "string",
"description": "Systeemcode die het type fout aangeeft",
"title": "code"
},
"title": {
"type": "string",
"description": "Generieke titel voor het type fout",
"title": "title"
},
"status": {
"type": "integer",
"description": "De HTTP status code",
"title": "status"
},
"detail": {
"type": "string",
"description": "Extra informatie bij de fout, indien beschikbaar",
"title": "detail"
},
"instance": {
"type": "string",
"description": "URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld.",
"title": "instance"
}
},
"required": [
"code",
"detail",
"instance",
"status",
"title"
]
},
"Gebruiksrechten": {
"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
},
"informatieobject": {
"type": "string",
"format": "uri",
"description": "URL-referentie naar het INFORMATIEOBJECT.",
"title": "informatieobject"
},
"startdatum": {
"type": "string",
"format": "date-time",
"description": "Begindatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject de startdatum.",
"title": "startdatum"
},
"einddatum": {
"type": "string",
"format": "date-time",
"nullable": true,
"title": "Startdatum",
"description": "Einddatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn."
},
"omschrijvingVoorwaarden": {
"type": "string",
"description": "Omschrijving van de van toepassing zijnde voorwaarden aan het gebruik anders dan raadpleging",
"title": "omschrijving voorwaarden"
}
},
"required": [
"informatieobject",
"omschrijvingVoorwaarden",
"startdatum",
"url"
]
},
"GebruiksrechtenExpanded": {
"allOf": [
{
"$ref": "#/components/schemas/Gebruiksrechten"
},
{
"properties": {
"_expand": {
"$ref": "#/components/schemas/GebruiksrechtenEmbedded"
}
}
}
]
},
"GebruiksrechtenEmbedded": {
"type": "object",
"properties": {
"informatieobject": {
"$ref": "#/components/schemas/EnkelvoudigInformatieObject"
}
}
},
"GebruiksrechtenRequest": {
"type": "object",
"properties": {
"informatieobject": {
"type": "string",
"format": "uri",
"description": "URL-referentie naar het INFORMATIEOBJECT.",
"title": "informatieobject"
},
"startdatum": {
"type": "string",
"format": "date-time",
"description": "Begindatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject de startdatum.",
"title": "startdatum"
},
"einddatum": {
"type": "string",
"format": "date-time",
"nullable": true,
"title": "Startdatum",
"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 gebruik anders dan raadpleging",
"title": "omschrijving voorwaarden"
}
},
"required": [
"informatieobject",
"omschrijvingVoorwaarden",
"startdatum"
]
},
"Integriteit": {
"type": "object",
"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.\n\nUitleg bij mogelijke waarden:\n\n* `crc_16` - CRC-16\n* `crc_32` - CRC-32\n* `crc_64` - CRC-64\n* `fletcher_4` - Fletcher-4\n* `fletcher_8` - Fletcher-8\n* `fletcher_16` - Fletcher-16\n* `fletcher_32` - Fletcher-32\n* `hmac` - HMAC\n* `md5` - MD5\n* `sha_1` - SHA-1\n* `sha_256` - SHA-256\n* `sha_512` - SHA-512\n* `sha_3` - SHA-3",
"title": "integriteit algoritme"
},
"waarde": {
"type": "string",
"description": "De waarde van de checksum.",
"title": "integriteit waarde",
"maxLength": 128
},
"datum": {
"type": "string",
"format": "date",
"description": "Datum waarop de checksum is gemaakt.",
"title": "integriteit datum"
}
},
"required": [
"algoritme",
"datum",
"waarde"
],
"nullable": true
},
"IntegriteitRequest": {
"type": "object",
"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.\n\nUitleg bij mogelijke waarden:\n\n* `crc_16` - CRC-16\n* `crc_32` - CRC-32\n* `crc_64` - CRC-64\n* `fletcher_4` - Fletcher-4\n* `fletcher_8` - Fletcher-8\n* `fletcher_16` - Fletcher-16\n* `fletcher_32` - Fletcher-32\n* `hmac` - HMAC\n* `md5` - MD5\n* `sha_1` - SHA-1\n* `sha_256` - SHA-256\n* `sha_512` - SHA-512\n* `sha_3` - SHA-3",
"title": "integriteit algoritme"
},
"waarde": {
"type": "string",
"minLength": 1,
"description": "De waarde van de checksum.",
"title": "integriteit waarde",
"maxLength": 128
},
"datum": {
"type": "string",
"format": "date",
"description": "Datum waarop de checksum is gemaakt.",
"title": "integriteit datum"
}
},
"required": [
"algoritme",
"datum",
"waarde"
],
"nullable": true
},
"LockEnkelvoudigInformatieObject": {
"type": "object",
"description": "Serializer for the lock action of EnkelvoudigInformatieObjectCanonical\nmodel",
"properties": {
"lock": {
"type": "string",
"readOnly": true,
"description": "Hash string, wordt gebruikt als ID voor de lock",
"title": "lock"
}
},
"required": [
"lock"
]
},
"ObjectInformatieObject": {
"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
},
"informatieobject": {
"type": "string",
"format": "uri",
"description": "URL-referentie naar het INFORMATIEOBJECT.",
"title": "informatieobject"
},
"object": {
"type": "string",
"format": "uri",
"description": "URL-referentie naar het gerelateerde OBJECT (in deze of een andere API).",
"title": "object",
"maxLength": 1000
},
"objectType": {
"allOf": [
{
"$ref": "#/components/schemas/ObjectTypeEnum"
}
],
"title": "Objecttype",
"description": "Het type van het gerelateerde OBJECT.\n\nUitleg bij mogelijke waarden:\n\n* `besluit` - Besluit\n* `zaak` - Zaak"
}
},
"required": [
"informatieobject",
"object",
"objectType",
"url"
]
},
"ObjectInformatieObjectRequest": {
"type": "object",
"properties": {
"informatieobject": {
"type": "string",
"format": "uri",
"description": "URL-referentie naar het INFORMATIEOBJECT.",
"title": "informatieobject"
},
"object": {
"type": "string",
"format": "uri",
"minLength": 1,
"description": "URL-referentie naar het gerelateerde OBJECT (in deze of een andere API).",
"title": "object",
"maxLength": 1000
},
"objectType": {
"allOf": [
{
"$ref": "#/components/schemas/ObjectTypeEnum"
}
],
"title": "Objecttype",
"description": "Het type van het gerelateerde OBJECT.\n\nUitleg bij mogelijke waarden:\n\n* `besluit` - Besluit\n* `zaak` - Zaak"
}
},
"required": [
"informatieobject",
"object",
"objectType"
]
},
"ObjectTypeEnum": {
"enum": [
"besluit",
"zaak",
"verzoek"
],
"type": "string"
},
"Ondertekening": {
"type": "object",
"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"
}
],
"title": "Ondertekeningsoort",
"description": "Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT\n\nUitleg bij mogelijke waarden:\n\n* `analoog` - Analoog\n* `digitaal` - Digitaal\n* `pki` - PKI"
},
"datum": {
"type": "string",
"format": "date",
"title": "Ondertekeningdatum",
"description": "De datum waarop de ondertekening van het INFORMATIEOBJECT heeft plaatsgevonden."
}
},
"required": [
"datum",
"soort"
],
"nullable": true
},
"OndertekeningRequest": {
"type": "object",
"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"
}
],
"title": "Ondertekeningsoort",
"description": "Aanduiding van de wijze van ondertekening van het INFORMATIEOBJECT\n\nUitleg bij mogelijke waarden:\n\n* `analoog` - Analoog\n* `digitaal` - Digitaal\n* `pki` - PKI"
},
"datum": {
"type": "string",
"format": "date",
"title": "Ondertekeningdatum",
"description": "De datum waarop de ondertekening van het INFORMATIEOBJECT heeft plaatsgevonden."
}
},
"required": [
"datum",
"soort"
],
"nullable": true
},
"PaginatedEnkelvoudigInformatieObjectList": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?page=4"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?page=2"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/EnkelvoudigInformatieObjectExpanded"
}
}
}
},
"PaginatedVerzendingList": {
"type": "object",
"properties": {
"count": {
"type": "integer",
"example": 123
},
"next": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?page=4"
},
"previous": {
"type": "string",
"nullable": true,
"format": "uri",
"example": "http://api.example.org/accounts/?page=2"
},
"results": {
"type": "array",
"items": {
"$ref": "#/components/schemas/VerzendingExpanded"
}
}
}
},
"PatchedEnkelvoudigInformatieObjectWithLockRequest": {
"type": "object",
"description": "This serializer class is used by EnkelvoudigInformatieObjectViewSet for\nupdate and partial_update operations",
"properties": {
"identificatie": {
"type": "string",
"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.",
"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",
"minLength": 1,
"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.\n\nUitleg bij mogelijke waarden:\n\n* `openbaar` - Openbaar\n* `beperkt_openbaar` - Beperkt openbaar\n* `intern` - Intern\n* `zaakvertrouwelijk` - Zaakvertrouwelijk\n* `vertrouwelijk` - Vertrouwelijk\n* `confidentieel` - Confidentieel\n* `geheim` - Geheim\n* `zeer_geheim` - Zeer geheim",
"title": "vertrouwelijkheidaanduiding",
"oneOf": [
{
"$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.",
"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.\n\nUitleg bij mogelijke waarden:\n\n* `in_bewerking` - (In bewerking) Aan het informatieobject wordt nog gewerkt.\n* `ter_vaststelling` - (Ter vaststelling) Informatieobject gereed maar moet nog vastgesteld worden.\n* `definitief` - (Definitief) Informatieobject door bevoegd iets of iemand vastgesteld dan wel ontvangen.\n* `gearchiveerd` - (Gearchiveerd) Informatieobject duurzaam bewaarbaar gemaakt; een gearchiveerd informatie-element.",
"title": "status",
"oneOf": [
{
"$ref": "#/components/schemas/StatusEnum"
},
{
"$ref": "#/components/schemas/BlankEnum"
}
]
},
"inhoudIsVervallen": {
"description": "Geeft aan of de inhoud van het INFORMATIEOBJECT al dan niet vervallen, dus niet langer geldig is.\n* `true` De inhoud van het INFORMATIEOBJECT is vervallen.\n* `false` De inhoud van het INFORMATIEOBJECT is niet vervallen.",
"title": "inhoud is vervallen",
"type": "boolean",
"nullable": true
},
"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",
"minLength": 3,
"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 is vastgelegd, inclusief extensie.",
"title": "bestandsnaam",
"maxLength": 255
},
"inhoud": {
"type": "string",
"format": "byte",
"description": "Binaire inhoud, in base64 geëncodeerd.",
"nullable": true,
"title": "inhoud"
},
"bestandsomvang": {
"type": "integer",
"maximum": 9223372036854776000,
"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": "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": "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ële opmaakaspecten van een INFORMATIEOBJECT.",
"title": "verschijningsvorm"
},
"ondertekening": {
"allOf": [
{
"$ref": "#/components/schemas/OndertekeningRequest"
}
],
"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/IntegriteitRequest"
}
],
"nullable": true,
"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 API).",
"title": "informatieobjecttype",
"maxLength": 200
},
"lock": {
"type": "string",
"writeOnly": true,
"minLength": 1,
"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"
}
}
},
"PatchedGebruiksrechtenRequest": {
"type": "object",
"properties": {
"informatieobject": {
"type": "string",
"format": "uri",
"description": "URL-referentie naar het INFORMATIEOBJECT.",
"title": "informatieobject"
},
"startdatum": {
"type": "string",
"format": "date-time",
"description": "Begindatum van de periode waarin de gebruiksrechtvoorwaarden van toepassing zijn. Doorgaans is de datum van creatie van het informatieobject de startdatum.",
"title": "startdatum"
},
"einddatum": {
"type": "string",
"format": "date-time",
"nullable": true,
"title": "Startdatum",
"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 gebruik anders dan raadpleging",
"title": "omschrijving voorwaarden"
}
}
},
"PatchedVerzendingRequest": {
"type": "object",
"description": "Set gegevensgroepdata from validated nested data.\n\nUsage: 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 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 verzonden.",
"title": "informatieobject"
},
"aardRelatie": {
"allOf": [
{
"$ref": "#/components/schemas/AardRelatieEnum"
}
],
"description": "Omschrijving van de aard van de relatie van de BETROKKENE tot het INFORMATIEOBJECT.",
"title": "aard relatie"
},
"toelichting": {
"type": "string",
"description": "Verduidelijking van de afzender- of geadresseerde-relatie.",
"title": "toelichting",
"maxLength": 200
},
"ontvangstdatum": {
"type": "string",
"format": "date",
"nullable": true,
"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 zijn waarbij die personen niet deel uit maken van de behandeling van de zaak waarin het document een rol speelt. Vervangt het gelijknamige attribuut uit Informatieobject. Verplicht gevuld wanneer aardRelatie de waarde 'afzender' heeft.",
"title": "ontvangstdatum"
},
"verzenddatum": {
"type": "string",
"format": "date",
"nullable": true,
"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 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. Vervangt het gelijknamige attribuut uit Informatieobject. Verplicht gevuld wanneer aardRelatie de waarde 'geadresseerde' heeft.",
"title": "verzenddatum"
},
"contactPersoon": {
"type": "string",
"format": "uri",
"minLength": 1,
"title": "Contactpersoon",
"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 voorde BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT.",
"title": "contactpersoonnaam",
"maxLength": 40
},
"binnenlandsCorrespondentieadres": {
"allOf": [
{
"$ref": "#/components/schemas/BinnenlandsCorrespondentieadresVerzendingRequest"
}
],
"nullable": true,
"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"
}
],
"nullable": true,
"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"
}
],
"nullable": true,
"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.",
"title": "correspondentiePostadres"
},
"faxnummer": {
"type": "string",
"nullable": true,
"description": "faxnummer van de ontvanger of afzender.",
"title": "faxnummer",
"maxLength": 15
},
"emailadres": {
"type": "string",
"nullable": true,
"description": "emailadres van de ontvanger of afzender.",
"title": "emailadres",
"maxLength": 100
},
"mijnOverheid": {
"type": "boolean",
"description": "is het informatieobject verzonden via mijnOverheid naar de ontvanger.",
"title": "mijn overheid"
},
"telefoonnummer": {
"type": "string",
"nullable": true,
"description": "telefoonnummer van de ontvanger of afzender.",
"title": "telefoonnummer",
"maxLength": 15
}
}
},
"PostadresTypeEnum": {
"enum": [
"antwoordnummer",
"postbusnummer"
],
"type": "string"
},
"SoortEnum": {
"enum": [
"analoog",
"digitaal",
"pki"
],
"type": "string"
},
"StatusEnum": {
"enum": [
"in_bewerking",
"ter_vaststelling",
"definitief",
"gearchiveerd"
],
"type": "string"
},
"UnlockEnkelvoudigInformatieObjectRequest": {
"type": "object",
"description": "Serializer for the unlock action of EnkelvoudigInformatieObjectCanonical\nmodel",
"properties": {
"lock": {
"type": "string",
"description": "Hash string, wordt gebruikt als ID voor de lock",
"title": "lock",
"maxLength": 100
}
}
},
"ValidatieFout": {
"type": "object",
"description": "Formaat van HTTP 4xx en 5xx fouten.",
"properties": {
"type": {
"type": "string",
"description": "URI referentie naar het type fout, bedoeld voor developers",
"title": "type"
},
"code": {
"type": "string",
"description": "Systeemcode die het type fout aangeeft",
"title": "code"
},
"title": {
"type": "string",
"description": "Generieke titel voor het type fout",
"title": "title"
},
"status": {
"type": "integer",
"description": "De HTTP status code",
"title": "status"
},
"detail": {
"type": "string",
"description": "Extra informatie bij de fout, indien beschikbaar",
"title": "detail"
},
"instance": {
"type": "string",
"description": "URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld.",
"title": "instance"
},
"invalidParams": {
"type": "array",
"items": {
"$ref": "#/components/schemas/FieldValidationError"
},
"title": "invalidParams"
}
},
"required": [
"code",
"detail",
"instance",
"invalidParams",
"status",
"title"
]
},
"VertrouwelijkheidaanduidingEnum": {
"enum": [
"openbaar",
"beperkt_openbaar",
"intern",
"zaakvertrouwelijk",
"vertrouwelijk",
"confidentieel",
"geheim",
"zeer_geheim"
],
"type": "string"
},
"Verzending": {
"type": "object",
"description": "Set gegevensgroepdata from validated nested data.\n\nUsage: include the mixin on the ModelSerializer that has gegevensgroepen.",
"properties": {
"url": {
"type": "string",
"format": "uri",
"readOnly": true,
"title": "url",
"description": "URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object.",
"minLength": 1,
"maxLength": 1000
},
"betrokkene": {
"type": "string",
"format": "uri",
"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 verzonden.",
"title": "informatieobject"
},
"aardRelatie": {
"allOf": [
{
"$ref": "#/components/schemas/AardRelatieEnum"
}
],
"description": "Omschrijving van de aard van de relatie van de BETROKKENE tot het INFORMATIEOBJECT.",
"title": "aard relatie"
},
"toelichting": {
"type": "string",
"description": "Verduidelijking van de afzender- of geadresseerde-relatie.",
"title": "toelichting",
"maxLength": 200
},
"ontvangstdatum": {
"type": "string",
"format": "date",
"nullable": true,
"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 zijn waarbij die personen niet deel uit maken van de behandeling van de zaak waarin het document een rol speelt. Vervangt het gelijknamige attribuut uit Informatieobject. Verplicht gevuld wanneer aardRelatie de waarde 'afzender' heeft.",
"title": "ontvangstdatum"
},
"verzenddatum": {
"type": "string",
"format": "date",
"nullable": true,
"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 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. Vervangt het gelijknamige attribuut uit Informatieobject. Verplicht gevuld wanneer aardRelatie de waarde 'geadresseerde' heeft.",
"title": "verzenddatum"
},
"contactPersoon": {
"type": "string",
"format": "uri",
"title": "Contactpersoon",
"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 voorde BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT.",
"title": "contactpersoonnaam",
"maxLength": 40
},
"binnenlandsCorrespondentieadres": {
"allOf": [
{
"$ref": "#/components/schemas/BinnenlandsCorrespondentieadresVerzending"
}
],
"nullable": true,
"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"
}
],
"nullable": true,
"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"
}
],
"nullable": true,
"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.",
"title": "correspondentiePostadres"
},
"faxnummer": {
"type": "string",
"nullable": true,
"description": "faxnummer van de ontvanger of afzender.",
"title": "faxnummer",
"maxLength": 15
},
"emailadres": {
"type": "string",
"nullable": true,
"description": "emailadres van de ontvanger of afzender.",
"title": "emailadres",
"maxLength": 100
},
"mijnOverheid": {
"type": "boolean",
"description": "is het informatieobject verzonden via mijnOverheid naar de ontvanger.",
"title": "mijn overheid"
},
"telefoonnummer": {
"type": "string",
"nullable": true,
"description": "telefoonnummer van de ontvanger of afzender.",
"title": "telefoonnummer",
"maxLength": 15
}
},
"required": [
"aardRelatie",
"betrokkene",
"contactPersoon",
"informatieobject",
"url"
]
},
"VerzendingExpanded": {
"allOf": [
{
"$ref": "#/components/schemas/Verzending"
},
{
"properties": {
"_expand": {
"$ref": "#/components/schemas/VerzendingEmbedded"
}
}
}
]
},
"VerzendingEmbedded": {
"type": "object",
"properties": {
"informatieobject": {
"$ref": "#/components/schemas/EnkelvoudigInformatieObject"
}
}
},
"VerzendingRequest": {
"type": "object",
"description": "Set gegevensgroepdata from validated nested data.\n\nUsage: 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 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 verzonden.",
"title": "informatieobject"
},
"aardRelatie": {
"allOf": [
{
"$ref": "#/components/schemas/AardRelatieEnum"
}
],
"description": "Omschrijving van de aard van de relatie van de BETROKKENE tot het INFORMATIEOBJECT.",
"title": "aard relatie"
},
"toelichting": {
"type": "string",
"description": "Verduidelijking van de afzender- of geadresseerde-relatie.",
"title": "toelichting",
"maxLength": 200
},
"ontvangstdatum": {
"type": "string",
"format": "date",
"nullable": true,
"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 zijn waarbij die personen niet deel uit maken van de behandeling van de zaak waarin het document een rol speelt. Vervangt het gelijknamige attribuut uit Informatieobject. Verplicht gevuld wanneer aardRelatie de waarde 'afzender' heeft.",
"title": "ontvangstdatum"
},
"verzenddatum": {
"type": "string",
"format": "date",
"nullable": true,
"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 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. Vervangt het gelijknamige attribuut uit Informatieobject. Verplicht gevuld wanneer aardRelatie de waarde 'geadresseerde' heeft.",
"title": "verzenddatum"
},
"contactPersoon": {
"type": "string",
"format": "uri",
"minLength": 1,
"title": "Contactpersoon",
"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 voorde BETROKKENE inzake het ontvangen of verzonden INFORMATIEOBJECT.",
"title": "contactpersoonnaam",
"maxLength": 40
},
"binnenlandsCorrespondentieadres": {
"allOf": [
{
"$ref": "#/components/schemas/BinnenlandsCorrespondentieadresVerzendingRequest"
}
],
"nullable": true,
"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"
}
],
"nullable": true,
"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"
}
],
"nullable": true,
"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.",
"title": "correspondentiePostadres"
},
"faxnummer": {
"type": "string",
"nullable": true,
"description": "faxnummer van de ontvanger of afzender.",
"title": "faxnummer",
"maxLength": 15
},
"emailadres": {
"type": "string",
"nullable": true,
"description": "emailadres van de ontvanger of afzender.",
"title": "emailadres",
"maxLength": 100
},
"mijnOverheid": {
"type": "boolean",
"description": "is het informatieobject verzonden via mijnOverheid naar de ontvanger.",
"title": "mijn overheid"
},
"telefoonnummer": {
"type": "string",
"nullable": true,
"description": "telefoonnummer van de ontvanger of afzender.",
"title": "telefoonnummer",
"maxLength": 15
}
},
"required": [
"aardRelatie",
"betrokkene",
"contactPersoon",
"informatieobject"
]
},
"Wijzigingen": {
"type": "object",
"properties": {
"oud": {
"type": "object",
"additionalProperties": {},
"description": "Volledige JSON body van het object zoals dat bestond voordat de actie heeft plaatsgevonden.",
"title": "oud"
},
"nieuw": {
"type": "object",
"additionalProperties": {},
"description": "Volledige JSON body van het object na de actie.",
"title": "nieuw"
}
}
}
},
"securitySchemes": {
"JWT-Claims": {
"type": "http",
"bearerFormat": "JWT",
"scheme": "bearer"
}
}
},
"servers": [
{
"description": "SwaggerHub API Auto Mocking",
"url": "https://virtserver.swaggerhub.com/michielverhoef/Documenten_API/1.4.2"
},
{
"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."
}
]
}