openapi: 3.2.0 info: title: Vng Realisatie Klantcontacten API x-refined-note: - x-imvertor-generator-version differs across the merged source definitions and was not carried - x-yamlCompiler-stylesheets-version differs across the merged source definitions and was not carried version: '1.0' description: 'Operations tagged Klantcontacten across 4 of this provider''s published API definitions: vng-realisatie-klantinteracties-openapi.yml, vng-realisatie-zaken-openapi.yml, vng-realisatie-klantinteracties-openapi.yml, vng-realisatie-zaken-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 - url: https://zaken-api.vng.cloud/api/v1/ description: Productie Omgeving tags: - name: Klantcontacten paths: /_registreer_binnenkomend_telefoongesprek: post: operationId: registreerbinnekomendtelefoongesprek description: 'De operatie waarmee gegevens van een klantcontact kunnen worden geregistreerd. De id, het nummer, geregistreerdOp, plaatsgevondenOp, Kanaal, IndicatieGelukt (`True`) en initiatiefnemer worden door de provider bepaald en vastgelegd. Indien de betrokkene een bekende Partij betreft worden de partijId en de Rol vastgelegd. de andere properties die ingevuld worden zullen als voorkeurs contactgegevens voor alleen de opvolging van dit klantcontact worden behandeld. Indien de betrokkene nog niet als Partij bekend is wordt, na uitvraag van de naam- en contactgegevens, de indicatie_hergebruik gevuld. Als deze True is wordt met de gegevens die bekend zijn een Partij aangemaakt. Organisatienaam gevuld --> Soort_Partij = `Organisatie` Persoonsnaam gevuld en rol = `Klant --> Soort_Partij = `Persoon` Persoonsnaam gevuld en rol = `Vertegenwoordiger` --> Soort_Partij = `Contactpersoon`.' requestBody: content: application/json: schema: $ref: '#/components/schemas/Registreertelefoongesprek_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/Klantcontact' 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: - Klantcontacten summary: Registreerbinnekomendtelefoongesprek 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_keukentafelgesprek: post: operationId: registreerkeukentafelgesprek description: 'De operatie waarmee gegevens van een klantcontact kunnen worden geregistreerd. De id, het nummer, geregistreerdOp, plaatsgevondenOp, Kanaal, IndicatieGelukt (`True`) worden door de provider bepaald en vastgelegd. Indien de betrokkene een bekende Partij betreft worden de partijId en de Rol vastgelegd. de andere properties die ingevuld worden zullen als voorkeurs contactgegevens voor alleen de opvolging van dit klantcontact worden behandeld. Indien de betrokkene nog niet als Partij bekend is wordt, na uitvraag van de naam- en contactgegevens, de indicatie_hergebruik gevuld. Als deze True is wordt met de gegevens die bekend zijn een Partij aangemaakt. Organisatienaam gevuld --> Soort_Partij = `Organisatie` Persoonsnaam gevuld en rol = `Klant --> Soort_Partij = `Persoon` Persoonsnaam gevuld en rol = `Vertegenwoordiger` --> Soort_Partij = `Contactpersoon`.' requestBody: content: application/json: schema: $ref: '#/components/schemas/Registreerkeukentafelgesprek_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/Klantcontact' 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: - Klantcontacten summary: Registreerkeukentafelgesprek 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_klantcontact: post: operationId: registreerklantcontact description: 'De operatie waarmee gegevens van een klantcontact kunnen worden geregistreerd. De id, het nummer en geregistreerdOp worden door de provider bepaald en vastgelegd. Indien de betrokkene een bekende Partij betreft worden de partijId en de Rol vastgelegd. de andere properties die ingevuld worden zullen als voorkeurs contactgegevens voor alleen de opvolging van dit klantcontact worden behandeld. Indien de betrokkene nog niet als Partij bekend is wordt, na uitvraag van de naam- en contactgegevens, de indicatie_hergebruik gevuld. Als deze True is wordt met de gegevens die bekend zijn een Partij aangemaakt. Organisatienaam gevuld --> Soort_Partij = `Organisatie` Persoonsnaam gevuld en rol = `Klant --> Soort_Partij = `Persoon` Persoonsnaam gevuld en rol = `Vertegenwoordiger` --> Soort_Partij = `Contactpersoon`.' requestBody: content: application/json: schema: $ref: '#/components/schemas/Registreerklantcontact_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/Klantcontact' 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: - Klantcontacten summary: Registreerklantcontact 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_klantcontact_gaat_over_interne_taak: post: operationId: registreerklantcontactgaatoverinternetaak description: De operatie waarmee de koppeling tussen een Klantcontact en de Interne Taak waar het Klnatcontct over gaat. De provider bepaalt de waarden van de id, onstaanUitKlantcontact (false), soortObject (Interne taak), externRegister (leeg) en externId (leeg). requestBody: content: application/json: schema: $ref: '#/components/schemas/RegistreerKlantcontactGaatOverInterneTaak_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/ObjectVanKlantcontact' 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: - Klantcontacten summary: Registreerklantcontactgaatoverinternetaak 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_klantcontact_gaat_over_object: post: operationId: registreerklantcontactgaatoverobject description: De operatie waarmee geregistreerd wordt over welk object het klantcontact gaat. De provider bepaalt de waarden van id en interneTaakId (leeg). requestBody: content: application/json: schema: $ref: '#/components/schemas/RegistreerKlantcontactGaatOverObject_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/ObjectVanKlantcontact' 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: - Klantcontacten summary: Registreerklantcontactgaatoverobject 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 /_verwijder_klantcontact_gaat_over: post: operationId: verwijderklantcontactgaatover description: De operatie waarmee de koppeling tussen een klantcontact en het object of de interne taak waarover het gaat kan worden verwijderd. requestBody: content: application/json: schema: $ref: '#/components/schemas/VerwijderKlantcontactGaatOver_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/ObjectVanKlantcontact' 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: - Klantcontacten summary: Verwijderklantcontactgaatover 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 /klantcontacten: get: operationId: klantcontact_list description: 'Alle KLANTCONTACTen opvragen. **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' summary: Alle KLANTCONTACTen opvragen parameters: - name: zaak required: false in: query description: URL-referentie naar de ZAAK. schema: type: string format: uri - name: page required: false in: query description: Een pagina binnen de gepagineerde set resultaten. schema: type: integer tags: - Klantcontacten security: - JWT-Claims: - zaken.lezen deprecated: true 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/PaginatedKlantContactList' 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 '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: klantcontact_create description: 'Indien geen identificatie gegeven is, dan wordt deze automatisch gegenereerd. **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' summary: Maak een KLANTCONTACT 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: - Klantcontacten requestBody: content: application/json: schema: $ref: '#/components/schemas/KlantContact' required: true security: - JWT-Claims: - (zaken.bijwerken | zaken.geforceerd-bijwerken) deprecated: true 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/KlantContact' 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 /klantcontacten/{uuid}: get: operationId: klantcontact_retrieve description: 'Een specifieke KLANTCONTACT opvragen. **DEPRECATED**: gebruik de contactmomenten API in plaats van deze endpoint.' summary: Een specifieke KLANTCONTACT opvragen parameters: - in: path name: uuid schema: type: string format: uuid description: Unieke resource identifier (UUID4) title: uuid required: true tags: - Klantcontacten security: - JWT-Claims: - zaken.lezen deprecated: true 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/KlantContact' 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 components: schemas: Datumtijd: type: string description: '' format: date-time Registreerklantcontact_parameters: type: object description: '' required: - actorId - betrokkeneBijKlantcontact - indicatieContactGelukt - indicatieHergebruikPartij - initiatiefnemer - kanaal - onderwerp - plaatsgevondenOp properties: actorId: type: array minItems: 1 items: $ref: '#/components/schemas/Identificatiecode' betrokkeneBijKlantcontact: type: array minItems: 1 items: $ref: '#/components/schemas/BetrokkeneBijKlantcontact_param' indicatieContactGelukt: $ref: '#/components/schemas/IndicatieJaNeeOnbekend' indicatieHergebruikPartij: $ref: '#/components/schemas/IndicatieJaNee' inhoudsdeel: type: array minItems: 0 items: $ref: '#/components/schemas/Inhoudsdeel_param' initiatiefnemer: $ref: '#/components/schemas/Initiatiefnemer' kanaal: $ref: '#/components/schemas/Kanaal' onderwerp: $ref: '#/components/schemas/Omschrijvingkort' plaatsgevondenOp: $ref: '#/components/schemas/Datumtijd' Huisnummertoevoeging: type: string description: '' maxLength: 4 SoortObject: type: object description: Een opsomming van de soorten objecten waarmee een koppeling gelegd wordt vanuit het register klantinteracties. required: - code - indicatieActief - naam properties: code: type: string title: Code description: De code, behorende bij het soort object. minLength: 1 indicatieActief: $ref: '#/components/schemas/IndicatieJaNee' naam: type: string title: Naam description: De naam van het soort object. minLength: 1 SoortInhoudsdeel: type: string description: De typering van het inhoudsdeel. enum: - informatieobject - overig_object - tekst Huisnummer: type: integer description: '' Registreertelefoongesprek_parameters: type: object description: '' required: - actorId - betrokkeneBijKlantcontact - indicatieHergebruikPartij - onderwerp properties: actorId: type: array minItems: 1 items: $ref: '#/components/schemas/Identificatiecode' betrokkeneBijKlantcontact: type: array minItems: 1 items: $ref: '#/components/schemas/BetrokkeneBijKlantcontact_param' indicatieHergebruikPartij: $ref: '#/components/schemas/IndicatieJaNee' inhoudsdeel: type: array minItems: 0 items: $ref: '#/components/schemas/Inhoudsdeel_param' onderwerp: $ref: '#/components/schemas/Omschrijvingkort' BetrokkeneBijKlantcontact: type: object description: 'De betrokkenheid en de rol van een persoon of organisatie bij het klantcontact. Klantcontact-betrokkene kent afhankelijk van mogelijkheid of wenselijkheid om in het kader van (opvolging van) de klantinteractie persoonsgegevens te verwerken twee gebruiksmogelijkheden. 1) is van de bij het klantcontact betrokken inwoner of ondernemer na identificatie en/of authenticatie voldoende duidelijk wie die is of vertegenwoordigt, dan wordt eerst opgezocht of deze inwoner of ondernemer reeds als partij bij de gemeente bekend is. Is dat niet zo, dan kan vervolgens een partij worden geregistreerd. Tussen de opgezochte of gecre??erde partij en klantcontact-betrokkene wordt vervolgens een relatie gelegd. Als de betrokkene aangeeft dat all????n voor opvolging van het klantcontact andere dan de bij partij geregistreerde ''default''-contactgegevens gebruikt moeten, worden deze alternatieve contactgegevens vastgelegd in klantcontact-betrokkene. Voor opvolging van het klantcontact gelden de in Klantcontact-betrokkene vastgelegde contactgegevens dus boven gelijkaardige gegevens die bij partij zijn geregistreerd. 2) is van de bij het klantcontact betrokken inwoner of ondernemer na eventuele identificatie en/of authenticatie onvoldoende duidelijk is wie die is of vertegenwoordigt, dan kan in klantcontact-betrokkene een set voor opvolging van het klantcontact benodigde of gewenste contactgegevens worden geregistreerd. In dit geval is er dus g????n sprake van een realtie tussen klantcontact-betrokkene en partij.' required: - digitaalAdres - id - rol properties: bezoekadres: $ref: '#/components/schemas/Bezoekadres' correspondentieadres: $ref: '#/components/schemas/Correspondentieadres' digitaalAdres: $ref: '#/components/schemas/DigitaalAdres' id: $ref: '#/components/schemas/Identificatiecode' organisatienaam: $ref: '#/components/schemas/Naamlang' persoonsnaam: $ref: '#/components/schemas/Persoonsnaamgegevens' rol: $ref: '#/components/schemas/Klantcontactrol' voorkeurskanaal: $ref: '#/components/schemas/Kanaal' voorkeurstaal: $ref: '#/components/schemas/Voorkeurstaal' SoortDigitaalAdres: type: object description: Een opsomming van de type digitaal adres waarlangs de gemeente klantcontacten kan hebben. required: - code - indicatieActief - naam properties: code: type: string title: Code description: De code, behorende bij het soort digitaal adres. minLength: 1 indicatieActief: $ref: '#/components/schemas/IndicatieJaNee' naam: type: string title: Naam description: De naam van het soort digitaal adres. minLength: 1 Klantcontact: type: object description: "Een contact tussen een klant of een vertegenwoordiger van een klant en de gemeente.\n\nHet klantcontact is bedoeld om inwoners of ondernemers die contact hebben gehad met de gemeente op een voor hen zo begrijpelijk en relevant mogelijke manier te infomeren over de inhoud van dat contact. Over een klantcontact vastgelegde informatie kan bijvoorbeeld (na inloggen) worden getoond op de gemeentelijke website of telefonisch worden verstrekt door een medewerker van het klantcontactcentrum. Als gevolg hiervan is de volledige inhoud van een klantcontact geschikt voor openbaarmaking aan betrokken inwoners. De definitie van klantcontact is bewust wat 'open' gelaten. Op deze manier passen daarbinnen ook contacten die voortkomen uit nu onvoorziene scenario's of via nog te ontwikkelen kanalen. Uitgangspunt is in alle gevallen dat ????n klantcontact de informatie omvat die een klant of dienst vertegenwoordiger tijdens een voor hen herkenbare handeling of gebeurtenis overbrengt aan de gemeente of vice versa. Zo'n handeling kan bijvoorbeeld het afleggen van baliebezoek zijn, het telefonisch voeren van een gesprek met een medewerker of een interactie met een chatbot op de gemeentelijke website. Maar ook gebeurtenissen als het indienen van een elektronisch formulier of het versturen van een brief door de gemeente aan een klant of vertegenwoordiger resulteren in een klantcontact. Voor het bepalen van het begin en eind van een klantcontact geldt dat informatie die binnen een korte tijdsperiode tussen gemeente en klant wordt uitgewisseld waar mogelijk resulteert in ????n klantcontact, terwijl een verzonden kennisgeving en een uren of dagen later ontvangen reactie daarop resulteren in twee ???losse??? klantcontacten. Dit betekent dat een klantcontact naar aanleiding van een telefoongesprek 'duurt' van het aannemen van het gesprek tot het be??indigen hiervan, terwijl een contact naar aanleiding van een baliebezoek de periode beschrijft vanaf het aan een medewerker verschijnen van een klant of vertegenwoordiger tot aan diens vertrek. In het geval van ontvangst door de gemeente van een brief van een klant waarop de gemeente enige dagen later eveneens schriftelijk reageert, worden beide brieven daarentegen als twee individuele klantcontacten te beschouwd. Tussen de voorbeelden hierboven in ligt een aantal kanalen waarbij informatie minder snel wordt uitgewisseld dan bij een telefoongesprek of baliecontact, maar (veel) sneller dan bij een briefwisseling. Denk aan communicatie via contactformulieren, e-mail of chatapps en -bots. Zeker in de laatste gevallen kan sprake zijn van korte, elkaar snel opvolgende interacties die samen het karakter hebben van een gesprek. Anders dan een telefoon- of baliegesprek kan een interactie via deze kanalen echter voor uren of dagen onderbroken worden, om daarna weer te worden opgepakt. In zo'n geval is het aan medewerkers van de gemeente - in geval van geautomatiseerde interacties samen met systeemontwikkelaars - om te bepalen wat vanuit klantperspectief de meest voor de hand liggende ???omvang??? van een klantcontact is. Tijdens een klantcontact kan duidelijk worden dat een inwoner verschillende verzoeken voor de gemeente heeft. Een klant kan tijdens een telefoongesprek bijvoorbeeld vragen naar een afspraak voor overleg over een te verbouwen woning en daarnaast een verzakking van stoep voor zijn huis melden. Deze verzoeken moeten op uiteenlopende wijze en waarschijnlijk door verschillende afdelingen worden opgevolgd. Met het bepalen welke medewerlkers of afdelingen nodig zijn om aan verzoeken van een klant invulling te geven, begint in feite de behandeling van deze verzoeken. Deze behandeling is nadrukkelijk g????n onderdeel van het klantcontact. Anders dan het registreren van voor het klantcontact relevante onderwerpen biedt het klantcontact dan ook geen mogelijkheden de inhoud daarvan naar verschillende verzoeken, aanvragen of meldingen uit te splitsen. Hiervoor zijn de concepten 'interne taak' en 'zaak' bedoeld. Het klantcontact uit het voorbeeld hierboven zou bijvoorbeeld aanleiding kunnen zijn voor het aanmaken van zowel een zaak van type 'melding openbare ruimte' om de stoep te herstellen, als een interne taak voor een medewerker van de afdeling fysieke leefomgeving om een afspraak te maken voor overleg over de voorgenomen verbouwing.\n\nHet klantcontact is bedoeld om inwoners of ondernemers die contact hebben gehad met de gemeente op een voor hen zo begrijpelijk en relevant mogelijke manier te infomeren over de inhoud van dat contact. Over een klantcontact vastgelegde informatie kan bijvoorbeeld (na inloggen) worden getoond op de gemeentelijke website of telefonisch worden verstrekt door een medewerker van het klantcontactcentrum. Als gevolg hiervan is de volledige inhoud van een klantcontact geschikt voor openbaarmaking aan betrokken inwoners. De definitie van klantcontact is bewust wat 'open' gelaten. Op deze manier passen daarbinnen ook contacten die voortkomen uit nu onvoorziene scenario's of via nog te ontwikkelen kanalen. Uitgangspunt is in alle gevallen dat ????n klantcontact de informatie omvat die een klant of dienst vertegenwoordiger tijdens een voor hen herkenbare handeling of gebeurtenis overbrengt aan de gemeente of vice versa. Zo'n handeling kan bijvoorbeeld het afleggen van baliebezoek zijn, het telefonisch voeren van een gesprek met een medewerker of een interactie met een chatbot op de gemeentelijke website. Maar ook gebeurtenissen als het indienen van een elektronisch formulier of het versturen van een brief door de gemeente aan een klant of vertegenwoordiger resulteren in een klantcontact. Voor het bepalen van het begin en eind van een klantcontact geldt dat informatie die binnen een korte tijdsperiode tussen gemeente en klant wordt uitgewisseld waar mogelijk resulteert in ????n klantcontact, terwijl een verzonden kennisgeving en een uren of dagen later ontvangen reactie daarop resulteren in twee ???losse??? klantcontacten. Dit betekent dat een klantcontact naar aanleiding van een telefoongesprek 'duurt' van het aannemen van het gesprek tot het be??indigen hiervan, terwijl een contact naar aanleiding van een baliebezoek de periode beschrijft vanaf het aan een medewerker verschijnen van een klant of vertegenwoordiger tot aan diens vertrek. In het geval van ontvangst door de gemeente van een brief van een klant waarop de gemeente enige dagen later eveneens schriftelijk reageert, worden beide brieven daarentegen als twee individuele klantcontacten te beschouwd. Tussen de voorbeelden hierboven in ligt een aantal kanalen waarbij informatie minder snel wordt uitgewisseld dan bij een telefoongesprek of baliecontact, maar (veel) sneller dan bij een briefwisseling. Denk aan communicatie via contactformulieren, e-mail of chatapps en -bots. Zeker in de laatste gevallen kan sprake zijn van korte, elkaar snel opvolgende interacties die samen het karakter hebben van een gesprek. Anders dan een telefoon- of baliegesprek kan een interactie via deze kanalen echter voor uren of dagen onderbroken worden, om daarna weer te worden opgepakt. In zo'n geval is het aan medewerkers van de gemeente - in geval van geautomatiseerde interacties samen met systeemontwikkelaars - om te bepalen wat vanuit klantperspectief de meest voor de hand liggende ???omvang??? van een klantcontact is. Tijdens een klantcontact kan duidelijk worden dat een inwoner verschillende verzoeken voor de gemeente heeft. Een klant kan tijdens een telefoongesprek bijvoorbeeld vragen naar een afspraak voor overleg over een te verbouwen woning en daarnaast een verzakking van stoep voor zijn huis melden. Deze verzoeken moeten op uiteenlopende wijze en waarschijnlijk door verschillende afdelingen worden opgevolgd. Met het bepalen welke medewerlkers of afdelingen nodig zijn om aan verzoeken van een klant invulling te geven, begint in feite de behandeling van deze verzoeken. Deze behandeling is nadrukkelijk g????n onderdeel van het klantcontact. Anders dan het registreren van voor het klantcontact relevante onderwerpen biedt het klantcontact dan ook geen mogelijkheden de inhoud daarvan naar verschillende verzoeken, aanvragen of meldingen uit te splitsen. Hiervoor zijn de concepten 'interne taak' en 'zaak' bedoeld. Het klantcontact uit het voorbeeld hierboven zou bijvoorbeeld aanleiding kunnen zijn voor het aanmaken van zowel een zaak van type 'melding openbare ruimte' om de stoep te herstellen, als een interne taak voor een medewerker van de afdeling fysieke leefomgeving om een afspraak te maken voor overleg over de voorgenomen verbouwing. \n\nHet klantcontact is bedoeld om inwoners of ondernemers die contact hebben gehad met de gemeente op een voor hen zo begrijpelijk en relevant mogelijke manier te infomeren over de inhoud van dat contact. Over een klantcontact vastgelegde informatie kan bijvoorbeeld (na inloggen) worden getoond op de gemeentelijke website of telefonisch worden verstrekt door een medewerker van het klantcontactcentrum. Als gevolg hiervan is de volledige inhoud van een klantcontact geschikt voor openbaarmaking aan betrokken inwoners. De definitie van klantcontact is bewust wat 'open' gelaten. Op deze manier passen daarbinnen ook contacten die voortkomen uit nu onvoorziene scenario's of via nog te ontwikkelen kanalen. Uitgangspunt is in alle gevallen dat ????n klantcontact de informatie omvat die een klant of dienst vertegenwoordiger tijdens een voor hen herkenbare handeling of gebeurtenis overbrengt aan de gemeente of vice versa. Zo'n handeling kan bijvoorbeeld het afleggen van baliebezoek zijn, het telefonisch voeren van een gesprek met een medewerker of een interactie met een chatbot op de gemeentelijke website. Maar ook gebeurtenissen als het indienen van een elektronisch formulier of het versturen van een brief door de gemeente aan een klant of vertegenwoordiger resulteren in een klantcontact. Voor het bepalen van het begin en eind van een klantcontact geldt dat informatie die binnen een korte tijdsperiode tussen gemeente en klant wordt uitgewisseld waar mogelijk resulteert in ????n klantcontact, terwijl een verzonden kennisgeving en een uren of dagen later ontvangen reactie daarop resulteren in twee ???losse??? klantcontacten. Dit betekent dat een klantcontact naar aanleiding van een telefoongesprek 'duurt' van het aannemen van het gesprek tot het be??indigen hiervan, terwijl een contact naar aanleiding van een baliebezoek de periode beschrijft vanaf het aan een medewerker verschijnen van een klant of vertegenwoordiger tot aan diens vertrek. In het geval van ontvangst door de gemeente van een brief van een klant waarop de gemeente enige dagen later eveneens schriftelijk reageert, worden beide brieven daarentegen als twee individuele klantcontacten te beschouwd. Tussen de voorbeelden hierboven in ligt een aantal kanalen waarbij informatie minder snel wordt uitgewisseld dan bij een telefoongesprek of baliecontact, maar (veel) sneller dan bij een briefwisseling. Denk aan communicatie via contactformulieren, e-mail of chatapps en -bots. Zeker in de laatste gevallen kan sprake zijn van korte, elkaar snel opvolgende interacties die samen het karakter hebben van een gesprek. Anders dan een telefoon- of baliegesprek kan een interactie via deze kanalen echter voor uren of dagen onderbroken worden, om daarna weer te worden opgepakt. In zo'n geval is het aan medewerkers van de gemeente - in geval van geautomatiseerde interacties samen met systeemontwikkelaars - om te bepalen wat vanuit klantperspectief de meest voor de hand liggende ???omvang??? van een klantcontact is. Tijdens een klantcontact kan duidelijk worden dat een inwoner verschillende verzoeken voor de gemeente heeft. Een klant kan tijdens een telefoongesprek bijvoorbeeld vragen naar een afspraak voor overleg over een te verbouwen woning en daarnaast een verzakking van stoep voor zijn huis melden. Deze verzoeken moeten op uiteenlopende wijze en waarschijnlijk door verschillende afdelingen worden opgevolgd. Met het bepalen welke medewerlkers of afdelingen nodig zijn om aan verzoeken van een klant invulling te geven, begint in feite de behandeling van deze verzoeken. Deze behandeling is nadrukkelijk g????n onderdeel van het klantcontact. Anders dan het registreren van voor het klantcontact relevante onderwerpen biedt het klantcontact dan ook geen mogelijkheden de inhoud daarvan naar verschillende verzoeken, aanvragen of meldingen uit te splitsen. Hiervoor zijn de concepten 'interne taak' en 'zaak' bedoeld. Het klantcontact uit het voorbeeld hierboven zou bijvoorbeeld aanleiding kunnen zijn voor het aanmaken van zowel een zaak van type 'melding openbare ruimte' om de stoep te herstellen, als een interne taak voor een medewerker van de afdeling fysieke leefomgeving om een afspraak te maken voor overleg over de voorgenomen verbouwing." required: - actorId - betrokkeneBijKlantcontact - geregistreerdOp - id - indicatieContactGelukt - initiatiefnemer - kanaal - nummer - onderwerp - plaatsgevondenOp properties: actorId: type: array minItems: 1 items: $ref: '#/components/schemas/Identificatiecode' betrokkeneBijKlantcontact: type: array minItems: 1 items: $ref: '#/components/schemas/BetrokkeneBijKlantcontact' geregistreerdOp: $ref: '#/components/schemas/Datumtijd' id: $ref: '#/components/schemas/Identificatiecode' indicatieContactGelukt: $ref: '#/components/schemas/IndicatieJaNeeOnbekend' inhoudsdelen: type: array minItems: 0 items: $ref: '#/components/schemas/Inhoudsdeel' initiatiefnemer: $ref: '#/components/schemas/Initiatiefnemer' kanaal: $ref: '#/components/schemas/Kanaal' nummer: $ref: '#/components/schemas/Identificerendnummer' onderwerp: $ref: '#/components/schemas/Omschrijvingkort' plaatsgevondenOp: $ref: '#/components/schemas/Datumtijd' VerwijderKlantcontactGaatOver_parameters: type: object description: '' required: - id properties: id: $ref: '#/components/schemas/Identificatiecode' RegistreerKlantcontactGaatOverObject_parameters: type: object description: '' required: - externId - externRegister - klantcontactId - ontstaanUitKlantcontact - soortObject properties: externId: $ref: '#/components/schemas/Identificatiecode' externRegister: $ref: '#/components/schemas/Omschrijvingkort' klantcontactId: $ref: '#/components/schemas/Identificatiecode' ontstaanUitKlantcontact: $ref: '#/components/schemas/IndicatieJaNee' soortObject: $ref: '#/components/schemas/SoortObject' AanduidingBijHuisnummer: type: string description: De aanduiding die gebruikt wordt voor bijvoorbeeld een ligplaats of een standplaats die geen eigen nummeraanduiding heeft. enum: - bij - tegenover Identificatiecode: type: string description: '' maxLength: 40 Correspondentieadres: type: object description: Het adres waarnaar de persoon of de organisatie de voor hen bestemde correspondentie laat verzenden. required: - soortCorrespondentieadres properties: aanduidingBijHuisnummer: $ref: '#/components/schemas/AanduidingBijHuisnummer' adresregelBuitenland1: $ref: '#/components/schemas/Adresregel' adresregelBuitenland2: $ref: '#/components/schemas/Adresregel' adresregelBuitenland3: $ref: '#/components/schemas/Adresregel' antwoordnummer: $ref: '#/components/schemas/Antwoordnummer' huisletter: $ref: '#/components/schemas/Huisletter' huisnummer: $ref: '#/components/schemas/Huisnummer' huisnummertoevoeging: $ref: '#/components/schemas/Huisnummertoevoeging' land: $ref: '#/components/schemas/Land' postbusnummer: $ref: '#/components/schemas/Postbusnummer' postcode: $ref: '#/components/schemas/Postcode' soortCorrespondentieadres: $ref: '#/components/schemas/SoortCorrespondentieadres' straat: $ref: '#/components/schemas/Straat' woonplaats: $ref: '#/components/schemas/Woonplaats' Initiatiefnemer: type: string description: De waarden van de partij die het contact heeft geinitieerd. enum: - gemeente - klant - vertegenwoordiger Klantcontactrol: type: string description: De typering van de rol van de persoon of organisatie in het klantcontact. enum: - vertegenwoordiger - klant Voorkeurstaal: type: object description: Een opsomming van de talen waarin de gemeente klantcontacten kan hebben. required: - code - indicatieActief - naam properties: code: type: string title: Code description: De code, behorende bij de voorkeurstaal. minLength: 1 indicatieActief: $ref: '#/components/schemas/IndicatieJaNee' naam: type: string title: Naam description: De naam van de voorkeurstaal. minLength: 1 Antwoordnummer: type: integer description: '' Registreerkeukentafelgesprek_parameters: type: object description: '' required: - actorId - betrokkeneBijKlantcontact - indicatieHergebruikPartij - initiatiefnemer - onderwerp properties: actorId: type: array minItems: 1 items: $ref: '#/components/schemas/Identificatiecode' betrokkeneBijKlantcontact: type: array minItems: 1 items: $ref: '#/components/schemas/BetrokkeneBijKlantcontact_param' indicatieHergebruikPartij: $ref: '#/components/schemas/IndicatieJaNee' inhoudsdeel: type: array minItems: 0 items: $ref: '#/components/schemas/Inhoudsdeel_param' initiatiefnemer: $ref: '#/components/schemas/Initiatiefnemer' onderwerp: $ref: '#/components/schemas/Omschrijvingkort' Huisletter: type: string description: '' maxLength: 1 Inhoudsdeel: type: object description: (Een deel van) de inhoud van een klantcontact. Deze inhoud kan bestaan uit stuk tekst dat in het element tekst is opgenomen of een verwijzing naar een object zoals een informatie-object, een object uit de overige objectenregistratie of een ander object. required: - externId - externRegister - id - indicatieWeerTeGeven - omschrijving - soortInhoudsdeel properties: externId: $ref: '#/components/schemas/Identificatiecode' externRegister: $ref: '#/components/schemas/Omschrijvingkort' id: $ref: '#/components/schemas/Identificatiecode' indicatieWeerTeGeven: $ref: '#/components/schemas/IndicatieJaNee' omschrijving: $ref: '#/components/schemas/Omschrijvingkort' soortInhoudsdeel: $ref: '#/components/schemas/SoortInhoudsdeel' tekst: $ref: '#/components/schemas/Omschrijvinglang' Woonplaats: type: string description: '' maxLength: 80 Adresregel: type: string description: Een generieke regel om adresgegevens in op te nemen. maxLength: 80 DigitaalAdres: type: object description: 'Adres waarop een persoon of een organisatie via een digitaal kanaal bereikt kan worden. Digitaal adres duidt gegevens aan die beschrijven hoe een persoon of organisatie via een digitaal kanaal bereikt kan worden. Voorbeelden hiervan zijn een telefoonnummer, een e-mailadres of een gebruikersnaam op een sociaal medium. Adressen die gekoppeld kunnen worden aan een vaste plaats in de fysieke wereld, zoals een bezoekadres, postbus of antwoordnummer zijn geen digitaal adres.' required: - adres - id - indicatieActief - omschrijving - partijId - soortDigitaalAdres properties: adres: $ref: '#/components/schemas/Adresregel' id: $ref: '#/components/schemas/Identificatiecode' indicatieActief: $ref: '#/components/schemas/IndicatieJaNee' omschrijving: $ref: '#/components/schemas/Omschrijvingkort' partijId: $ref: '#/components/schemas/Identificatiecode' soortDigitaalAdres: $ref: '#/components/schemas/SoortDigitaalAdres' Land: type: object description: Een opsomming van alle huidige en voormalige landen met hun codes, namen en geldigheidstermijnen. required: - einddatumLand - ingangsdatumLand - landcode - landnaam properties: einddatumLand: type: string title: Einddatum land description: De datum waarop het land/gebied is opgeheven. format: date ingangsdatumLand: type: string title: Ingangsdatum land description: De datum waarop het land/gebied is ontstaan. format: date landcode: type: string title: Landcode description: De code, behorende bij de landnaam, opgenomen in de Landentabel van de GBA. minLength: 1 landnaam: type: string title: Landnaam description: De naam van het land, zoals opgenomen in de Landentabel van de GBA. minLength: 1 Omschrijvingkort: type: string description: '' maxLength: 40 ObjectVanKlantcontact: type: object description: De relatie tussen het klantcontact en de Zaak, Klanttaak of ander object waar dit klantcontact betrekking op heeft. required: - externId - externRegister - id - interneTaakId - klantcontactId - ontstaanUitKlantcontact - soortObject properties: externId: $ref: '#/components/schemas/Identificatiecode' externRegister: $ref: '#/components/schemas/Omschrijvingkort' id: $ref: '#/components/schemas/Identificatiecode' interneTaakId: $ref: '#/components/schemas/Identificatiecode' klantcontactId: $ref: '#/components/schemas/Identificatiecode' ontstaanUitKlantcontact: $ref: '#/components/schemas/IndicatieJaNee' soortObject: $ref: '#/components/schemas/SoortObject' InterneTaken: title: gaat over description: De taak waarvan uitvoering aanleiding gaf tot het klantcontact. type: string format: uri readOnly: true example: datapunt.voorbeeldgemeente.nl/api/v1/InterneTaken/123456789 AndereObjecten: type: array title: gaat over description: '' items: type: string format: uri readOnly: true uniqueItems: true example: datapunt.voorbeeldgemeente.nl/api/v1/Objecten/123456789 Zaken: title: gaat over description: De zaak die uit een klantcontact ontstond of waarover een klantcontact ging. type: string format: uri readOnly: true example: datapunt.voorbeeldgemeente.nl/api/v1/Zaken/123456789 Klanttaken: title: gaat over description: De klanttaak waarover het klantcontact ging. type: string format: uri readOnly: true example: datapunt.voorbeeldgemeente.nl/api/v1/Klanttaken/123456789 Klantcontacten: title: heeft description: Het klantcontact dat aanleiding gaf tot het starten van een zaak of dat over een zaak ging. type: string format: uri readOnly: true example: datapunt.voorbeeldgemeente.nl/api/v1/Klantcontacten/123456789 RegistreerKlantcontactGaatOverInterneTaak_parameters: type: object description: '' required: - interneTaakId - klantcontactId properties: interneTaakId: $ref: '#/components/schemas/Identificatiecode' klantcontactId: $ref: '#/components/schemas/Identificatiecode' Inhoudsdeel_param: type: object description: '' required: - externId - externRegister - indicatieWeerTeGeven - omschrijving - soortInhoudsdeel properties: externId: $ref: '#/components/schemas/Identificatiecode' externRegister: $ref: '#/components/schemas/Omschrijvingkort' indicatieWeerTeGeven: $ref: '#/components/schemas/IndicatieJaNee' omschrijving: $ref: '#/components/schemas/Omschrijvingkort' soortInhoudsdeel: $ref: '#/components/schemas/SoortInhoudsdeel' tekst: $ref: '#/components/schemas/Omschrijvinglang' Identificerendnummer: type: integer description: '' SoortBezoekadres: type: string description: Typering waarmee aangegeven of het bezoekadres een binnenlands - of een buitenlands adres is. enum: - binnenlands_adres - buitenlands_adres Straat: type: string description: '' maxLength: 80 Postcode: type: string description: '' maxLength: 7 Kanaal: type: object description: Een opsomming van de kanalen waarlangs de gemeente klantcontacten kan hebben. required: - code - indicatieActief - naam properties: code: type: string title: Code description: De code, behorende bij het kanaal. minLength: 1 indicatieActief: $ref: '#/components/schemas/IndicatieJaNee' naam: type: string title: Naam description: De naam van het kanaal. minLength: 1 BetrokkeneBijKlantcontact_param: type: object description: '' required: - digitaalAdres - rol properties: bezoekadres: $ref: '#/components/schemas/Bezoekadres' correspondentieadres: $ref: '#/components/schemas/Correspondentieadres' digitaalAdres: $ref: '#/components/schemas/DigitaalAdres' organisatienaam: $ref: '#/components/schemas/Naamlang' persoonsnaam: $ref: '#/components/schemas/Persoonsnaamgegevens' rol: $ref: '#/components/schemas/Klantcontactrol' voorkeurskanaal: $ref: '#/components/schemas/Kanaal' voorkeurstaal: $ref: '#/components/schemas/Voorkeurstaal' Bezoekadres: type: object description: Een bezoekadres is een adres waar een persoon of een bedrijf bezoekers ontvangt. required: - soortBezoekadres properties: aanduidingBijHuisnummer: $ref: '#/components/schemas/AanduidingBijHuisnummer' adresregelBuitenland1: $ref: '#/components/schemas/Adresregel' adresregelBuitenland2: $ref: '#/components/schemas/Adresregel' adresregelBuitenland3: $ref: '#/components/schemas/Adresregel' huisletter: $ref: '#/components/schemas/Huisletter' huisnummer: $ref: '#/components/schemas/Huisnummer' huisnummertoevoeging: $ref: '#/components/schemas/Huisnummertoevoeging' land: $ref: '#/components/schemas/Land' postcode: $ref: '#/components/schemas/Postcode' soortBezoekadres: $ref: '#/components/schemas/SoortBezoekadres' straat: $ref: '#/components/schemas/Straat' woonplaats: $ref: '#/components/schemas/Woonplaats' Postbusnummer: type: integer description: '' IndicatieJaNeeOnbekend: type: string description: Deze enumeratie is toegevoegd omdat de ingevulde waarde geen boolean kan zijn (waar of niet waar). De gewenste waarden zijn ja,nee of onbekend. enum: - onbekend - ja IndicatieJaNee: type: boolean description: '' Omschrijvinglang: type: string description: '' maxLength: 200 Persoonsnaamgegevens: type: object description: De naamgegevens van een persoon. properties: achternaam: type: string title: Achternaam description: De axhternaam waarmee de persoon aangesproken wnest te worden. Deze zal over het algemeen gelijk zijn aan de (geslachts)naam waarvan de eventueel aanwezige voorvoegsels en adellijke titel/predikaat zijn afgesplitst. voornaam: type: string title: Voornaam description: De roepnaam waarmee de persoon wenst aangeproken te worden. voorvoegselAchternaam: type: string title: Voorvoegsel achternaam description: Dat deel van de achternaam dat voorkomt in de Voorvoegseltabel en, gescheiden door een spatie, vooraf gaat aan de rest van de achternaam. Naamlang: type: string description: '' maxLength: 200 SoortCorrespondentieadres: type: string description: Typering waarmee aangegeven wordt of het correspondentieadres een binnenlands - of een buitenlands adres is danwel een postbusnummer of een antwoordnummer. enum: - postbusnummer - antwoordnummer - binnenlands_adres - buitenlands_adres 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 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 KlantContact: 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 identificatie: type: string description: De unieke aanduiding van een KLANTCONTACT title: identificatie maxLength: 14 datumtijd: type: string format: date-time description: De datum en het tijdstip waarop het KLANTCONTACT begint title: datumtijd kanaal: type: string description: Het communicatiekanaal waarlangs het KLANTCONTACT gevoerd wordt title: kanaal maxLength: 20 onderwerp: type: string description: Het onderwerp waarover contact is geweest met de klant. title: onderwerp maxLength: 200 toelichting: type: string description: Een toelichting die inhoudelijk het contact met de klant beschrijft. title: toelichting maxLength: 1000 required: - datumtijd - url - uuid - zaak 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 PaginatedKlantContactList: 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/KlantContact' securitySchemes: JWT-Claims: type: http bearerFormat: JWT scheme: bearer x-refined-from: - vng-realisatie-klantinteracties-openapi.yml - vng-realisatie-zaken-openapi.yml - vng-realisatie-klantinteracties-openapi.yml - vng-realisatie-zaken-openapi.yml