v9

latestOpenAPI 3.0.0EUPL 1.2raw.githubusercontent.com2022-02-112812174.0 KB
verzoeken

Maak een VERZOEK aan.

Maak een VERZOEK aan.

post/verzoeken

Headers

Content-Type'application/json' required

Content type van de verzoekinhoud.

X-NLX-Request-Application-Idstring

Identificatie van de applicatie die het verzoek stuurt (indien NLX wordt gebruikt).

X-NLX-Request-User-Idstring

Identificatie van de gebruiker die het verzoek stuurt (indien NLX wordt gebruikt).

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.

identificatiestring

De unieke identificatie van het VERZOEK binnen de organisatie die verantwoordelijk is voor de behandeling van het VERZOEK.

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

externeIdentificatiestring

De identificatie van het VERZOEK buiten de eigen organisatie.

registratiedatumstring date-time

De datum en het tijdstip waarop het VERZOEK is geregistreerd.

voorkeurskanaalstring

Het communicatiekanaal dat voor opvolging van het VERZOEK de voorkeur heeft van de KLANT.

tekststring

Een toelichting die inhoudelijk het VERZOEK van de KLANT beschrijft.

status'ontvangen' | 'in_behandeling' | 'afgehandeld' | 'afgewezen' | 'ingetrokken' required

De waarden van de typering van de voortgang van afhandeling van een VERZOEK.

Uitleg bij mogelijke waarden:

  • ontvangen - (Ontvangen) Het verzoek is ingediend en door de organisatie ontvangen.
  • in_behandeling - (In behandeling) Het is verzoek is in behandeling.
  • afgehandeld - (Afgehandeld) Het verzoek zelf is afgehandeld. Eventuele vervolg acties, zoals zaken die voortkomen uit het verzoek, hebben een eigen status.
  • afgewezen - (Afgewezen) Het verzoek is afgewezen zonder vervolg acties.
  • ingetrokken - (Ingetrokken) De indiener heeft het verzoek ingetrokken.
inTeTrekkenVerzoekstring uri nullable

URL-referentie naar het (eerdere) VERZOEK dat door dit VERZOEK wordt verzocht ingetrokken te worden.

intrekkendeVerzoekstring uri nullable

URL-referentie naar het (latere) VERZOEK waarin verzocht wordt dit VERZOEK in te trekken. Dit veld is alleen leesbaar en wordt automatisch gezet wanneer er een ander VERZOEK wordt aangemaakt dat dit VERZOEK intrekt.

aangevuldeVerzoekstring uri nullable

URL-referentie naar het (eerdere) VERZOEK dat door dit VERZOEK wordt aangevuld.

aanvullendeVerzoekstring uri nullable

URL-referentie naar het (latere) VERZOEK waarin dit VERZOEK wordt aangevuld. Dit veld is alleen leesbaar en wordt automatisch gezet indien een ander VERZOEK wordt aangemaakt dat dit VERZOEK aanvult.

Response

Created

urlstring uri

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

identificatiestring

De unieke identificatie van het VERZOEK binnen de organisatie die verantwoordelijk is voor de behandeling van het VERZOEK.

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

externeIdentificatiestring

De identificatie van het VERZOEK buiten de eigen organisatie.

registratiedatumstring date-time

De datum en het tijdstip waarop het VERZOEK is geregistreerd.

voorkeurskanaalstring

Het communicatiekanaal dat voor opvolging van het VERZOEK de voorkeur heeft van de KLANT.

tekststring

Een toelichting die inhoudelijk het VERZOEK van de KLANT beschrijft.

status'ontvangen' | 'in_behandeling' | 'afgehandeld' | 'afgewezen' | 'ingetrokken' required

De waarden van de typering van de voortgang van afhandeling van een VERZOEK.

Uitleg bij mogelijke waarden:

  • ontvangen - (Ontvangen) Het verzoek is ingediend en door de organisatie ontvangen.
  • in_behandeling - (In behandeling) Het is verzoek is in behandeling.
  • afgehandeld - (Afgehandeld) Het verzoek zelf is afgehandeld. Eventuele vervolg acties, zoals zaken die voortkomen uit het verzoek, hebben een eigen status.
  • afgewezen - (Afgewezen) Het verzoek is afgewezen zonder vervolg acties.
  • ingetrokken - (Ingetrokken) De indiener heeft het verzoek ingetrokken.
inTeTrekkenVerzoekstring uri nullable

URL-referentie naar het (eerdere) VERZOEK dat door dit VERZOEK wordt verzocht ingetrokken te worden.

intrekkendeVerzoekstring uri nullable

URL-referentie naar het (latere) VERZOEK waarin verzocht wordt dit VERZOEK in te trekken. Dit veld is alleen leesbaar en wordt automatisch gezet wanneer er een ander VERZOEK wordt aangemaakt dat dit VERZOEK intrekt.

aangevuldeVerzoekstring uri nullable

URL-referentie naar het (eerdere) VERZOEK dat door dit VERZOEK wordt aangevuld.

aanvullendeVerzoekstring uri nullable

URL-referentie naar het (latere) VERZOEK waarin dit VERZOEK wordt aangevuld. Dit veld is alleen leesbaar en wordt automatisch gezet indien een ander VERZOEK wordt aangemaakt dat dit VERZOEK aanvult.