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

docs: :pencil2: Einreichungen und Attachment Verfügbarkeit (planning#25

parent 6d27c358
No related branches found
No related tags found
1 merge request!153Einreichungen und Attachment Verfügbarkeit Doku Anpassung (planning#25)
......@@ -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
......
......@@ -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"
......
......@@ -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.
......
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