Skip to content
Snippets Groups Projects
Verified Commit 9fb84d0f authored by Florian Kaufmann's avatar Florian Kaufmann
Browse files

Weitere docs anpassungen zum Event Log via cases api

parent 5a412d35
No related branches found
No related tags found
1 merge request!56Docuanpassung für die event retrival Api Endpunkt Migration
......@@ -83,7 +83,7 @@ Sind alle Prüfungen erfolgreich durchlaufen, wird das SET im Event Log abgespei
## Event Log abfragen
Der Event Log einer Einreichung kann über <ApiLink to="/v1/cases/{caseId}/events" /> abgefragt werden.
Hierbei wird der Event Log aller Einreichungen eines Cases zurückgeliefert, der die verschiedenen Statusübergänge bzw. abgelegten Ereignisse beinhaltet.
Hierbei wird der Event Log aller Einreichungen eines Cases zurückgeliefert. Dieser Event Log beinhaltet die verschiedenen Statusübergänge bzw. abgelegten Ereignisse.
Es kann über die Queryparameter `offset` und `limit` das Gesamtergebnis in kleinere Teillisten der verfügbaren Events aufgeteilt werden.
Die maximale Anzahl an Events in einer Teilliste (`limit`) sind 500 Events.
Das Ergebnis könnte wie folgt aussehen:
......@@ -101,7 +101,7 @@ Das Ergebnis könnte wie folgt aussehen:
}
```
Im Log von diesem Case wurden drei Events aufgezeichnet.
Im Log von diesem Case wurden drei Events einer Einreichung aufgezeichnet.
Das letzte SET aus obigem Beispiel hat folgenden Payload.
```json
......
......@@ -18,8 +18,8 @@ Wie der Zustellpunkt der zuständigen empfangenden Stelle technisch ermittelt wi
FIT-Connect möchte einen sehr sicheren Übermittlungsweg bereitstellen, weswegen alle Daten immer vom Browser des Users bis in die Behörde Ende-zu-Ende-Verschlüsselt übertragen werden müssen.
Das dafür benötigte Schlüsselmaterial wird auch über die Submission API und Routing API bereitgestellt und der Umgang damit im Weiteren erklärt.
Während der Einreichung erhält man von der API eine `submissionId`, mithilfe welcher man nach der Abgabe den Event Log der Einreichung abrufen kann.
Dieser Event Log enthält eine Liste von Ereignissen, ähnlich wie im Interface einer Paketverfolgung, mit denen der aktuelle Zustellungsstatus der Einreichung transparent wird.
Während der Einreichung erhält man von der API eine `caseId`, mithilfe welcher man nach der Abgabe den Event Log der Einreichung abrufen kann.
Dieser Event Log enthält eine Liste von Ereignissen, ähnlich wie im Interface einer Paketverfolgung, mit denen der aktuelle Zustellungsstatus der Einreichung sowie aller zukünftig zu diesem Case hinzugehörigen Einreichungen transparent wird.
## Prozessablauf
......
......@@ -27,7 +27,7 @@ Das Statusmodell einer Einreichung ist in der folgenden Grafik dargestellt und e
Der Status wird über
<ApiLink to="/v1/cases/{caseId}/events"/>
abgefragt.
Hierbei wird der Event Log aller Einreichungen eines Cases zurückgeliefert, der die verschiedenen Statusübergänge bzw. abgelegten Ereignisse beinhaltet.
Hierbei wird der Event Log aller Einreichungen eines Cases zurückgeliefert. Dieser Event Log beinhaltet die verschiedenen Statusübergänge bzw. abgelegten Ereignisse.
Es kann über die Queryparameter `offset` und `limit` das Gesamtergebnis in kleinere Teillisten der verfügbaren Events aufgeteilt werden.
Die maximale Anzahl an Events in einer Teilliste (`limit`) sind 500 Events.
Das Ergebnis könnte wie folgt aussehen:
......@@ -45,7 +45,7 @@ Das Ergebnis könnte wie folgt aussehen:
}
```
Im Log von diesem Case wurden drei Events aufgezeichnet.
Im Log von diesem Case wurden drei Events einer Einreichung aufgezeichnet.
Das letzte, aktuellste Security-Event-Token hat folgenden Payload.
```json
......
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