From 7387b57809c9f297c6d1c995683307fa71f824a2 Mon Sep 17 00:00:00 2001 From: Alexander Hoose <alexander.hoose@fitko.de> Date: Sat, 14 Aug 2021 10:03:16 +0000 Subject: [PATCH] Aktualisieren docs/sidebar.js, docs/getting-started/submission-structure.md Dateien --- docs/getting-started/submission-structure.md | 17 +++++++++++++++++ docs/sidebar.js | 1 + 2 files changed, 18 insertions(+) create mode 100644 docs/getting-started/submission-structure.md diff --git a/docs/getting-started/submission-structure.md b/docs/getting-started/submission-structure.md new file mode 100644 index 000000000..5fe5d6366 --- /dev/null +++ b/docs/getting-started/submission-structure.md @@ -0,0 +1,17 @@ +# Hintergrund und Aufbau von Einreichungen + +Der zentrale Anwendungs der Submission API besteht darin, im Rahmen von Verwaltungsverfahren Daten an hoheitliche Stellen (Behörden, Handelskammern, etc.) zu übermitteln. +Diese Daten werden durch Kunden und Verfahrenspartner initiierend übermitteln, um Verfahren (bspw. über einen Antrag) zu starten oder Berichtspflichten nachzukommen. +Diese Datenübermittlung wird in der Submission API als Einreichung bezeichnet und besitzt eine besitzt eine festgelegte Struktur aus Datenobjekten, die über die Ressourcen +der Submission abgebildet werden. Hintegrund dieser Struktur ist eine standardisierte Verarbeitung und Interpretation der einzelnen Bestandteile einer Einreichung. +Fachlich gesehen können Einreichung Anträge (Ein strukturierte Datensatz mit den Daten eines Wohngeldanträge und Anlagen in beliebigen Datenformaten wie einer PDF Urkunde), +Berichte (bspw. ein Datensatz wie eine elektronischen Bilanz oder in festlegten Berichtsformat für Statistik- oder Sozialmeldenungen) oder sonstige prozessauslösende Datensätze sein. + +## Wie ist eine Einreichung aufgebaut? + + + +Eine Einreichung über FIT-Connect besteht aus einem obligatorischen Metadatensatz, der die Einreichung beschreibt. +Der Metadatensatz gibt an, wie viele Anlagen beigefügt werden. +Zusätzlich zu den allgemeinen Anlagen kann ein Fachdatensatz im JSON- oder XML-Format beigefügt werden. +Im Zustellpunkt wird definiert, ob für die gewählte Verwaltungsleistung ein Fachdatensatz beigefügt wird und welchem Format er entsprechen muss. diff --git a/docs/sidebar.js b/docs/sidebar.js index 0703c4659..f83336d5e 100644 --- a/docs/sidebar.js +++ b/docs/sidebar.js @@ -27,6 +27,7 @@ module.exports = { items: [ 'getting-started/overview', 'getting-started/authentication', + 'getting-started/submission-structure' 'getting-started/metadata', 'getting-started/encryption', 'getting-started/event-log', -- GitLab