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

Ergänzung XFall Antrag / Application in der Kurzreferenz

parent f3be794e
No related branches found
No related tags found
2 merge requests!4Documentation integriert,!5Version 0.2
assets/images/quick_reference/application_structure.png

10.4 KiB

# API-Kurzreferenz # API-Kurzreferenz
## Der XFall Antrag
![application_structur]( "Struktur des XFall Antrags")
Die Metadaten des Antrags ([Application Metadata](../models/application/metadata.json)) entsprechen dem früheren XFall-Container und enthalten allgemeine Informationen über den Antrag, die enthaltenen Antragsfachdaten und die enthaltenen Anhänge:
- Die `application-id` zur eindeutigen Identifizierung des Antrags (diese wird erst nach initialer Anlage der Antragsressource von der API vergeben)
- Fachliche Informationen über den Antrag (zusätzliche Prozessinfromationen, Antragssteller oder Bezahlinformationen)
- Angaben zu, verwendeten Schema in den Antragsfachdaten
- Anzahl und Strukturinformationen zu den enthaltenen Anhängen
## IDs in den XFall Endpunkten ## IDs in den XFall Endpunkten
Um Ressourcen eindeutig zu identifizieren, werden in den URLs der REST Endpunkt eine oder mehrere Identifikatoren benutzt. Um Ressourcen eindeutig zu identifizieren, werden in den URLs der REST Endpunkt eine oder mehrere Identifikatoren benutzt.
......
...@@ -30,7 +30,7 @@ Code | Text | Bedeutung ...@@ -30,7 +30,7 @@ Code | Text | Bedeutung
### Detailangaben zu clientseitig verursachten Fehlern ### Detailangaben zu clientseitig verursachten Fehlern
Bei durch den API-Client verursachte Fehler (HTTP Statusklasse 4XX), liefert die API im Response Body eine Error Mitteilung mit detaillierten Angaben, wodurch der Fehler versacht wurde. Bei durch den API-Client verursachte Fehler (HTTP Statusklasse 4XX), liefert die API im Response Body eine [Error](../models/error.json) Mitteilung mit detaillierten Angaben, wodurch der Fehler versacht wurde.
Eine Error Mitteilung enthält dabei folgende Angaben: Eine Error Mitteilung enthält dabei folgende Angaben:
......
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