From cbabc6688a22be16375cdff4821fd3c16f839ee3 Mon Sep 17 00:00:00 2001
From: PublicServiceGuy <alexander.hoose@fitko.de>
Date: Mon, 30 Mar 2020 23:46:09 +0200
Subject: [PATCH] =?UTF-8?q?=C3=9Cberarbeitung=20Kurzreferenz=20und=20Statu?=
 =?UTF-8?q?s=20und=20Fehlercodes?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/2_Quick_Reference.md         | 17 +++++++----------
 docs/5_Status-_und_Fehlercodes.md |  8 ++++----
 2 files changed, 11 insertions(+), 14 deletions(-)

diff --git a/docs/2_Quick_Reference.md b/docs/2_Quick_Reference.md
index af21e38e..0f1ec258 100644
--- a/docs/2_Quick_Reference.md
+++ b/docs/2_Quick_Reference.md
@@ -4,20 +4,17 @@
 
 ![application_structure](https://raw.githubusercontent.com/fiep-poc/assets/master/images/quick_reference/application_structure.png "Struktur des XFall Antrags")
 
-Der XFall Antrag (`application`) ist das zentrale Geschäftsobjekt in der XFall API. Dieser besteht aus den Fachdaten (`data`) und den beigefügten Anhängen (`document`) und wird über Metadaten beschrieben.
+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](../models/application/metadata.json)) 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 Fachdaten und die enthaltenen Anhänge:
+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.
 
-- 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 Fachdaten
-- Anzahl und Strukturinformationen zu den enthaltenen 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. 
 
-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.
+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 Endpunkt eine oder mehrere Identifikatoren (IDs) benutzt. 
+Um Ressourcen eindeutig zu identifizieren, werden in den URLs der REST Endpunkte eine oder mehrere Identifikatoren (IDs) benutzt. 
 
 ### Von der API bereitgestellte IDs
 #### application-id
@@ -52,9 +49,9 @@ Darüber hinaus stehen dem Sender folgende weitere Operationen zur Verfügung:
 - [Get Destination](../reference/sender.json/paths/~1{source-id}~1{destination-id}/get) - Ruft übertragungsrelevante Informationen über den Zustellpunkt (bspw. zulässige Schemata oder Datentypen) ab.
 - [Get Status](../reference/sender.json/paths/~1{source-id}~1{application-id}~1status/get) - Ruft den Status sowie die Statushistorie der Zustellung des Antrags ab.
 
-## Operation derApplication Subscriber API
+## Operation der Application Subscriber API
 
-Mit diesen Operationen kann der Subscriber einer oder mehrere Zustellpunkte (`Destinations`) verwalten:
+Mit diesen Operationen kann der Subscriber eine oder mehrere Zustellpunkte (`Destinations`) verwalten:
 - [Create Destination](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations/post) - Legt ein neues Ãœbertragungsziel (Destination) an.
 - [List Destinations](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations/get) - Listet alle Ãœbertragungsziele (Destinations) eines Subscribers auf.
 - [Get Destination](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}/get) - Ruf die Daten eines Ãœbertragungsziels (Destination) ab.
diff --git a/docs/5_Status-_und_Fehlercodes.md b/docs/5_Status-_und_Fehlercodes.md
index 193f6998..e79a8300 100644
--- a/docs/5_Status-_und_Fehlercodes.md
+++ b/docs/5_Status-_und_Fehlercodes.md
@@ -1,8 +1,8 @@
 # Status- und Fehlercodes
 
-Die XFall APIs liefert in allen Responses die entsprechenden HTTP Response Codes. In der aktuell vorliegenden API Version werden nur HTTP Response Codes verwendet, die im [RFC 7231](https://tools.ietf.org/html/rfc7231) beschrieben sind. 
+Die XFall RESTful API liefert in allen Responses HTTP Response Codes. In der aktuell vorliegenden API Version werden nur HTTP Response Codes verwendet, die im [RFC 7231](https://tools.ietf.org/html/rfc7231) beschrieben sind. 
 
-API Clients sollten aber gemäß RFC 7231 so implementiert, dass auch unbekannte Response Status Codes  (Neue verwendete Standardcodes oder proprietäre Erweiterungen) gemäß ihrer Statusklasse interpretiert werden können:
+API Clients sollten aber gemäß RFC 7231 so implementiert, dass auch unbekannte Response Status Codes (Neue Standardcodes oder proprietäre Erweiterungen) gemäß ihrer Statusklasse interpretiert werden können:
 >    "HTTP status codes are extensible.  HTTP clients are not required to
    understand the meaning of all registered status codes, though such
    understanding is obviously desirable.  However, a client MUST
@@ -30,9 +30,9 @@ Code | Text | Bedeutung
 
 ### Detailangaben zu clientseitig verursachten Fehlern
 
-Bei durch den API-Client verursachte Fehler (HTTP Statusklasse 4XX), liefert die API im Response Body einen [Error Body](../models/error-body.json) 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 Body](../models/error-body.json) Mitteilung mit detaillierten Angaben, wodurch der Fehler versacht wurde. 
 
-Eine Error Mitteilung enthält dabei folgende Angaben:
+Eine Error Mitteilung enthält folgende Angaben:
 
     code: Standardisierter Fehlercode
 
-- 
GitLab