Skip to content
Snippets Groups Projects
Commit 03cb6ac2 authored by David Schwarzmann's avatar David Schwarzmann
Browse files

refactor: rename delivery service page to api spec

parent ad5e31c9
No related branches found
No related tags found
1 merge request!38Adapt the schema URL for displaying/loading the api spec
File moved
......@@ -44,7 +44,7 @@ Weiterhin ist es notwendig, dass die Id der Einreichung und des zugehörigen Vor
```
Die Payload- und Header-Attribute des SET müssen wie oben beschrieben definiert werden (siehe markierte Zeilen).
Im dritten markierten Block wird das SET mit dem Schlüssel signiert und danach kann der serialisierte Wert an den [Zustelldienst](../../apis/delivery-service.mdx#post-/submissions/-submissionId-/events) gesendet werden.
Im dritten markierten Block wird das SET mit dem Schlüssel signiert und danach kann der serialisierte Wert an den [Zustelldienst](../../apis/submission-api.mdx#post-/submissions/-submissionId-/events) gesendet werden.
```java {3-10,12-16,22-24}
try {
......
......@@ -7,7 +7,7 @@ import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
## Eine neue Einreichung anlegen
Das Anlegen einer neuen Einreichung über die API erfordert den Versand einer [HTTP-POST-Nachricht](../../apis/delivery-service.mdx#post-/submissions), die definiert, an welchen Zustellpunkt der Einreichung versendet werden soll und welche Inhalte übermittelt werden sollen.
Das Anlegen einer neuen Einreichung über die API erfordert den Versand einer [HTTP-POST-Nachricht](../../apis/submission-api.mdx#post-/submissions), die definiert, an welchen Zustellpunkt der Einreichung versendet werden soll und welche Inhalte übermittelt werden sollen.
Die Inhalte umfassen hierbei die Identifikatoren der Anlagen als UUIDs und die Information, ob Fachdaten mit versendet werden oder nicht.
Die UUIDs der Anlagen müssen eindeutig sein und werden vom sendenden System festgelegt.
......
......@@ -6,7 +6,7 @@ sidebar_position: 8
import Tabs from '@theme/Tabs'
import TabItem from '@theme/TabItem'
Die Einreichung kann abgeschlossen werden, indem mit einem PUT auf den Endpunkt [/submissions/{submissionId}](../../apis/delivery-service.mdx#put-/submissions/-submissionId-) der Metadatensatz und der Fachdatensatz hochgeladen wird.
Die Einreichung kann abgeschlossen werden, indem mit einem PUT auf den Endpunkt [/submissions/{submissionId}](../../apis/submission-api.mdx#put-/submissions/-submissionId-) der Metadatensatz und der Fachdatensatz hochgeladen wird.
Diese PUT Methode kann nur folgreich durchgeführt werden, wenn folgende Bedingungen vorliegen:
- Es muss immer ein Metadatensatz hochgeladen werden
......
......@@ -16,7 +16,7 @@ Eine Einreichung, die über die Submission API übermittelt wird, besteht aus dr
- Ein optionaler Fachdatensatz (`data`), der die Daten eines Antrags oder Berichts enthält und einem im Zustellpunkt vorgegebenen Datenschema (`submissionSchema`) entspricht.
- Eine oder mehrere optionale Anlagen (`attachments`) ergänzend zum Fachdatensatz. Die können Nachweise in Form von PDF-Urkunden, Bauanlagen wie XPlanGML-basierte Baupläne oder auch technische Laufzettel vom sendenden System sein.
- Ein obligatorischer Metadatensatz `metadata`), der die Einreichung beschreibt und zusammen mit der Submission API im Rahmen von FIT-Connect standardisiert wird.
Dieser enthält Strukturinformationen zum Fachdatensatz und Anlagen sowie prozessrelevante Informationen wie die Authentizierung des Absenders, Zahlungsinformationen (z.B. von Verfahrensgebühren) oder Rückkanalwünschen.
Dieser enthält Strukturinformationen zum Fachdatensatz und Anlagen sowie prozessrelevante Informationen wie die Authentizierung des Absenders, Zahlungsinformationen (z.B. von Verfahrensgebühren) oder Rückkanalwünschen.
## Wie stimmen sich sendende und empfangende Systeme beim Inhalt einer Einreichung ab?
......@@ -60,7 +60,7 @@ Die Fachschemarefenz ist im Zustellpunkt daher immer einer dazugehörigen Leistu
```
Wenn ein sendendes System die Angaben eines Zustellpunkts ermittelt (bspw. über [GET /destinations/{destinationId}](../apis/delivery-service.mdx#get-/destinations/-destinationId-) oder zukünftig die Routing API), so muss der Fachdatensatz diesem Schema entsprechen.
Wenn ein sendendes System die Angaben eines Zustellpunkts ermittelt (bspw. über [GET /destinations/{destinationId}](../apis/submission-api.mdx#get-/destinations/-destinationId-) oder zukünftig die Routing API), so muss der Fachdatensatz diesem Schema entsprechen.
Wenn mehrere Schemata (bspw. innerhalb des `submissionSchemas` Array) im Zustellpunkt referenziert werden, so muss der Fachdatensatz einem dieser referenzierten Schemata entsprechen.
## Warum muss das sendende System über den Metadatensatz eine Fachschemareferenz mitliefern?
......@@ -82,7 +82,7 @@ Insbesondere wenn ein empfangendes System viele unterschiedliche Schemata über
## Sind Vorgaben für die Anzahl der Anlagen und deren Format möglich?
Aktuell sind keine konkreten Vorgaben für die Anzahl und das Format der Anlagen durch ein empfangendes Sytem über die Angaben im Zustellpunkt möglich.
Aktuell sind keine konkreten Vorgaben für die Anzahl und das Format der Anlagen durch ein empfangendes Sytem über die Angaben im Zustellpunkt möglich.
Aktuell existieren lediglich Vorgaben für die Gesamtgröße einer Einreichung (Fachdatensatz+Anlagen), die den Umfang der Anlagen hinsichtlich der Datengrößen begrenzen.
Für sonstige technische Vorgaben für Anlagen wird aktuell davon ausgegangen, dass die Fachstandards, zu denen ein genutzter Fachdatensatz gehört, technische Vorgaben für Anlagen machen. Ansonsten sollte ein empfangendes System im Mimimum PDF als Format für Anlagen akzeptieren.
......
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