diff --git a/docs/getting-started/first-steps.mdx b/docs/getting-started/first-steps.mdx index 01dcdc3bf28e47fc3ae22a852678129e93749576..a3a9e2fec789eddd75dd7ac109fb4a6c8650a1e2 100644 --- a/docs/getting-started/first-steps.mdx +++ b/docs/getting-started/first-steps.mdx @@ -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` - [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. ::: diff --git a/docs/getting-started/submission/data.mdx b/docs/getting-started/submission/data.mdx index 441c5e251561e5ce8bd467b279731df00787a0bc..4a9db010ba2ad77c44411b519e7b3bfde0589d33 100644 --- a/docs/getting-started/submission/data.mdx +++ b/docs/getting-started/submission/data.mdx @@ -4,3 +4,7 @@ Das Thema der Fachdaten hinsichtlich ihres Aufbaus und Verwendung wird hier in Zukunft beschrieben. 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). diff --git a/docs/getting-started/submission/metadata.mdx b/docs/getting-started/submission/metadata.mdx index 68527c1cf9dd87cd7c527f504d7cd3858e10e7d1..4910269418b1afe23e9f81a1009905c93c40f7c5 100644 --- a/docs/getting-started/submission/metadata.mdx +++ b/docs/getting-started/submission/metadata.mdx @@ -2,17 +2,21 @@ title: Metadatensatz --- -Die Antragsmetadaten beschreiben die Struktur der Einreichung und dessen Inhalte, wie beispielsweise Anhänge oder die -Fachdaten. Zusätzlich können weitere Informationen über Verwaltungskund:innen hinterlegt werden. Eine genaue Definition -ist in der [Schema-Beschreibung](../../metadata/schema.mdx) zu finden. Im Folgenden wird nun beschrieben, wie für das -Versenden einer Einreichung das Schema aufgebaut und befüllt wird. +Die Antragsmetadaten beschreiben die Struktur der Einreichung und dessen Inhalte, wie beispielsweise Anhänge oder die Fachdaten. +Zusätzlich können weitere Informationen über Verwaltungskund:innen hinterlegt werden. +Eine genaue Definition ist in der [Schema-Beschreibung](../../metadata/schema.mdx) zu finden. +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`. -In der Beschreibung der Struktur (`contentStructure`) muss angegeben werden, ob und in welchem Format ein Fachdatensatz -mit versendet wird. 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, -die im Metadatenschema definiert sind, befüllt und mitversendet werden. Ob diese jedoch ausgewertet werden oder nicht -hängt u. a. von der vom Empfängers unterstützten Version des Metadatenschemas ab. +Das Minimum, was an Information in den Metadaten vorhanden sein muss, ist der Abbschnitt `contentStructure`. +In der Beschreibung der Struktur der Einreichung (`contentStructure`) muss angegeben werden, ob und in welchem Format ein Fachdatensatz mit versendet wird. +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, die im Metadatenschema definiert sind, befüllt und mitversendet werden. +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: diff --git a/docs/getting-started/submission/structure.mdx b/docs/getting-started/submission/structure.mdx index 78ed4cd75e2398b15f98a9a198a2278f81c429b8..8d21f262d720a0b1cf15a19ca6bf2320ed79c4e3 100644 --- a/docs/getting-started/submission/structure.mdx +++ b/docs/getting-started/submission/structure.mdx @@ -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? -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). diff --git a/docs/metadata/overview.mdx b/docs/metadata/overview.mdx index ce28ca63927505c64a649f7ab09dfe540255b173..84f526f83b80d7aced06719c076ecf2aaf1ad80d 100644 --- a/docs/metadata/overview.mdx +++ b/docs/metadata/overview.mdx @@ -1,17 +1,17 @@ # Metadatensatz -Metadaten sind ein zentraler Bestandteil einer Einreichung. Sie beschreiben die Struktur der Einreichung und deren -Inhalte, wie beispielsweise Anlagen oder die Fachdaten. Zusätzlich können weitere Informationen über d:ie Verwaltungskund:in -hinterlegt werden. 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. +Metadaten sind ein zentraler Bestandteil einer Einreichung. +Sie beschreiben die Struktur der Einreichung und deren Inhalte, wie beispielsweise Anlagen oder die Fachdaten. +Zusätzlich können weitere Informationen über d:ie Verwaltungskund:in hinterlegt werden. +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 -Ein Beispiel für den Metadatensatz eines Kindergeldantrags findet sich in der [Dokumentation für sendende Systeme](../getting-started/submission/metadata.mdx) +:::tip Hinweis +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) -in der Version von 2020. Es besteht primär aus den fünf Bereichen Authentifizierungsinformationen, Inhaltsstruktur, -Bezahlinformationen, Verwaltungsleistung und Rückkanal. +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. +Es besteht primär aus den fünf Bereichen Authentifizierungsinformationen, Inhaltsstruktur, Bezahlinformationen, Verwaltungsleistung und Rückkanal. ```json {