Anmerkungen zu Must-Support-Feldern

FeldnameKurzbeschreibungHinweise
Subscription.statusStatus

Bedeutung: Der Status der Subscription, der den Serverstatus der Subscription angibt. Neue Subscriptions werden immer mit dem Status requested an den Server übergeben. Der Server ändert im Anschluss den Status auf active oder im Fehlerfall auf error.

Subscription.reasonGrund der Subscription

Bedeutung: Beschreibung wieso diese Subscription erstellt wurde.

Subscription.criteria.extension:filterCriteria.value[x]
Subscription.channelKommunikationskanal

Bedeutung: Kommunikationskanal über den die Subscription Benachrichtigungen gesendet werden sollen.

Subscription.channel.extension:heartbeatPeriodHeartbeat-Intervall

Bedeutung: Intervall in dem der Server prüft, ob der Kommunikationskanal noch aktiv ist.

Subscription.channel.extension:heartbeatPeriod.value[x]
Subscription.channel.typeTyp des Kommunikationskanals

Bedeutung: Der Typ des Kommunikationskanals, über den Subscription-Benachrichtigungen gesendet werden sollen.
In ISiK MUSS der Wert rest-hook unterstützt werden, weitere Werte KÖNNEN unterstützt werden.

Subscription.channel.endpointEndpunkt

Bedeutung: Adresse des Kommunikationskanals/ Endpunkts, an den Subscription-Benachrichtigungen gesendet werden sollen. Dies ist nur für rest-hook Subscriptions relevant.

Subscription.channel.payloadFormat der Nutzdaten

Bedeutung: Format in dem Subscription Notifications versendet werden sollen (JSON oder XML).

Subscription.channel.headerFalls eine REST-Enpunkt einen Authorization-Header benötigt, kann dieser hier gesetzt werden

Bedeutung: http-Header welcher dazu genutzt werden kann einen Authorization-header zu setzen. Dies ist nur für rest-hook Subscriptions relevant.
Hinweise: ACHTUNG: dieses Datenfeld muss bei READ-Interaktionen maskiert werden! Siehe R4 Subscriptions