openapi: 3.2.0
info:
  title: Vng Realisatie Interne taken API
  version: 00.01.00
  contact:
    url: http://www.verzoeken.nl
    email: standaarden.ondersteuning@vng.nl
  license:
    name: European Union Public License, version 1.2 (EUPL-1.2)
    url: https://eupl.eu/1.2/nl/
  x-imvertor-generator-version: 2.0.0
  x-yamlCompiler-stylesheets-version: '20230512'
  description: 'Operations tagged Interne taken across 2 of this provider''s published API definitions: vng-realisatie-klantinteracties-openapi.yml, vng-realisatie-klantinteracties-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- description: SwaggerHub API Auto Mocking
  url: https://virtserver.swaggerhub.com/VNGRealisatie/api/klantinteracties/v00
- description: Referentie-implementatie
  url: https://www.voorbeeldgemeente.nl/api/klantinteracties/v00
tags:
- name: Interne taken
paths:
  /_corrigeer_interne_taak:
    post:
      operationId: wijziginternetaak
      description: De operatie waarmee gegevens van een interne taak kunnen worden gewijzigd. De id, het nummer, geregistreerdOp en de status (waarde `te verwerken`) worden door de provider bepaald en vastgelegd.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CorrigeerInterneTaak_parameters'
      responses:
        200:
          description: OK
          headers:
            api-version:
              $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/headers/api_version
            warning:
              $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/headers/warning
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterneTaak'
        400:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/400
        401:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/401
        403:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/403
        409:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/409
        410:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/410
        415:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/415
        429:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/429
        500:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/500
        501:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/501
        503:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/503
        default:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/default
      tags:
      - Interne taken
      summary: Wijziginternetaak
      x-summary-source: derived
    servers:
    - description: SwaggerHub API Auto Mocking
      url: https://virtserver.swaggerhub.com/VNGRealisatie/api/klantinteracties/v00
    - description: Referentie-implementatie
      url: https://www.voorbeeldgemeente.nl/api/klantinteracties/v00
  /_markeer_interne_taak_verwerkt:
    post:
      operationId: markeerinternetaakverwerkt
      description: De operatie waarmee gegevens van een interne taak als verwerkt wordt gemarkeerd. Op basis van het ID wordt de Status van de Interne Taak gewijzigd naar `Verwerkt`.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MarkeerInterneTaakVerwerkt_parameters'
      responses:
        200:
          description: OK
          headers:
            api-version:
              $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/headers/api_version
            warning:
              $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/headers/warning
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterneTaak'
        400:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/400
        401:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/401
        403:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/403
        409:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/409
        410:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/410
        415:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/415
        429:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/429
        500:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/500
        501:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/501
        503:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/503
        default:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/default
      tags:
      - Interne taken
      summary: Markeerinternetaakverwerkt
      x-summary-source: derived
    servers:
    - description: SwaggerHub API Auto Mocking
      url: https://virtserver.swaggerhub.com/VNGRealisatie/api/klantinteracties/v00
    - description: Referentie-implementatie
      url: https://www.voorbeeldgemeente.nl/api/klantinteracties/v00
  /_registreer_interne_taak:
    post:
      operationId: registreerinternetaak
      description: De operatie waarmee gegevens van een interne taak kunnen worden geregistreerd. De id, het nummer, geregistreerdOp en de status (waarde `te verwerken`) worden door de provider bepaald en vastgelegd.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegistreerInterneTaak_parameters'
      responses:
        200:
          description: OK
          headers:
            api-version:
              $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/headers/api_version
            warning:
              $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/headers/warning
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterneTaak'
        400:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/400
        401:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/401
        403:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/403
        409:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/409
        410:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/410
        415:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/415
        429:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/429
        500:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/500
        501:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/501
        503:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/503
        default:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/default
      tags:
      - Interne taken
      summary: Registreerinternetaak
      x-summary-source: derived
    servers:
    - description: SwaggerHub API Auto Mocking
      url: https://virtserver.swaggerhub.com/VNGRealisatie/api/klantinteracties/v00
    - description: Referentie-implementatie
      url: https://www.voorbeeldgemeente.nl/api/klantinteracties/v00
  /_zoek_interne_taak:
    post:
      operationId: zoekinternetaak
      description: De operatie waarmee gegevens van een interne taak kunnen worden gezocht.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ZoekInterneTaak_parameters'
      responses:
        200:
          description: OK
          headers:
            api-version:
              $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/headers/api_version
            warning:
              $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/headers/warning
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InterneTaak'
        400:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/400
        401:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/401
        403:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/403
        409:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/409
        410:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/410
        415:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/415
        429:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/429
        500:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/500
        501:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/501
        503:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/503
        default:
          $ref: https://raw.githubusercontent.com/VNG-Realisatie/API-Kennisbank/master/common/common.yaml#/components/responses/default
      tags:
      - Interne taken
      summary: Zoekinternetaak
      x-summary-source: derived
    servers:
    - description: SwaggerHub API Auto Mocking
      url: https://virtserver.swaggerhub.com/VNGRealisatie/api/klantinteracties/v00
    - description: Referentie-implementatie
      url: https://www.voorbeeldgemeente.nl/api/klantinteracties/v00
