--- title: "Werk een VERZOEK deels bij." method: PATCH path: "/verzoeken/{uuid}" tags: ["verzoeken"] --- # Werk een VERZOEK deels bij. `PATCH /verzoeken/{uuid}` ## Request - Base URL: `/api/v1` (relative, and the document was published on a file host, not at the API’s origin) - URL: `/api/v1/verzoeken/{uuid}` - Auth: HTTP bearer - TypeScript: (a function with typed inputs; its response is checked against the schema) Werk een VERZOEK deels bij. ## Headers - `Content-Type` 'application/json', required - `X-NLX-Request-Application-Id` string - `X-NLX-Request-User-Id` string - `X-Audit-Toelichting` string ## Request body - Verzoek - `url` string, uri: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. - `identificatie` string: De unieke identificatie van het VERZOEK binnen de organisatie die verantwoordelijk is voor de behandeling van het VERZOEK. - `bronorganisatie` string, required: 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 - `externeIdentificatie` string: De identificatie van het VERZOEK buiten de eigen organisatie. - `registratiedatum` string, date-time: De datum en het tijdstip waarop het VERZOEK is geregistreerd. - `voorkeurskanaal` string: Het communicatiekanaal dat voor opvolging van het VERZOEK de voorkeur heeft van de KLANT. - `tekst` string: Een toelichting die inhoudelijk het VERZOEK van de KLANT beschrijft. - `status` 'ontvangen' | 'in_behandeling' | 'afgehandeld' | 'afgewezen' | 'ingetrokken', required: 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. - `inTeTrekkenVerzoek` string, uri, nullable: URL-referentie naar het (eerdere) VERZOEK dat door dit VERZOEK wordt verzocht ingetrokken te worden. - `intrekkendeVerzoek` string, uri, nullable: 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. - `aangevuldeVerzoek` string, uri, nullable: URL-referentie naar het (eerdere) VERZOEK dat door dit VERZOEK wordt aangevuld. - `aanvullendeVerzoek` string, uri, nullable: 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. ## Response `200` OK - Verzoek - `url` string, uri: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. - `identificatie` string: De unieke identificatie van het VERZOEK binnen de organisatie die verantwoordelijk is voor de behandeling van het VERZOEK. - `bronorganisatie` string, required: 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 - `externeIdentificatie` string: De identificatie van het VERZOEK buiten de eigen organisatie. - `registratiedatum` string, date-time: De datum en het tijdstip waarop het VERZOEK is geregistreerd. - `voorkeurskanaal` string: Het communicatiekanaal dat voor opvolging van het VERZOEK de voorkeur heeft van de KLANT. - `tekst` string: Een toelichting die inhoudelijk het VERZOEK van de KLANT beschrijft. - `status` 'ontvangen' | 'in_behandeling' | 'afgehandeld' | 'afgewezen' | 'ingetrokken', required: 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. - `inTeTrekkenVerzoek` string, uri, nullable: URL-referentie naar het (eerdere) VERZOEK dat door dit VERZOEK wordt verzocht ingetrokken te worden. - `intrekkendeVerzoek` string, uri, nullable: 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. - `aangevuldeVerzoek` string, uri, nullable: URL-referentie naar het (eerdere) VERZOEK dat door dit VERZOEK wordt aangevuld. - `aanvullendeVerzoek` string, uri, nullable: 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. ## Other responses - `400`: Bad request - `401`: Unauthorized - `403`: Forbidden - `404`: Not found - `406`: Not acceptable - `409`: Conflict - `410`: Gone - `415`: Unsupported media type - `429`: Too many requests - `500`: Internal server error ## Changes > 9 revisions in range; 1 not diffed. - **2022-06-13** `1f46a04e9dae`: 1 breaking, 3 info - added the new required `header` request parameter `Content-Type` - added the new optional `header` request parameter `X-Audit-Toelichting` - added the new optional `header` request parameter `X-NLX-Request-Application-Id` - added the new optional `header` request parameter `X-NLX-Request-User-Id` - **2020-07-09** `a7cd30866623`: 1 warning - deleted the `header` request parameter `Content-Type` - **2020-07-09** `9f46760652b6`: 4 breaking, 4 info - the response property `aangevuldeVerzoek` became nullable for the status `200` - the response property `aanvullendeVerzoek` became nullable for the status `200` - the response property `inTeTrekkenVerzoek` became nullable for the status `200` - the response property `intrekkendeVerzoek` became nullable for the status `200` - …4 more - **2020-07-09** `d63999b3259d`: 4 warning, 8 info - removed the request property `interactiedatum` - removed the request property `klant` - removed the optional property `interactiedatum` from the response with the `200` status - removed the optional property `klant` from the response with the `200` status - …8 more - **2020-07-09** `1fba4e92a46d`: 2 info - the security scope `verzoeken.bijwerken` was added to the endpoint's security scheme `JWT-Claims` - the security scope `klanten.bijwerken` was removed from the endpoint's security scheme `JWT-Claims` [Operation history](https://skmtc.dev/vng-realisatie/apis/verzoeken-api/changes/verzoeken/:uuid/patch.md) --- [API](https://skmtc.dev/vng-realisatie/apis/verzoeken-api.md) - [All operations](https://skmtc.dev/vng-realisatie/apis/verzoeken-api/llms.txt) - [OpenAPI document](https://skmtc.dev/vng-realisatie/apis/verzoeken-api/revisions/1f46a04e9dae?raw)