v12

latestOpenAPI 3.0.0EUPL 1.2raw.githubusercontent.com2022-02-1881845.4 KB
klanten

Maak een KLANT aan.

Maak een KLANT aan.

post/klanten

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

Created

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"
}