From f18304095421fb2a517f945336f7f9fd762307ad Mon Sep 17 00:00:00 2001
From: Alexander Hoose <alexander.hoose@fitko.de>
Date: Sat, 14 Aug 2021 15:06:53 +0000
Subject: [PATCH] Aktualisieren docs/getting-started/submission-structure.md,
 docs/details/reference-schemas.md Dateien

---
 docs/details/fachschema_draft.md             |  1 -
 docs/details/reference-schemas.md            | 69 ++++++++++++++++++++
 docs/getting-started/submission-structure.md | 14 ++--
 3 files changed, 76 insertions(+), 8 deletions(-)
 delete mode 100644 docs/details/fachschema_draft.md
 create mode 100644 docs/details/reference-schemas.md

diff --git a/docs/details/fachschema_draft.md b/docs/details/fachschema_draft.md
deleted file mode 100644
index 8b1378917..000000000
--- a/docs/details/fachschema_draft.md
+++ /dev/null
@@ -1 +0,0 @@
-
diff --git a/docs/details/reference-schemas.md b/docs/details/reference-schemas.md
new file mode 100644
index 000000000..ec99c1f0d
--- /dev/null
+++ b/docs/details/reference-schemas.md
@@ -0,0 +1,69 @@
+# Fachschemarefenzen auf Fachstandards und Rahmenwerke abbilden
+
+Im Folgenden wird aufgezeigt, wie Fachschemarerenzen für Fachdatensätze auf bestehende Fachstandards und Rahmenwerke abgebildet werden. Aktuell
+werden folgende Fachstandards und Rahmenwerke beschrieben:
+
+Soll ein anderer Fachstandard mit der FIT-Conect Submission API übermittelt werden, können wir gerne die Beschreibung dieser Schemareferenz hier aufnehmen,
+um diese Informationen einem breiteren Nutzerkreis zugänglich zu machen. Hierzu bitte einfach Issue [hier](https://git.fitko.de/fit-connect/docs) aufmachen
+und gerne schon einen konkreten Vorschlag zuliefern.
+
+## Aufbau Fachschemareferenz
+
+Eine Fachschemareferenz besteht aus zwei Angaben.
+- Die `schemaURI` referenziert das zu verwendende Fachschema.
+- Der `mimeType` gibt den Datentyp (JSON oder XML) der Fachdaten vor.
+
+Bitte beachten Sie, dass manche Fachschema nur JSON oder XML als Datentyp zulassen.
+
+## FIM Fachschemareferenz
+
+Um ein FIM Fachschema eindeutig zu referenzieren sind folgende Angaben notwendig:
+
+- **ID** des Stammdatenschemas mit kleinem "S" ("s00000000009" im Beispiel)
+- **Version** des Stammdatenschemas ("1.0.0" im Beispiel)
+- **Art** des Schemas (JSON oder XML Schema)
+
+Für ein JSON Schema wird die schemaURI wird wie folgt gebildet:
+`https://schema.fitko.de/fim/{ID}_{Version}.schema.json`
+
+Für ein XML Schema wird die schemaURI wird wie folgt gebildet:
+`https://schema.fitko.de/fim/{ID}_{Version}.xsd`
+
+### Beispiel für eine FIM Fachschemareferenz
+
+JSON Schema:
+```json
+  {
+    "schemaURI": "https://schema.fitko.de/fim/s00000000009_1.0.0.schema.json",
+    "mimeType": "application/json"
+  }
+```
+
+XML Schema:
+```json
+  {
+    "schemaURI": "https://schema.fitko.de/fim/s00000000009_1.0.0.xsd",
+    "mimeType": "application/xml"
+  }
+```
+
+## XÖV Fachschemareferenz
+
+Ein XÖV Fachschema wird über folgende Angaben referenziert:
+- **Kennung** (ID) des Fachschemas ("urn:xoev-de:bmk:standard:xbau" im Beispiel)
+- **Version** des Fachschemas ("2.2" im Beispiel)
+- Verwendete **Nachricht** aus dem Fachschema ("baugenehmigung.antrag.0200" im Beispiel)
+
+Beispiel: `urn:xoev-de:bmk:standard:xbau_2.2#baugenehmigung.antrag.0200`
+
+Die schemaURI wird wie folgt gebildet:
+`{Kennung}_{Version}#{Nachricht}`
+
+### Beispiel für eine XÖV Fachschemareferenz
+
+```json
+  {
+    "schemaURI": "urn:xoev-de:bmk:standard:xbau_2.2#baugenehmigung.antrag.0200",
+     "mimeType": "application/xml"
+  }
+```
diff --git a/docs/getting-started/submission-structure.md b/docs/getting-started/submission-structure.md
index 0acd39394..1eff1d844 100644
--- a/docs/getting-started/submission-structure.md
+++ b/docs/getting-started/submission-structure.md
@@ -1,4 +1,4 @@
-# Einreichungen / Submissions
+# Einreichungen
 
 Der zentrale Anwendungsfall 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.
@@ -31,16 +31,16 @@ In den Angaben eines Zustellpunkts befindet es diese Schemareferenz immer innerh
 
 ```json
 
-services: [
+"services": [
     {
-        identifier: "urn:de:fim:leika:leistung:99010003001006",
-        submissionSchemas: [
+        "identifier": "urn:de:fim:leika:leistung:99010003001006",
+        "submissionSchemas": [
             {
-                schemaURI: "https://schema.fitko.de/fim/s00000121_1.0.0.schema.json",
-                mimeType: "application/json"
+                "schemaURI": "https://schema.fitko.de/fim/s00000121_1.0.0.schema.json",
+                "mimeType": "application/json"
             }
         ],
-        regions: [
+        "regions": [
             "DE094750156156",
             "DE09330411"
         ]
-- 
GitLab