notificaties

POST /notificaties

Publiceer een notificatie.

Request

Base URL
/api/v1 (relative, and the document was published on a file host, not at the API’s origin)
Auth
HTTP bearer
TypeScript
https://skmtc.dev/vng-realisatie/apis/notificaties-api/docs/notificaties/post.ts
A function with typed inputs. Its response is checked against the schema.

kanaalstring required

De naam van het kanaal (KANAAL.naam) waar het bericht op moet worden gepubliceerd.

hoofdObjectstring uri required

URL-referentie naar het hoofd object van de publicerende API die betrekking heeft op de resource.

resourcestring required

De resourcenaam waar de notificatie over gaat.

resourceUrlstring uri required

URL-referentie naar de resource van de publicerende API.

actiestring required

De actie die door de publicerende API is gedaan. De publicerende API specificeert de toegestane acties.

aanmaakdatumstring date-time required

Datum en tijd waarop de actie heeft plaatsgevonden.

kenmerkenobject

Mapping van kenmerken (sleutel/waarde) van de notificatie. De publicerende API specificeert de toegestane kenmerken.