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

Merge branch 'mr-metadata-references' into 'main'

Verweise im Kontext Metadatensatz ergänzt/überarbeitet

See merge request !124
parents 738b2722 1bc925c8
No related branches found
No related tags found
1 merge request!124Verweise im Kontext Metadatensatz ergänzt/überarbeitet
...@@ -22,6 +22,6 @@ Für Anbindungstests in der Testumgebung können Sie die folgenden Links & Infos ...@@ -22,6 +22,6 @@ Für Anbindungstests in der Testumgebung können Sie die folgenden Links & Infos
- [Submission API](../apis/submission-api.mdx): `https://submission-api-testing.fit-connect.fitko.dev` - [Submission API](../apis/submission-api.mdx): `https://submission-api-testing.fit-connect.fitko.dev`
- [Routing API](../apis/routing-api.mdx): `https://routing-api-testing.fit-connect.fitko.dev` - [Routing API](../apis/routing-api.mdx): `https://routing-api-testing.fit-connect.fitko.dev`
:::tip :::tip Hinweis
Auf den folgenden Seiten stellen wir Code-Beispiele für die Anbindung von IT-Systemen an FIT-Connect zur Verfügung. Die Code-Beispiele veranschaulichen und vereinfachen die konkrete Implementierung der Nutzung der Programmierschnittstellen (APIs) von FIT-Connect. Diese Schnittstellen basieren auf gängigen offenen Standards und ermöglichen auch über die bereitgestellten Code-Beispiel hinaus eine Anbindung an FIT-Connect mit allen gängigen Programmiersprachen. Auf den folgenden Seiten stellen wir Code-Beispiele für die Anbindung von IT-Systemen an FIT-Connect zur Verfügung. Die Code-Beispiele veranschaulichen und vereinfachen die konkrete Implementierung der Nutzung der Programmierschnittstellen (APIs) von FIT-Connect. Diese Schnittstellen basieren auf gängigen offenen Standards und ermöglichen auch über die bereitgestellten Code-Beispiel hinaus eine Anbindung an FIT-Connect mit allen gängigen Programmiersprachen.
::: :::
...@@ -4,3 +4,7 @@ ...@@ -4,3 +4,7 @@
Das Thema der Fachdaten hinsichtlich ihres Aufbaus und Verwendung wird hier in Zukunft beschrieben. Das Thema der Fachdaten hinsichtlich ihres Aufbaus und Verwendung wird hier in Zukunft beschrieben.
Daher ist der Artikel aktuell noch in Bearbeitung. Daher ist der Artikel aktuell noch in Bearbeitung.
::: :::
Weitere Informationen zur Validierung eines Fachdatensatzes finden sich im Artikel [Schemavalidierung](../schema-validation.mdx).
Eine Erläuterung der Fachschemareferenzen für die gängigsten Fachstandards der Verwaltung findet sich im Artikel [Fachschemarefenzen auf Fachstandards und Rahmenwerke abbilden](/details/schema-reference.md).
...@@ -2,17 +2,21 @@ ...@@ -2,17 +2,21 @@
title: Metadatensatz title: Metadatensatz
--- ---
Die Antragsmetadaten beschreiben die Struktur der Einreichung und dessen Inhalte, wie beispielsweise Anhänge oder die Die Antragsmetadaten beschreiben die Struktur der Einreichung und dessen Inhalte, wie beispielsweise Anhänge oder die Fachdaten.
Fachdaten. Zusätzlich können weitere Informationen über Verwaltungskund:innen hinterlegt werden. Eine genaue Definition Zusätzlich können weitere Informationen über Verwaltungskund:innen hinterlegt werden.
ist in der [Schema-Beschreibung](../../metadata/schema.mdx) zu finden. Im Folgenden wird nun beschrieben, wie für das Eine genaue Definition ist in der [Schema-Beschreibung](../../metadata/schema.mdx) zu finden.
Versenden einer Einreichung das Schema aufgebaut und befüllt wird. Im Folgenden wird nun beschrieben, wie für das Versenden einer Einreichung das Schema aufgebaut und befüllt wird.
Das Minimum, was an Information in den Metadaten vorhanden sein muss, sind die Felder `authenticationInformation` und `contentStructure`. Das Minimum, was an Information in den Metadaten vorhanden sein muss, ist der Abbschnitt `contentStructure`.
In der Beschreibung der Struktur (`contentStructure`) muss angegeben werden, ob und in welchem Format ein Fachdatensatz In der Beschreibung der Struktur der Einreichung (`contentStructure`) muss angegeben werden, ob und in welchem Format ein Fachdatensatz mit versendet wird.
mit versendet wird. Des Weiteren können Anhänge mit ihren Metainformationen beschrieben werden, die der Einreichung Des Weiteren können Anhänge mit ihren Metainformationen beschrieben werden, die der Einreichung
beigefügt sind. Sollte ein Rückkanal gewünscht sein oder Bezahlinformationen notwendig sein, können die weiteren Felder, beigefügt sind.
die im Metadatenschema definiert sind, befüllt und mitversendet werden. Ob diese jedoch ausgewertet werden oder nicht Sollte ein Rückkanal gewünscht sein oder Bezahlinformationen notwendig sein, können die weiteren Felder, die im Metadatenschema definiert sind, befüllt und mitversendet werden.
hängt u. a. von der vom Empfängers unterstützten Version des Metadatenschemas ab. Ob diese jedoch ausgewertet werden oder nicht hängt u. a. von der vom Empfängers unterstützten Version des Metadatenschemas ab.
:::tip Hinweis
Die einzelnen Abschnitte des Metadatensatzes werden im eigenständigen Abschnitt [Metadatensatz](../../metadata/overview.mdx) näher beschrieben.
:::
Ein Beispiel für das Metadatenschema eines Kindergeldantrags ist unten dargestellt: Ein Beispiel für das Metadatenschema eines Kindergeldantrags ist unten dargestellt:
......
...@@ -97,4 +97,4 @@ Es wird für sendende Systeme empfohlen, auf den Versand eigener proprietärer A ...@@ -97,4 +97,4 @@ Es wird für sendende Systeme empfohlen, auf den Versand eigener proprietärer A
## Meine Software übermittelt oder empfängt nach Standard XYZ Fachdatensätze, wie kann ich das jeweils genutzte Fachschema korrekt referenzieren? ## Meine Software übermittelt oder empfängt nach Standard XYZ Fachdatensätze, wie kann ich das jeweils genutzte Fachschema korrekt referenzieren?
Eine Erläuterung der Fachschemareferenzen für die gängigsten Fachstandards der Verwaltung findet sich [hier](/details/schema-reference.md). Eine Erläuterung der Fachschemareferenzen für die gängigsten Fachstandards der Verwaltung findet sich im Artikel [Fachschemarefenzen auf Fachstandards und Rahmenwerke abbilden](/details/schema-reference.md).
# Metadatensatz # Metadatensatz
Metadaten sind ein zentraler Bestandteil einer Einreichung. Sie beschreiben die Struktur der Einreichung und deren Metadaten sind ein zentraler Bestandteil einer Einreichung.
Inhalte, wie beispielsweise Anlagen oder die Fachdaten. Zusätzlich können weitere Informationen über d:ie Verwaltungskund:in Sie beschreiben die Struktur der Einreichung und deren Inhalte, wie beispielsweise Anlagen oder die Fachdaten.
hinterlegt werden. Eine genaue Definition ist in der [Schema-Definition](../metadata/schema.mdx) Zusätzlich können weitere Informationen über d:ie Verwaltungskund:in hinterlegt werden.
zu finden. Im Folgenden werden nun die großen Bereiche, die im Metadatenschema aufgeführt werden, grob beschrieben. Eine genaue Definition ist in der [Schema-Definition](../metadata/schema.mdx) zu finden.
Im Folgenden werden nun die großen Bereiche, die im Metadatenschema aufgeführt werden, grob beschrieben.
:::note Beispiele :::tip Hinweis
Ein Beispiel für den Metadatensatz eines Kindergeldantrags findet sich in der [Dokumentation für sendende Systeme](../getting-started/submission/metadata.mdx) Ein Beispiel für den Metadatensatz eines Kindergeldantrags findet sich in der [Dokumentation zum Aufbau einer Einreichung](../getting-started/submission/metadata.mdx)
::: :::
Das Metadaten-Schema validiert gegen und orientiert sich an der [JSON Schema Spezifikation 2020-12](https://json-schema.org/specification-links.html#2020-12) Das Metadaten-Schema validiert gegen und orientiert sich an der [JSON Schema Spezifikation 2020-12](https://json-schema.org/specification-links.html#2020-12) in der Version von 2020.
in der Version von 2020. Es besteht primär aus den fünf Bereichen Authentifizierungsinformationen, Inhaltsstruktur, Es besteht primär aus den fünf Bereichen Authentifizierungsinformationen, Inhaltsstruktur, Bezahlinformationen, Verwaltungsleistung und Rückkanal.
Bezahlinformationen, Verwaltungsleistung und Rückkanal.
```json ```json
{ {
......
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