From 2bd3235efb9916f0c35b5c65166c93e759d8a8b6 Mon Sep 17 00:00:00 2001 From: PublicServiceGuy <alexander.hoose@fitko.de> Date: Fri, 27 Mar 2020 09:36:42 +0100 Subject: [PATCH] Application Structure eingearbeitet in Kurzreferenz --- docs/2_Quick Reference.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/docs/2_Quick Reference.md b/docs/2_Quick Reference.md index a1f18f2f..ef34af6e 100644 --- a/docs/2_Quick Reference.md +++ b/docs/2_Quick Reference.md @@ -4,15 +4,17 @@ ![application_structur]( "Struktur des XFall Antrags") +Der XFall Antrag ist das zentrale Element in der XFall API. Dieser besteht aus den Fachdaten (`Data`) und den beigefügten Anhängen (`document`). Der Antrag selbst wird über Metadaten beschrieben. - -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 Metadaten des Antrags ([Application Metadata](../models/application/metadata.json)) entsprechen dem früheren XFall-Container und enthalten allgemeine Informationen über den Antrag, die enthaltenen Fachdaten 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 +- Angaben zu, verwendeten Schema in den Fachdaten - Anzahl und Strukturinformationen zu den enthaltenen Anhängen +Fachdaten bezeichnen in XFall 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) sein oder oder eine PDF Representation des Fachantrags, falls dies aus rechtlichen oder technischen Gründen notwendig ist. + ## IDs in den XFall Endpunkten Um Ressourcen eindeutig zu identifizieren, werden in den URLs der REST Endpunkt eine oder mehrere Identifikatoren benutzt. -- GitLab