Skip to content
Snippets Groups Projects
Commit 78ed9a80 authored by Pascal Osterwinter's avatar Pascal Osterwinter
Browse files

Merge branch 'docs/einreichung-anlegen' into 'main'

Added a description for the required parameters. planning#74

See merge request !175
parents 1ddd0bcb 63712b67
No related branches found
No related tags found
1 merge request!175Added a description for the required parameters. https://git.fitko.de/fit-connect/planning/-/issues/74
......@@ -12,6 +12,14 @@ Hierbei legt das sendende System fest, an welchen Zustellpunkt der Einreichung v
Anlagen werden dabei über UUIDs eindeutig identifiziert.
Die UUIDs der Anlagen müssen eindeutig sein und werden vom sendenden System festgelegt.
Der Endpunkt erwartet folgende Parameter:
- Eine Destination-ID. Dies ist die eindeutige UUID des Zustellpunktes, an den die Einreichung vermittelt werden soll (`destinationId`). Im Artikel [Zustellpunkt Ermitteln](../responsibilities/get-destination.mdx) wird beschrieben wie diese ermittelt werden kann.
- Die announcedAttachments. Dies ist eine liste mit den Attachment-IDs die mit der Einreichung hochgeladen werden sollen (`announcedAttachments`).
- Außerdem wird ein Typ der Verwaltungsleistung erwartet (`serviceType`). Dies ist eine Beschreibung der Art der Verwaltungsleistung. Die angegebene Verwaltungsleistung muss der Verwaltungsleistung der Einreichung und einem der angebotenen Verwaltungsleistung des Zustellpunkts entsprechen. Für die jeweilige Verwaltungsleistung muss immer sowohl ein Name (`name`), als auch ein eindeutiger Identifier (`identifier`) angegeben werden. Der Identifier besteht aus einem einem Leistungsschlüssel und dem Präfix `urn:de:fim:leika:leistung:`. Ist für die gegebene Verwaltungsleistung kein Leistungsschlüssel vorhanden, kann die Verwaltungsleistung übergangsweise über die Angabe einer anderen eindeutigen Schema-URN beschrieben werden. Bestehende Leistungssschlüssel können [über das FIM-Portal](https://fimportal.de/) oder [über die LeiKa-Suche (inoffiziell)](https://opengovtech.de/leika/) ermittelt werden.
Optional kann hier auch ein Callback hinterlegt werden um Benachrichtigungen über neue Events der Einreichung zu erfahren. Näheres dazu wird im Artikel [Verwendung von Callbacks](../details/callbacks.mdx) beschrieben.
:::note Hinweis
Die für das Anlegen von Einreichungen notwendige Struktur von Einreichungen und die Referenzierung von Fachdatenschemata ist im Artikel [Aufbau einer Einreichung](../getting-started/submission/structure.mdx) näher beschrieben.
:::
......@@ -104,3 +112,4 @@ TBD
</TabItem>
</Tabs>
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