openapi: 3.2.0
info:
  title: Vng Realisatie Resultaten API
  license:
    name: EUPL 1.2
    url: https://opensource.org/licenses/EUPL-1.2
  version: '1.0'
  description: 'Operations tagged resultaten across 4 of this provider''s published API definitions: vng-realisatie-referentielijsten-openapi.yml, vng-realisatie-zaken-openapi.yml, vng-realisatie-referentielijsten-openapi.yml, vng-realisatie-zaken-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: http://referentielijsten-api.internal/api/v1
- url: https://referentielijsten-api.internal/api/v1
- url: https://zaken-api.vng.cloud/api/v1/
  description: Productie Omgeving
tags:
- name: resultaten
paths:
  /resultaten:
    get:
      tags:
      - resultaten
      summary: Ontsluit de selectielijst resultaten
      description: 'Procestypen worden gerefereerd in zaaktypecatalogi - bij het configureren

        van een zaaktype wordt aangegeven welk procestype van toepassing is, zodat

        het archiefregime van zaken bepaald kan worden.

        Zie https://vng.nl/files/vng/20170706-selectielijst-gemeenten-intergemeentelijke-organen-2017.pdf

        voor de bron van de inhoud.'
      operationId: resultaten_list
      parameters:
      - name: proces_type
        in: query
        description: proces_type
        schema:
          type: string
      - name: page
        in: query
        description: Een pagina binnen de gepagineerde set resultaten.
        schema:
          type: integer
      responses:
        200:
          description: Resultaten
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resultaten'
        400:
          description: ValidatieFout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ValidatieFout'
        404:
          description: Fout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fout'
        405:
          description: Fout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fout'
    post:
      operationId: resultaat_create
      description: '**Er wordt gevalideerd op:**

        - geldigheid URL naar de ZAAK

        - geldigheid URL naar het RESULTAATTYPE'
      summary: Maak een RESULTAAT bij 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
      tags:
      - resultaten
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Resultaat_2'
        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/Resultaat_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          description: Internal server error
    servers:
    - url: http://referentielijsten-api.internal/api/v1
    - url: https://referentielijsten-api.internal/api/v1
  /resultaten/{uuid}:
    get:
      tags:
      - resultaten
      summary: Ontsluit de selectielijst resultaten
      description: 'Procestypen worden gerefereerd in zaaktypecatalogi - bij het configureren

        van een zaaktype wordt aangegeven welk procestype van toepassing is, zodat

        het archiefregime van zaken bepaald kan worden.

        Zie https://vng.nl/files/vng/20170706-selectielijst-gemeenten-intergemeentelijke-organen-2017.pdf

        voor de bron van de inhoud.'
      operationId: resultaten_retrieve
      parameters:
      - name: uuid
        in: path
        description: uuid van de resultaattypeomschrijving
        required: true
        schema:
          type: string
          format: uuid
      responses:
        200:
          description: Resultaat
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Resultaat'
        404:
          description: Fout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fout'
        405:
          description: Fout
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Fout'
    put:
      operationId: resultaat_update
      description: '**Er wordt gevalideerd op**

        - geldigheid URL naar de ZAAK

        - het RESULTAATTYPE mag niet gewijzigd worden'
      summary: Werk een RESULTAAT in zijn geheel bij
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
          description: Unieke resource identifier (UUID4)
          title: uuid
        required: true
      - in: header
        name: Content-Type
        schema:
          type: string
          enum:
          - application/json
        description: Content type van de verzoekinhoud.
        required: true
      - in: header
        name: X-NLX-Logrecord-ID
        schema:
          type: string
        description: Identifier of the request, traceable throughout the network
      - in: header
        name: X-Audit-Toelichting
        schema:
          type: string
        description: Toelichting waarom een bepaald verzoek wordt gedaan
      tags:
      - resultaten
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Resultaat_2'
        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/Resultaat_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          description: Internal server error
    patch:
      operationId: resultaat_partial_update
      description: '**Er wordt gevalideerd op**

        - geldigheid URL naar de ZAAK

        - het RESULTAATTYPE mag niet gewijzigd worden'
      summary: Werk een RESULTAAT deels bij
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
          description: Unieke resource identifier (UUID4)
          title: uuid
        required: true
      - in: header
        name: Content-Type
        schema:
          type: string
          enum:
          - application/json
        description: Content type van de verzoekinhoud.
        required: true
      - in: header
        name: X-NLX-Logrecord-ID
        schema:
          type: string
        description: Identifier of the request, traceable throughout the network
      - in: header
        name: X-Audit-Toelichting
        schema:
          type: string
        description: Toelichting waarom een bepaald verzoek wordt gedaan
      tags:
      - resultaten
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedResultaat'
      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/Resultaat_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          description: Internal server error
    delete:
      operationId: resultaat_destroy
      description: Verwijder een RESULTAAT van een ZAAK.
      summary: Verwijder een RESULTAAT van 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
      tags:
      - resultaten
      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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          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_2'
          description: Internal server error
    head:
      operationId: resultaat_headers
      description: Vraag de headers op die je bij een GET request zou krijgen.
      summary: De headers voor een specifiek(e) RESULTAAT opvragen
      parameters:
      - in: path
        name: uuid
        schema:
          type: string
          format: uuid
          description: Unieke resource identifier (UUID4)
          title: uuid
        required: true
      - in: header
        name: If-None-Match
        schema:
          type: string
        description: Voer een voorwaardelijk verzoek uit. Deze header moet één of meerdere ETag-waardes bevatten van resources die de consumer gecached heeft. Indien de waarde van de ETag van de huidige resource voorkomt in deze set, dan antwoordt de provider met een lege HTTP 304 request. Zie [MDN](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/If-None-Match) voor meer informatie.
        examples:
          OneValue:
            value: '"79054025255fb1a26e4bc422aef54eb4"'
            summary: Eén ETag-waarde
          MultipleValues:
            value: '"79054025255fb1a26e4bc422aef54eb4", "e4d909c290d0fb1ca068ffaddf22cbd0"'
            summary: Meerdere ETag-waardes
      tags:
      - resultaten
      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/Resultaat_2'
          description: OK
    servers:
    - url: http://referentielijsten-api.internal/api/v1
    - url: https://referentielijsten-api.internal/api/v1
