diff --git a/docs/Use Cases der API.md b/docs/Use Cases der API.md index f2e2d70d437b201cd1827c7a0c43ac9a56f41403..77b9599e2c1bed254330d5e5ae35a6c6157e2ea0 100644 --- a/docs/Use Cases der API.md +++ b/docs/Use Cases der API.md @@ -1,24 +1,28 @@ # Use Cases der XFall APIs +## Überblick + Die übergreifende Zielstellung der XFall APIs besteht darin, Anträge und Berichte, die aus den vorgelagerten Systemen (bspw. Onlineantragsdienste, Fachportal oder Berichtssysteme) in die elektronische Verfahrensbearbeitung der Verwaltung zu übergeben. -k -Um diese übergreifende Zielstellung zur erfüllen, werden über die Sender-API und Subscriber-API den Sender und Empfänger von Anträge folgende Anwendungsfälle zur Verfügung gestellt: + +Um diese übergreifende Zielstellung zur erfüllen, werden über die Sender-API und Subscriber-API den `Sender` und `Subscriber` (Empfänger) von Anträge folgende Anwendungsfälle zur Verfügung gestellt:  + + ## Systematik und Legende der verwendeten BPMN Symbole bei Anwendungsfallabläufen ### Aktivität **(Platzhalter Grafik)** -Beschreibt eine Tätigkeit innerhalb einer Prozessablaufs. +Eine Tätigkeit innerhalb einer Prozessablaufs. ### Aktivität mit multiplen parallelen Instanzen (Platzhalter Grafik) -Beschreibt eine Tätigkeit innerhalb einer Prozessablaufs, die ab dem aktivierungszeitpunkt mehrfach parallel durchgeführt werden kann. +Eine Tätigkeit innerhalb einer Prozessablaufs, die ab dem aktivierungszeitpunkt mehrfach parallel durchgeführt werden kann. ### Exclusive Gateways @@ -32,11 +36,15 @@ Ein Entscheidungspunkt innerhalb des Prozessablaufs im Sinne einer ODER Entschei Parallelisierungspunkt innerhalb des Prozessablauf. Prozessflüsse nach dem parallelen Gateway parallel durchgeführt. -## Anwendungsfälle für Subscriber +## Anwendungsfälle für den Sender ### Antrag bei einem Zustellpunkt abgeben -Ziel: +**Vorbedingung:** Es muss zuvor die `destination-id` eines gültigen Zustellpunkts ermittelt worden sein. Zum aktuellen Zeitpunkt wird dieser über einen persönlichen Kontakt zwischen dem Subscriber und den Sendern übermittelt. + +**Ziel:** Alle Bestandteile des Antrags sind in den Abholbereich des addressierten Zustellpunkts übergeben worden und liegen dort zur Abholung des Subscribers bereit. + +**Beschreibung:** Der Sender überträgt mittels eines POST Request die Metadaten des Antrags an die Sender API und legt die `application` (Antrag) als Ressource an. Zudem werden alle weiteren zu übermittelnden Antragsbestandteile (`data`, `document`) auf Basis der Angaben in den Metadaten als Subressourcen angelegt und sind durch die doc-id aus den Metadaten adressierbar. Für diese Subressourcen überträgt der Sender die Inhalte per PUT. Nach Übermittlung aller Antragsbestandteile wird durch einen POST auf die `application` die vollständige Übertragung des Antrags bestätigt und damit der Antrag den Abholbereich des Zustellpunkts übermittelt. ![Application_Transfer] (../assets/images/use_case_documentation/application_transfer.png "Ablaufbeschreibung zur Uebertragung eines Antrags")