diff --git a/assets/images/use_case_documentation/application_retrieval.png b/assets/images/use_case_documentation/application_retrieval.png
index 39008a717ec53aed0a26f56e3f83d017794724ab..bd7415d9a6de3a74d6dd7fa3c060ecd7a98ac3a0 100644
Binary files a/assets/images/use_case_documentation/application_retrieval.png and b/assets/images/use_case_documentation/application_retrieval.png differ
diff --git a/docs/2_Quick_Reference.md b/docs/2_Quick_Reference.md
index a04e566fd66e444c2e6bf40b4b72e6035721e2fa..af21e38e1134f226a19a94c7377fbcf3356ecaff 100644
--- a/docs/2_Quick_Reference.md
+++ b/docs/2_Quick_Reference.md
@@ -2,7 +2,7 @@
## Der XFall Antrag
-
+
Der XFall Antrag (`application`) ist das zentrale Geschäftsobjekt in der XFall API. Dieser besteht aus den Fachdaten (`data`) und den beigefügten Anhängen (`document`) und wird über Metadaten beschrieben.
@@ -54,7 +54,7 @@ Darüber hinaus stehen dem Sender folgende weitere Operationen zur Verfügung:
## Operation derApplication Subscriber API
-Mit diesen Operationen kann der Subscriber Zustellpunkte (`Destinations`) verwalten:
+Mit diesen Operationen kann der Subscriber einer oder mehrere Zustellpunkte (`Destinations`) verwalten:
- [Create Destination](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations/post) - Legt ein neues Ãœbertragungsziel (Destination) an.
- [List Destinations](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations/get) - Listet alle Ãœbertragungsziele (Destinations) eines Subscribers auf.
- [Get Destination](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}/get) - Ruf die Daten eines Ãœbertragungsziels (Destination) ab.
diff --git a/docs/3_Use_Cases_der_API.md b/docs/3_Use_Cases_der_API.md
index 5f5d8620cebf9445d06afb511db3f567c22a2f02..117f976d404bde6b205bb4f94b011faad76661a2 100644
--- a/docs/3_Use_Cases_der_API.md
+++ b/docs/3_Use_Cases_der_API.md
@@ -2,40 +2,7 @@
## Überblick über die Anwendungsfälle
-
-
-### Legende der verwendeten BPMN Symbole bei Anwendungsfallabläufen
-
-#### Start- und Endereignisse
-
-
-
-
-
-Startet oder beendet einen Prozessablauf.
-
-#### Aktivität
-
-
-
-Eine Tätigkeit innerhalb einer Prozessablaufs.
-
-#### Aktivität mit mehrfachen parallelen Instanzen
-
-
-
-Eine Tätigkeit innerhalb einer Prozessablaufs, die ab dem aktivierungszeitpunkt mehrfach parallel durchgeführt werden kann.
-
-#### Exclusive Gateway
-
-
-
-Ein Entscheidungspunkt innerhalb des Prozessablaufs im Sinne einer ODER Entscheidung. Es wird nur der weitere Prozessablauf weiterverfolgt, der dem Entscheidungsergebnis entspricht.
-#### Parallel Gateway
-
-
-
-Parallelisierungspunkt innerhalb des Prozessablauf. Prozessflüsse nach dem parallelen Gateway parallel durchgeführt.
+
## Anwendungsfälle für den Sender
@@ -47,7 +14,7 @@ Parallelisierungspunkt innerhalb des Prozessablauf. Prozessflüsse nach dem para
**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. Hierfür bekommt der Sender durch die API eine eindeutige `application-id`in der Response zugeteilt. 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.
-
+
### Zustellstatus des abgegebenen Antrags abrufen
@@ -83,4 +50,37 @@ Parallelisierungspunkt innerhalb des Prozessablauf. Prozessflüsse nach dem para
**Beschreibung:** Zunächst ruft der Subscriber alle Metadaten der vorliegenden Anträge ab. Als nächsten Schritt ruft der Subscriber die Fachdaten (`data`) sowie basierend auf den Angaben der Metadaten alle Anlagen (`document`) des Antrag ab. Falls der Subscriber den vollständigen Antrag oder alle relevanten Bestandteile abgerufen hat, bestätigt er den vollständigen Abruf. Dieser hat zur Folge, dass innerhalb einer definierten zeitlichen Frist der Antrag unwiederruflich gelöscht wird.
-
+
+
+### Legende der verwendeten BPMN Symbole
+
+#### Start- und Endereignisse
+
+
+
+
+
+Startet oder beendet einen Prozessablauf.
+
+#### Aktivität
+
+
+
+Eine Tätigkeit innerhalb einer Prozessablaufs.
+
+#### Aktivität mit mehrfachen parallelen Instanzen
+
+
+
+Eine Tätigkeit innerhalb einer Prozessablaufs, die ab dem aktivierungszeitpunkt mehrfach parallel durchgeführt werden kann.
+
+#### Exclusive Gateway
+
+
+
+Ein Entscheidungspunkt innerhalb des Prozessablaufs im Sinne einer ODER Entscheidung. Es wird nur der weitere Prozessablauf weiterverfolgt, der dem Entscheidungsergebnis entspricht.
+#### Parallel Gateway
+
+
+
+Parallelisierungspunkt innerhalb des Prozessablauf. Prozessflüsse nach dem parallelen Gateway parallel durchgeführt.
diff --git a/docs/README.md b/docs/README.md
index 6075ed2664a4f8e70ff05032bf8dc8621e1a219f..f895abe555eef29461b24735f4da0920db3f86c6 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -36,7 +36,7 @@ Die föderale Integrations- und Entwicklungsplattform folgt einem offenen Plattf
Die föderale Integrations- und Entwicklungsplattform ist dabei ganz bewusst nicht als zentralischer Ansatz zu sehen, sondern als ein föderaler Ansatz, der die Stärken des Föderalismus und der sozialen Markwirtschaft zum Tragen kommen lässt.
-
+
### Wozu dient der Proof of Concept?
@@ -48,7 +48,7 @@ Bei einem positiven Ergebnis des PoC wird angestrebt, die föderale Integrations
### Ãœberblick PoC-Integrationsarchitektur
-![PoC_Integrationarchitecture]( "Integrationsarchitektur für den PoC")
+
Für den PoC werden zwei zentrale Komponenten bereitgestellt:
- **XFall-Zustelldienst:** Dieser Dienst stellt die `Application Sender API` und `Application Subscriber API` und die dahinter liegenden fachlichen Funktionen bereit.
@@ -61,7 +61,9 @@ Diese `destination-id` wird im Rahmen des PoC mit der Antragssenderseite bilater
Die Integrationsarchitektur wird im Rahmen des PoC um einige zentrale Aspekte vereinfacht, die für die zukünftige Integrationsarchitektur fest eingeplant sind:
- **Nutzung von Zuständigkeitsfindern:** Langfristig ist angedacht, die `destination-id` über die bestehenden und etablierten Zuständigkeitsfindern von Bund und Ländern und deren Redaktionsprozesse zu veröffentlichen. Damit steht ein skalierbarer Ansatz bereit, bei dem Antragsdienste in Echtzeit während der Antragsstellung die `destination-id` der fachlich und örtlich zuständigen Stelle beim einem Zuständigkeitsfinder ermitteln können. Durch diesen Ansatz sind keine aufwendigen bilateralen Absprachen in der Entwicklung mehr notwendig, sondern die Antragsdienste können einen universellen zuständigkeitsbasierten Ansatz auf Basis föderaler Basisinfrastukturen nutzen!
-
+
- **Standardisierte XTA-Einbindung:** Mit XTA steht ein in vielen Teilen der Verwaltung etablierter Standard bereit, um standardisiert Transportverfahren anzubinden, welche die eigentliche Übertragung von Fachdaten über diverse Protokolle und Kommunikationsinfrastrukturen für das Fachverfahren übernehmen. Während es schon im PoC prinzipiell möglich sein sollte, technische Intermedäre für die XFall RESTful API Anbindung per XTA-SOAP Webservice anzusprechen, wird zukünftig eine vollumfängliche Unterstützung alle XTA Bestandteile (wie bspw. Reports) angestrebt.
-- **Anbindung von Servicekonten und Antragsmanagementkomponenten:** Zukünftig soll der XFall-Zustelldienst alle antragsrelevenaten Daten (Kopien der Antragsdaten und Statusinformationen) bei definierten Ereignissen (Abgabe beim Zustelldienst und Abholung am Zustellpunkt) in den Hohheitsbereich des Antragsstellers übermitteln und damit Antragsdienst und Fachverfahren von dieser Querschnittsaufgabe entlasten. Hierfür ist angedacht, die zukünftig verfügbaren interoperablen Postfächer als standardisierten Übertragsweg in den Hohheitsbereich des Antragsstellers zu nutzen.
\ No newline at end of file
+- **Anbindung von Servicekonten und Antragsmanagementkomponenten:** Zukünftig soll der XFall-Zustelldienst alle antragsrelevenaten Daten (Kopien der Antragsdaten und Statusinformationen) bei definierten Ereignissen (Abgabe beim Zustelldienst und Abholung am Zustellpunkt) in den Hohheitsbereich des Antragsstellers übermitteln und damit Antragsdienst und Fachverfahren von dieser Querschnittsaufgabe entlasten. Hierfür ist angedacht, die zukünftig verfügbaren interoperablen Postfächer als standardisierten Übertragsweg in den Hohheitsbereich des Antragsstellers zu nutzen.
+
+
diff --git a/reference/subscriber.json b/reference/subscriber.json
index 0868ceb5c00aaab56fd79aa9b744a937f45445d0..e97c5082e320e1565ddbab65d4ee3abca899ae1f 100644
--- a/reference/subscriber.json
+++ b/reference/subscriber.json
@@ -17,10 +17,6 @@
{
"url": "https://subscriber.fiep-poc.de",
"description": "Produktionsumgebung der API."
- },
- {
- "url": "https://xfall-sender-api.sandbox.fiep-poc.de",
- "description": "Testumgebung der API."
}
],
"paths": {
@@ -121,14 +117,11 @@
],
"security": [
{
- "Production API Key": [
+ "API Key": [
"{subscriber-id}:manage",
"{subscriber-id}:application:receive",
"{subscriber-id}:destination:{destination-id}:application:receive"
]
- },
- {
- "Sandbox API Key": []
}
]
}
@@ -240,14 +233,11 @@
],
"security": [
{
- "Production API Key": [
+ "API Key": [
"{subscriber-id}:manage",
"{subscriber-id}:application:receive",
"{subscriber-id}:destination:{destination-id}:application:receive"
]
- },
- {
- "Sandbox API Key": []
}
]
}
@@ -439,14 +429,11 @@
],
"security": [
{
- "Production API Key": [
+ "API Key": [
"{subscriber-id}:manage",
"{subscriber-id}:application:receive",
"{subscriber-id}:destination:{destination-id}:application:receive"
]
- },
- {
- "Sandbox API Key": []
}
]
},
@@ -530,14 +517,11 @@
],
"security": [
{
- "Production API Key": [
+ "API Key": [
"{subscriber-id}:manage",
"{subscriber-id}:application:receive",
"{subscriber-id}:destination:{destination-id}:application:receive"
]
- },
- {
- "Sandbox API Key": []
}
]
}
@@ -729,14 +713,11 @@
],
"security": [
{
- "Production API Key": [
+ "API Key": [
"{subscriber-id}:manage",
"{subscriber-id}:application:receive",
"{subscriber-id}:destination:{destination-id}:application:receive"
]
- },
- {
- "Sandbox API Key": []
}
]
}
@@ -858,15 +839,12 @@
],
"security": [
{
- "Production API Key": [
+ "API Key": [
"{subscriber-id}:destination:read",
"{subscriber-id}:destination:manage",
"{subscriber-id}:manage",
"{subscriber-id}:destination:{destination-id}:read"
]
- },
- {
- "Sandbox API Key": []
}
]
},
@@ -961,15 +939,12 @@
],
"security": [
{
- "Production API Key": [
+ "API Key": [
"{subscriber-id}:manage",
"{subscriber-id}:destination:update",
"{subscriber-id}:destination:manage",
"{subscriber-id}:destination:{destination-id}:update"
]
- },
- {
- "Sandbox API Key": []
}
]
},
@@ -1027,15 +1002,12 @@
],
"security": [
{
- "Production API Key": [
+ "API Key": [
"{subscriber-id}:manage",
"{subscriber-id}:destination:manage",
"{subscriber-id}:destination:delete",
"{subscriber-id}:destination:{destination-id}:delete"
]
- },
- {
- "Sandbox API Key": []
}
]
}
@@ -1135,14 +1107,11 @@
],
"security": [
{
- "Production API Key": [
+ "API Key": [
"{subscriber-id}:destination:read",
"{subscriber-id}:manage",
"{subscriber-id}:destination:manage"
]
- },
- {
- "Sandbox API Key": []
}
]
},
@@ -1250,7 +1219,7 @@
],
"security": [
{
- "Production API Key": [
+ "API Key": [
"{subscriber-id}:manage",
"{subscriber-id}:destination:manage",
"{subscriber-id}:destination:create"
@@ -1270,7 +1239,7 @@
],
"components": {
"securitySchemes": {
- "Production API Key": {
+ "API Key": {
"type": "oauth2",
"flows": {
"clientCredentials": {
@@ -1292,12 +1261,6 @@
}
},
"description": "Dieses Authentifizierungsmethode wird genutzt, um den Zugriff auf die Produktiv API zu autorisieren. "
- },
- "Sandbox API Key": {
- "name": "API-Key",
- "type": "apiKey",
- "in": "header",
- "description": "Der API-Key wird als Authentifizierungsmittel für die Sandbox API benutzt."
}
}
}