openapi: 3.0.0 info: title: verzoeken API description: 'Een API voor het registreren, bewerken en opvragen van verzoeken. **Afhankelijkheden** Deze API is afhankelijk van: * Autorisaties API * Klanten API * Contactmomenten API *(optioneel)* * Zaken API *(optioneel)* * Documenten 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 `verzoeken`. **Main resource** `verzoek` **Kenmerken** * `bronorganisatie`: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die de klantinteractie heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef **Resources en acties** **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-beta security: - JWT-Claims: [] paths: /klantverzoeken: get: operationId: klantverzoek_list summary: Alle KLANT-VERZOEK relaties opvragen. description: Deze lijst kan gefilterd wordt met query-string parameters. parameters: - name: verzoek in: query description: URL-referentie naar het VERZOEK. required: false schema: type: string format: uri - name: klant in: query description: URL-referentie naar een KLANT (in Klanten API) 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/KlantVerzoek' '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: - klantverzoeken security: - JWT-Claims: - verzoeken.lezen post: operationId: klantverzoek_create description: Maak een KLANT-VERZOEK relatie aan. parameters: - name: Content-Type in: header description: Content type van de verzoekinhoud. required: true schema: type: string enum: - application/json - 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/KlantVerzoek' 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/KlantVerzoek' '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: - klantverzoeken security: - JWT-Claims: - verzoeken.aanmaken parameters: [] /klantverzoeken/{uuid}: get: operationId: klantverzoek_read summary: Een specifieke KLANT-VERZOEK relatie opvragen. description: Een specifieke KLANT-VERZOEK 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 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." required: false examples: oneValue: summary: "E\xE9n ETag-waarde" value: '"79054025255fb1a26e4bc422aef54eb4"' multipleValues: summary: Meerdere ETag-waardes value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' 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/KlantVerzoek' '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: - klantverzoeken security: - JWT-Claims: - verzoeken.lezen delete: operationId: klantverzoek_delete summary: Verwijder een KLANT-VERZOEK relatie. description: Verwijder een KLANT-VERZOEK 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: - klantverzoeken security: - JWT-Claims: - verzoeken.verwijderen parameters: - name: uuid in: path description: Unieke resource identifier (UUID4) required: true schema: type: string format: uuid /objectverzoeken: get: operationId: objectverzoek_list summary: Alle OBJECT-VERZOEK relaties opvragen. description: Alle OBJECT-VERZOEK relaties opvragen. parameters: - name: object in: query description: URL-referentie naar het gerelateerde OBJECT (in een andere API). required: false schema: type: string format: uri - name: verzoek in: query description: URL-referentie naar het VERZOEK. 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/ObjectVerzoek' '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: - objectverzoeken security: - JWT-Claims: - verzoeken.lezen post: operationId: objectverzoek_create summary: Maak een OBJECT-VERZOEK relatie aan. description: 'Maak een OBJECT-VERZOEK relatie aan. **LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** Andere API''s, zoals de Zaken API, gebruiken dit endpoint bij het synchroniseren van relaties.' parameters: - name: Content-Type in: header description: Content type van de verzoekinhoud. required: true schema: type: string enum: - application/json requestBody: content: application/json: schema: $ref: '#/components/schemas/ObjectVerzoek' 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/ObjectVerzoek' '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: - objectverzoeken security: - JWT-Claims: - verzoeken.aanmaken parameters: [] /objectverzoeken/{uuid}: get: operationId: objectverzoek_read summary: Een specifiek OBJECT-VERZOEK relatie opvragen. description: Een specifiek OBJECT-VERZOEK 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 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." required: false examples: oneValue: summary: "E\xE9n ETag-waarde" value: '"79054025255fb1a26e4bc422aef54eb4"' multipleValues: summary: Meerdere ETag-waardes value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' 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/ObjectVerzoek' '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: - objectverzoeken security: - JWT-Claims: - verzoeken.lezen delete: operationId: objectverzoek_delete summary: Verwijder een OBJECT-VERZOEK relatie. description: 'Verwijder een OBJECT-VERZOEK relatie. **LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** Andere API''s, zoals de Zaken API, gebruiken dit endpoint bij het synchroniseren van relaties.' 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: - objectverzoeken security: - JWT-Claims: - verzoeken.verwijderen parameters: - name: uuid in: path description: Unieke resource identifier (UUID4) required: true schema: type: string format: uuid /verzoekcontactmomenten: get: operationId: verzoekcontactmoment_list summary: Alle VERZOEK-CONTACTMOMENT relaties opvragen. description: Deze lijst kan gefilterd wordt met query-string parameters. parameters: - name: verzoek in: query description: URL-referentie naar het VERZOEK. required: false schema: type: string format: uri - name: contactmoment in: query description: URL-referentie naar een CONTACTMOMENT (in Contactmoment API) 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/VerzoekContactMoment' '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: - verzoekcontactmomenten security: - JWT-Claims: - verzoeken.lezen post: operationId: verzoekcontactmoment_create summary: Maak een VERZOEK-CONTACTMOMENT relatie aan. description: 'Registreer een CONTACTMOMENT bij een VERZOEK. Er worden twee types van relaties met andere objecten gerealiseerd: **Er wordt gevalideerd op** - geldigheid `verzoek` URL - geldigheid `contactmoment` URL - de combinatie `contactmoment` en `verzoek` moet uniek zijn' parameters: - name: Content-Type in: header description: Content type van de verzoekinhoud. required: true schema: type: string enum: - application/json - 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/VerzoekContactMoment' 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/VerzoekContactMoment' '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: - verzoekcontactmomenten security: - JWT-Claims: - verzoeken.aanmaken parameters: [] /verzoekcontactmomenten/{uuid}: get: operationId: verzoekcontactmoment_read summary: Een specifieke VERZOEK-CONTACTMOMENT relatie opvragen. description: Een specifieke VERZOEK-CONTACTMOMENT 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 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." required: false examples: oneValue: summary: "E\xE9n ETag-waarde" value: '"79054025255fb1a26e4bc422aef54eb4"' multipleValues: summary: Meerdere ETag-waardes value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' 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/VerzoekContactMoment' '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: - verzoekcontactmomenten security: - JWT-Claims: - verzoeken.lezen delete: operationId: verzoekcontactmoment_delete summary: Verwijder een VERZOEK-CONTACTMOMENT relatie. description: Verwijder een VERZOEK-CONTACTMOMENT 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: - verzoekcontactmomenten security: - JWT-Claims: - verzoeken.verwijderen parameters: - name: uuid in: path description: Unieke resource identifier (UUID4) required: true schema: type: string format: uuid /verzoeken: get: operationId: verzoek_list summary: Alle VERZOEKen opvragen. description: Alle VERZOEKen opvragen. parameters: - name: identificatie in: query description: De unieke identificatie van het VERZOEK binnen de organisatie die verantwoordelijk is voor de behandeling van het VERZOEK. required: false schema: type: string - name: bronorganisatie in: query description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die de klantinteractie heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef required: false schema: type: string - name: externeIdentificatie in: query description: De identificatie van het VERZOEK buiten de eigen organisatie. required: false schema: type: string - name: registratiedatum in: query description: De datum en het tijdstip waarop het VERZOEK is geregistreerd. required: false schema: type: string - name: registratiedatum__gt in: query description: De datum en het tijdstip waarop het VERZOEK is geregistreerd. required: false schema: type: string - name: registratiedatum__gte in: query description: De datum en het tijdstip waarop het VERZOEK is geregistreerd. required: false schema: type: string - name: registratiedatum__lt in: query description: De datum en het tijdstip waarop het VERZOEK is geregistreerd. required: false schema: type: string - name: registratiedatum__lte in: query description: De datum en het tijdstip waarop het VERZOEK is geregistreerd. required: false schema: type: string - name: voorkeurskanaal in: query description: Het communicatiekanaal dat voor opvolging van het VERZOEK de voorkeur heeft van de KLANT. required: false schema: type: string - name: tekst in: query description: Een toelichting die inhoudelijk het VERZOEK van de KLANT beschrijft. required: false schema: type: string - name: status in: query description: De waarden van de typering van de voortgang van afhandeling van een VERZOEK. required: false schema: type: string enum: - ontvangen - in_behandeling - afgehandeld - afgewezen - ingetrokken - name: inTeTrekkenVerzoek in: query description: URL-referentie naar het (eerdere) VERZOEK dat door dit VERZOEK wordt verzocht ingetrokken te worden. required: false schema: type: string format: uri - name: intrekkendeVerzoek in: query description: URL-referentie naar het (latere) VERZOEK waarin verzocht wordt dit VERZOEK in te trekken. Dit veld is alleen leesbaar en wordt automatisch gezet wanneer er een ander VERZOEK wordt aangemaakt dat dit VERZOEK intrekt. required: false schema: type: string format: uri - name: aangevuldeVerzoek in: query description: URL-referentie naar het (eerdere) VERZOEK dat door dit VERZOEK wordt aangevuld. required: false schema: type: string format: uri - name: aanvullendeVerzoek in: query description: URL-referentie naar het (latere) VERZOEK waarin dit VERZOEK wordt aangevuld. Dit veld is alleen leesbaar en wordt automatisch gezet indien een ander VERZOEK wordt aangemaakt dat dit VERZOEK aanvult. 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/Verzoek' '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: - verzoeken security: - JWT-Claims: - verzoeken.lezen post: operationId: verzoek_create summary: Maak een VERZOEK aan. description: Maak een VERZOEK aan. parameters: - name: Content-Type in: header description: Content type van de verzoekinhoud. required: true schema: type: string enum: - application/json - 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/Verzoek' 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/Verzoek' '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: - verzoeken security: - JWT-Claims: - verzoeken.aanmaken parameters: [] /verzoeken/{uuid}: get: operationId: verzoek_read summary: Een specifiek VERZOEK opvragen. description: Een specifiek VERZOEK 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 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." required: false examples: oneValue: summary: "E\xE9n ETag-waarde" value: '"79054025255fb1a26e4bc422aef54eb4"' multipleValues: summary: Meerdere ETag-waardes value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' 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/Verzoek' '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: - verzoeken security: - JWT-Claims: - verzoeken.lezen put: operationId: verzoek_update summary: Werk een VERZOEK in zijn geheel bij. description: Werk een VERZOEK in zijn geheel bij. parameters: - name: Content-Type in: header description: Content type van de verzoekinhoud. required: true schema: type: string enum: - application/json - 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/Verzoek' 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/Verzoek' '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: - verzoeken security: - JWT-Claims: - verzoeken.bijwerken patch: operationId: verzoek_partial_update summary: Werk een VERZOEK deels bij. description: Werk een VERZOEK deels bij. parameters: - name: Content-Type in: header description: Content type van de verzoekinhoud. required: true schema: type: string enum: - application/json - 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/Verzoek' 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/Verzoek' '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: - verzoeken security: - JWT-Claims: - verzoeken.bijwerken delete: operationId: verzoek_delete summary: Verwijder een VERZOEK. description: Verwijder een VERZOEK. 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: - verzoeken security: - JWT-Claims: - verzoeken.verwijderen parameters: - name: uuid in: path description: Unieke resource identifier (UUID4) required: true schema: type: string format: uuid /verzoeken/{verzoek_uuid}/audittrail: get: operationId: audittrail_list summary: Alle audit trail regels behorend bij het VERZOEK. description: Alle audit trail regels behorend bij het VERZOEK. 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: - verzoeken security: - JWT-Claims: - audittrails.lezen parameters: - name: verzoek_uuid in: path required: true description: Unieke resource identifier (UUID4) schema: type: string format: uuid /verzoeken/{verzoek_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 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." required: false examples: oneValue: summary: "E\xE9n ETag-waarde" value: '"79054025255fb1a26e4bc422aef54eb4"' multipleValues: summary: Meerdere ETag-waardes value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' 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: - verzoeken security: - JWT-Claims: - audittrails.lezen parameters: - name: uuid in: path description: Unieke identificatie van de audit regel. required: true schema: type: string format: uuid - name: verzoek_uuid in: path required: true description: Unieke resource identifier (UUID4) schema: type: string format: uuid /verzoekinformatieobjecten: get: operationId: verzoekinformatieobject_list summary: Alle VERZOEK-INFORMATIEOBJECT relaties opvragen. description: Deze lijst kan gefilterd wordt met query-string parameters. parameters: - name: verzoek in: query description: URL-referentie naar het VERZOEK. 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 verzoek beschreven is of aanvullende informatie biedt bij het VERZOEK. 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/VerzoekInformatieObject' '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: - verzoekinformatieobjecten security: - JWT-Claims: - verzoeken.lezen post: operationId: verzoekinformatieobject_create summary: Maak een VERZOEK-INFORMATIEOBJECT relatie aan. description: "Registreer een INFORMATIEOBJECT bij een VERZOEK. Er worden twee\ \ types van\nrelaties met andere objecten gerealiseerd:\n\n**Er wordt gevalideerd\ \ op**\n- geldigheid `verzoek` URL\n- geldigheid `informatieobject` URL\n\ - de combinatie `informatieobject` en `verzoek` moet uniek zijn\n\n**Opmerkingen**\n\ - Bij het aanmaken wordt ook in de Documenten API de gespiegelde relatie\n\ \ aangemaakt, echter zonder de relatie-informatie." parameters: - name: Content-Type in: header description: Content type van de verzoekinhoud. required: true schema: type: string enum: - application/json - 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/VerzoekInformatieObject' 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/VerzoekInformatieObject' '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: - verzoekinformatieobjecten security: - JWT-Claims: - verzoeken.aanmaken parameters: [] /verzoekinformatieobjecten/{uuid}: get: operationId: verzoekinformatieobject_read summary: Een specifieke VERZOEK-INFORMATIEOBJECT relatie opvragen. description: Een specifieke VERZOEK-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 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." required: false examples: oneValue: summary: "E\xE9n ETag-waarde" value: '"79054025255fb1a26e4bc422aef54eb4"' multipleValues: summary: Meerdere ETag-waardes value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' 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/VerzoekInformatieObject' '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: - verzoekinformatieobjecten security: - JWT-Claims: - verzoeken.lezen delete: operationId: verzoekinformatieobject_delete summary: Verwijder een VERZOEK-INFORMATIEOBJECT relatie. description: Verwijder een VERZOEK-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: - verzoekinformatieobjecten security: - JWT-Claims: - verzoeken.verwijderen parameters: - name: uuid in: path description: Unieke resource identifier (UUID4) required: true schema: type: string format: uuid /verzoekproducten: get: operationId: verzoekproduct_list summary: Alle VERZOEK-PRODUCT relaties opvragen. description: Deze lijst kan gefilterd wordt met query-string parameters. parameters: - name: verzoek in: query description: URL-referentie naar het VERZOEK. required: false schema: type: string format: uri - name: product in: query description: URL-referentie naar het PRODUCT (in de Producten en Diensten API). required: false schema: type: string format: uri - name: productIdentificatie__code in: query description: De unieke code van het PRODUCT. required: false schema: type: string - 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/VerzoekProduct' '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: - verzoekproducten security: - JWT-Claims: - verzoeken.lezen post: operationId: verzoekproduct_create summary: Maak een VERZOEK-PRODUCT relatie aan. description: 'Registreer een PRODUCT bij een VERZOEK. Er worden twee types van relaties met andere objecten gerealiseerd: **Er wordt gevalideerd op** - geldigheid `verzoek` URL - geldigheid `product` URL' parameters: - name: Content-Type in: header description: Content type van de verzoekinhoud. required: true schema: type: string enum: - application/json - 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/VerzoekProduct' 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/VerzoekProduct' '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: - verzoekproducten security: - JWT-Claims: - verzoeken.aanmaken parameters: [] /verzoekproducten/{uuid}: get: operationId: verzoekproduct_read summary: Een specifieke VERZOEK-PRODUCT relatie opvragen. description: Een specifieke VERZOEK-PRODUCT 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 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." required: false examples: oneValue: summary: "E\xE9n ETag-waarde" value: '"79054025255fb1a26e4bc422aef54eb4"' multipleValues: summary: Meerdere ETag-waardes value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' 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/VerzoekProduct' '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: - verzoekproducten security: - JWT-Claims: - verzoeken.lezen delete: operationId: verzoekproduct_delete summary: Verwijder een VERZOEK-PRODUCT relatie. description: Verwijder een VERZOEK-PRODUCT 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: - verzoekproducten security: - JWT-Claims: - verzoeken.verwijderen parameters: - name: uuid in: path description: Unieke resource identifier (UUID4) required: true schema: type: string format: uuid tags: - name: klantverzoeken description: '' - name: objectverzoeken description: 'Het betreft een relatie tussen een willekeurig OBJECT, bijvoorbeeld een ZAAK in de Zaken API, en een VERZOEK.' - name: verzoekcontactmomenten description: '' - name: verzoeken description: '' - name: verzoekinformatieobjecten description: '' - name: verzoekproducten description: '' servers: - url: /api/v1 components: requestBodies: Verzoek: content: application/json: schema: $ref: '#/components/schemas/Verzoek' required: true securitySchemes: JWT-Claims: type: http scheme: bearer bearerFormat: JWT schemas: KlantVerzoek: required: - klant - verzoek 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 klant: title: Klant description: URL-referentie naar een KLANT (in Klanten API) type: string format: uri maxLength: 1000 minLength: 1 verzoek: title: Verzoek description: URL-referentie naar het VERZOEK. type: string format: uri maxLength: 1000 minLength: 1 rol: title: Rol description: 'Rol van de KLANT bij het VERZOEK. Uitleg bij mogelijke waarden: * `belanghebbende` - Belanghebbende * `initiator` - Initiator * `mede_initiator` - Mede-initiator' type: string enum: - belanghebbende - initiator - mede_initiator indicatieMachtiging: title: Indicatie machtiging description: 'Indicatie machtiging Uitleg bij mogelijke waarden: * `gemachtigde` - (Gemachtigde) De KLANT is door een andere KLANT gemachtigd om in het VERZOEK namens hem of haar te handelen. * `machtiginggever` - (Machtiginggever) De KLANT heeft een andere KLANT gemachtigd om in het VERZOEK namens hem of haar te handelen.' type: string enum: - gemachtigde - machtiginggever 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' ObjectVerzoek: required: - verzoek - object - objectType 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 verzoek: title: Verzoek description: URL-referentie naar het VERZOEK. type: string format: uri maxLength: 1000 minLength: 1 object: title: Object description: URL-referentie naar het gerelateerde OBJECT (in een andere API). type: string format: uri maxLength: 1000 minLength: 1 objectType: title: Objecttype description: 'Het type van het gerelateerde OBJECT. Uitleg bij mogelijke waarden: * `zaak` - Zaak' type: string enum: - zaak VerzoekContactMoment: required: - contactmoment - verzoek 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 contactmoment: title: Contactmoment description: URL-referentie naar een CONTACTMOMENT (in Contactmoment API) type: string format: uri maxLength: 1000 minLength: 1 verzoek: title: Verzoek description: URL-referentie naar het VERZOEK. type: string format: uri maxLength: 1000 minLength: 1 Verzoek: required: - bronorganisatie - status 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: De unieke identificatie van het VERZOEK binnen de organisatie die verantwoordelijk is voor de behandeling van het VERZOEK. type: string maxLength: 40 bronorganisatie: title: Bronorganisatie description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die de klantinteractie heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef type: string maxLength: 9 minLength: 1 externeIdentificatie: title: Externe identificatie description: De identificatie van het VERZOEK buiten de eigen organisatie. type: string maxLength: 40 registratiedatum: title: Registratiedatum description: De datum en het tijdstip waarop het VERZOEK is geregistreerd. type: string format: date-time voorkeurskanaal: title: Voorkeurskanaal description: Het communicatiekanaal dat voor opvolging van het VERZOEK de voorkeur heeft van de KLANT. type: string maxLength: 50 tekst: title: Tekst description: Een toelichting die inhoudelijk het VERZOEK van de KLANT beschrijft. type: string status: title: Status description: 'De waarden van de typering van de voortgang van afhandeling van een VERZOEK. Uitleg bij mogelijke waarden: * `ontvangen` - (Ontvangen) Het verzoek is ingediend en door de organisatie ontvangen. * `in_behandeling` - (In behandeling) Het is verzoek is in behandeling. * `afgehandeld` - (Afgehandeld) Het verzoek zelf is afgehandeld. Eventuele vervolg acties, zoals zaken die voortkomen uit het verzoek, hebben een eigen status. * `afgewezen` - (Afgewezen) Het verzoek is afgewezen zonder vervolg acties. * `ingetrokken` - (Ingetrokken) De indiener heeft het verzoek ingetrokken.' type: string enum: - ontvangen - in_behandeling - afgehandeld - afgewezen - ingetrokken inTeTrekkenVerzoek: title: In te trekken verzoek description: URL-referentie naar het (eerdere) VERZOEK dat door dit VERZOEK wordt verzocht ingetrokken te worden. type: string format: uri maxLength: 1000 minLength: 1 nullable: true intrekkendeVerzoek: title: Intrekkende verzoek description: URL-referentie naar het (latere) VERZOEK waarin verzocht wordt dit VERZOEK in te trekken. Dit veld is alleen leesbaar en wordt automatisch gezet wanneer er een ander VERZOEK wordt aangemaakt dat dit VERZOEK intrekt. type: string format: uri readOnly: true maxLength: 1000 minLength: 1 nullable: true aangevuldeVerzoek: title: Aangevulde verzoek description: URL-referentie naar het (eerdere) VERZOEK dat door dit VERZOEK wordt aangevuld. type: string format: uri maxLength: 1000 minLength: 1 nullable: true aanvullendeVerzoek: title: Aanvullende verzoek description: URL-referentie naar het (latere) VERZOEK waarin dit VERZOEK wordt aangevuld. Dit veld is alleen leesbaar en wordt automatisch gezet indien een ander VERZOEK wordt aangemaakt dat dit VERZOEK aanvult. type: string format: uri readOnly: true maxLength: 1000 minLength: 1 nullable: true 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` - Autorisatiecomponent * `nrc` - Notificatierouteringcomponent * `zrc` - Zaakregistratiecomponent * `ztc` - Zaaktypecatalogus * `drc` - Documentregistratiecomponent * `brc` - Besluitregistratiecomponent * `kic` - Klantinteractiescomponent' type: string enum: - ac - nrc - zrc - ztc - drc - brc - kic 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' VerzoekInformatieObject: required: - informatieobject - verzoek 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 verzoek beschreven is of aanvullende informatie biedt bij het VERZOEK. type: string format: uri maxLength: 1000 minLength: 1 verzoek: title: Verzoek description: URL-referentie naar het VERZOEK. type: string format: uri maxLength: 1000 minLength: 1 Product: title: Product identificatie description: Identificerende gegevens van het PRODUCT voor het geval er bij `product` geen URL kan worden opgenomen naar het PRODUCT in de Producten en Diensten API. required: - code type: object properties: code: title: Code description: De unieke code van het PRODUCT. type: string maxLength: 20 minLength: 1 VerzoekProduct: required: - verzoek 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 verzoek: title: Verzoek description: URL-referentie naar het VERZOEK. type: string format: uri maxLength: 1000 minLength: 1 product: title: Product description: URL-referentie naar het PRODUCT (in de Producten en Diensten API). type: string format: uri maxLength: 1000 productIdentificatie: $ref: '#/components/schemas/Product'