openapi: 3.0.0 info: title: Besluiten API description: 'Een API om een Besluiten API (BRC) te benaderen. Een BESLUIT wordt veelal schriftelijk vastgelegd maar dit is niet noodzakelijk. Omgekeerd kan het voorkomen dat in een INFORMATIEOBJECT meerdere besluiten vastgelegd zijn. Vandaar de N:M-relatie naar INFORMATIEOBJECT. Een besluit komt voort uit een zaak van de zaakbehandelende organisatie dan wel is een besluit van een andere organisatie dat het onderwerp (object) is van een zaak van de zaakbehandelende organisatie. BESLUIT heeft dan ook een optionele relatie met de ZAAK waarvan het een uitkomst is. De typering van BESLUITen is in de Catalogi API (ZTC) ondergebracht in de vorm van BESLUITTYPEn. **Afhankelijkheden** Deze API is afhankelijk van: * Catalogi API * Notificaties API * Documenten API *(optioneel)* * Zaken API *(optioneel)* * Autorisaties API *(optioneel)* **Autorisatie** Deze API vereist autorisatie. Je kan de [token-tool](https://zaken-auth.vng.cloud/) gebruiken om JWT-tokens te genereren. ### Notificaties Deze API publiceert notificaties op het kanaal `besluiten`. **Main resource** `besluit` **Kenmerken** * `verantwoordelijke_organisatie`: Het RSIN van de niet-natuurlijk persoon zijnde de organisatie die het besluit heeft vastgesteld. * `besluittype`: URL-referentie naar het BESLUITTYPE (in de Catalogi API). **Resources en acties** - `besluit`: create, update, destroy - `besluitinformatieobject`: create, destroy **Handige links** * [Documentatie](https://zaakgerichtwerken.vng.cloud/standaard) * [Zaakgericht werken](https://zaakgerichtwerken.vng.cloud) ' contact: url: https://zaakgerichtwerken.vng.cloud email: standaarden.ondersteuning@vng.nl license: name: EUPL 1.2 url: https://opensource.org/licenses/EUPL-1.2 version: 1.0.0-rc2 security: - JWT-Claims: [] paths: /besluiten: get: operationId: besluit_list summary: Alle BESLUITen opvragen. description: Deze lijst kan gefilterd wordt met query-string parameters. parameters: - name: identificatie in: query description: Identificatie van het besluit binnen de organisatie die het besluit heeft vastgesteld. Indien deze niet opgegeven is, dan wordt die gegenereerd. required: false schema: type: string - name: verantwoordelijkeOrganisatie in: query description: Het RSIN van de niet-natuurlijk persoon zijnde de organisatie die het besluit heeft vastgesteld. required: false schema: type: string - name: besluittype in: query description: URL-referentie naar het BESLUITTYPE (in de Catalogi API). required: false schema: type: string format: uri - name: zaak in: query description: URL-referentie naar de ZAAK (in de Zaken API) waarvan dit besluit uitkomst is. required: false schema: type: string format: uri - name: page in: query description: Een pagina binnen de gepagineerde set resultaten. required: false schema: type: integer responses: '200': description: OK headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: required: - count - results type: object properties: count: type: integer next: type: string format: uri nullable: true previous: type: string format: uri nullable: true results: type: array items: $ref: '#/components/schemas/Besluit' '400': description: Bad request headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' '401': description: Unauthorized headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '403': description: Forbidden headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '406': description: Not acceptable headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '409': description: Conflict headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '410': description: Gone headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '415': description: Unsupported media type headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '429': description: Too many requests headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '500': description: Internal server error headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' tags: - besluiten security: - JWT-Claims: - besluiten.lezen post: operationId: besluit_create summary: Maak een BESLUIT aan. description: 'Indien geen identificatie gegeven is, dan wordt deze automatisch gegenereerd. Er wordt gevalideerd op: - uniciteit van `verantwoorlijkeOrganisatie` + `identificatie` - geldigheid `verantwoorlijkeOrganisatie` RSIN - geldigheid `besluittype` URL - geldigheid `zaak` URL - `datum` in het verleden of nu - publicatie `besluittype` - `concept` moet `false` zijn' parameters: - name: X-NLX-Request-Application-Id in: header description: Identificatie van de applicatie die het verzoek stuurt (indien NLX wordt gebruikt). required: false schema: type: string - name: X-NLX-Request-User-Id in: header description: Identificatie van de gebruiker die het verzoek stuurt (indien NLX wordt gebruikt). required: false schema: type: string - name: X-Audit-Toelichting in: header description: Toelichting waarom een bepaald verzoek wordt gedaan required: false schema: type: string requestBody: $ref: '#/components/requestBodies/Besluit' responses: '201': description: Created headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' Location: schema: type: string format: uri description: URL waar de resource leeft. content: application/json: schema: $ref: '#/components/schemas/Besluit' '400': description: Bad request headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' '401': description: Unauthorized headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '403': description: Forbidden headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '406': description: Not acceptable headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '409': description: Conflict headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '410': description: Gone headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '415': description: Unsupported media type headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '429': description: Too many requests headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '500': description: Internal server error headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' tags: - besluiten security: - JWT-Claims: - besluiten.aanmaken parameters: [] /besluiten/{besluit_uuid}/audittrail: get: operationId: audittrail_list summary: Alle audit trail regels behorend bij het BESLUIT. description: Alle audit trail regels behorend bij het BESLUIT. responses: '200': description: OK headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: type: array items: $ref: '#/components/schemas/AuditTrail' '401': description: Unauthorized headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '403': description: Forbidden headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '406': description: Not acceptable headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '409': description: Conflict headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '410': description: Gone headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '415': description: Unsupported media type headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '429': description: Too many requests headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '500': description: Internal server error headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' tags: - besluiten security: - JWT-Claims: - audittrails.lezen parameters: - name: besluit_uuid in: path required: true description: Unieke resource identifier (UUID4) schema: type: string format: uuid /besluiten/{besluit_uuid}/audittrail/{uuid}: get: operationId: audittrail_read summary: Een specifieke audit trail regel opvragen. description: Een specifieke audit trail regel opvragen. parameters: - name: If-None-Match in: header description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoord 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." required: false examples: multipleValues: summary: Meerdere ETag-waardes value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' oneValue: summary: "E\xE9n ETag-waarde" value: '"79054025255fb1a26e4bc422aef54eb4"' schema: type: string responses: '200': description: OK headers: ETag: 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. schema: type: string API-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' '401': description: Unauthorized headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '403': description: Forbidden headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '404': description: Not found headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '406': description: Not acceptable headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '409': description: Conflict headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '410': description: Gone headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '415': description: Unsupported media type headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '429': description: Too many requests headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '500': description: Internal server error headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' tags: - besluiten security: - JWT-Claims: - audittrails.lezen parameters: - name: besluit_uuid in: path required: true description: Unieke resource identifier (UUID4) schema: type: string format: uuid - name: uuid in: path description: Unieke identificatie van de audit regel. required: true schema: type: string format: uuid /besluiten/{uuid}: get: operationId: besluit_read summary: Een specifiek BESLUIT opvragen. description: Een specifiek BESLUIT opvragen. parameters: - name: If-None-Match in: header description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoord 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." required: false examples: multipleValues: summary: Meerdere ETag-waardes value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' oneValue: summary: "E\xE9n ETag-waarde" value: '"79054025255fb1a26e4bc422aef54eb4"' schema: type: string responses: '200': description: OK headers: ETag: 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. schema: type: string API-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/Besluit' '401': description: Unauthorized headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '403': description: Forbidden headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '404': description: Not found headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '406': description: Not acceptable headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '409': description: Conflict headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '410': description: Gone headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '415': description: Unsupported media type headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '429': description: Too many requests headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '500': description: Internal server error headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' tags: - besluiten security: - JWT-Claims: - besluiten.lezen head: operationId: besluit_headers summary: De headers voor een specifiek(e) BESLUIT opvragen description: Vraag de headers op die je bij een GET request zou krijgen. parameters: - name: If-None-Match in: header description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoord 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." required: false examples: multipleValues: summary: Meerdere ETag-waardes value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' oneValue: summary: "E\xE9n ETag-waarde" value: '"79054025255fb1a26e4bc422aef54eb4"' schema: type: string responses: '200': description: OK headers: ETag: 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. schema: type: string API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' tags: - besluiten security: - JWT-Claims: - besluiten.lezen put: operationId: besluit_update summary: Werk een BESLUIT in zijn geheel bij. description: 'Er wordt gevalideerd op: - uniciteit van `verantwoorlijkeOrganisatie` + `identificatie` - geldigheid `verantwoorlijkeOrganisatie` RSIN - geldigheid `besluittype` URL - geldigheid `zaak` URL - `datum` in het verleden of nu - publicatie `besluittype` - `concept` moet `false` zijn' parameters: - name: X-NLX-Request-Application-Id in: header description: Identificatie van de applicatie die het verzoek stuurt (indien NLX wordt gebruikt). required: false schema: type: string - name: X-NLX-Request-User-Id in: header description: Identificatie van de gebruiker die het verzoek stuurt (indien NLX wordt gebruikt). required: false schema: type: string - name: X-Audit-Toelichting in: header description: Toelichting waarom een bepaald verzoek wordt gedaan required: false schema: type: string requestBody: $ref: '#/components/requestBodies/Besluit' responses: '200': description: OK headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Besluit' '400': description: Bad request headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' '401': description: Unauthorized headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '403': description: Forbidden headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '404': description: Not found headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '406': description: Not acceptable headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '409': description: Conflict headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '410': description: Gone headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '415': description: Unsupported media type headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '429': description: Too many requests headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '500': description: Internal server error headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' tags: - besluiten security: - JWT-Claims: - besluiten.bijwerken patch: operationId: besluit_partial_update summary: Werk een BESLUIT deels bij. description: 'Er wordt gevalideerd op: - uniciteit van `verantwoorlijkeOrganisatie` + `identificatie` - geldigheid `verantwoorlijkeOrganisatie` RSIN - geldigheid `besluittype` URL - geldigheid `zaak` URL - `datum` in het verleden of nu - publicatie `besluittype` - `concept` moet `false` zijn' parameters: - name: X-NLX-Request-Application-Id in: header description: Identificatie van de applicatie die het verzoek stuurt (indien NLX wordt gebruikt). required: false schema: type: string - name: X-NLX-Request-User-Id in: header description: Identificatie van de gebruiker die het verzoek stuurt (indien NLX wordt gebruikt). required: false schema: type: string - name: X-Audit-Toelichting in: header description: Toelichting waarom een bepaald verzoek wordt gedaan required: false schema: type: string requestBody: $ref: '#/components/requestBodies/Besluit' responses: '200': description: OK headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Besluit' '400': description: Bad request headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' '401': description: Unauthorized headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '403': description: Forbidden headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '404': description: Not found headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '406': description: Not acceptable headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '409': description: Conflict headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '410': description: Gone headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '415': description: Unsupported media type headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '429': description: Too many requests headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '500': description: Internal server error headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' tags: - besluiten security: - JWT-Claims: - besluiten.bijwerken delete: operationId: besluit_delete summary: Verwijder een BESLUIT. description: 'Verwijder een BESLUIT samen met alle gerelateerde resources binnen deze API. **De gerelateerde resources zijn** - `BESLUITINFORMATIEOBJECT` - audit trail regels' parameters: - name: X-NLX-Request-Application-Id in: header description: Identificatie van de applicatie die het verzoek stuurt (indien NLX wordt gebruikt). required: false schema: type: string - name: X-NLX-Request-User-Id in: header description: Identificatie van de gebruiker die het verzoek stuurt (indien NLX wordt gebruikt). required: false schema: type: string - name: X-Audit-Toelichting in: header description: Toelichting waarom een bepaald verzoek wordt gedaan required: false schema: type: string responses: '204': description: No content headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' '401': description: Unauthorized headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '403': description: Forbidden headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '404': description: Not found headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '406': description: Not acceptable headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '409': description: Conflict headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '410': description: Gone headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '415': description: Unsupported media type headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '429': description: Too many requests headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '500': description: Internal server error headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' tags: - besluiten security: - JWT-Claims: - besluiten.verwijderen parameters: - name: uuid in: path required: true schema: type: string format: uuid /besluitinformatieobjecten: get: operationId: besluitinformatieobject_list summary: Alle BESLUIT-INFORMATIEOBJECT relaties opvragen. description: Deze lijst kan gefilterd wordt met query-string parameters. parameters: - name: besluit in: query description: URL-referentie naar het BESLUIT. required: false schema: type: string format: uri - name: informatieobject in: query description: URL-referentie naar het INFORMATIEOBJECT (in de Documenten API) waarin (een deel van) het besluit beschreven is. required: false schema: type: string format: uri responses: '200': description: OK headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: type: array items: $ref: '#/components/schemas/BesluitInformatieObject' '400': description: Bad request headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' '401': description: Unauthorized headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '403': description: Forbidden headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '406': description: Not acceptable headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '409': description: Conflict headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '410': description: Gone headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '415': description: Unsupported media type headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '429': description: Too many requests headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '500': description: Internal server error headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' tags: - besluitinformatieobjecten security: - JWT-Claims: - besluiten.lezen post: operationId: besluitinformatieobject_create summary: Maak een BESLUIT-INFORMATIEOBJECT relatie aan. description: "Registreer een INFORMATIEOBJECT bij een BESLUIT. Er worden twee\ \ types van\nrelaties met andere objecten gerealiseerd:\n\n**Er wordt gevalideerd\ \ op**\n- geldigheid `besluit` URL\n- geldigheid `informatieobject` URL\n\ - de combinatie `informatieobject` en `besluit` moet uniek zijn\n\n**Opmerkingen**\n\ - De `registratiedatum` wordt door het systeem op 'NU' gezet. De\n `aardRelatie`\ \ wordt ook door het systeem gezet.\n- Bij het aanmaken wordt ook in de Documenten\ \ API de gespiegelde relatie\n aangemaakt, echter zonder de relatie-informatie." parameters: - name: X-NLX-Request-Application-Id in: header description: Identificatie van de applicatie die het verzoek stuurt (indien NLX wordt gebruikt). required: false schema: type: string - name: X-NLX-Request-User-Id in: header description: Identificatie van de gebruiker die het verzoek stuurt (indien NLX wordt gebruikt). required: false schema: type: string - name: X-Audit-Toelichting in: header description: Toelichting waarom een bepaald verzoek wordt gedaan required: false schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/BesluitInformatieObject' required: true responses: '201': description: Created headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' Location: schema: type: string format: uri description: URL waar de resource leeft. content: application/json: schema: $ref: '#/components/schemas/BesluitInformatieObject' '400': description: Bad request headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' '401': description: Unauthorized headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '403': description: Forbidden headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '406': description: Not acceptable headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '409': description: Conflict headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '410': description: Gone headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '415': description: Unsupported media type headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '429': description: Too many requests headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '500': description: Internal server error headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' tags: - besluitinformatieobjecten security: - JWT-Claims: - besluiten.aanmaken parameters: [] /besluitinformatieobjecten/{uuid}: get: operationId: besluitinformatieobject_read summary: Een specifieke BESLUIT-INFORMATIEOBJECT relatie opvragen. description: Een specifieke BESLUIT-INFORMATIEOBJECT relatie opvragen. parameters: - name: If-None-Match in: header description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoord 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." required: false examples: multipleValues: summary: Meerdere ETag-waardes value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' oneValue: summary: "E\xE9n ETag-waarde" value: '"79054025255fb1a26e4bc422aef54eb4"' schema: type: string responses: '200': description: OK headers: ETag: 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. schema: type: string API-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/BesluitInformatieObject' '401': description: Unauthorized headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '403': description: Forbidden headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '404': description: Not found headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '406': description: Not acceptable headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '409': description: Conflict headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '410': description: Gone headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '415': description: Unsupported media type headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '429': description: Too many requests headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '500': description: Internal server error headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' tags: - besluitinformatieobjecten security: - JWT-Claims: - besluiten.lezen head: operationId: besluitinformatieobject_headers summary: De headers voor een specifiek(e) BESLUITINFORMATIEOBJECT opvragen description: Vraag de headers op die je bij een GET request zou krijgen. parameters: - name: If-None-Match in: header description: "Voer een voorwaardelijk verzoek uit. Deze header moet \xE9\xE9\ n of meerdere ETag-waardes bevatten van resources die de consumer gecached\ \ heeft. Indien de waarde van de ETag van de huidige resource voorkomt in\ \ deze set, dan antwoord 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." required: false examples: multipleValues: summary: Meerdere ETag-waardes value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' oneValue: summary: "E\xE9n ETag-waarde" value: '"79054025255fb1a26e4bc422aef54eb4"' schema: type: string responses: '200': description: OK headers: ETag: 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. schema: type: string API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' tags: - besluitinformatieobjecten security: - JWT-Claims: - besluiten.lezen delete: operationId: besluitinformatieobject_delete summary: Verwijder een BESLUIT-INFORMATIEOBJECT relatie. description: Verwijder een BESLUIT-INFORMATIEOBJECT relatie. parameters: - name: X-NLX-Request-Application-Id in: header description: Identificatie van de applicatie die het verzoek stuurt (indien NLX wordt gebruikt). required: false schema: type: string - name: X-NLX-Request-User-Id in: header description: Identificatie van de gebruiker die het verzoek stuurt (indien NLX wordt gebruikt). required: false schema: type: string - name: X-Audit-Toelichting in: header description: Toelichting waarom een bepaald verzoek wordt gedaan required: false schema: type: string responses: '204': description: No content headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' '401': description: Unauthorized headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '403': description: Forbidden headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '404': description: Not found headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '406': description: Not acceptable headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '409': description: Conflict headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '410': description: Gone headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '415': description: Unsupported media type headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '429': description: Too many requests headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' '500': description: Internal server error headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' tags: - besluitinformatieobjecten security: - JWT-Claims: - besluiten.verwijderen parameters: - name: uuid in: path description: Unieke resource identifier (UUID4) required: true schema: type: string format: uuid servers: - url: /api/v1 components: requestBodies: Besluit: content: application/json: schema: $ref: '#/components/schemas/Besluit' required: true securitySchemes: JWT-Claims: bearerFormat: JWT scheme: bearer type: http schemas: Besluit: required: - verantwoordelijkeOrganisatie - besluittype - datum - ingangsdatum type: object properties: url: title: Url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. type: string format: uri readOnly: true maxLength: 1000 minLength: 1 identificatie: title: Identificatie description: Identificatie van het besluit binnen de organisatie die het besluit heeft vastgesteld. Indien deze niet opgegeven is, dan wordt die gegenereerd. type: string maxLength: 50 verantwoordelijkeOrganisatie: title: Verantwoordelijke organisatie description: Het RSIN van de niet-natuurlijk persoon zijnde de organisatie die het besluit heeft vastgesteld. type: string maxLength: 9 minLength: 1 besluittype: title: Besluittype description: URL-referentie naar het BESLUITTYPE (in de Catalogi API). type: string format: uri maxLength: 200 minLength: 1 zaak: title: Zaak description: URL-referentie naar de ZAAK (in de Zaken API) waarvan dit besluit uitkomst is. type: string format: uri maxLength: 200 datum: title: Datum description: De beslisdatum (AWB) van het besluit. type: string format: date toelichting: title: Toelichting description: Toelichting bij het besluit. type: string bestuursorgaan: title: Bestuursorgaan description: Een orgaan van een rechtspersoon krachtens publiekrecht ingesteld of een persoon of college, met enig openbaar gezag bekleed onder wiens verantwoordelijkheid het besluit vastgesteld is. type: string maxLength: 50 ingangsdatum: title: Ingangsdatum description: Ingangsdatum van de werkingsperiode van het besluit. type: string format: date vervaldatum: title: Vervaldatum description: Datum waarop de werkingsperiode van het besluit eindigt. type: string format: date nullable: true vervalreden: title: Vervalreden description: 'De omschrijving die aangeeft op grond waarvan het besluit is of komt te vervallen. Uitleg bij mogelijke waarden: * `tijdelijk` - Besluit met tijdelijke werking * `ingetrokken_overheid` - Besluit ingetrokken door overheid * `ingetrokken_belanghebbende` - Besluit ingetrokken o.v.v. belanghebbende' type: string enum: - tijdelijk - ingetrokken_overheid - ingetrokken_belanghebbende vervalredenWeergave: title: Vervalreden weergave type: string readOnly: true minLength: 1 publicatiedatum: title: Publicatiedatum description: Datum waarop het besluit gepubliceerd wordt. type: string format: date nullable: true verzenddatum: title: Verzenddatum description: Datum waarop het besluit verzonden is. type: string format: date nullable: true uiterlijkeReactiedatum: title: Uiterlijke reactiedatum description: De datum tot wanneer verweer tegen het besluit mogelijk is. type: string format: date nullable: true Fout: required: - code - title - status - detail - instance type: object properties: type: title: Type description: URI referentie naar het type fout, bedoeld voor developers type: string code: title: Code description: Systeemcode die het type fout aangeeft type: string minLength: 1 title: title: Title description: Generieke titel voor het type fout type: string minLength: 1 status: title: Status description: De HTTP status code type: integer detail: title: Detail description: Extra informatie bij de fout, indien beschikbaar type: string minLength: 1 instance: title: Instance description: URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. type: string minLength: 1 FieldValidationError: required: - name - code - reason type: object properties: name: title: Name description: Naam van het veld met ongeldige gegevens type: string minLength: 1 code: title: Code description: Systeemcode die het type fout aangeeft type: string minLength: 1 reason: title: Reason description: Uitleg wat er precies fout is met de gegevens type: string minLength: 1 ValidatieFout: required: - code - title - status - detail - instance - invalidParams type: object properties: type: title: Type description: URI referentie naar het type fout, bedoeld voor developers type: string code: title: Code description: Systeemcode die het type fout aangeeft type: string minLength: 1 title: title: Title description: Generieke titel voor het type fout type: string minLength: 1 status: title: Status description: De HTTP status code type: integer detail: title: Detail description: Extra informatie bij de fout, indien beschikbaar type: string minLength: 1 instance: title: Instance description: URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. type: string minLength: 1 invalidParams: type: array items: $ref: '#/components/schemas/FieldValidationError' Wijzigingen: title: Wijzigingen type: object properties: oud: title: Oud description: Volledige JSON body van het object zoals dat bestond voordat de actie heeft plaatsgevonden. type: object nieuw: title: Nieuw description: Volledige JSON body van het object na de actie. type: object AuditTrail: required: - bron - actie - resultaat - hoofdObject - resource - resourceUrl - resourceWeergave - wijzigingen type: object properties: uuid: title: Uuid description: Unieke identificatie van de audit regel. type: string format: uuid bron: title: Bron description: 'De naam van het component waar de wijziging in is gedaan. Uitleg bij mogelijke waarden: * `ac` - Autorisaties API * `nrc` - Notificaties API * `zrc` - Zaken API * `ztc` - Catalogi API * `drc` - Documenten API * `brc` - Besluiten API' type: string enum: - ac - nrc - zrc - ztc - drc - brc requestId: title: Request id description: Een globaal "request" ID om een verzoek door het netwerk heen te traceren. type: string maxLength: 255 applicatieId: title: Applicatie id description: Unieke identificatie van de applicatie, binnen de organisatie. type: string maxLength: 100 applicatieWeergave: title: Applicatie weergave description: Vriendelijke naam van de applicatie. type: string maxLength: 200 gebruikersId: title: Gebruikers id description: Unieke identificatie van de gebruiker die binnen de organisatie herleid kan worden naar een persoon. type: string maxLength: 255 gebruikersWeergave: title: Gebruikers weergave description: Vriendelijke naam van de gebruiker. type: string maxLength: 255 actie: title: Actie description: 'De uitgevoerde handeling. De bekende waardes voor dit veld zijn hieronder aangegeven, maar andere waardes zijn ook toegestaan Uitleg bij mogelijke waarden: * `create` - Object aangemaakt * `list` - Lijst van objecten opgehaald * `retrieve` - Object opgehaald * `destroy` - Object verwijderd * `update` - Object bijgewerkt * `partial_update` - Object deels bijgewerkt' type: string maxLength: 50 minLength: 1 actieWeergave: title: Actie weergave description: Vriendelijke naam van de actie. type: string maxLength: 200 resultaat: title: Resultaat description: HTTP status code van de API response van de uitgevoerde handeling. type: integer maximum: 599 minimum: 100 hoofdObject: title: Hoofd object description: De URL naar het hoofdobject van een component. type: string format: uri maxLength: 1000 minLength: 1 resource: title: Resource description: Het type resource waarop de actie gebeurde. type: string maxLength: 50 minLength: 1 resourceUrl: title: Resource url description: De URL naar het object. type: string format: uri maxLength: 1000 minLength: 1 toelichting: title: Toelichting description: Toelichting waarom de handeling is uitgevoerd. type: string resourceWeergave: title: Resource weergave description: Vriendelijke identificatie van het object. type: string maxLength: 200 minLength: 1 aanmaakdatum: title: Aanmaakdatum description: De datum waarop de handeling is gedaan. type: string format: date-time readOnly: true wijzigingen: $ref: '#/components/schemas/Wijzigingen' BesluitInformatieObject: required: - informatieobject - besluit type: object properties: url: title: Url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. type: string format: uri readOnly: true maxLength: 1000 minLength: 1 informatieobject: title: Informatieobject description: URL-referentie naar het INFORMATIEOBJECT (in de Documenten API) waarin (een deel van) het besluit beschreven is. type: string format: uri maxLength: 1000 minLength: 1 besluit: title: Besluit description: URL-referentie naar het BESLUIT. type: string format: uri