openapi: 3.2.0 info: title: Vng Realisatie Zaken API version: 1.5.1 contact: email: standaarden.ondersteuning@vng.nl url: https://vng-realisatie.github.io/gemma-zaken license: name: EUPL 1.2 url: https://opensource.org/licenses/EUPL-1.2 description: 'Operations tagged zaken across 2 of this provider''s published API definitions: vng-realisatie-zaken-openapi.yml, vng-realisatie-zaken-openapi.yml. Each path carries the servers of the definition it was published in.' servers: - url: https://zaken-api.vng.cloud/api/v1/ description: Productie Omgeving tags: - name: zaken description: Een zaak mag (in principe) niet meer gewijzigd worden als de `archiefstatus` een andere status heeft dan "nog_te_archiveren". Voor praktische redenen is er geen harde validatie regel aan de provider kant. paths: /zaken: get: operationId: zaak_list description: Deze lijst kan gefilterd wordt met query-string parameters. summary: Alle ZAAKen opvragen parameters: - name: identificatie required: false in: query description: De unieke identificatie van de ZAAK binnen de organisatie die verantwoordelijk is voor de behandeling van de ZAAK. schema: type: string - name: bronorganisatie required: false in: query description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef schema: type: string - name: bronorganisatie__in required: false in: query description: Multiple values may be separated by commas. schema: type: array items: type: string style: form explode: false - name: zaaktype required: false in: query description: URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS waar deze voorkomt schema: type: string format: uri - name: archiefnominatie required: false in: query description: Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde termijn vernietigd moet worden. schema: type: string enum: - blijvend_bewaren - vernietigen - name: archiefnominatie__in required: false in: query description: Multiple values may be separated by commas. schema: type: array items: type: string style: form explode: false - name: archiefactiedatum required: false in: query description: De datum waarop het gearchiveerde zaakdossier vernietigd moet worden dan wel overgebracht moet worden naar een archiefbewaarplaats. Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT aan deze ZAAK indien nog leeg. schema: type: string - name: archiefactiedatum__lt required: false in: query description: De datum waarop het gearchiveerde zaakdossier vernietigd moet worden dan wel overgebracht moet worden naar een archiefbewaarplaats. Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT aan deze ZAAK indien nog leeg. schema: type: string - name: archiefactiedatum__gt required: false in: query description: De datum waarop het gearchiveerde zaakdossier vernietigd moet worden dan wel overgebracht moet worden naar een archiefbewaarplaats. Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT aan deze ZAAK indien nog leeg. schema: type: string - name: archiefactiedatum__isnull required: false in: query description: De datum waarop het gearchiveerde zaakdossier vernietigd moet worden dan wel overgebracht moet worden naar een archiefbewaarplaats. Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT aan deze ZAAK indien nog leeg. schema: type: string - name: archiefstatus required: false in: query description: Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde termijn vernietigd moet worden. schema: type: string enum: - nog_te_archiveren - gearchiveerd - gearchiveerd_procestermijn_onbekend - overgedragen - name: archiefstatus__in required: false in: query description: Multiple values may be separated by commas. schema: type: array items: type: string style: form explode: false - name: startdatum required: false in: query description: De datum waarop met de uitvoering van de zaak is gestart schema: type: string - name: startdatum__gt required: false in: query description: De datum waarop met de uitvoering van de zaak is gestart schema: type: string - name: startdatum__gte required: false in: query description: De datum waarop met de uitvoering van de zaak is gestart schema: type: string - name: startdatum__lt required: false in: query description: De datum waarop met de uitvoering van de zaak is gestart schema: type: string - name: startdatum__lte required: false in: query description: De datum waarop met de uitvoering van de zaak is gestart schema: type: string - name: registratiedatum required: false in: query description: De datum waarop de zaakbehandelende organisatie de ZAAK heeft geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag gebruikt. schema: type: string - name: registratiedatum__gt required: false in: query description: De datum waarop de zaakbehandelende organisatie de ZAAK heeft geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag gebruikt. schema: type: string - name: registratiedatum__lt required: false in: query description: De datum waarop de zaakbehandelende organisatie de ZAAK heeft geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag gebruikt. schema: type: string - name: einddatum required: false in: query description: De datum waarop de uitvoering van de zaak afgerond is. schema: type: string - name: einddatum__gt required: false in: query description: De datum waarop de uitvoering van de zaak afgerond is. schema: type: string - name: einddatum__lt required: false in: query description: De datum waarop de uitvoering van de zaak afgerond is. schema: type: string - name: einddatum__isnull required: false in: query description: De datum waarop de uitvoering van de zaak afgerond is. schema: type: string - name: einddatumGepland required: false in: query description: De datum waarop volgens de planning verwacht wordt dat de zaak afgerond wordt. schema: type: string - name: einddatumGepland__gt required: false in: query description: De datum waarop volgens de planning verwacht wordt dat de zaak afgerond wordt. schema: type: string - name: einddatumGepland__lt required: false in: query description: De datum waarop volgens de planning verwacht wordt dat de zaak afgerond wordt. schema: type: string - name: uiterlijkeEinddatumAfdoening required: false in: query description: De laatste datum waarop volgens wet- en regelgeving de zaak afgerond dient te zijn. schema: type: string - name: uiterlijkeEinddatumAfdoening__gt required: false in: query description: De laatste datum waarop volgens wet- en regelgeving de zaak afgerond dient te zijn. schema: type: string - name: uiterlijkeEinddatumAfdoening__lt required: false in: query description: De laatste datum waarop volgens wet- en regelgeving de zaak afgerond dient te zijn. schema: type: string - name: rol__betrokkeneType required: false in: query description: Type van de `betrokkene`. schema: type: string enum: - natuurlijk_persoon - niet_natuurlijk_persoon - vestiging - organisatorische_eenheid - medewerker - name: rol__betrokkene required: false in: query description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. schema: type: string format: uri - name: rol__omschrijvingGeneriek required: false in: query description: Algemeen gehanteerde benaming van de aard van de ROL, afgeleid uit het ROLTYPE. schema: type: string enum: - adviseur - behandelaar - belanghebbende - beslisser - initiator - klantcontacter - zaakcoordinator - mede_initiator - name: maximaleVertrouwelijkheidaanduiding required: false in: query description: Zaken met een vertrouwelijkheidaanduiding die beperkter is dan de aangegeven aanduiding worden uit de resultaten gefiltered. schema: type: string enum: - openbaar - beperkt_openbaar - intern - zaakvertrouwelijk - vertrouwelijk - confidentieel - geheim - zeer_geheim - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn required: false in: query description: Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene bepalingen burgerservicenummer. schema: type: string maxLength: 9 - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie required: false in: query description: Het door de gemeente uitgegeven unieke nummer voor een ANDER NATUURLIJK PERSOON schema: type: string maxLength: 17 - name: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer required: false in: query description: Het administratienummer van de persoon, bedoeld in de Wet BRP schema: type: string maxLength: 10 - name: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId required: false in: query description: Het door een kamer toegekend uniek nummer voor de INGESCHREVEN NIET-NATUURLIJK PERSOON schema: type: string - name: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie required: false in: query description: Het door de gemeente uitgegeven unieke nummer voor een ANDER NIET-NATUURLIJK PERSOON schema: type: string maxLength: 17 - name: rol__betrokkeneIdentificatie__vestiging__vestigingsNummer required: false in: query description: Een korte unieke aanduiding van de Vestiging. schema: type: string maxLength: 24 - name: rol__betrokkeneIdentificatie__medewerker__identificatie required: false in: query description: Een korte unieke aanduiding van de MEDEWERKER. schema: type: string maxLength: 24 - name: rol__betrokkeneIdentificatie__organisatorischeEenheid__identificatie required: false in: query description: Een korte identificatie van de organisatorische eenheid. schema: type: string - name: ordering required: false in: query description: Het veld waarop de resultaten geordend worden. schema: type: array items: type: string enum: - - startdatum - -startdatum - einddatum - -einddatum - publicatiedatum - -publicatiedatum - archiefactiedatum - -archiefactiedatum style: form explode: false - name: expand required: false in: query description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt." schema: type: string - name: page required: false in: query description: Een pagina binnen de gepagineerde set resultaten. schema: type: integer - in: header name: Accept-Crs schema: type: string enum: - EPSG:4326 description: Het gewenste 'Coordinate Reference System' (CRS) van de geometrie in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). required: true - in: header name: Content-Crs schema: type: string enum: - EPSG:4326 description: Het 'Coordinate Reference System' (CRS) van de geometrie in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). required: true tags: - zaken security: - JWT-Claims: - zaken.lezen responses: '200': headers: Content-Crs: schema: type: string enum: - EPSG:4326 description: Het 'Coordinate Reference System' (CRS) van de geometrie in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). API-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/PaginatedZaakList' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '412': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Precondition failed '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: zaak_create description: 'Indien geen identificatie gegeven is, dan wordt deze automatisch gegenereerd. De identificatie moet uniek zijn binnen de bronorganisatie. **Er wordt gevalideerd op:** - geldigheid `zaaktype` URL - de resource moet opgevraagd kunnen worden uit de Catalogi API en de vorm van een ZAAKTYPE hebben. - `zaaktype` is geen concept (`zaaktype.concept = False`) - `laatsteBetaaldatum` mag niet in de toekomst liggen. - `laatsteBetaaldatum` mag niet gezet worden als de betalingsindicatie "nvt" is. - `barchiefnominatie` moet een waarde hebben indien archiefstatus niet de waarde "nog_te_archiveren" heeft. - `archiefactiedatum` moet een waarde hebben indien archiefstatus niet de waarde "nog_te_archiveren" heeft. - `archiefstatus` kan alleen een waarde anders dan "nog_te_archiveren" hebben indien van alle gerelateeerde INFORMATIEOBJECTen het attribuut `status` de waarde "gearchiveerd" heeft.' summary: Maak een ZAAK aan parameters: - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true - in: header name: X-NLX-Logrecord-ID schema: type: string description: Identifier of the request, traceable throughout the network - in: header name: X-Audit-Toelichting schema: type: string description: Toelichting waarom een bepaald verzoek wordt gedaan - in: header name: Accept-Crs schema: type: string enum: - EPSG:4326 description: Het gewenste 'Coordinate Reference System' (CRS) van de geometrie in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). required: true - in: header name: Content-Crs schema: type: string enum: - EPSG:4326 description: Het 'Coordinate Reference System' (CRS) van de geometrie in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). required: true tags: - zaken requestBody: content: application/json: schema: $ref: '#/components/schemas/Zaak' required: true security: - JWT-Claims: - zaken.aanmaken responses: '201': headers: Content-Crs: schema: type: string enum: - EPSG:4326 description: Het 'Coordinate Reference System' (CRS) van de geometrie in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). Location: schema: type: string format: uri description: URL waar de resource leeft. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/Zaak' description: Created '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '412': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Precondition failed '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error servers: - url: https://zaken-api.vng.cloud/api/v1/ description: Productie Omgeving /zaken/{uuid}: get: operationId: zaak_retrieve description: Een specifieke ZAAK opvragen. summary: Een specifieke ZAAK opvragen parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: Voer een voorwaardelijk verzoek uit. Deze header moet één of meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. Indien de waarde van de ETag van de huidige resource voorkomt in deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) voor meer informatie. examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: Eén ETag-waarde MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes - in: header name: Accept-Crs schema: type: string enum: - EPSG:4326 description: Het gewenste 'Coordinate Reference System' (CRS) van de geometrie in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). required: true - in: header name: Content-Crs schema: type: string enum: - EPSG:4326 description: Het 'Coordinate Reference System' (CRS) van de geometrie in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). required: true - in: query name: expand schema: type: string description: Haal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt. examples: ExpandZaaktype: value: zaaktype summary: expand zaaktype ExpandStatus: value: status summary: expand status ExpandStatus.statustype: value: status.statustype summary: expand status.statustype ExpandHoofdzaak.status.statustype: value: hoofdzaak.status.statustype summary: expand hoofdzaak.status.statustype ExpandHoofdzaak.deelzaken.status.statustype: value: hoofdzaak.deelzaken.status.statustype summary: expand hoofdzaak.deelzaken.status.statustype tags: - zaken security: - JWT-Claims: - zaken.lezen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. Content-Crs: schema: type: string enum: - EPSG:4326 description: Het 'Coordinate Reference System' (CRS) van de geometrie in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). API-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/Zaak' description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '412': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Precondition failed '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: zaak_update description: '**Er wordt gevalideerd op** - `identificatie` mag niet gewijzigd worden. - `laatsteBetaaldatum` mag niet in de toekomst liggen. - `laatsteBetaaldatum` mag niet gezet worden als de betalingsindicatie "nvt" is. - `archiefnominatie` moet een waarde hebben indien `archiefstatus` niet de waarde "nog_te_archiveren" heeft. - `archiefactiedatum` moet een waarde hebben indien `archiefstatus` niet de waarde "nog_te_archiveren" heeft. - `archiefstatus` kan alleen een waarde anders dan "nog_te_archiveren" hebben indien van alle gerelateeerde INFORMATIEOBJECTen het attribuut `status` de waarde "gearchiveerd" heeft. **Opmerkingen** - er worden enkel zaken getoond van de zaaktypes waar u toe geautoriseerd bent. - indien een zaak heropend moet worden, doe dit dan door een nieuwe status toe te voegen die NIET de eindstatus is. Zie de `Status` resource.' summary: Werk een ZAAK in zijn geheel bij parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true - in: header name: X-NLX-Logrecord-ID schema: type: string description: Identifier of the request, traceable throughout the network - in: header name: X-Audit-Toelichting schema: type: string description: Toelichting waarom een bepaald verzoek wordt gedaan - in: header name: Accept-Crs schema: type: string enum: - EPSG:4326 description: Het gewenste 'Coordinate Reference System' (CRS) van de geometrie in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). required: true - in: header name: Content-Crs schema: type: string enum: - EPSG:4326 description: Het 'Coordinate Reference System' (CRS) van de geometrie in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). required: true tags: - zaken requestBody: content: application/json: schema: $ref: '#/components/schemas/Zaak' required: true security: - JWT-Claims: - (zaken.bijwerken | zaken.geforceerd-bijwerken) responses: '200': headers: Content-Crs: schema: type: string enum: - EPSG:4326 description: Het 'Coordinate Reference System' (CRS) van de geometrie in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). API-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/Zaak' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '412': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Precondition failed '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: zaak_partial_update description: '**Er wordt gevalideerd op** - `identificatie` mag niet gewijzigd worden. - `laatsteBetaaldatum` mag niet in de toekomst liggen. - `laatsteBetaaldatum` mag niet gezet worden als de betalingsindicatie "nvt" is. - `archiefnominatie` moet een waarde hebben indien `archiefstatus` niet de waarde "nog_te_archiveren" heeft. - `archiefactiedatum` moet een waarde hebben indien `archiefstatus` niet de waarde "nog_te_archiveren" heeft. - `archiefstatus` kan alleen een waarde anders dan "nog_te_archiveren" hebben indien van alle gerelateeerde INFORMATIEOBJECTen het attribuut `status` de waarde "gearchiveerd" heeft. **Opmerkingen** - er worden enkel zaken getoond van de zaaktypes waar u toe geautoriseerd bent. - indien een zaak heropend moet worden, doe dit dan door een nieuwe status toe te voegen die NIET de eindstatus is. Zie de `Status` resource.' summary: Werk een ZAAK deels bij parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true - in: header name: X-NLX-Logrecord-ID schema: type: string description: Identifier of the request, traceable throughout the network - in: header name: X-Audit-Toelichting schema: type: string description: Toelichting waarom een bepaald verzoek wordt gedaan - in: header name: Accept-Crs schema: type: string enum: - EPSG:4326 description: Het gewenste 'Coordinate Reference System' (CRS) van de geometrie in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). required: true - in: header name: Content-Crs schema: type: string enum: - EPSG:4326 description: Het 'Coordinate Reference System' (CRS) van de geometrie in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). required: true tags: - zaken requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedZaak' security: - JWT-Claims: - (zaken.bijwerken | zaken.geforceerd-bijwerken) responses: '200': headers: Content-Crs: schema: type: string enum: - EPSG:4326 description: Het 'Coordinate Reference System' (CRS) van de geometrie in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). API-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/Zaak' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '412': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Precondition failed '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: zaak_destroy description: '***De gerelateerde resources zijn hierbij*** - `zaak` - de deelzaken van de verwijderde hoofzaak - `status` - alle statussen van de verwijderde zaak - `resultaat` - het resultaat van de verwijderde zaak - `rol` - alle rollen bij de zaak - `zaakobject` - alle zaakobjecten bij de zaak - `zaakeigenschap` - alle eigenschappen van de zaak - `zaakkenmerk` - alle kenmerken van de zaak - `zaakinformatieobject` - dit moet door-cascaden naar de Documenten API, zie ook: https://github.com/VNG-Realisatie/gemma-zaken/issues/791 (TODO) - `klantcontact` - alle klantcontacten bij een zaak' summary: Verwijder een ZAAK parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: X-NLX-Logrecord-ID schema: type: string description: Identifier of the request, traceable throughout the network - in: header name: X-Audit-Toelichting schema: type: string description: Toelichting waarom een bepaald verzoek wordt gedaan - in: header name: Accept-Crs schema: type: string enum: - EPSG:4326 description: Het gewenste 'Coordinate Reference System' (CRS) van de geometrie in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). required: true - in: header name: Content-Crs schema: type: string enum: - EPSG:4326 description: Het 'Coordinate Reference System' (CRS) van de geometrie in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). required: true tags: - zaken security: - JWT-Claims: - zaken.verwijderen responses: '204': description: No content '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '412': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Precondition failed '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error head: operationId: zaak_headers description: Vraag de headers op die je bij een GET request zou krijgen. summary: De headers voor een specifiek(e) ZAAK opvragen parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: Voer een voorwaardelijk verzoek uit. Deze header moet één of meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. Indien de waarde van de ETag van de huidige resource voorkomt in deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) voor meer informatie. examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: Eén ETag-waarde MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes - in: header name: Accept-Crs schema: type: string enum: - EPSG:4326 description: Het gewenste 'Coordinate Reference System' (CRS) van de geometrie in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). required: true - in: header name: Content-Crs schema: type: string enum: - EPSG:4326 description: Het 'Coordinate Reference System' (CRS) van de geometrie in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). required: true tags: - zaken responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. Content-Crs: schema: type: string enum: - EPSG:4326 description: Het 'Coordinate Reference System' (CRS) van de geometrie in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). API-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/Zaak' description: OK servers: - url: https://zaken-api.vng.cloud/api/v1/ description: Productie Omgeving /zaken/{zaak_uuid}/audittrail: get: operationId: audittrail_list description: Alle audit trail regels behorend bij de ZAAK. summary: Alle audit trail regels behorend bij de ZAAK parameters: - in: path name: zaak_uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) required: true tags: - zaken security: - JWT-Claims: - audittrails.lezen responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: type: array items: $ref: '#/components/schemas/AuditTrail' description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error servers: - url: https://zaken-api.vng.cloud/api/v1/ description: Productie Omgeving /zaken/{zaak_uuid}/audittrail/{uuid}: get: operationId: audittrail_retrieve description: Een specifieke audit trail regel opvragen. summary: Een specifieke audit trail regel opvragen parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke identificatie van de audit regel. title: uuid required: true - in: path name: zaak_uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) required: true tags: - zaken security: - JWT-Claims: - audittrails.lezen responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/AuditTrail' description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error servers: - url: https://zaken-api.vng.cloud/api/v1/ description: Productie Omgeving /zaken/{zaak_uuid}/besluiten: get: operationId: zaakbesluit_list description: Alle ZAAKBESLUITen opvragen. summary: Alle ZAAKBESLUITen opvragen parameters: - in: path name: zaak_uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) required: true tags: - zaken security: - JWT-Claims: - zaken.lezen responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: type: array items: $ref: '#/components/schemas/ZaakBesluit' description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: zaakbesluit_create description: '**LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.** De Besluiten API gebruikt dit endpoint om relaties te synchroniseren, daarom is dit endpoint in de Zaken API geimplementeerd. **Er wordt gevalideerd op:** - geldigheid URL naar de ZAAK' summary: Maak een ZAAKBESLUIT aan parameters: - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true - in: header name: X-NLX-Logrecord-ID schema: type: string description: Identifier of the request, traceable throughout the network - in: header name: X-Audit-Toelichting schema: type: string description: Toelichting waarom een bepaald verzoek wordt gedaan - in: path name: zaak_uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) required: true tags: - zaken requestBody: content: application/json: schema: $ref: '#/components/schemas/ZaakBesluit' required: true security: - JWT-Claims: - zaken.bijwerken responses: '201': headers: Location: schema: type: string format: uri description: URL waar de resource leeft. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakBesluit' description: Created '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error servers: - url: https://zaken-api.vng.cloud/api/v1/ description: Productie Omgeving /zaken/{zaak_uuid}/besluiten/{uuid}: get: operationId: zaakbesluit_retrieve description: Een specifiek ZAAKBESLUIT opvragen. summary: Een specifiek ZAAKBESLUIT opvragen parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: path name: zaak_uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) required: true tags: - zaken security: - JWT-Claims: - zaken.lezen responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakBesluit' description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: zaakbesluit_destroy description: '***LET OP: Dit endpoint hoor je als consumer niet zelf aan te spreken.*** De Besluiten API gebruikt dit endpoint om relaties te synchroniseren, daarom is dit endpoint in de Zaken API geimplementeerd.' summary: Verwijder een ZAAKBESLUIT parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: X-NLX-Logrecord-ID schema: type: string description: Identifier of the request, traceable throughout the network - in: header name: X-Audit-Toelichting schema: type: string description: Toelichting waarom een bepaald verzoek wordt gedaan - in: path name: zaak_uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) required: true tags: - zaken security: - JWT-Claims: - zaken.bijwerken responses: '204': description: No content '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error servers: - url: https://zaken-api.vng.cloud/api/v1/ description: Productie Omgeving /zaken/{zaak_uuid}/zaakeigenschappen: get: operationId: zaakeigenschap_list description: Alle ZAAKEIGENSCHAPpen opvragen. summary: Alle ZAAKEIGENSCHAPpen opvragen parameters: - in: path name: zaak_uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) required: true tags: - zaken security: - JWT-Claims: - zaken.lezen responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: type: array items: $ref: '#/components/schemas/ZaakEigenschap' description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error post: operationId: zaakeigenschap_create description: 'Maak een ZAAKEIGENSCHAP aan. **Er wordt gevalideerd op:** - geldigheid `eigenschap` URL - de resource moet opgevraagd kunnen worden uit de Catalogi API en de vorm van een EIGENSCHAP hebben. - de `eigenschap` moet bij het `ZAAK.zaaktype` horen' summary: Maak een ZAAKEIGENSCHAP aan parameters: - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true - in: header name: X-NLX-Logrecord-ID schema: type: string description: Identifier of the request, traceable throughout the network - in: header name: X-Audit-Toelichting schema: type: string description: Toelichting waarom een bepaald verzoek wordt gedaan - in: path name: zaak_uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) required: true tags: - zaken requestBody: content: application/json: schema: $ref: '#/components/schemas/ZaakEigenschap' required: true security: - JWT-Claims: - (zaken.bijwerken | zaken.geforceerd-bijwerken) responses: '201': headers: Location: schema: type: string format: uri description: URL waar de resource leeft. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakEigenschap' description: Created '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error servers: - url: https://zaken-api.vng.cloud/api/v1/ description: Productie Omgeving /zaken/{zaak_uuid}/zaakeigenschappen/{uuid}: get: operationId: zaakeigenschap_retrieve description: Een specifieke ZAAKEIGENSCHAP opvragen. summary: Een specifieke ZAAKEIGENSCHAP opvragen parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: Voer een voorwaardelijk verzoek uit. Deze header moet één of meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. Indien de waarde van de ETag van de huidige resource voorkomt in deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) voor meer informatie. examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: Eén ETag-waarde MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes - in: path name: zaak_uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) required: true tags: - zaken security: - JWT-Claims: - zaken.lezen responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakEigenschap' description: OK '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error put: operationId: zaakeigenschap_update description: '**Er wordt gevalideerd op** - Alleen de `waarde` mag gewijzigd worden' summary: Werk een ZAAKEIGENSCHAP in zijn geheel bij parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true - in: path name: zaak_uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) required: true tags: - zaken requestBody: content: application/json: schema: $ref: '#/components/schemas/ZaakEigenschap' required: true security: - JWT-Claims: - (zaken.bijwerken | zaken.geforceerd-bijwerken) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakEigenschap' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error patch: operationId: zaakeigenschap_partial_update description: '**Er wordt gevalideerd op** - Alleen de `waarde` mag gewijzigd worden' summary: Werk een ZAAKEIGENSCHAP deels bij parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true - in: path name: zaak_uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) required: true tags: - zaken requestBody: content: application/json: schema: $ref: '#/components/schemas/PatchedZaakEigenschap' security: - JWT-Claims: - (zaken.bijwerken | zaken.geforceerd-bijwerken) responses: '200': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakEigenschap' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error delete: operationId: zaakeigenschap_destroy summary: Verwijder een ZAAKEIGENSCHAP parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: path name: zaak_uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) required: true tags: - zaken security: - JWT-Claims: - (zaken.bijwerken | zaken.geforceerd-bijwerken) responses: '204': description: No content '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '404': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not found '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error head: operationId: zaakeigenschap_headers description: Vraag de headers op die je bij een GET request zou krijgen. summary: De headers voor een specifiek(e) ZAAKEIGENSCHAP opvragen parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true - in: header name: If-None-Match schema: type: string description: Voer een voorwaardelijk verzoek uit. Deze header moet één of meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. Indien de waarde van de ETag van de huidige resource voorkomt in deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) voor meer informatie. examples: OneValue: value: '"79054025255fb1a26e4bc422aef54eb4"' summary: Eén ETag-waarde MultipleValues: value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"' summary: Meerdere ETag-waardes - in: path name: zaak_uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) required: true tags: - zaken responses: '200': headers: ETag: schema: type: string description: De ETag berekend op de response body JSON. Indien twee resources exact dezelfde ETag hebben, dan zijn deze resources identiek aan elkaar. Je kan de ETag gebruiken om caching te implementeren. API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/json: schema: $ref: '#/components/schemas/ZaakEigenschap' description: OK servers: - url: https://zaken-api.vng.cloud/api/v1/ description: Productie Omgeving /zaken/_zoek: post: operationId: zaak__zoek description: Zoeken/filteren gaat normaal via de `list` operatie, deze is echter niet geschikt voor geo-zoekopdrachten. summary: Voer een (geo)-zoekopdracht uit op ZAAKen parameters: - in: header name: Content-Type schema: type: string enum: - application/json description: Content type van de verzoekinhoud. required: true - in: query name: page schema: type: integer description: Een pagina binnen de gepagineerde set resultaten. - in: header name: Accept-Crs schema: type: string enum: - EPSG:4326 description: Het gewenste 'Coordinate Reference System' (CRS) van de geometrie in het antwoord (response body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). required: true - in: header name: Content-Crs schema: type: string enum: - EPSG:4326 description: Het 'Coordinate Reference System' (CRS) van de geometrie in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). required: true tags: - zaken requestBody: content: application/json: schema: $ref: '#/components/schemas/ZaakZoek' security: - JWT-Claims: - zaken.lezen responses: '200': headers: Content-Crs: schema: type: string enum: - EPSG:4326 description: Het 'Coordinate Reference System' (CRS) van de geometrie in de vraag (request body). Volgens de GeoJSON spec is WGS84 de default (EPSG:4326 is hetzelfde als WGS84). API-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/PaginatedZaakList' description: OK '400': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/ValidatieFout' description: Bad request '401': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unauthorized '403': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Forbidden '406': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Not acceptable '409': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Conflict '410': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Gone '412': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Precondition failed '415': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Unsupported media type '429': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Too many requests '500': headers: API-version: schema: type: string description: 'Geeft een specifieke API-versie aan in de context van een specifieke aanroep. Voorbeeld: 1.2.1.' content: application/problem+json: schema: $ref: '#/components/schemas/Fout' description: Internal server error servers: - url: https://zaken-api.vng.cloud/api/v1/ description: Productie Omgeving components: schemas: ZaakZoek: type: object properties: zaakgeometrie: allOf: - $ref: '#/components/schemas/GeoWithin' title: GeoWithin uuid__in: type: array items: type: string format: uuid title: '' description: Array of unieke resource identifiers (UUID4) title: uuid__in identificatie: type: string description: De unieke identificatie van de ZAAK binnen de organisatie die verantwoordelijk is voor de behandeling van de ZAAK. title: identificatie expand: type: string description: "Examples: \n`expand=zaaktype, status, status.statustype, hoofdzaak.status.statustype, hoofdzaak.deelzaken.status.statustype`\nHaal details van gelinkte resources direct op. Als je meerdere resources tegelijk wilt ophalen kun je deze scheiden met een komma. Voor het ophalen van resources die een laag dieper genest zijn wordt de punt-notatie gebruikt." title: expand bronorganisatie: type: string description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef title: bronorganisatie bronorganisatie__in: type: array items: type: string title: '' description: Array van bronorganisaties. title: bronorganisatie__in zaaktype: type: string format: uri description: URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS waar deze voorkomt title: zaaktype zaaktype__in: type: array items: type: string format: uri title: '' description: Array van zaaktypen. title: zaaktype__in archiefnominatie: allOf: - $ref: '#/components/schemas/ArchiefnominatieEnum' description: 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Uitleg bij mogelijke waarden: * blijvend_bewaren - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum overgedragen worden naar een archiefbewaarplaats. * vernietigen - Het zaakdossier moet op of na de Archiefactiedatum vernietigd worden.' title: archiefnominatie archiefnominatie__in: type: array items: type: string title: '' description: Multiple values may be separated by commas. title: archiefnominatie__in einddatum: type: string description: De datum waarop de uitvoering van de zaak afgerond is. title: einddatum einddatum__gt: type: string title: einddatum__gt einddatum__lt: type: string title: einddatum__lt einddatum__isnull: type: boolean title: einddatum__isnull einddatumGepland: type: string description: De datum waarop volgens de planning verwacht wordt dat de zaak afgerond wordt. title: einddatumGepland einddatumGepland__gt: type: string title: einddatumGepland__gt einddatumGepland__lt: type: string title: einddatumGepland__lt uiterlijkeEinddatumAfdoening: type: string description: De laatste datum waarop volgens wet- en regelgeving de zaak afgerond dient te zijn. title: uiterlijkeEinddatumAfdoening uiterlijkeEinddatumAfdoening__gt: type: string title: uiterlijkeEinddatumAfdoening__gt uiterlijkeEinddatumAfdoening__lt: type: string title: uiterlijkeEinddatumAfdoening__lt archiefactiedatum: type: string description: De datum waarop het gearchiveerde zaakdossier vernietigd moet worden dan wel overgebracht moet worden naar een archiefbewaarplaats. Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT aan deze ZAAK indien nog leeg. title: archiefactiedatum archiefactiedatum__lt: type: string title: Archiefactiedatum lt archiefactiedatum__gt: type: string title: Archiefactiedatum gt archiefactiedatum__isnull: type: boolean title: Archiefactiedatum is leeg description: De archiefactiedatum is leeg archiefstatus: allOf: - $ref: '#/components/schemas/ArchiefstatusEnum' description: 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Uitleg bij mogelijke waarden: * nog_te_archiveren - De zaak cq. het zaakdossier is nog niet als geheel gearchiveerd. * gearchiveerd - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar bewaarbaar gemaakt. * gearchiveerd_procestermijn_onbekend - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum kan nog niet bepaald worden. * overgedragen - De zaak cq. het zaakdossier is overgebracht naar een archiefbewaarplaats.' title: archiefstatus archiefstatus__in: type: array items: type: string title: '' description: Multiple values may be separated by commas. title: archiefstatus__in startdatum: type: string description: De datum waarop met de uitvoering van de zaak is gestart title: startdatum startdatum__gt: type: string description: De datum waarop met de uitvoering van de zaak is gestart title: startdatum__gt startdatum__gte: type: string description: De datum waarop met de uitvoering van de zaak is gestart title: startdatum__gte startdatum__lt: type: string description: De datum waarop met de uitvoering van de zaak is gestart title: startdatum__lt startdatum__lte: type: string description: De datum waarop met de uitvoering van de zaak is gestart title: startdatum__lte rol__betrokkeneType: allOf: - $ref: '#/components/schemas/Rol_betrokkeneTypeEnum' description: 'Type van de betrokkene. Uitleg bij mogelijke waarden: * natuurlijk_persoon - Natuurlijk persoon * niet_natuurlijk_persoon - Niet-natuurlijk persoon * vestiging - Vestiging * organisatorische_eenheid - Organisatorische eenheid * medewerker - Medewerker' title: rol__betrokkeneType rol__betrokkene: type: string description: URL-referentie naar een betrokkene gerelateerd aan de ZAAK. title: rol__betrokkene rol__omschrijvingGeneriek: allOf: - $ref: '#/components/schemas/Rol_omschrijvingGeneriekEnum' description: "Algemeen gehanteerde benaming van de aard van de ROL, afgeleid uit het ROLTYPE. Uitleg bij mogelijke waarden:\n\n`adviseur` - Adviseur\n\n`behandelaar` - Behandelaar\n\n`belanghebbende` - Belanghebbende\n\n`beslisser` - Beslisser\n\n`initiator` - Initiator\n\n`klantcontacter` - Klantcontacter\n\n`zaakcoordinator` - Zaakcoördinator\n \n`mede_initiator` - Mede-initiator\n" title: rol__omschrijvingGeneriek maximaleVertrouwelijkheidaanduiding: allOf: - $ref: '#/components/schemas/MaximaleVertrouwelijkheidaanduidingEnum' description: 'Zaken met een vertrouwelijkheidaanduiding die beperkter is dan de aangegeven aanduiding worden uit de resultaten gefiltered. Uitleg bij mogelijke waarden: * `openbaar` - Openbaar * `beperkt_openbaar` - Beperkt openbaar * `intern` - Intern * `zaakvertrouwelijk` - Zaakvertrouwelijk * `vertrouwelijk` - Vertrouwelijk * `confidentieel` - Confidentieel * `geheim` - Geheim * `zeer_geheim` - Zeer geheim' title: maximaleVertrouwelijkheidaanduiding rol__betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie: type: string description: Het door de gemeente uitgegeven unieke nummer voor een ANDER NATUURLIJK PERSOON title: rol__betrokkeneIdentificatie__natuurlijkPersoon__anpIdentificatie maxLength: 17 rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn: type: string description: Het burgerservicenummer, bedoeld in artikel 1.1 van de Wet algemene bepalingen burgerservicenummer. title: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpBsn maxLength: 9 rol__betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer: type: string description: Het administratienummer van de persoon, bedoeld in de Wet BRP title: rol__betrokkeneIdentificatie__natuurlijkPersoon__inpA_nummer maxLength: 10 rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId: type: string description: Het door een kamer toegekend uniek nummer voor de INGESCHREVEN NIET-NATUURLIJK PERSOON title: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__innNnpId rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie: type: string description: Het door de gemeente uitgegeven unieke nummer voor een ANDER NIET-NATUURLIJK PERSOON title: rol__betrokkeneIdentificatie__nietNatuurlijkPersoon__annIdentificatie maxLength: 17 rol__betrokkeneIdentificatie__vestiging__vestigingsNummer: type: string description: Een korte unieke aanduiding van de Vestiging. title: rol__betrokkeneIdentificatie__vestiging__vestigingsNummer maxLength: 24 rol__betrokkeneIdentificatie__medewerker__identificatie: type: string description: Een korte unieke aanduiding van de MEDEWERKER. title: rol__betrokkeneIdentificatie__medewerker__identificatie maxLength: 24 rol__betrokkeneIdentificatie__organisatorischeEenheid__identificatie: type: string description: Een korte identificatie van de organisatorische eenheid. title: rol__betrokkeneIdentificatie__organisatorischeEenheid__identificatie registratiedatum: type: string description: De datum waarop de zaakbehandelende organisatie de ZAAK heeft geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag gebruikt. title: registratiedatum registratiedatum__gt: type: string title: registratiedatum__gt registratiedatum__lt: type: string title: registratiedatum__lt ordering: allOf: - $ref: '#/components/schemas/OrderingEnum' description: Het veld waarop de resultaten geordend worden. Het minnetje betekent omgekeerde volgorde. title: ordering Wijzigingen: type: object properties: oud: type: object additionalProperties: {} description: Volledige JSON body van het object zoals dat bestond voordat de actie heeft plaatsgevonden. title: oud nieuw: type: object additionalProperties: {} description: Volledige JSON body van het object na de actie. title: nieuw BronEnum: enum: - ac - nrc - zrc - ztc - drc - brc - cmc - kc - vrc type: string Point2D: title: Point2D type: array items: type: number maxItems: 2 minItems: 2 PatchedZaakEigenschap: type: object description: 'A type of `ModelSerializer` that uses hyperlinked relationships with compound keys instead of primary key relationships. Specifically: * A ''url'' field is included instead of the ''id'' field. * Relationships to other instances are hyperlinks, instead of primary keys. NOTE: this only works with DRF 3.1.0 and above.' properties: url: type: string format: uri readOnly: true title: url uuid: type: string format: uuid readOnly: true description: Unieke resource identifier (UUID4) title: uuid zaak: type: string format: uri title: zaak eigenschap: type: string format: uri description: URL-referentie naar de EIGENSCHAP (in de Catalogi API). title: eigenschap maxLength: 1000 naam: type: string readOnly: true description: De naam van de EIGENSCHAP (overgenomen uit de Catalogi API). title: ' naam' waarde: type: string title: waarde Zaak: type: object description: 'Set gegevensgroepdata from validated nested data. Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 uuid: type: string format: uuid readOnly: true description: Unieke resource identifier (UUID4) title: uuid identificatie: type: string description: De unieke identificatie van de ZAAK binnen de organisatie die verantwoordelijk is voor de behandeling van de ZAAK. title: identificatie maxLength: 40 bronorganisatie: type: string description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef title: bronorganisatie maxLength: 9 omschrijving: type: string description: Een korte omschrijving van de zaak. title: omschrijving maxLength: 80 toelichting: type: string description: Een toelichting op de zaak. title: toelichting maxLength: 1000 zaaktype: type: string format: uri description: URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS waar deze voorkomt title: zaaktype maxLength: 1000 registratiedatum: type: string format: date description: De datum waarop de zaakbehandelende organisatie de ZAAK heeft geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag gebruikt. title: registratiedatum verantwoordelijkeOrganisatie: type: string description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die eindverantwoordelijk is voor de behandeling van de zaak. Dit moet een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef title: verantwoordelijke organisatie maxLength: 9 startdatum: type: string format: date description: De datum waarop met de uitvoering van de zaak is gestart title: startdatum einddatum: type: - string - 'null' format: date readOnly: true description: De datum waarop de uitvoering van de zaak afgerond is. title: einddatum einddatumGepland: type: - string - 'null' format: date description: De datum waarop volgens de planning verwacht wordt dat de zaak afgerond wordt. title: einddatum gepland uiterlijkeEinddatumAfdoening: type: - string - 'null' format: date description: De laatste datum waarop volgens wet- en regelgeving de zaak afgerond dient te zijn. title: uiterlijke einddatum afdoening publicatiedatum: type: - string - 'null' format: date description: Datum waarop (het starten van) de zaak gepubliceerd is of wordt. title: publicatiedatum communicatiekanaal: type: string format: uri description: Het medium waarlangs de aanleiding om een zaak te starten is ontvangen. URL naar een communicatiekanaal in de VNG-Referentielijst van communicatiekanalen. title: communicatiekanaal maxLength: 1000 productenOfDiensten: type: array items: type: string format: uri title: URL naar product/dienst maxLength: 1000 description: De producten en/of diensten die door de zaak worden voortgebracht. Dit zijn URLs naar de resources zoals die door de producten- en dienstencatalogus-API wordt ontsloten. De producten/diensten moeten bij het zaaktype vermeld zijn. title: producten of diensten vertrouwelijkheidaanduiding: allOf: - $ref: '#/components/schemas/MaximaleVertrouwelijkheidaanduidingEnum' title: Vertrouwlijkheidaanduiding description: Aanduiding van de mate waarin het zaakdossier van de ZAAK voor de openbaarheid bestemd is. Optioneel - indien geen waarde gekozen wordt, dan wordt de waarde van het ZAAKTYPE overgenomen. Dit betekent dat de API _altijd_ een waarde teruggeeft. betalingsindicatie: description: 'Indicatie of de, met behandeling van de zaak gemoeide, kosten betaald zijn door de desbetreffende betrokkene. Uitleg bij mogelijke waarden: * `nvt` - Er is geen sprake van te betalen, met de zaak gemoeide, kosten. * `nog_niet` - De met de zaak gemoeide kosten zijn (nog) niet betaald. * `gedeeltelijk` - De met de zaak gemoeide kosten zijn gedeeltelijk betaald. * `geheel` - De met de zaak gemoeide kosten zijn geheel betaald.' title: betalingsindicatie oneOf: - $ref: '#/components/schemas/BetalingsindicatieEnum' - $ref: '#/components/schemas/BlankEnum' betalingsindicatieWeergave: type: string readOnly: true description: Uitleg bij `betalingsindicatie`. title: betalingsindicatieWeergave laatsteBetaaldatum: type: - string - 'null' format: date-time description: De datum waarop de meest recente betaling is verwerkt van kosten die gemoeid zijn met behandeling van de zaak. title: laatste betaaldatum zaakgeometrie: allOf: - $ref: '#/components/schemas/GeoJSONGeometry' description: Punt, lijn of (multi-)vlak geometrie-informatie, in GeoJSON. title: zaakgeometrie verlenging: allOf: - $ref: '#/components/schemas/Verlenging' description: Gegevens omtrent het verlengen van de doorlooptijd van de behandeling van de ZAAK title: verlenging opschorting: allOf: - $ref: '#/components/schemas/Opschorting' description: Gegevens omtrent het tijdelijk opschorten van de behandeling van de ZAAK title: opschorting selectielijstklasse: type: string format: uri description: URL-referentie naar de categorie in de gehanteerde 'Selectielijst Archiefbescheiden' die, gezien het zaaktype en het resultaattype van de zaak, bepalend is voor het archiefregime van de zaak. title: selectielijstklasse maxLength: 1000 hoofdzaak: type: - string - 'null' format: uri title: Is deelzaak van description: URL-referentie naar de ZAAK, waarom verzocht is door de initiator daarvan, die behandeld wordt in twee of meer separate ZAAKen waarvan de onderhavige ZAAK er één is. minLength: 1 maxLength: 1000 deelzaken: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar deel ZAAKen. title: is deelzaak van uniqueItems: true relevanteAndereZaken: type: array items: $ref: '#/components/schemas/RelevanteZaak' description: Een lijst van relevante andere zaken. title: zaak eigenschappen: type: array items: type: string format: uri title: '' readOnly: true title: zaak uniqueItems: true rollen: type: array items: type: string format: uri title: '' readOnly: true title: zaak uniqueItems: true status: type: - string - 'null' format: uri readOnly: true description: Indien geen status bekend is, dan is de waarde 'null' title: status zaakinformatieobjecten: type: array items: type: string format: uri title: '' readOnly: true title: zaak uniqueItems: true zaakobjecten: type: array items: type: string format: uri title: '' readOnly: true title: zaak uniqueItems: true kenmerken: type: array items: $ref: '#/components/schemas/ZaakKenmerk' description: Lijst van kenmerken. Merk op dat refereren naar gerelateerde objecten beter kan via `ZaakObject`. title: zaak archiefnominatie: description: 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Uitleg bij mogelijke waarden: * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum overgedragen worden naar een archiefbewaarplaats. * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd worden.' title: archiefnominatie oneOf: - $ref: '#/components/schemas/ArchiefnominatieEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' archiefstatus: allOf: - $ref: '#/components/schemas/ArchiefstatusEnum' description: 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Uitleg bij mogelijke waarden: * `nog_te_archiveren` - De zaak cq. het zaakdossier is nog niet als geheel gearchiveerd. * `gearchiveerd` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar bewaarbaar gemaakt. * `gearchiveerd_procestermijn_onbekend` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum kan nog niet bepaald worden. * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een archiefbewaarplaats.' title: archiefstatus archiefactiedatum: type: - string - 'null' format: date description: De datum waarop het gearchiveerde zaakdossier vernietigd moet worden dan wel overgebracht moet worden naar een archiefbewaarplaats. Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT aan deze ZAAK indien nog leeg. title: archiefactiedatum resultaat: type: - string - 'null' format: uri readOnly: true description: URL-referentie naar het RESULTAAT. Indien geen resultaat bekend is, dan is de waarde 'null' title: resultaat opdrachtgevendeOrganisatie: type: string description: De krachtens publiekrecht ingestelde rechtspersoon dan wel ander niet-natuurlijk persoon waarbinnen het (bestuurs)orgaan zetelt dat opdracht heeft gegeven om taken uit te voeren waaraan de zaak invulling geeft. title: opdrachtgevende organisatie maxLength: 9 processobjectaard: type: - string - 'null' title: Procesobjectaard description: Omschrijving van het object, subject of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking heeft. maxLength: 200 startdatumBewaartermijn: type: - string - 'null' format: date description: De datum die de start markeert van de termijn waarop het zaakdossier vernietigd moet worden. title: startdatum bewaartermijn processobject: allOf: - $ref: '#/components/schemas/Processobject' description: Specificatie van de attribuutsoort van het object, subject of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking heeft en dat bepalend is voor de start van de archiefactietermijn. title: processobject required: - betalingsindicatieWeergave - bronorganisatie - deelzaken - eigenschappen - einddatum - resultaat - rollen - startdatum - status - url - uuid - verantwoordelijkeOrganisatie - zaakinformatieobjecten - zaakobjecten - zaaktype AardRelatieEnum: enum: - vervolg - onderwerp - bijdrage type: string ZaakBesluit: type: object description: 'A type of `ModelSerializer` that uses hyperlinked relationships with compound keys instead of primary key relationships. Specifically: * A ''url'' field is included instead of the ''id'' field. * Relationships to other instances are hyperlinks, instead of primary keys. NOTE: this only works with DRF 3.1.0 and above.' properties: url: type: string format: uri readOnly: true title: url uuid: type: string format: uuid readOnly: true description: Unieke resource identifier (UUID4) title: uuid besluit: type: string format: uri description: URL-referentie naar het BESLUIT (in de Besluiten API), waar ook de relatieinformatie opgevraagd kan worden. title: besluit maxLength: 1000 required: - besluit - url - uuid Processobject: type: - object - 'null' description: Specificatie van de attribuutsoort van het object, subject of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking heeft en dat bepalend is voor de start van de archiefactietermijn. properties: datumkenmerk: type: string description: De naam van de attribuutsoort van het procesobject dat bepalend is voor het einde van de procestermijn. title: datumkenmerk maxLength: 250 identificatie: type: string description: De unieke aanduiding van het procesobject. title: identificatie maxLength: 250 objecttype: type: string description: Het soort object dat het procesobject representeert. title: objecttype maxLength: 250 registratie: type: string description: De naam van de registratie waarvan het procesobject deel uit maakt. title: registratie maxLength: 250 required: - datumkenmerk - identificatie - objecttype - registratie Opschorting: type: - object - 'null' description: Gegevens omtrent het tijdelijk opschorten van de behandeling van de ZAAK properties: indicatie: type: boolean description: Aanduiding of de behandeling van de ZAAK tijdelijk is opgeschort. title: indicatie opschorting reden: type: string description: Omschrijving van de reden voor het opschorten van de behandeling van de zaak. title: reden opschorting maxLength: 200 required: - indicatie - reden ZaakEigenschap: type: object description: 'A type of `ModelSerializer` that uses hyperlinked relationships with compound keys instead of primary key relationships. Specifically: * A ''url'' field is included instead of the ''id'' field. * Relationships to other instances are hyperlinks, instead of primary keys. NOTE: this only works with DRF 3.1.0 and above.' properties: url: type: string format: uri readOnly: true title: url uuid: type: string format: uuid readOnly: true description: Unieke resource identifier (UUID4) title: uuid zaak: type: string format: uri title: zaak eigenschap: type: string format: uri description: URL-referentie naar de EIGENSCHAP (in de Catalogi API). title: eigenschap maxLength: 1000 naam: type: string readOnly: true description: De naam van de EIGENSCHAP (overgenomen uit de Catalogi API). title: ' naam' waarde: type: string title: waarde required: - eigenschap - naam - url - uuid - waarde - zaak BetalingsindicatieEnum: enum: - nvt - nog_niet - gedeeltelijk - geheel type: string Fout: type: object description: Formaat van HTTP 4xx en 5xx fouten. properties: type: type: string description: URI referentie naar het type fout, bedoeld voor developers title: type code: type: string description: Systeemcode die het type fout aangeeft title: code title: type: string description: Generieke titel voor het type fout title: title status: type: integer description: De HTTP status code title: status detail: type: string description: Extra informatie bij de fout, indien beschikbaar title: detail instance: type: string description: URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. title: instance required: - code - detail - instance - status - title GeoWithin: type: object properties: within: allOf: - $ref: '#/components/schemas/GeoJSONGeometry' title: within Polygon: title: Polygon description: GeoJSON polygon geometry type: object externalDocs: url: https://tools.ietf.org/html/rfc7946#section-3.1.6 allOf: - $ref: '#/components/schemas/Geometry' - type: object required: - coordinates properties: coordinates: type: array items: type: array items: $ref: '#/components/schemas/Point2D' ArchiefstatusEnum: enum: - nog_te_archiveren - gearchiveerd - gearchiveerd_procestermijn_onbekend - overgedragen type: string BlankEnum: enum: - '' Point: title: Point description: GeoJSON point geometry type: object externalDocs: url: https://tools.ietf.org/html/rfc7946#section-3.1.2 allOf: - $ref: '#/components/schemas/Geometry' - type: object required: - coordinates properties: coordinates: $ref: '#/components/schemas/Point2D' FieldValidationError: type: object description: Formaat van validatiefouten. properties: name: type: string description: Naam van het veld met ongeldige gegevens title: name code: type: string description: Systeemcode die het type fout aangeeft title: code reason: type: string description: Uitleg wat er precies fout is met de gegevens title: reason required: - code - name - reason Rol_omschrijvingGeneriekEnum: enum: - adviseur - behandelaar - belanghebbende - beslisser - initiator - klantcontacter - zaakcoordinator - mede_initiator type: string MultiLineString: title: Multi-line string description: GeoJSON multi-line-string geometry type: object externalDocs: url: https://tools.ietf.org/html/rfc7946#section-3.1.5 allOf: - $ref: '#/components/schemas/Geometry' - type: object required: - coordinates properties: coordinates: type: array items: type: array items: $ref: '#/components/schemas/Point2D' NullEnum: enum: - null ZaakKenmerk: type: object properties: kenmerk: type: string description: Identificeert uniek de zaak in een andere administratie. title: kenmerk maxLength: 40 bron: type: string description: De aanduiding van de administratie waar het kenmerk op slaat. title: bron maxLength: 40 required: - bron - kenmerk GeometryTypeEnum: type: string enum: - Point - MultiPoint - LineString - MultiLineString - Polygon - MultiPolygon - Feature - FeatureCollection - GeometryCollection MultiPolygon: title: Multi-polygon description: GeoJSON multi-polygon geometry type: object externalDocs: url: https://tools.ietf.org/html/rfc7946#section-3.1.7 allOf: - $ref: '#/components/schemas/Geometry' - type: object required: - coordinates properties: coordinates: type: array items: type: array items: type: array items: $ref: '#/components/schemas/Point2D' MultiPoint: title: MultiPoint description: GeoJSON multi-point geometry type: object externalDocs: url: https://tools.ietf.org/html/rfc7946#section-3.1.3 allOf: - $ref: '#/components/schemas/Geometry' - type: object required: - coordinates properties: coordinates: type: array items: $ref: '#/components/schemas/Point2D' RelevanteZaak: type: object properties: url: type: string format: uri title: URL-referentie naar de ZAAK. maxLength: 1000 aardRelatie: allOf: - $ref: '#/components/schemas/AardRelatieEnum' description: 'Benamingen van de aard van de relaties van andere zaken tot (onderhanden) zaken. Uitleg bij mogelijke waarden: * `vervolg` - De andere zaak gaf aanleiding tot het starten van de onderhanden zaak. * `onderwerp` - De andere zaak is relevant voor cq. is onderwerp van de onderhanden zaak. * `bijdrage` - Aan het bereiken van de uitkomst van de andere zaak levert de onderhanden zaak een bijdrage.' title: aard relatie required: - aardRelatie - url ValidatieFout: type: object description: Formaat van HTTP 4xx en 5xx fouten. properties: type: type: string description: URI referentie naar het type fout, bedoeld voor developers title: type code: type: string description: Systeemcode die het type fout aangeeft title: code title: type: string description: Generieke titel voor het type fout title: title status: type: integer description: De HTTP status code title: status detail: type: string description: Extra informatie bij de fout, indien beschikbaar title: detail instance: type: string description: URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld. title: instance invalidParams: type: array items: $ref: '#/components/schemas/FieldValidationError' title: invalidParams required: - code - detail - instance - invalidParams - status - title OrderingEnum: enum: - startdatum - -startdatum - einddatum - -einddatum - publicatiedatum - -publicatiedatum - archiefactiedatum - -archiefactiedatum - registratiedatum - -registratiedatum - identificatie - -identificatie type: string GeometryCollection: title: Geometry collection description: GeoJSON multi-polygon geometry type: object externalDocs: url: https://tools.ietf.org/html/rfc7946#section-3.1.8 allOf: - $ref: '#/components/schemas/Geometry' - type: object required: - geometries properties: geometries: type: array items: $ref: '#/components/schemas/Geometry' GeoJSONGeometry: title: GeoJSONGeometry type: object oneOf: - $ref: '#/components/schemas/Point' - $ref: '#/components/schemas/MultiPoint' - $ref: '#/components/schemas/LineString' - $ref: '#/components/schemas/MultiLineString' - $ref: '#/components/schemas/Polygon' - $ref: '#/components/schemas/MultiPolygon' - $ref: '#/components/schemas/GeometryCollection' discriminator: propertyName: type Geometry: title: Geometry description: GeoJSON geometry type: object required: - type externalDocs: url: https://tools.ietf.org/html/rfc7946#section-3.1 properties: type: allOf: - $ref: '#/components/schemas/GeometryTypeEnum' description: The geometry type Rol_betrokkeneTypeEnum: enum: - natuurlijk_persoon - niet_natuurlijk_persoon - vestiging - organisatorische_eenheid - medewerker type: string PatchedZaak: type: object description: 'Set gegevensgroepdata from validated nested data. Usage: include the mixin on the ModelSerializer that has gegevensgroepen.' properties: url: type: string format: uri readOnly: true title: url description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object. minLength: 1 maxLength: 1000 uuid: type: string format: uuid readOnly: true description: Unieke resource identifier (UUID4) title: uuid identificatie: type: string description: De unieke identificatie van de ZAAK binnen de organisatie die verantwoordelijk is voor de behandeling van de ZAAK. title: identificatie maxLength: 40 bronorganisatie: type: string description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die de zaak heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef title: bronorganisatie maxLength: 9 omschrijving: type: string description: Een korte omschrijving van de zaak. title: omschrijving maxLength: 80 toelichting: type: string description: Een toelichting op de zaak. title: toelichting maxLength: 1000 zaaktype: type: string format: uri description: URL-referentie naar het ZAAKTYPE (in de Catalogi API) in de CATALOGUS waar deze voorkomt title: zaaktype maxLength: 1000 registratiedatum: type: string format: date description: De datum waarop de zaakbehandelende organisatie de ZAAK heeft geregistreerd. Indien deze niet opgegeven wordt, wordt de datum van vandaag gebruikt. title: registratiedatum verantwoordelijkeOrganisatie: type: string description: Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die eindverantwoordelijk is voor de behandeling van de zaak. Dit moet een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef title: verantwoordelijke organisatie maxLength: 9 startdatum: type: string format: date description: De datum waarop met de uitvoering van de zaak is gestart title: startdatum einddatum: type: - string - 'null' format: date readOnly: true description: De datum waarop de uitvoering van de zaak afgerond is. title: einddatum einddatumGepland: type: - string - 'null' format: date description: De datum waarop volgens de planning verwacht wordt dat de zaak afgerond wordt. title: einddatum gepland uiterlijkeEinddatumAfdoening: type: - string - 'null' format: date description: De laatste datum waarop volgens wet- en regelgeving de zaak afgerond dient te zijn. title: uiterlijke einddatum afdoening publicatiedatum: type: - string - 'null' format: date description: Datum waarop (het starten van) de zaak gepubliceerd is of wordt. title: publicatiedatum communicatiekanaal: type: string format: uri description: Het medium waarlangs de aanleiding om een zaak te starten is ontvangen. URL naar een communicatiekanaal in de VNG-Referentielijst van communicatiekanalen. title: communicatiekanaal maxLength: 1000 productenOfDiensten: type: array items: type: string format: uri title: URL naar product/dienst maxLength: 1000 description: De producten en/of diensten die door de zaak worden voortgebracht. Dit zijn URLs naar de resources zoals die door de producten- en dienstencatalogus-API wordt ontsloten. De producten/diensten moeten bij het zaaktype vermeld zijn. title: producten of diensten vertrouwelijkheidaanduiding: allOf: - $ref: '#/components/schemas/MaximaleVertrouwelijkheidaanduidingEnum' title: Vertrouwlijkheidaanduiding description: Aanduiding van de mate waarin het zaakdossier van de ZAAK voor de openbaarheid bestemd is. Optioneel - indien geen waarde gekozen wordt, dan wordt de waarde van het ZAAKTYPE overgenomen. Dit betekent dat de API _altijd_ een waarde teruggeeft. betalingsindicatie: description: 'Indicatie of de, met behandeling van de zaak gemoeide, kosten betaald zijn door de desbetreffende betrokkene. Uitleg bij mogelijke waarden: * `nvt` - Er is geen sprake van te betalen, met de zaak gemoeide, kosten. * `nog_niet` - De met de zaak gemoeide kosten zijn (nog) niet betaald. * `gedeeltelijk` - De met de zaak gemoeide kosten zijn gedeeltelijk betaald. * `geheel` - De met de zaak gemoeide kosten zijn geheel betaald.' title: betalingsindicatie oneOf: - $ref: '#/components/schemas/BetalingsindicatieEnum' - $ref: '#/components/schemas/BlankEnum' betalingsindicatieWeergave: type: string readOnly: true description: Uitleg bij `betalingsindicatie`. title: betalingsindicatieWeergave laatsteBetaaldatum: type: - string - 'null' format: date-time description: De datum waarop de meest recente betaling is verwerkt van kosten die gemoeid zijn met behandeling van de zaak. title: laatste betaaldatum zaakgeometrie: allOf: - $ref: '#/components/schemas/GeoJSONGeometry' description: Punt, lijn of (multi-)vlak geometrie-informatie, in GeoJSON. title: zaakgeometrie verlenging: allOf: - $ref: '#/components/schemas/Verlenging' description: Gegevens omtrent het verlengen van de doorlooptijd van de behandeling van de ZAAK title: verlenging opschorting: allOf: - $ref: '#/components/schemas/Opschorting' description: Gegevens omtrent het tijdelijk opschorten van de behandeling van de ZAAK title: opschorting selectielijstklasse: type: string format: uri description: URL-referentie naar de categorie in de gehanteerde 'Selectielijst Archiefbescheiden' die, gezien het zaaktype en het resultaattype van de zaak, bepalend is voor het archiefregime van de zaak. title: selectielijstklasse maxLength: 1000 hoofdzaak: type: - string - 'null' format: uri title: Is deelzaak van description: URL-referentie naar de ZAAK, waarom verzocht is door de initiator daarvan, die behandeld wordt in twee of meer separate ZAAKen waarvan de onderhavige ZAAK er één is. minLength: 1 maxLength: 1000 deelzaken: type: array items: type: string format: uri title: '' readOnly: true description: URL-referenties naar deel ZAAKen. title: is deelzaak van uniqueItems: true relevanteAndereZaken: type: array items: $ref: '#/components/schemas/RelevanteZaak' description: Een lijst van relevante andere zaken. title: zaak eigenschappen: type: array items: type: string format: uri title: '' readOnly: true title: zaak uniqueItems: true rollen: type: array items: type: string format: uri title: '' readOnly: true title: zaak uniqueItems: true status: type: - string - 'null' format: uri readOnly: true description: Indien geen status bekend is, dan is de waarde 'null' title: status zaakinformatieobjecten: type: array items: type: string format: uri title: '' readOnly: true title: zaak uniqueItems: true zaakobjecten: type: array items: type: string format: uri title: '' readOnly: true title: zaak uniqueItems: true kenmerken: type: array items: $ref: '#/components/schemas/ZaakKenmerk' description: Lijst van kenmerken. Merk op dat refereren naar gerelateerde objecten beter kan via `ZaakObject`. title: zaak archiefnominatie: description: 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Uitleg bij mogelijke waarden: * `blijvend_bewaren` - Het zaakdossier moet bewaard blijven en op de Archiefactiedatum overgedragen worden naar een archiefbewaarplaats. * `vernietigen` - Het zaakdossier moet op of na de Archiefactiedatum vernietigd worden.' title: archiefnominatie oneOf: - $ref: '#/components/schemas/ArchiefnominatieEnum' - $ref: '#/components/schemas/BlankEnum' - $ref: '#/components/schemas/NullEnum' archiefstatus: allOf: - $ref: '#/components/schemas/ArchiefstatusEnum' description: 'Aanduiding of het zaakdossier blijvend bewaard of na een bepaalde termijn vernietigd moet worden. Uitleg bij mogelijke waarden: * `nog_te_archiveren` - De zaak cq. het zaakdossier is nog niet als geheel gearchiveerd. * `gearchiveerd` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar bewaarbaar gemaakt. * `gearchiveerd_procestermijn_onbekend` - De zaak cq. het zaakdossier is als geheel niet-wijzigbaar bewaarbaar gemaakt maar de vernietigingsdatum kan nog niet bepaald worden. * `overgedragen` - De zaak cq. het zaakdossier is overgebracht naar een archiefbewaarplaats.' title: archiefstatus archiefactiedatum: type: - string - 'null' format: date description: De datum waarop het gearchiveerde zaakdossier vernietigd moet worden dan wel overgebracht moet worden naar een archiefbewaarplaats. Wordt automatisch berekend bij het aanmaken of wijzigen van een RESULTAAT aan deze ZAAK indien nog leeg. title: archiefactiedatum resultaat: type: - string - 'null' format: uri readOnly: true description: URL-referentie naar het RESULTAAT. Indien geen resultaat bekend is, dan is de waarde 'null' title: resultaat opdrachtgevendeOrganisatie: type: string description: De krachtens publiekrecht ingestelde rechtspersoon dan wel ander niet-natuurlijk persoon waarbinnen het (bestuurs)orgaan zetelt dat opdracht heeft gegeven om taken uit te voeren waaraan de zaak invulling geeft. title: opdrachtgevende organisatie maxLength: 9 processobjectaard: type: - string - 'null' title: Procesobjectaard description: Omschrijving van het object, subject of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking heeft. maxLength: 200 startdatumBewaartermijn: type: - string - 'null' format: date description: De datum die de start markeert van de termijn waarop het zaakdossier vernietigd moet worden. title: startdatum bewaartermijn processobject: allOf: - $ref: '#/components/schemas/Processobject' description: Specificatie van de attribuutsoort van het object, subject of gebeurtenis waarop, vanuit archiveringsoptiek, de zaak betrekking heeft en dat bepalend is voor de start van de archiefactietermijn. title: processobject PaginatedZaakList: type: object properties: count: type: integer example: 123 next: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=4 previous: type: - string - 'null' format: uri example: http://api.example.org/accounts/?page=2 results: type: array items: $ref: '#/components/schemas/Zaak' ArchiefnominatieEnum: enum: - blijvend_bewaren - vernietigen type: string Verlenging: type: - object - 'null' description: Gegevens omtrent het verlengen van de doorlooptijd van de behandeling van de ZAAK properties: reden: type: string description: Omschrijving van de reden voor het verlengen van de behandeling van de zaak. title: reden verlenging maxLength: 200 duur: type: string description: Het aantal werkbare dagen waarmee de doorlooptijd van de behandeling van de ZAAK is verlengd (of verkort) ten opzichte van de eerder gecommuniceerde doorlooptijd. title: duur verlenging format: duration required: - duur - reden AuditTrail: type: object properties: uuid: type: string format: uuid description: Unieke identificatie van de audit regel. title: uuid bron: allOf: - $ref: '#/components/schemas/BronEnum' description: 'De naam van het component waar de wijziging in is gedaan. Uitleg bij mogelijke waarden: * `ac` - Autorisaties API * `nrc` - Notificaties API * `zrc` - Zaken API * `ztc` - Catalogi API * `drc` - Documenten API * `brc` - Besluiten API * `cmc` - Contactmomenten API * `kc` - Klanten API * `vrc` - Verzoeken API' title: bron applicatieId: type: string description: Unieke identificatie van de applicatie, binnen de organisatie. title: applicatie id maxLength: 100 applicatieWeergave: type: string description: Vriendelijke naam van de applicatie. title: applicatie weergave maxLength: 200 gebruikersId: type: string description: Unieke identificatie van de gebruiker die binnen de organisatie herleid kan worden naar een persoon. title: gebruikers id maxLength: 255 gebruikersWeergave: type: string description: Vriendelijke naam van de gebruiker. title: gebruikers weergave maxLength: 255 actie: type: string description: 'De uitgevoerde handeling. 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' title: actie maxLength: 50 actieWeergave: type: string description: Vriendelijke naam van de actie. title: actie weergave maxLength: 200 resultaat: type: integer maximum: 599 minimum: 100 description: HTTP status code van de API response van de uitgevoerde handeling. title: resultaat hoofdObject: type: string format: uri description: De URL naar het hoofdobject van een component. title: hoofd object maxLength: 1000 resource: type: string description: Het type resource waarop de actie gebeurde. title: resource maxLength: 50 resourceUrl: type: string format: uri description: De URL naar het object. title: resource url maxLength: 1000 toelichting: type: string description: Toelichting waarom de handeling is uitgevoerd. title: toelichting resourceWeergave: type: string description: Vriendelijke identificatie van het object. title: resource weergave maxLength: 200 aanmaakdatum: type: string format: date-time readOnly: true description: De datum waarop de handeling is gedaan. title: aanmaakdatum wijzigingen: allOf: - $ref: '#/components/schemas/Wijzigingen' title: wijzigingen required: - aanmaakdatum - actie - bron - hoofdObject - resource - resourceUrl - resourceWeergave - resultaat - wijzigingen MaximaleVertrouwelijkheidaanduidingEnum: enum: - openbaar - beperkt_openbaar - intern - zaakvertrouwelijk - vertrouwelijk - confidentieel - geheim - zeer_geheim type: string LineString: title: Line-string description: GeoJSON line-string geometry type: object externalDocs: url: https://tools.ietf.org/html/rfc7946#section-3.1.4 allOf: - $ref: '#/components/schemas/Geometry' - type: object required: - coordinates properties: coordinates: type: array items: $ref: '#/components/schemas/Point2D' minItems: 2 securitySchemes: JWT-Claims: type: http bearerFormat: JWT scheme: bearer x-refined-from: - vng-realisatie-zaken-openapi.yml - vng-realisatie-zaken-openapi.yml