components:
  schemas:
    FieldValidationError:
      title: FieldValidationError represents an error
      required:
      - code
      - name
      - reason
      type: object
      properties:
        code:
          type: string
          description: Systeemcode die het type fout aangeeft
        name:
          type: string
          description: Naam van het veld met ongeldige gegevens
        reason:
          type: string
          description: Uitleg wat er precies fout is met de gegevens
      description: Formaat van validatiefouten.
    Fout:
      title: Fout represents an error
      required:
      - code
      - detail
      - instance
      - status
      - title
      type: object
      properties:
        code:
          type: string
          description: Systeemcode die het type fout aangeeft
        detail:
          type: string
          description: Extra informatie bij de fout, indien beschikbaar
        instance:
          type: string
          description: URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld.
        status:
          type: integer
          description: De HTTP status code
          format: int64
        title:
          type: string
          description: Generieke titel voor het type fout
        type:
          type: string
          description: URI referentie naar het type fout, bedoeld voor developers
      description: Formaat van HTTP 4xx en 5xx fouten.
    Resultaten:
      type: object
      properties:
        count:
          type: integer
          description: Totaal aantal resultaten
          format: int64
          example: 356
        next:
          type:
          - string
          - 'null'
          description: Volgende pagina indien beschikbaar
          format: uri
          example: http://localhost:8000/api/v1/resultaten?page=2
        previous:
          type:
          - string
          - 'null'
          description: Vorige pagina indien beschikbaar
          format: uri
          example: http://localhost:8000/api/v1/resultaten?page=1
        results:
          type: array
          items:
            $ref: '#/components/schemas/Resultaat'
    ValidatieFout:
      title: ValidatieFout represents an error
      required:
      - code
      - detail
      - instance
      - invalidParams
      - status
      - title
      type: object
      properties:
        code:
          type: string
          description: Systeemcode die het type fout aangeeft
        detail:
          type: string
          description: Extra informatie bij de fout, indien beschikbaar
        instance:
          type: string
          description: URI met referentie naar dit specifiek voorkomen van de fout. Deze kan gebruikt worden in combinatie met server logs, bijvoorbeeld.
        invalidParams:
          type: array
          items:
            $ref: '#/components/schemas/FieldValidationError'
        status:
          type: integer
          description: De HTTP status code
          format: int32
        title:
          type: string
          description: Generieke titel voor het type fout
        type:
          type: string
          description: URI referentie naar het type fout, bedoeld voor developers
      description: Formaat van HTTP 4xx en 5xx fouten.
    Resultaat:
      required:
      - generiek
      - herkomst
      - naam
      - nummer
      - procesType
      - procestermijnWeergave
      - specifiek
      - url
      - volledigNummer
      type: object
      properties:
        algemeenBestuurEnInrichtingOrganisatie:
          type: boolean
          description: algemeen bestuur en inrichting organisatie
          readOnly: true
        alleTaakgebieden:
          type: boolean
          description: alle taakgebieden
          readOnly: true
        bedrijfsvoeringEnPersoneel:
          type: boolean
          description: bedrijfsvoering en personeel
          readOnly: true
        bewaartermijn:
          type:
          - string
          - 'null'
          description: bewaartermijn
        burgerzaken:
          type: boolean
          description: burgerzaken
          readOnly: true
        economie:
          type: boolean
          description: economie
          readOnly: true
        generiek:
          type: boolean
          description: generiek
          readOnly: true
        heffenBelastingen:
          type: boolean
          description: Heffen belastingen etc.
          readOnly: true
        herkomst:
          maxLength: 200
          type: string
          description: '"Voorbeeld: ''Risicoanalyse'', ''Systeemanalyse'' of verwijzing

            naar Wet- en regelgeving"'
        naam:
          maxLength: 40
          type: string
          description: Benaming van het procestype
        nummer:
          maximum: 2147483647
          minimum: -2147483648
          type: integer
          description: Nummer van het resultaat. Dit wordt samengesteld met het procestype en generiek resultaat indien van toepassing.
          format: int64
          example: 6
        omschrijving:
          maxLength: 150
          type: string
          description: Omschrijving van het specifieke resultaat
        onderwijs:
          type: boolean
          description: onderwijs
          readOnly: true
        procesType:
          type: string
          description: procestype
          format: uri
          readOnly: true
        procestermijn:
          type: string
          description: 'Uitleg bij mogelijke waarden:

            `nihil` - Nihil

            `bestaansduur_procesobject` - De bestaans- of geldigheidsduur van het procesobject.

            `ingeschatte_bestaansduur_procesobject` - De ingeschatte maximale bestaans- of geldigheidsduur van het procesobject.

            `vast_te_leggen_datum` - De tijdens het proces vast te leggen datum waarop de geldigheid van het procesobject komt te vervallen.

            `samengevoegd_met_bewaartermijn` - De procestermijn is samengevoegd met de bewaartermijn."'
          enum:
          - bestaansduur_procesobject
          - nihil
          - ''
          - samengevoegd_met_bewaartermijn
          - vast_te_leggen_datum
        procestermijnOpmerking:
          maxLength: 20
          type: string
          description: 'Voorbeeld: ''25 jaar'', ''30 jaar, ''5 of 10 jaar'''
        procestermijnWeergave:
          type: string
          description: procestermijnWeergave
          readOnly: true
        publiekeInformatieEnRegistratie:
          type: boolean
          description: publieke informatie en registratie
          readOnly: true
        sociaalDomein:
          type: boolean
          description: sociaal domein
          readOnly: true
        specifiek:
          type: boolean
          description: specifiek
          readOnly: true
        sportCultuurEnRecreatie:
          type: boolean
          description: sport, cultuur en recreatie
          readOnly: true
        toelichting:
          maxLength: 150
          type: string
          description: Toelichting
        url:
          type: string
          description: Interne referentie naar de url
          readOnly: true
          example: http://referentielijsten-api.internal/api/v1/651a1b5b-f84f-4c73-9151-4d485c7dcb99
        veiligheid:
          type: boolean
          description: veiligheid
          readOnly: true
        verkeerEnVervoer:
          type: boolean
          description: verkeer en vervoer
          readOnly: true
        vhrosv:
          type: boolean
          description: VHROSV
          readOnly: true
        volksgezonheidEnMilieu:
          type: boolean
          description: volksgezondheid en milieu
          readOnly: true
        volledigNummer:
          type: string
          description: volledigNummer
          readOnly: true
        waardering:
          type: string
          enum:
          - blijvend_bewaren
          - vernietigen
    PaginatedResultaatList:
      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/Resultaat_2'
    FieldValidationError_2:
      type: object
      description: Formaat van validatiefouten.
      properties:
        name:
          type: string
          description: Naam van het veld met ongeldige gegevens
          title: name
        code:
          type: string
          description: Systeemcode die het type fout aangeeft
          title: code
        reason:
          type: string
          description: Uitleg wat er precies fout is met de gegevens
          title: reason
      required:
      - code
      - name
      - reason
    Fout_2:
      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
    PatchedResultaat:
      type: object
      properties:
        url:
          type: string
          format: uri
          readOnly: true
          title: url
          description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object.
          minLength: 1
          maxLength: 1000
        uuid:
          type: string
          format: uuid
          readOnly: true
          description: Unieke resource identifier (UUID4)
          title: uuid
        zaak:
          type: string
          format: uri
          description: URL-referentie naar de ZAAK.
          title: zaak
          minLength: 1
          maxLength: 1000
        resultaattype:
          type: string
          format: uri
          description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API).
          title: resultaattype
          maxLength: 1000
        toelichting:
          type: string
          description: Een toelichting op wat het resultaat van de zaak inhoudt.
          title: toelichting
          maxLength: 1000
    ValidatieFout_2:
      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_2'
          title: invalidParams
      required:
      - code
      - detail
      - instance
      - invalidParams
      - status
      - title
    Resultaat_2:
      type: object
      properties:
        url:
          type: string
          format: uri
          readOnly: true
          title: url
          description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object.
          minLength: 1
          maxLength: 1000
        uuid:
          type: string
          format: uuid
          readOnly: true
          description: Unieke resource identifier (UUID4)
          title: uuid
        zaak:
          type: string
          format: uri
          description: URL-referentie naar de ZAAK.
          title: zaak
          minLength: 1
          maxLength: 1000
        resultaattype:
          type: string
          format: uri
          description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API).
          title: resultaattype
          maxLength: 1000
        toelichting:
          type: string
          description: Een toelichting op wat het resultaat van de zaak inhoudt.
          title: toelichting
          maxLength: 1000
      required:
      - resultaattype
      - url
      - uuid
      - zaak
    PaginatedResultaatList_2:
      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/Resultaat_3'
    FieldValidationError_3:
      type: object
      description: Formaat van validatiefouten.
      properties:
        name:
          type: string
          description: Naam van het veld met ongeldige gegevens
          title: name
        code:
          type: string
          description: Systeemcode die het type fout aangeeft
          title: code
        reason:
          type: string
          description: Uitleg wat er precies fout is met de gegevens
          title: reason
      required:
      - code
      - name
      - reason
    Fout_3:
      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
    ValidatieFout_3:
      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_3'
          title: invalidParams
      required:
      - code
      - detail
      - instance
      - invalidParams
      - status
      - title
    Resultaat_3:
      type: object
      properties:
        url:
          type: string
          format: uri
          readOnly: true
          title: url
          description: URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object.
          minLength: 1
          maxLength: 1000
        uuid:
          type: string
          format: uuid
          readOnly: true
          description: Unieke resource identifier (UUID4)
          title: uuid
        zaak:
          type: string
          format: uri
          description: URL-referentie naar de ZAAK.
          title: zaak
          minLength: 1
          maxLength: 1000
        resultaattype:
          type: string
          format: uri
          description: URL-referentie naar het RESULTAATTYPE (in de Catalogi API).
          title: resultaattype
          maxLength: 1000
        toelichting:
          type: string
          description: Een toelichting op wat het resultaat van de zaak inhoudt.
          title: toelichting
          maxLength: 1000
      required:
      - resultaattype
      - url
      - uuid
      - zaak
  securitySchemes:
    JWT-Claims:
      type: http
      bearerFormat: JWT
      scheme: bearer
x-refined-from:
- vng-realisatie-referentielijsten-openapi.yml
- vng-realisatie-zaken-openapi.yml
- vng-realisatie-referentielijsten-openapi.yml
- vng-realisatie-zaken-openapi.yml