openapi: 3.2.0
info:
  title: Vng Realisatie Medewerkers 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 Medewerkers 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: Medewerkers
paths:
  /_registreer_medewerker:
    post:
      operationId: registreermedewerker
      description: De operatie waarmee gegevens van een medewerker kunnen worden geregistreerd. De id, de soort actor (in dit geval default `medewerker`) en de indicatie actief (default `True`) worden door de provider bepaald op het moment van registeren.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/RegistreerMedewerker_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/Medewerker'
        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:
      - Medewerkers
      summary: Registreermedewerker
      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
  /_wijzig_medewerker:
    post:
      operationId: wijzigmedewerker
      description: De operatie waarmee gegevens van medewerkers kunnen worden gewijzigd. De id, de soort actor (in dit geval `medewerker`) en de indicatie actief kunnen niet gewijzigd worden. Het deactiveren van de medewerker is een beheer-functie.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WijzigMedewerker_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/Medewerker'
        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:
      - Medewerkers
      summary: Wijzigmedewerker
      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_medewerker:
    post:
      operationId: zoekmedewerker
      description: De operatie waarmee gegevens van medewerkers kunnen worden gezocht.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ZoekMedewerker_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/Medewerker'
        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:
      - Medewerkers
      summary: Zoekmedewerker
      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:
    ZoekMedewerker_parameters:
      type: object
      description: ''
      required:
      - eMailadres
      - functie
      - naam
      properties:
        eMailadres:
          $ref: '#/components/schemas/Emailadres'
        functie:
          $ref: '#/components/schemas/Omschrijvingkort'
        naam:
          $ref: '#/components/schemas/Naamlang'
    SoortActor:
      type: string
      description: De typering van de actor.<body><ul><li>`medewerker` - medewerker </li><li>`geautomatiseerde_actor` - geautomatiseerde actor </li><li>`organisatorische_eenheid` - organisatorische eenheid </li></ul></body>
      enum:
      - medewerker
      - geautomatiseerde_actor
      - organisatorische_eenheid
    Omschrijvingkort:
      type: string
      description: ''
      maxLength: 40
    Telefoonnummer:
      type: string
      description: ''
      maxLength: 20
    WijzigMedewerker_parameters:
      type: object
      description: ''
      required:
      - id
      properties:
        eMailadres:
          $ref: '#/components/schemas/Emailadres'
        externId:
          $ref: '#/components/schemas/Identificatiecode'
        externRegister:
          $ref: '#/components/schemas/Omschrijvingkort'
        functie:
          $ref: '#/components/schemas/Omschrijvingkort'
        id:
          $ref: '#/components/schemas/Identificatiecode'
        naam:
          $ref: '#/components/schemas/Naamlang'
        telefoonnummer:
          $ref: '#/components/schemas/Telefoonnummer'
    Medewerker:
      allOf:
      - $ref: '#/components/schemas/Actor'
      - type: object
        description: Iemand die voor of namens de gemeente werkzaamheden verricht.
        required:
        - eMailadres
        - externId
        - externRegister
        - functie
        - telefoonnummer
        properties:
          eMailadres:
            $ref: '#/components/schemas/Emailadres'
          externId:
            $ref: '#/components/schemas/Identificatiecode'
          externRegister:
            $ref: '#/components/schemas/Omschrijvingkort'
          functie:
            $ref: '#/components/schemas/Omschrijvingkort'
          telefoonnummer:
            $ref: '#/components/schemas/Telefoonnummer'
    IndicatieJaNee:
      type: boolean
      description: ''
    RegistreerMedewerker_parameters:
      type: object
      description: ''
      required:
      - eMailadres
      - functie
      - naam
      - telefoonnummer
      properties:
        eMailadres:
          $ref: '#/components/schemas/Emailadres'
        externId:
          $ref: '#/components/schemas/Identificatiecode'
        externRegister:
          $ref: '#/components/schemas/Omschrijvingkort'
        functie:
          $ref: '#/components/schemas/Omschrijvingkort'
        naam:
          $ref: '#/components/schemas/Naamlang'
        telefoonnummer:
          $ref: '#/components/schemas/Telefoonnummer'
    Emailadres:
      type: string
      description: Een geldig email-adres, maximaal 20 karakters lang en minimaal een @ en een . opgenomen.
      maxLength: 200
    Naamlang:
      type: string
      description: ''
      maxLength: 200
    Identificatiecode:
      type: string
      description: ''
      maxLength: 40
    Actor:
      type: object
      description: De acor handelt in een interne taak of een klantcontact.
      required:
      - id
      - indicatieActief
      - naam
      - soortActor
      properties:
        id:
          $ref: '#/components/schemas/Identificatiecode'
        indicatieActief:
          $ref: '#/components/schemas/IndicatieJaNee'
        naam:
          $ref: '#/components/schemas/Naamlang'
        soortActor:
          $ref: '#/components/schemas/SoortActor'
x-refined-from:
- vng-realisatie-klantinteracties-openapi.yml
- vng-realisatie-klantinteracties-openapi.yml