From 08c4500806998e8bd326f300fa5b424918987701 Mon Sep 17 00:00:00 2001 From: Florian Kaufmann <florian.kaufmann@codecentric.de> Date: Tue, 29 Mar 2022 09:56:14 +0200 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20Einreichungen=20un?= =?UTF-8?q?d=20Attachment=20Verf=C3=BCgbarkeit=20(planning#25?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/getting-started/event-log/set-validation.mdx | 2 +- docs/receiving/download-submission.mdx | 4 ++-- docs/receiving/notification.mdx | 2 +- 3 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/getting-started/event-log/set-validation.mdx b/docs/getting-started/event-log/set-validation.mdx index 2ac3a58d7..925dd79ba 100644 --- a/docs/getting-started/event-log/set-validation.mdx +++ b/docs/getting-started/event-log/set-validation.mdx @@ -318,7 +318,7 @@ Konkret sind das hier: ### Abruf des JWK zur Gültigkeitsprüfung des SET Mit der `submissionId` kann über den Endpunkt <ApiLink api="submission-api" to="/v1/submissions/{submissionId}" /> die zugehörige `destinationId` ermittelt werden. -Hier ist das konkret der Wert `92f2f581-c89d-44a5-b834-1fe3f6fa48d5`. +Hier ist das konkret der Wert `92f2f581-c89d-44a5-b834-1fe3f6fa48d5`. Dabei können nur Submissions im Status Submitted oder Forwarded abgerufen werden. ```http title="Abfrage der destinationId einer Submission" GET /v1/submissions/F65FEAB2-4883-4DFF-85FB-169448545D9F diff --git a/docs/receiving/download-submission.mdx b/docs/receiving/download-submission.mdx index 5e10ef105..0ee92b61d 100644 --- a/docs/receiving/download-submission.mdx +++ b/docs/receiving/download-submission.mdx @@ -5,7 +5,7 @@ title: Einreichung herunterladen import ApiLink from '@site/src/components/ApiLink' ## Abruf von Metadaten und Fachdaten -Der Abruf einer Einreichung ist über den Endpunkt <ApiLink api="submission-api" to="/v1/submissions/{submissionId}" /> möglich. Liegen zur Einreichung neben den verschlüsselten Metadaten (`encryptedMetadata`) und Fachdaten (`encryptedData`) zusätzlich weitere Anlagen vor, so sind die IDs der Anlagen im Feld `attachments` zu finden. Anlagen müssen separat heruntergeladen werden (siehe nächster Abschnitt). +Der Abruf einer Einreichung ist über den Endpunkt <ApiLink api="submission-api" to="/v1/submissions/{submissionId}" /> möglich. Liegen zur Einreichung neben den verschlüsselten Metadaten (`encryptedMetadata`) und Fachdaten (`encryptedData`) zusätzlich weitere Anlagen vor, so sind die IDs der Anlagen im Feld `attachments` zu finden. Anlagen müssen separat heruntergeladen werden (siehe nächster Abschnitt). Einreichungen und deren Anlagen können dabei nur im Status Submitted oder Forwarded abgerufen werden. :::note Hinweis Die URL der Submission API findet sich im Artikel [Erste Schritte](../getting-started/first-steps.mdx#test-infrastruktur). @@ -39,7 +39,7 @@ $ curl \ Anschließend können die Metadaten und Fachdaten [entschlüsselt](./decrypt.mdx) sowie deren Schemata [validiert](../getting-started/schema-validation.mdx) werden. ## Abruf von Anlagen -Anlagen können über den Endpunkt <ApiLink api="submission-api" to="/v1/submissions/{submissionId}/attachments/{attachmentId}" /> abgerufen werden. Anschließend können auch die Anlagen [entschlüsselt werden](./decrypt.mdx). +Anlagen können über den Endpunkt <ApiLink api="submission-api" to="/v1/submissions/{submissionId}/attachments/{attachmentId}" /> abgerufen werden. Anlagen können dabei nur von Einreichungen im Status Submitted oder Forwarded abgerufen werden. Anschließend können auch die Anlagen [entschlüsselt werden](./decrypt.mdx). ```bash title="Herunterladen einer Anlage" diff --git a/docs/receiving/notification.mdx b/docs/receiving/notification.mdx index 8fa012862..f2597c6ca 100644 --- a/docs/receiving/notification.mdx +++ b/docs/receiving/notification.mdx @@ -31,7 +31,7 @@ Callbacks werden wiederholt, bis ein [Accepted- oder Rejected-Event gesetzt wurd Wenn das empfangende System über den Eingang neuer Einreichungen benachrichtigt wurde, dann kann es diese wie im Artikel [Einreichung herunterladen](./download-submission.mdx) beschrieben herunterladen. ## Polling -Über Polling, d.h. regelmäßiges Abfragen des Endpunktes <ApiLink api="submission-api" to="/v1/submissions" />, können alle Einreichungen abgefragt werden, die zum Abholen bereitstehen. +Über Polling, d.h. regelmäßiges Abfragen des Endpunktes <ApiLink api="submission-api" to="/v1/submissions" />, können alle Einreichungen abgefragt werden, die zum Abholen bereitstehen (Einreichungen im Status Submitted). Dies wird aus Performancegründen jedoch nicht empfohlen. Die abgerufene Liste der Submissions kann über den Queryparameter `destinationId` auf einzelne Zustellpunkte eingeschränkt werden. -- GitLab