Änderungen von Dokument Submission-API

Zusammenfassung

• Seiteneigenschaften (1 geändert, 0 hinzugefügt, 0 gelöscht)

Details

Seiteneigenschaften

Inhalt

...	...	@@ -15,9 +15,9 @@
15	15
16	16	Um die Schnittstelle verwenden zu können, muss eine Authentifizierung vorgenommen werden. Für diese ist die Mandantennummer und der dafür hinterlegte API-Schlüssel notwendig, wobei die Mandantennummer als Benutzername und der API-Schlüssel als Passwort gilt. Sollte noch kein passender API-Schlüssel vorliegen, kann dieser beim Administrator des Fomularservers beantragt werden.
17	17
18		-Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
19		-***Mandantennummer:*** 77777777-0000
20		-***API-Schlüssel:*** yIJNM2BS6LI0lS25Qa5xbtEK
	18	+Die erforderlichen Authentifizierungsdaten dienen zu Demonstrationszwecken und lauten wie folgt:
	19	+***Mandantennummer:*** 77777777-0000
	20	+***API-Schlüssel:*** yIJNM2BS6LI0lS25Qa5xbtEK
21	21
22	22	> {{icon name="far fa-info-circle" size="3"/}} **Hinweis:**
23	23	> Die verwendete Authentifizierungsart ist eine Basis-Authentifizierung.
...	...	@@ -26,13 +26,43 @@
26	26
27	27	Um die Schnittstelle beispielhaft bedienen zu können, wird eine Demoanwendung unter folgender URL bereitgestellt: https://vertrieb.form-solutions.de/submission/swagger-ui/index.html
28	28
	29	+> ***Achtung***
	30	+> Die oben verlinkte Swagger-Dokumentation greift auf den Form-Solutions internen Vertriebsserver zu. Um die Dokumentation auf anderen Servern einzusehen muss die URL folgendem Format entsprechen: < BASIS_URL >/submission/swagger-ui/index.html
	31	+
29	29	Ebenso steht dem Anwender mit dieser Beispielanwendung eine technische Dokumentation zur Verfügung, welche die einzelnen Ressourcen detaillierter beschreibt.
30	30
31	31	### Testdaten zu Demonstrationszwecken
32	32
33		-***organizationID:*** 77777777-0000
34		-***Identifier:*** KFAS_SubmissionAPI_Test_WithUpload
35		-***transactionID:*** KFAS_SubmissionAPI_Test_WithUpload-SxqFFZb
36		-***messageID:*** 6050a243756f151657af46a4
37		-***fileID:*** 6050a2e8756f151657af46a6
	36	+***organizationID:*** 77777777-0000
	37	+***Identifier:*** KFAS_SubmissionAPI_Test_WithUpload
	38	+***transactionID:*** KFAS_SubmissionAPI_Test_WithUpload-SxqFFZb
	39	+***messageID:*** 6050a243756f151657af46a4
	40	+***fileID:*** 6050a2e8756f151657af46a6
38	38
	42	+## Anwendungsbeispiele
	43	+
	44	+### Anwendungsbeispiel 1
	45	+
	46	+**Abholung eines Detaildatensatzes durch ein einzelnes externes System**
	47	+Greift ein einzelnes externes System (beispielsweise eine Portalsoftware) auf einen Detaildatensatz für die weitere Verarbeitung zu, ist nach erfolgreicher Übermittlung der Status des entsprechenden Datensatzes von "NEW" auf "DELETED" zu setzen.
	48	+
	49	+### Anwendungsbeispiel 2
	50	+
	51	+**Einsicht und Abholung von Detaildatensätzen durch ein externes System:**
	52	+Greift ein externes System (beispielsweise eine Portalsoftware) auf die Übersicht aller Einreichungen eines spezifischen Assistenten zu, ist der Status der ermittelten Datensätze von "NEW" auf "READ" zu setzen.
	53	+Wird ein Detaildatensatz für die weitere Verarbeitung im externen System abgerufen, ist nach erfolgreicher Übermittlung der Status des entsprechenden Datensatzes von "READ" auf "DELETED" zu setzen.
	54	+
	55	+### Anwendungsbeispiel 3
	56	+
	57	+**Abholung von Detaildatensätzen durch zwei externe Systeme:**
	58	+Wird ein Detaildatensatz für die weitere Verarbeitung in der Portalsoftware abgerufen, ist nach erfolgreicher Übermittlung der Status des entsprechenden Datensatzes von "NEW" auf "READ" zu setzen.
	59	+Greift ein weiteres System (beispielsweise ein Fachverfahren) auf die Detaildatensätze zu, sollte stets eine Filterung auf Einreichungen mit dem Status „READ“ erfolgen. Nach erfolgreicher Übermittlung ist der Status des entsprechenden Datensatzes von „READ“ auf „DELETED“ zu setzen.
	60	+
	61	+### Anwendungsbeispiel 4
	62	+
	63	+**Abholung von Detaildatensätzen durch drei externe Systeme:**
	64	+Wird ein Detaildatensatz für die weitere Verarbeitung in der Portalsoftware abgerufen, ist nach erfolgreicher Übermittlung der Status des entsprechenden Datensatzes von "NEW" auf "READ" zu setzen.
	65	+Greift ein zweites System (beispielsweise ein Fachverfahren) auf die Detaildatensätze zu, sollte stets eine Filterung auf Einreichungen mit dem Status „READ“ erfolgen. Nach erfolgreicher Übermittlung ist der Status des entsprechenden Datensatzes von „READ“ auf „PRELIMINARY“ zu setzen.
	66	+Greift ein drittes System (beispielsweise eine Software zur Benachrichtigung des Antragstellers über das Ergebnis) auf die Detaildatensätze zu, sollte stets eine Filterung auf Einreichungen mit dem Status „PRELIMINARY“ erfolgen. Nach erfolgreicher Übermittlung ist der Status des entsprechenden Datensatzes von „PRELIMINARY“ auf „DELETED“ zu setzen.
	67	+
	68	+