VNvng-realisatie
contactmomenten

Werk een CONTACTMOMENT in zijn geheel bij.

Changed on

Werk een CONTACTMOMENT in zijn geheel bij.

put/contactmomenten/{uuid}

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    HTTP bearer

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.

vorigContactmomentstring uri nullable

URL-referentie naar het vorige CONTACTMOMENT.

volgendContactmomentstring uri nullable

URL-referentie naar het volgende CONTACTMOMENT.

bronorganisatiestring required

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

registratiedatumstring date-time

De datum en het tijdstip waarop het CONTACTMOMENT is geregistreerd.

kanaalstring

Het communicatiekanaal waarlangs het CONTACTMOMENT gevoerd wordt

voorkeurskanaalstring

Het communicatiekanaal dat voor opvolging van deze klantinteractie de voorkeur heeft van de KLANT.

voorkeurstaalstring

Een ISO 639-2/B taalcode waarin de voorkeurstaal van de KLANT voor de opvolging van deze klantinteractie is vastgelegd. Voorbeeld: nld. Zie: https://www.iso.org/standard/4767.html

onderwerpLinksstring[]

Eén of meerdere links naar een product, webpagina of andere entiteit zodat contactmomenten gegroepeerd kunnen worden op onderwerp.

initiatiefnemer'gemeente' | 'klant'

De partij die het contact heeft geïnitieerd.

medewerkerstring uri

URL-referentie naar een medewerker

Example request

{
  "tekst": {
    "inhoud": "Tekst die in **MarkDown** formaat is opgemaakt.",
    "formaat": "markdown",
    "formaatWeergave": "text/markdown; charset=utf-8"
  }
}

Response

OK

urlstring uri

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

vorigContactmomentstring uri nullable

URL-referentie naar het vorige CONTACTMOMENT.

volgendContactmomentstring uri nullable

URL-referentie naar het volgende CONTACTMOMENT.

bronorganisatiestring required

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

registratiedatumstring date-time

De datum en het tijdstip waarop het CONTACTMOMENT is geregistreerd.

kanaalstring

Het communicatiekanaal waarlangs het CONTACTMOMENT gevoerd wordt

voorkeurskanaalstring

Het communicatiekanaal dat voor opvolging van deze klantinteractie de voorkeur heeft van de KLANT.

voorkeurstaalstring

Een ISO 639-2/B taalcode waarin de voorkeurstaal van de KLANT voor de opvolging van deze klantinteractie is vastgelegd. Voorbeeld: nld. Zie: https://www.iso.org/standard/4767.html

onderwerpLinksstring[]

Eén of meerdere links naar een product, webpagina of andere entiteit zodat contactmomenten gegroepeerd kunnen worden op onderwerp.

initiatiefnemer'gemeente' | 'klant'

De partij die het contact heeft geïnitieerd.

medewerkerstring uri

URL-referentie naar een medewerker

Example response

{
  "tekst": {
    "inhoud": "Tekst die in **MarkDown** formaat is opgemaakt.",
    "formaat": "markdown",
    "formaatWeergave": "text/markdown; charset=utf-8"
  }
}

Changes

  • be7c3ce11319Revision changes
    • breaking

      removed the enum value plain_text of the request property /

    • warning

      added the new plain enum value to the / response property for the response status

    • info

      added the new plain enum value to the request property /

    • info

      removed the plain_text enum value from the / response property for the response status

  • 5a6cf8f199bbRevision changes
    • info

      added the required property / to the response with the status