Skip to content
Snippets Groups Projects
Commit 97ba35e8 authored by Michael Haidner's avatar Michael Haidner
Browse files

Setengliederung neuu

parent 845eb79c
No related branches found
No related tags found
2 merge requests!463515_NEW_New_Rueckkanal_Dokumentation_ueber_die_Verwendung(planning#515),!426515_NEW_Rueckkanal_Dokumentation_ueber_die_Verwendung(planning#515, planning#115)
This commit is part of merge request !426. Comments created here will be created in the context of that merge request.
...@@ -20,7 +20,7 @@ In FIT-Connect ist die Konfiguration eines konkreten empfangenden Systems (eines ...@@ -20,7 +20,7 @@ In FIT-Connect ist die Konfiguration eines konkreten empfangenden Systems (eines
Somit können Sender diesen Zustellpunkt abfragen, um zu erfahren, welche Rückkanäle das nachgelagerte Fachverfahren anbietet. Somit können Sender diesen Zustellpunkt abfragen, um zu erfahren, welche Rückkanäle das nachgelagerte Fachverfahren anbietet.
Im [Glossar](../glossary.md) zu dieser Dokumentation finden Sie eine Definition für den Begriff "Zustellpunkt". Im [Glossar](../glossary.md) zu dieser Dokumentation finden Sie eine Definition für den Begriff "Zustellpunkt".
### Konfiguration eines Zustellpunktes {#KonfigZustellpunkt} ### Konfiguration eines Zustellpunktes abfragenn {#KonfigZustellpunkt}
Die Konfiguration eines Zustellpunktes für ein Fachverfahren können Sender über die Routing-API von FIT-Connect erfragen: <br/> Die Konfiguration eines Zustellpunktes für ein Fachverfahren können Sender über die Routing-API von FIT-Connect erfragen: <br/>
Der Aufruf des Endpunkts <ApiLink api="routing-api" to="/routes" /> mit Leistungs- und Gebietsschlüssel liefert die Informationen zu Zustellpunkten in einem JSON-Objekt zurück. Der Aufruf des Endpunkts <ApiLink api="routing-api" to="/routes" /> mit Leistungs- und Gebietsschlüssel liefert die Informationen zu Zustellpunkten in einem JSON-Objekt zurück.
...@@ -65,16 +65,18 @@ Gibt es keine Einträge zu `replyChannels`, dann stellt das nachgelagerte Fachve ...@@ -65,16 +65,18 @@ Gibt es keine Einträge zu `replyChannels`, dann stellt das nachgelagerte Fachve
## Rückkanäle E-Mail, De-Mail, FINK und Elster ## Rückkanäle E-Mail, De-Mail, FINK und Elster
### Erforderliche Einstellungen ### Erforderliche Einträge in den Metadaten
Im [Beispiel oben](#KonfigZustellpunkt) für die Konfiguration eines Zustellpunkts Im [Beispiel oben](#KonfigZustellpunkt) für die Konfiguration eines Zustellpunkts
sind als mögliche Rückkanäle Elster, E-Mail und FIT-Connect eingetragen, sind als mögliche Rückkanäle Elster, E-Mail und FIT-Connect eingetragen,
somit können Sender für ihre Einreichungen einen dieser Rückkanäle auswählen. <br/> somit können Sender einen dieser Rückkanäle für ihre Einreichungen auswählen. <br/>
Wenn ein Sennder für eine Einreichung E-MMail, Elster odr FINK auswählten will, Wenn ein Sender für eine Einreichung E-Mail, Elster odr FINK auswählen will,
dann muuss er diese Auswahl dem addresierten Fachverfahren mitteilen, dann muuss er diese Auswahl dem addresierten Fachverfahren mitteilen,
indem er einen entsprechen Einrag in den Metadaten zu einer Einreichung einfügt. <br/> indem er einen entsprechen Eintrag in den Metadaten zu der Einreichung einfügt. <br/>
Im Folgenden sollenn die erforderlichen Einstellung in den Metadaten für E-Mail gezeigt werden. #### Einträge für E-Mail
Das folgende Beispiel für die Metadaten einer Einreichuung zeigt die Einträge für E-Mail als Rückkanal:
```json ```json
{ {
...@@ -105,6 +107,74 @@ Im Folgenden sollenn die erforderlichen Einstellung in den Metadaten für E-Mail ...@@ -105,6 +107,74 @@ Im Folgenden sollenn die erforderlichen Einstellung in den Metadaten für E-Mail
} }
``` ```
#### Einträge für De-Mail
Das folgende Beispiel für die Metadaten einer Einreichuung zeigt die Einträge für De-Mail als Rückkanal:
```json
{
"$schema": "https://schema.fitko.de/fit-connect/metadata/1.0.0/metadata.schema.json",
"authenticationInformation": [
{
...
}
],
"contentStructure": {
"data": {
...
},
"attachments": [
...
]
},
"paymentInformation": {
...
},
"publicServiceType": {
...
},
"replyChannel": {
"de-mail": {
...
}
}
```
#### Einträge für Elster
Das folgende Beispiel für die Metadaten einer Einreichuung zeigt die Einträge für Elster als Rückkanal:
```json
{
"$schema": "https://schema.fitko.de/fit-connect/metadata/1.0.0/metadata.schema.json",
"authenticationInformation": [
{
...
}
],
"contentStructure": {
"data": {
...
},
"attachments": [
...
]
},
"paymentInformation": {
...
},
"publicServiceType": {
...
},
"replyChannel": {
"fink": {
...
}
}
```
## Rückkanal FIT-Connect
Im [Beispiel oben](#KonfigZustellpunkt) für die Konfiguration eines Zustellpunkts sind als mögliche Rückkanal Elster, E-MMail und FIT-Connect eingetragen, Im [Beispiel oben](#KonfigZustellpunkt) für die Konfiguration eines Zustellpunkts sind als mögliche Rückkanal Elster, E-MMail und FIT-Connect eingetragen,
somit können Sender in diesem Beispiel die bidirektionale Kommunikation über FIT-Connect wählen (folgende Absätze). somit können Sender in diesem Beispiel die bidirektionale Kommunikation über FIT-Connect wählen (folgende Absätze).
...@@ -118,8 +188,6 @@ der darin besteht, dass ein sendendes System (Onlinedienst) eine Nachricht sende ...@@ -118,8 +188,6 @@ der darin besteht, dass ein sendendes System (Onlinedienst) eine Nachricht sende
Das sendende System empfängt die Antwort, wertet sie programmtechnisch aus und reagiert darauf, Das sendende System empfängt die Antwort, wertet sie programmtechnisch aus und reagiert darauf,
indem es zum Beispiel eine weitere Nachricht an das empfangende System sendet, das dann wiederum darauf antworten kann. indem es zum Beispiel eine weitere Nachricht an das empfangende System sendet, das dann wiederum darauf antworten kann.
## Rückkanal FIT-Connect
### Erforderliche Einstellungen für bidirektionale Kommunikation ### Erforderliche Einstellungen für bidirektionale Kommunikation
Soll ein Sender bei einer Einreichung die bidirektionale Kommunikation verwenden, Soll ein Sender bei einer Einreichung die bidirektionale Kommunikation verwenden,
...@@ -147,7 +215,8 @@ Das folgende Beispiel zeigt diese Einstellung: ...@@ -147,7 +215,8 @@ Das folgende Beispiel zeigt diese Einstellung:
} }
``` ```
### 2: Einträge in den Metadaten erforderlich {#MetadatenFitConnect}
### 2: Erforderliche Einträge in den Metadaten {#MetadatenFitConnect}
Wenn ein Sender FIT-Connect für Antworten nutzen will (FIT-Connect als Rückkanal), dann muss in den Metadaten, Wenn ein Sender FIT-Connect für Antworten nutzen will (FIT-Connect als Rückkanal), dann muss in den Metadaten,
die dieser Sender an ein Fachverfahren sendet, unter "replyChannel" der Wert "fitConnect" eingetragen sein. <br/> die dieser Sender an ein Fachverfahren sendet, unter "replyChannel" der Wert "fitConnect" eingetragen sein. <br/>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment