Skip to content
Snippets Groups Projects
Select Git revision
  • renovate/stoplight-spectral-6.x
  • main default protected
  • prototyping/process-support
  • 2288_BundID_instead_of_DeutschlandID
  • size-limits
  • release/1.2.1
  • release/1.2.0
  • beta7
  • beta6
  • beta5
  • encryption
  • 1.14.0
  • 1.13.0
  • 1.12.0
  • 1.11.0
  • 1.10.0
  • 1.9.0
  • 1.8.0
  • 1.7.0
  • 1.6.0
  • 1.5.0
  • 1.4.2
  • 1.4.1
  • 1.4.0
  • 1.3.0
  • 1.2.1
  • 1.2.0
  • 1.1.3
  • 1.1.2
  • 1.1.1
  • 1.1.0
31 results
Blame Permalink
2_Quick_Reference.md 5.62 KiB

API-Kurzreferenz

Der XFall Antrag

application_structure

Der XFall Antrag (application) ist das zentrale Geschäftsobjekt in der XFall API. Der XFall Antrag besteht aus den Fachdaten (data) sowie den beigefügten Anhängen (document) und wird über die Metadaten (application metadata) beschrieben.

Die Metadaten des Antrags entsprechen dem früheren XFall-Container und enthalten übergreifenden Informationen über den Antrag sowie Strukturinformationen zu den enthaltenen Fachdaten und Anhängen.

Fachdaten bezeichnen in XFall Antrag im einen strukturieren Datensatz in XML oder JSON und können über ein externes Schema (bspw. aus FIM) beschrieben werden.

Anhänge können entweder klassische Anhänge (bspw. Nachweise) oder oder eine PDF-Repräsentation der Fachdaten des Antrags, falls eine solche alternative Repräsentation aus rechtlichen, technischen oder organisatorischen Gründen notwendig ist.

Identifikatoren der XFall Ressourcen

Um Ressourcen eindeutig zu identifizieren, werden in den URLs der REST Endpunkte eine oder mehrere Identifikatoren (IDs) benutzt.

Von der API bereitgestellte IDs

applicationId

Der Zustelldienst weist jedem übertragenen Antrag (application) eine global eindeutige applicationId zu, die diesen Antrag dauerhaft über den gesamten Bearbeitungsverlauf eindeutig identifiziert.

destinationId

Die destinationId ist eine vom Zustelldienst vergebene ID für einen durch den Subscriber angelegten Zustellpunkt (destination). Diese ID wird dem Sender über externe Systeme (bspw. Zuständigkeitsfinder) oder bilaterale Absprachen zwischen beiden Seiten mitgeteilt.

Vom Sender vergebene Identifikatoren

docId

Der Sender vergibt für jedes Antragsformular und jede Anlage in einer Übertragung eine docId. Diese muss für alle Dokumente (PDF-Antragsformulare und beliebige Anlagen) in der Übertragung eindeutig sein. Es wird empfohlen, die IDs 1, 2 etc. zu verwenden.

Operation der Application Sender API

Mit folgenden Operationen kann der Sender eine Application übertragen und die Übertragung verwalten:

  • Create Application - Legt eine neue Übertragung durch Übermittlung der Metadaten an.
  • Add Application Data - Fügt dem Antrag strukturierte Daten (Fachdaten) hinzu.
  • Add Application Document - Übermittelt ein Antragsformular oder eine Anlage.
  • Send Application - Beendet die Übertragung des Antrags und löst seinen Versand aus.
  • Get Application Upload Status - Ruft den Status der Uploads der Teile der Übertragung ab. Für die Fachdaten und Dokumente wird jeweils der Status und die auf dem Server vorliegende Länge in Bytes zurückgegegben.

Darüber hinaus stehen dem Sender folgende weitere Operationen zur Verfügung:

  • Get Destination Info - Ruft übertragungsrelevante Informationen über den Zustellpunkt (bspw. zulässige Schemata oder Datentypen) ab.
  • Get Status - Ruft den Status sowie die Statushistorie der Zustellung des Antrags ab.

Operation der Application Subscriber API

Mit diesen Operationen kann der Subscriber eine oder mehrere Zustellpunkte (Destinations) verwalten:

Mit diesen Operationen wird nach wartenden Applications gesucht und diese abgeholt: