VNvng-realisatie
klanten

Werk een KLANT deels bij.

Changed on

Werk een KLANT deels bij.

patch/klanten/{uuid}

Request

Headers

Content-Type'application/json' required

Content type van de verzoekinhoud.

X-NLX-Logrecord-IDstring

Identifier of the request, traceable throughout the network

X-Audit-Toelichtingstring

Toelichting waarom een bepaald verzoek wordt gedaan

Request body

urlstring uri

URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object.

bronorganisatiestring required

Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die de klant heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef

klantnummerstring required

De unieke identificatie van de klant binnen de bronorganisatie.

bedrijfsnaamstring

De bedrijfsnaam van de klant.

functiestring

De functie van de klant.

websiteUrlstring uri required

Het label of etiket dat aan de specifieke informatiebron, zoals een webpagina, een bestand of een plaatje op internet is toegewezen waar de KLANT in de regel op het internet vindbaar is.

voornaamstring

De voornaam, voorletters of roepnaam van de klant.

voorvoegselAchternaamstring

Het voorvoegsel van de achternaam van de klant.

achternaamstring

De achternaam van de klant.

telefoonnummerstring

Het mobiele of vaste telefoonnummer van de klant.

emailadresstring email

Het e-mail adres van de klant.

voorkeurskanaalstring

Het communicatiekanaal dat de voorkeur heeft van de KLANT. Deze voorkeur is default maar kan overruled worden in een specifieke klantinteractie.

voorkeurstaalstring

Een ISO 639-2/B taalcode waarin de voorkeurstaal van de klant voor interacties met de gemeente is vastgelegd. Zie: https://www.iso.org/standard/4767.html. Deze voorkeur is default maar kan overruled worden in een specifieke klantinteractie.

subjectstring uri

URL-referentie naar een subject

subjectType'natuurlijk_persoon' | 'niet_natuurlijk_persoon' | 'vestiging' nullable

Type van de subject.

Uitleg bij mogelijke waarden:

  • natuurlijk_persoon - Natuurlijk persoon
  • niet_natuurlijk_persoon - Niet-natuurlijk persoon
  • vestiging - Vestiging

Example request

{
  "voorkeurstaal": "nld"
}

Response

OK

urlstring uri

URL-referentie naar dit object. Dit is de unieke identificatie en locatie van dit object.

bronorganisatiestring required

Het RSIN van de Niet-natuurlijk persoon zijnde de organisatie die de klant heeft gecreeerd. Dit moet een geldig RSIN zijn van 9 nummers en voldoen aan https://nl.wikipedia.org/wiki/Burgerservicenummer#11-proef

klantnummerstring required

De unieke identificatie van de klant binnen de bronorganisatie.

bedrijfsnaamstring

De bedrijfsnaam van de klant.

functiestring

De functie van de klant.

websiteUrlstring uri required

Het label of etiket dat aan de specifieke informatiebron, zoals een webpagina, een bestand of een plaatje op internet is toegewezen waar de KLANT in de regel op het internet vindbaar is.

voornaamstring

De voornaam, voorletters of roepnaam van de klant.

voorvoegselAchternaamstring

Het voorvoegsel van de achternaam van de klant.

achternaamstring

De achternaam van de klant.

telefoonnummerstring

Het mobiele of vaste telefoonnummer van de klant.

emailadresstring email

Het e-mail adres van de klant.

voorkeurskanaalstring

Het communicatiekanaal dat de voorkeur heeft van de KLANT. Deze voorkeur is default maar kan overruled worden in een specifieke klantinteractie.

voorkeurstaalstring

Een ISO 639-2/B taalcode waarin de voorkeurstaal van de klant voor interacties met de gemeente is vastgelegd. Zie: https://www.iso.org/standard/4767.html. Deze voorkeur is default maar kan overruled worden in een specifieke klantinteractie.

subjectstring uri

URL-referentie naar een subject

subjectType'natuurlijk_persoon' | 'niet_natuurlijk_persoon' | 'vestiging' nullable

Type van de subject.

Uitleg bij mogelijke waarden:

  • natuurlijk_persoon - Natuurlijk persoon
  • niet_natuurlijk_persoon - Niet-natuurlijk persoon
  • vestiging - Vestiging

Example response

{
  "voorkeurstaal": "nld"
}

Changes

  • 82dc113b604bRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 62ce297cf2d6Revision changes
    • breaking

      added the new required header request parameter Content-Type

    • breaking

      added the new required request property

    • breaking

      the request property became required

    • breaking

      the / request property type changed from string to integer

    • breaking

      the response property became nullable for the status

    • breaking

      the response property / became nullable for the status

    • breaking

      the / response property's minLength was decreased from 1 to 0 for the response status

    • breaking

      the / response's property type changed from string to integer for status

    • warning

      the / request property's maxLength was set to 1

    • warning

      the / request property's maxLength was set to 4

    • warning

      the / request property's maxLength was set to 7

    • warning

      the / request property's maxLength was set to 100

    • warning

      the / request property's maxLength was set to 80

    • warning

      the / request property's max was set to 99999.00

    • warning

      the / request property's min was set to 0.00

    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

    • info

      added the new optional header request parameter X-Audit-Toelichting

    • info

      added the new optional header request parameter X-NLX-Logrecord-ID

    • info

      the request property became nullable

    • info

      the request property / became nullable

    • info

      the / request property's minLength was decreased from 1 to 0

    • info

      the response property became required for the status

    • info

      added the required property to the response with the status