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

Kleine doc Verbesserung

parent 763ce445
No related branches found
No related tags found
1 merge request!54Anpassung der submission und event GET endpoint Beispiele sodass Sie paging beinhalten
...@@ -84,7 +84,7 @@ Sind alle Prüfungen erfolgreich durchlaufen, wird das SET im Event Log abgespei ...@@ -84,7 +84,7 @@ Sind alle Prüfungen erfolgreich durchlaufen, wird das SET im Event Log abgespei
Der Event Log einer Einreichung kann über <ApiLink to="/v1/submissions/{submissionId}/events" /> abgefragt werden. Der Event Log einer Einreichung kann über <ApiLink to="/v1/submissions/{submissionId}/events" /> abgefragt werden.
Hierbei wird der Event Log der Einreichung zurückgeliefert, der die verschiedenen Statusübergänge bzw. abgelegten Ereignisse beinhaltet. Hierbei wird der Event Log der Einreichung zurückgeliefert, der die verschiedenen Statusübergänge bzw. abgelegten Ereignisse beinhaltet.
Es kann über die Parameter `offset` und `limit` das Gesamtergebnis in kleinere Teillisten der verfügbaren Events aufgeteilt werden. 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. Die maximale Anzahl an Events in einer Teilliste (`limit`) sind 500 Events.
Das Ergebnis könnte wie folgt aussehen: Das Ergebnis könnte wie folgt aussehen:
......
...@@ -29,8 +29,8 @@ Wenn das empfangende System über den Eingang neuer Einreichungen benachrichtigt ...@@ -29,8 +29,8 @@ Wenn das empfangende System über den Eingang neuer Einreichungen benachrichtigt
Über Polling, d.h. regelmäßiges Abfragen des Endpunktes <ApiLink to="/v1/submissions" />, können alle Einreichungen abgefragt werden, die zum Abholen bereitstehen. Über Polling, d.h. regelmäßiges Abfragen des Endpunktes <ApiLink to="/v1/submissions" />, können alle Einreichungen abgefragt werden, die zum Abholen bereitstehen.
Dies wird aus Performancegründen jedoch nicht empfohlen. Dies wird aus Performancegründen jedoch nicht empfohlen.
Die abgerufene Liste der Submissions kann über den Parameter `destinationId` auf einzelne Zustellpunkte eingeschränkt werden. Die abgerufene Liste der Submissions kann über den Queryparameter `destinationId` auf einzelne Zustellpunkte eingeschränkt werden.
In diesem Fall werden nur die Submissions zurückgegeben, die zum angegebenen Zustellpunkt gehören. Zusätzlich kann über die Parameter In diesem Fall werden nur die Submissions zurückgegeben, die zum angegebenen Zustellpunkt gehören. Zusätzlich kann über die Queryparameter
`offset` und `limit` das Gesamtergebnis in kleinere Teillisten der verfügbaren Submissions aufgeteilt werden. Die maximale `offset` und `limit` das Gesamtergebnis in kleinere Teillisten der verfügbaren Submissions aufgeteilt werden. Die maximale
Anzahl an Submissions in einer Teilliste (`limit`) sind 500 Submissions. Anzahl an Submissions in einer Teilliste (`limit`) sind 500 Submissions.
......
...@@ -28,7 +28,7 @@ Der Status wird über ...@@ -28,7 +28,7 @@ Der Status wird über
<ApiLink to="/v1/submissions/{submissionId}/events"/> <ApiLink to="/v1/submissions/{submissionId}/events"/>
abgefragt. abgefragt.
Hierbei wird der Event Log der Einreichung zurückgeliefert, der die verschiedenen Statusübergänge bzw. abgelegten Ereignisse beinhaltet. Hierbei wird der Event Log der Einreichung zurückgeliefert, der die verschiedenen Statusübergänge bzw. abgelegten Ereignisse beinhaltet.
Es kann über die Parameter `offset` und `limit` das Gesamtergebnis in kleinere Teillisten der verfügbaren Events aufgeteilt werden. 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. Die maximale Anzahl an Events in einer Teilliste (`limit`) sind 500 Events.
Das Ergebnis könnte wie folgt aussehen: Das Ergebnis könnte wie folgt aussehen:
......
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