Skip to content
Snippets Groups Projects
Commit 2bead36d authored by Marco Holz's avatar Marco Holz
Browse files

Merge branch 'mr-get-submission' into 'main'

Doku zum Abruf von Meta-, Fachdaten und Anlagen gemäß API aktualisiert

See merge request !21
parents 92f67f4c ecf144fa
No related branches found
No related tags found
1 merge request!21Doku zum Abruf von Meta-, Fachdaten und Anlagen gemäß API aktualisiert
...@@ -3,10 +3,12 @@ sidebar_position: 5 ...@@ -3,10 +3,12 @@ sidebar_position: 5
title: Einreichung herunterladen title: Einreichung herunterladen
--- ---
In den Ausschnitten unten wird zuerst gezeigt, wie die allgemeinen Informationen abgefragt werden. import ApiLink from '@site/src/components/ApiLink'
Abhängig von der Struktur `announcedContentStructure` können dann noch weitere Ressourcen geladen werden.
Der Marker `data` gibt an, ob in dem Feld `encryptedData` Inhalt sein sollte oder nicht. ## Abruf von Metadaten und Fachdaten
In `attachments` sind die Identifikatoren der Anlagen zu finden, die separat herunterzuladen sind, wie im zweiten Beispiel gezeigt ist. Der Abruf einer Einreichung ist über den Endpunkt <ApiLink to="/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).
Anschließend können die Metadaten und Fachdaten [entschlüsselt](./decrypt.mdx) sowie deren Schemata [validiert](./validate.mdx) werden.
```bash title="Abfrage der Einreichung inkl. Fachdaten und Metadaten" ```bash title="Abfrage der Einreichung inkl. Fachdaten und Metadaten"
$ export SERVICE_URL=<URL> $ export SERVICE_URL=<URL>
...@@ -17,22 +19,26 @@ $ curl \ ...@@ -17,22 +19,26 @@ $ curl \
-H "Content-Type: application/json" \ -H "Content-Type: application/json" \
-X GET $SERVICE_URL/submissions/$SUBMISSION_ID -X GET $SERVICE_URL/submissions/$SUBMISSION_ID
> { > {
"destinationId": "7a2668ad-3081-407c-9358-7ce4b6144b02", "destinationId": "879ee109-a690-4db8-ab32-424284184d7d",
"submissionId": "9d618546-0ff7-4e93-9f15-714e5dd1bf12", "submissionId": "ce75a6b8-d72f-4b94-b09e-af6be35bc2ae",
"attachments": [], "caseId": "e89e107e-ed79-40e6-ad34-4e770f9df26d",
"currentStatus": "forwarded", "attachments": [
"encryptedMetadata": "eyJhbGciOiA...5XZMvG-fAJ6oDnAw", "879ee109-a690-4db8-ab32-424284184d7d",
"encryptedData": null, "2046f9f1-dc89-4440-9c24-c76a8f40d668"
"statusHistory": [...], ],
"announcedContentStructure": { "encryptedMetadata": "eyJlbmMiOiJ...VBHJ00FyDTYjOA_OYfiz5g",
"data": false, "`encryptedData`": "eyJlbmMiOiJ...VBHJ00FyDTYjOA_OYfiz5g",
"attachments": [ "serviceType": {
"122668ad-3081-497c-9358-7ce4b6144b02", "name": "Bauantrag",
] "identifier": "urn:de:fim:leika:leistung:99010003001006"
} }
} }
``` ```
## Abruf von Anlagen
Anlagen können über den Endpunkt Endpunkt <ApiLink to="/submissions/{submissionId}/attachments/{attachmentId}" /> abgerufen werden. Anschließend können auch die Anlagen [entschlüsselt werden](./decrypt.mdx).
```bash title="Herunterladen einer Anlage" ```bash title="Herunterladen einer Anlage"
$ export SERVICE_URL=<URL> $ export SERVICE_URL=<URL>
$ export JWT_TOKEN=eyJhbGciOiJIUzI1NiJ9.eyJJc3N1Z...NL-MKFrDGvn9TvkA $ export JWT_TOKEN=eyJhbGciOiJIUzI1NiJ9.eyJJc3N1Z...NL-MKFrDGvn9TvkA
......
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