From 8fea767dedd8de0922ae31d38428cf42a694513d Mon Sep 17 00:00:00 2001 From: Florian Kaufmann <florian.kaufmann@codecentric.de> Date: Wed, 27 Oct 2021 14:31:17 +0200 Subject: [PATCH] Kleine doc Verbesserung --- docs/getting-started/receiving/process-and-acknowledge.mdx | 2 +- docs/getting-started/receiving/query.mdx | 4 ++-- docs/getting-started/sending/query-status.mdx | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/getting-started/receiving/process-and-acknowledge.mdx b/docs/getting-started/receiving/process-and-acknowledge.mdx index 923e215ad..8074fb421 100644 --- a/docs/getting-started/receiving/process-and-acknowledge.mdx +++ b/docs/getting-started/receiving/process-and-acknowledge.mdx @@ -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. 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. Das Ergebnis könnte wie folgt aussehen: diff --git a/docs/getting-started/receiving/query.mdx b/docs/getting-started/receiving/query.mdx index 2aca420ec..aebabbc6d 100644 --- a/docs/getting-started/receiving/query.mdx +++ b/docs/getting-started/receiving/query.mdx @@ -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. Dies wird aus Performancegründen jedoch nicht empfohlen. -Die abgerufene Liste der Submissions kann über den Parameter `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 +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 Queryparameter `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. diff --git a/docs/getting-started/sending/query-status.mdx b/docs/getting-started/sending/query-status.mdx index 1c259124f..4bdccbcfd 100644 --- a/docs/getting-started/sending/query-status.mdx +++ b/docs/getting-started/sending/query-status.mdx @@ -28,7 +28,7 @@ Der Status wird über <ApiLink to="/v1/submissions/{submissionId}/events"/> abgefragt. 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. Das Ergebnis könnte wie folgt aussehen: -- GitLab