TIFlow - Kernfunktionalitäten
Version 2.0.0-ballot.1 - ci-build

Server-Anforderungen: Channels-Query

Seiteninhalt:

Diese Seite enthält die normativen Anforderungen an den TI-Flow-Fachdienst für den channels-Endpunkt.

Der TI-Flow-Fachdienst MUSS alle Zugriffe auf die Ressource Channels mittels der HTTP-Operationen PUT, PATCH, HEAD und DELETE unterbinden und mit dem folgenden Fehler:
HTTP-Code 405 - Method Not Allowed
Error Code methodNotAllowed
Error Details Die verwendete HTTP-Methode ist für diese Ressource nicht zulässig
abbrechen, damit keine unzulässigen Operationen ausgeführt werden können. Der TI-Flow-Fachdienst MUSS die API mit den Endpunkten GET /channels, GET /channels/{pushkey} und POST /channels/{pushkey} gemäß [OpenAPI_FD] bereitstellen.

GET /channels

Mit der Operation GET /channels können die verfügbaren Channels abgefragt werden.

Der TI-Flow-Fachdienst MUSS beim Aufruf der Operation GET /channels die zeta-user-info.professionOID des Nutzers bestimmen und sicherstellen, dass ausschließlich Nutzer in der Rolle
  • oid_versicherter
die Operation aufrufen, und bei Abweichungen die Operation mit dem folgenden Fehler:
HTTP-Code 403 - Forbidden
Severity error
Code invalid
Details Code TIFLOW_AUTH_ROLE_NOT_ALLOWED
Details Text Der Nutzer ist nicht berechtigt, die aufgerufene Operation anzufordern
abbrechen, damit die Operation nicht durch unberechtigte Dritte ausgeführt wird.

Mit der Operation GET /channels/{pushkey} können die Channels und deren Konfiguration für eine spezifische FdV-Instanz abgefragt werden.

Der TI-Flow-Fachdienst MUSS beim Aufruf der Operation GET /channels/{pushkey} die zeta-user-info.professionOID des Nutzers bestimmen und sicherstellen, dass ausschließlich Nutzer in der Rolle
  • oid_versicherter
die Operation aufrufen, und bei Abweichungen die Operation mit dem folgenden Fehler:
HTTP-Code 403 - Forbidden
Severity error
Code invalid
Details Code TIFLOW_AUTH_ROLE_NOT_ALLOWED
Details Text Der Nutzer ist nicht berechtigt, die aufgerufene Operation anzufordern
abbrechen, damit die Operation nicht durch unberechtigte Dritte ausgeführt wird.

POST /channels

Der TI-Flow-Fachdienst MUSS beim Aufruf der Operation POST /channels/{pushkey} die zeta-user-info.professionOID des Nutzers bestimmen und sicherstellen, dass ausschließlich Nutzer in der Rolle
  • oid_versicherter
die Operation aufrufen, und bei Abweichungen die Operation mit dem folgenden Fehler:
HTTP-Code 403 - Forbidden
Severity error
Code invalid
Details Code TIFLOW_AUTH_ROLE_NOT_ALLOWED
Details Text Der Nutzer ist nicht berechtigt, die aufgerufene Operation anzufordern
abbrechen, damit die Operation nicht durch unberechtigte Dritte ausgeführt wird. Der TI-Flow-Fachdienst MUSS beim Aufruf der Operation POST /channels/{pushkey} das Payload gegen das Schema in [OpenAPI_FD] validieren und bei Abweichungen mit dem folgenden Fehler:
HTTP-Code 400 - Bad Request
Error Code malformedRequest
Error Details Ungültiger http-Request
abbrechen, damit kein Schadcode und keine "fachfremden" Daten in den TI-Flow-Fachdienst hochgeladen werden.