Zum Hauptinhalt springen

Aufbau einer Einreichung

Der zentrale Anwendungsfall der Submission API besteht darin, Daten im Rahmen von Verwaltungsverfahren an hoheitliche Stellen (Behörden, Handelskammern, etc.) zu übermitteln. Diese Daten werden durch Kunden und Verfahrenspartner übermittelt, um Verfahren (bspw. über einen Antrag) zu starten oder um Berichtspflichten zu erfüllen.

Diese Datenübermittlung wird in der Submission API als Einreichung (submission) bezeichnet und besitzt eine festgelegte Struktur aus Datenobjekten, die über die Ressourcen der Submission API abgebildet werden. Mit dieser Struktur soll eine standardisierte Verarbeitung und Interpretation der einzelnen Bestandteile einer Einreichung ermöglicht werden.

Einreichungen können aus fachlicher Sicht Anträge (bspw. ein strukturierter Datensatz mit den Daten eines Wohngeldantrags und Anlagen in beliebigen Datenformaten wie einer Urkunde als PDF), Berichte (bspw. ein Datensatz wie eine elektronische Bilanz in einem festlegten Berichtsformat für Statistik- oder Sozialmeldungen) oder sonstige prozessauslösende Datensätze sein, die an Systeme von hoheitlichen Stellen übermittelt werden.

Wie ist eine Einreichung aufgebaut?​

Eine Einreichung, die über die Submission API übermittelt wird, besteht aus drei Bestandteilen:

  • 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 Authentisierung des Absenders, Zahlungsinformationen (z.B. von Verfahrensgebühren) oder Rückkanalwünsche.

Struktur einer Einreichung

Wie stimmen sich sendende und empfangende Systeme beim Inhalt einer Einreichung ab?​

Ein empfangendes System legt in seinem Zustellpunkt das Schema der Fachdaten fest.

Ein sendendes System muss Fachdaten senden, die diesem Schema entsprechen.

Eine Fachschemareferenz besteht aus zwei Angaben:

  • Die schemaUri referenziert das zu verwendende Fachschema.
  • Der mimeType gibt den Datentyp (JSON oder XML) des Fachdatensatzes vor.

Ein sendendes System ermittelt die Fachdatenreferenz, die ein Zustellpunkt verwendet, durch den Aufruf des Endpunkts GET /v2/destinations/{destinationId} der Submission API.

In der Antwort steht die Fachschemareferenz im publicServices Arrays, unter submissionSchemas:

"publicServices":[
   {
      "identifier":"urn:de:fim:leika:leistung:99010003001006",
      "submissionSchemas":[
         {
            "schemaUri":"https://schema.fim.fitko.net/immutable/schemas/S00000121V1.0_2024-01-22-1705941957653.schema.json",
            "mimeType":"application/json"
         }
      ],
      "regions":[
         "DE094750156156",
         "DE09330411"
      ]
   },
      ...
   ]

Die Fachschemareferenz ist im Zustellpunkt immer einer dazugehörigen Leistung zugeordnet (siehe Beispiel oben).

Zudem können Sie die Fachdatenreferenz über die Routing API ermitten, wie dies die Seite Zustellunkt ermitteln beschreibt.

Bietet ein Zustellpunkt zwei oder mehr Schemata an, dann muss der zu sendende Fachdatensatz einem Schemata entsprechen:

          "submissionSchemas":[
                  {
                     "schemaUri":"https://schema.fim.fitko.net/immutable/schemas/S00000092V1.1_2024-03-27-1711553458904.schema.json",
                     "mimeType":"application/json"
                  },
                  {
                     "schemaUri":"https://schema.fim.fitko.net/immutable/schemas/S00000103V1.0_2024-01-22-1705941847100.schema.json",
                     "mimeType":"application/json"
                  }
               ]

Eintrag in den Metadaten erforderlich​

Ein sendendes System (Onlinedienst) muss die Referenz auf das verwendete Fachdatenschema in die Metadaten einer Einreichung eintragen:

"contentStructure": {
  "data": {
    "submissionSchema": {
      "schemaUri": "https://schema.fim.fitko.net/immutable/schemas/S00000092V1.1_2024-03-27-1711553458904.schema.json",
      "mimeType": "application/json"
    }
  }
}

Insbesondere wenn ein empfangendes System viele unterschiedliche Schemata über den Zustellpunkt unterstützt, hilft diese Angabe bei der effizienten Validierung des Fachdatensatzes. Dies ist insbesondere dann relevant, wenn keine eindeutige Schemareferenz im Fachdatensatz enthalten ist.

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 System ü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. Ein empfangendes System sollte mindestens Anlagen im PDF-Format akzeptieren.

Es wird für sendende Systeme empfohlen, auf den Versand eigener proprietärer Anlagen zu verzichten, wenn deren Nutzung nicht explizit mit den empfangenden Stellen abgestimmt wurde.

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 im Artikel Fachdaten.