erp_notification.adoc

E-Rezept API-Dokumentation für den Benachrichtigungsdienst

Zielgruppe:

Hier dokumentiert die gematik die Nutzung der Schnittstellen rund um den Benachrichtigungsdienst.

Inhaltsverzeichnis

• Anwendungsfall Benachrichtigungen aktivieren
• Anwendungsfall Benachrichtigungen deaktivieren

Anwendungsfall Benachrichtigungen aktivieren

Als Versicherter möchte ich die Benachrichtigungsfunktion auf meinem mobilen Gerät aktivieren, um Benachrichtigungen über neue Informationen auf dem E-Rezept-Fachdienst zu erhalten.

Der Aufruf erfolgt als http-GET-Operation. Im Aufruf muss das während der Authentisierung erhaltene ACCESS_TOKEN im http-Request-Header Authorization übergeben werden.

Request

URI	https://erp.zentral.erp.splitdns.ti-dienste.de/notifications/opt-in
Method	GET
Requester
Responder
HTTP Header	Authorization: Bearer eyJraWQ.ewogImL2pA10Qql22ddtutrvx4FsDlz.rHQjEmB1lLmpqn9J X-RegistrationToken: bk3RNwTe3H0:CI2k_HHwgIpoDKCIZvvDMExUdFQ3P1 ℹ️ Mit dem ACCESS_TOKEN im Authorization-Header weist sich der Zugreifende als Versicherter aus, im Token ist seine Versichertennummer enthalten. Die Base64-Darstellung des Tokens ist stark gekürzt. ℹ️ Der X-Registration-Token transportiert das FCM-Registration-Token base64-codiert.
Payload	-

Response

HTTP/1.1 204 No Content

Code	Type Success
204	No Content Die Anfrage wurde erfolgreich bearbeitet. Die Response enthält jedoch keine Daten.
Code	Type Error
400	Bad Request Die Anfrage-Nachricht war fehlerhaft aufgebaut.
401	Unauthorized Die Anfrage kann nicht ohne gültige Authentifizierung durchgeführt werden. Wie die Authentifizierung durchgeführt werden soll, wird im "WWW-Authenticate"-Header-Feld der Antwort übermittelt.
403	Forbidden Die Anfrage wurde mangels Berechtigung des Clients nicht durchgeführt, bspw. weil der authentifizierte Benutzer nicht berechtigt ist.
405	Method Not Allowed Die Anfrage darf nur mit anderen HTTP-Methoden (zum Beispiel GET statt POST) gestellt werden. Gültige Methoden für die betreffende Ressource werden im "Allow"-Header-Feld der Antwort übermittelt.
429	Too Many Requests Der Client hat zu viele Anfragen in einem bestimmten Zeitraum gesendet.
500	Server Errors Unerwarteter Serverfehler

Anwendungsfall Benachrichtigungen deaktivieren

Als Versicherter möchte ich die Benachrichtigungsfunktion auf meinem mobilen Gerät deaktivieren. Das mobile Gerät wird aus dem Benachrichtigungsdienst entfernt und es werden keine Benachrichtigungen versendet.

Der Aufruf erfolgt als http-GET-Operation. Im Aufruf muss das während der Authentisierung erhaltene ACCESS_TOKEN im http-Request-Header Authorization übergeben werden.

Request

URI	https://erp.zentral.erp.splitdns.ti-dienste.de//notifications/opt-out
Method	GET
Requester
Responder
HTTP Header	Authorization: Bearer eyJraWQ.ewogImL2pA10Qql22ddtutrvx4FsDlz.rHQjEmB1lLmpqn9J ℹ️ Mit dem ACCESS_TOKEN im Authorization-Header weist sich der Zugreifende als Versicherter aus, im Token ist seine Versichertennummer enthalten. Die Base64-Darstellung des Tokens ist stark gekürzt.
Payload	-

Response

HTTP/1.1 204 No Content

Code	Type Success
204	No Content Die Anfrage wurde erfolgreich bearbeitet. Die Response enthält jedoch keine Daten.
Code	Type Error
400	Bad Request Die Anfrage-Nachricht war fehlerhaft aufgebaut.
401	Unauthorized Die Anfrage kann nicht ohne gültige Authentifizierung durchgeführt werden. Wie die Authentifizierung durchgeführt werden soll, wird im "WWW-Authenticate"-Header-Feld der Antwort übermittelt.
403	Forbidden Die Anfrage wurde mangels Berechtigung des Clients nicht durchgeführt, bspw. weil der authentifizierte Benutzer nicht berechtigt ist.
405	Method Not Allowed Die Anfrage darf nur mit anderen HTTP-Methoden (zum Beispiel GET statt POST) gestellt werden. Gültige Methoden für die betreffende Ressource werden im "Allow"-Header-Feld der Antwort übermittelt.
429	Too Many Requests Der Client hat zu viele Anfragen in einem bestimmten Zeitraum gesendet.
500	Server Errors Unerwarteter Serverfehler