diff --git a/assets/images/quick_reference/application_structure.png b/assets/images/quick_reference/application_structure.png new file mode 100644 index 0000000000000000000000000000000000000000..c710d371f1642d88e675ccca4a67cd4d6929a167 Binary files /dev/null and b/assets/images/quick_reference/application_structure.png differ diff --git a/docs/2_Quick Reference.md b/docs/2_Quick Reference.md index 10f7cf6ebae961049b430d93473c09fb2b4b567c..a1f18f2febc28cd8c8b6ab67fc71612763d9e072 100644 --- a/docs/2_Quick Reference.md +++ b/docs/2_Quick Reference.md @@ -1,5 +1,18 @@ # 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 Um Ressourcen eindeutig zu identifizieren, werden in den URLs der REST Endpunkt eine oder mehrere Identifikatoren benutzt. diff --git a/docs/5_Status-_und_Fehlercodes.md b/docs/5_Status-_und_Fehlercodes.md index 2d9468d04d5147b80cd45b3b2eba3f6bce706db1..876a38b247ce7a2a697b21b1264afa8cd779f007 100644 --- a/docs/5_Status-_und_Fehlercodes.md +++ b/docs/5_Status-_und_Fehlercodes.md @@ -30,7 +30,7 @@ Code | Text | Bedeutung ### 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: