Skip to content
Snippets Groups Projects
Commit f1830409 authored by Alexander Hoose's avatar Alexander Hoose
Browse files

Aktualisieren docs/getting-started/submission-structure.md,...

Aktualisieren docs/getting-started/submission-structure.md, docs/details/reference-schemas.md Dateien
parent e9ee65d6
No related branches found
No related tags found
1 merge request!14Aktualisieren docs/getting-started/submission-structure.md,...
# 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"
}
```
# 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. 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. 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 ...@@ -31,16 +31,16 @@ In den Angaben eines Zustellpunkts befindet es diese Schemareferenz immer innerh
```json ```json
services: [ "services": [
{ {
identifier: "urn:de:fim:leika:leistung:99010003001006", "identifier": "urn:de:fim:leika:leistung:99010003001006",
submissionSchemas: [ "submissionSchemas": [
{ {
schemaURI: "https://schema.fitko.de/fim/s00000121_1.0.0.schema.json", "schemaURI": "https://schema.fitko.de/fim/s00000121_1.0.0.schema.json",
mimeType: "application/json" "mimeType": "application/json"
} }
], ],
regions: [ "regions": [
"DE094750156156", "DE094750156156",
"DE09330411" "DE09330411"
] ]
......
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