Ä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.
...	...	@@ -30,9 +30,36 @@
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
	33	+***organizationID:*** 77777777-0000
	34	+***Identifier:*** KFAS_SubmissionAPI_Test_WithUpload
	35	+***transactionID:*** KFAS_SubmissionAPI_Test_WithUpload-SxqFFZb
	36	+***messageID:*** 6050a243756f151657af46a4
	37	+***fileID:*** 6050a2e8756f151657af46a6
38	38
	39	+## Anwendungsbeispiele
	40	+
	41	+### Anwendungsbeispiel 1
	42	+
	43	+**Abholung eines Detaildatensatzes durch ein einzelnes externes System**
	44	+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.
	45	+
	46	+### Anwendungsbeispiel 2
	47	+
	48	+**Einsicht und Abholung von Detaildatensätzen durch ein externes System:**
	49	+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.
	50	+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.
	51	+
	52	+### Anwendungsbeispiel 3
	53	+
	54	+**Abholung von Detaildatensätzen durch zwei externe Systeme:**
	55	+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.
	56	+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.
	57	+
	58	+### Anwendungsbeispiel 4
	59	+
	60	+**Abholung von Detaildatensätzen durch drei externe Systeme:**
	61	+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.
	62	+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.
	63	+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.
	64	+
	65	+