components:
  schemas:
    Datumtijd:
      type: string
      description: ''
      format: date-time
    CorrigeerInterneTaak_parameters:
      type: object
      description: ''
      required:
      - id
      properties:
        actorId:
          $ref: '#/components/schemas/Identificatiecode'
        gevraagdeHandeling:
          $ref: '#/components/schemas/Omschrijvinglang'
        id:
          $ref: '#/components/schemas/Identificatiecode'
        status:
          $ref: '#/components/schemas/Taakstatus'
        toelichting:
          $ref: '#/components/schemas/Toelichting'
    ZoekInterneTaak_parameters:
      type: object
      description: ''
      properties:
        actorId:
          $ref: '#/components/schemas/Identificatiecode'
        geregistreerdOp:
          $ref: '#/components/schemas/Datumtijd'
        gevraagdeHandeling:
          $ref: '#/components/schemas/Omschrijvinglang'
        id:
          $ref: '#/components/schemas/Identificatiecode'
        klantcontactId:
          $ref: '#/components/schemas/Identificatiecode'
        nummer:
          $ref: '#/components/schemas/Identificerendnummer'
        status:
          $ref: '#/components/schemas/Taakstatus'
        toelichting:
          $ref: '#/components/schemas/Toelichting'
    InterneTaak:
      type: object
      description: Iets dat als onderdeel van opvolging van een klantcontact door een medewerker of organisatie-afdeling moet worden gedaan.
      required:
      - actorId
      - geregistreerdOp
      - gevraagdeHandeling
      - id
      - nummer
      - status
      properties:
        actorId:
          $ref: '#/components/schemas/Identificatiecode'
        geregistreerdOp:
          $ref: '#/components/schemas/Datumtijd'
        gevraagdeHandeling:
          $ref: '#/components/schemas/Omschrijvinglang'
        id:
          $ref: '#/components/schemas/Identificatiecode'
        nummer:
          $ref: '#/components/schemas/Identificerendnummer'
        status:
          $ref: '#/components/schemas/Taakstatus'
        toelichting:
          $ref: '#/components/schemas/Toelichting'
    Identificerendnummer:
      type: integer
      description: ''
    Taakstatus:
      type: string
      description: De waarden van de typering van de voortgang van afhandeling van een VERZOEK.<body><ul><li>`te_verwerken` - te verwerken Het verzoek is afgehandeld.</li><li>`verwerkt` - verwerkt Het verzoek id buiten behandeling gesteld.</li></ul></body>
      enum:
      - te_verwerken
      - verwerkt
    Toelichting:
      type: string
      description: Toelichtende tekst
      maxLength: 400
    RegistreerInterneTaak_parameters:
      type: object
      description: ''
      required:
      - actorId
      - gevraagdeHandeling
      - klantcontactId
      properties:
        actorId:
          $ref: '#/components/schemas/Identificatiecode'
        gevraagdeHandeling:
          $ref: '#/components/schemas/Omschrijvinglang'
        klantcontactId:
          $ref: '#/components/schemas/Identificatiecode'
        toelichting:
          $ref: '#/components/schemas/Toelichting'
    Omschrijvinglang:
      type: string
      description: ''
      maxLength: 200
    MarkeerInterneTaakVerwerkt_parameters:
      type: object
      description: ''
      required:
      - id
      properties:
        id:
          $ref: '#/components/schemas/Identificatiecode'
    Identificatiecode:
      type: string
      description: ''
      maxLength: 40
x-refined-from:
- vng-realisatie-klantinteracties-openapi.yml
- vng-realisatie-klantinteracties-openapi.yml