diff --git a/docs/sender.md b/docs/sender.md
index 85cedf0199aef981dd2c08d601bf19ecdf8c6fc9..4188ff8be2d7ac0023ba2fd79f975c354e3c009c 100644
--- a/docs/sender.md
+++ b/docs/sender.md
@@ -1,101 +1,22 @@
# Application Sender API
## Transfer Operationen
+### IDs
Es werden folgende Parameter in der URL verwendet:
-- `source-id`: Wird mit dem SourceAccount zugewiesen.
+- `source-id`: Wird mit dem Source Account zugewiesen.
- `destination-id`: Über externes System (Zuständigkeitsfinder) dem Onlineantragsdienst bekannt.
- `application-id`: Vom Zustelldienst vergebene ID für die Übertragung.
-
-
-### [Create Transfer](../reference/sender.json/paths/~1{source-id}~1{destination-id}/post)
+### Operationen
+- [Create Application](../reference/sender.json/paths/~1{source-id}~1{destination-id}/post)
Legt eine neue Ãœbertragung an.
-
-#### Request
-- Body: [Application Metadata ohne ID](../models/application/metadata-no-id.json)
-
-#### Response
-- Body: `application-id`
-
-
-
-### [Add Application Data](../reference/sender.json/paths/~1{source-id}~1{destination-id}~1{application-id}~1data/put)
+- [Add Application Data](../reference/sender.json/paths/~1{source-id}~1{destination-id}~1{application-id}~1data/put)
Fügt dem Antrag strukturierte Daten hinzu.
-
-#### Request application/json
-- Body: Strukturierte JSON-Daten, die dem in der Application angegebenen ApplicationSchema entsprechen.
-
-#### Request application/xml
-- Body: Strukturierte XML-Daten, die dem in der Application angegebenen ApplicationSchema entsprechen.
-
-#### Response
-- Body: (leer)
-
-#### Falls Transfer-ID ungültig/Transfer-Timeout
-- HTTP 410 Gone
-- Body: [Error](../models/error.json)
-
-#### Falls Kein Schema zugeordnet
-- HTTP 406 Not Acceptable
-- Body: [Error](../models/error.json)
-
-#### Falls Übertragung zu groß
-- HTTP 413 Request Entity Too Large
-- Body: [Error](../models/error.json)
-
-#### Falls Schemafehler
-- HTTP 406 Not Acceptable
-- Body: [Error](../models/error.json)
-
-
-
-### [Add Application Document](../reference/sender.json/paths/~1{source-id}~1{destination-id}~1{application-id}~1docs~1{doc-id}/put)
+- [Add Application Document](../reference/sender.json/paths/~1{source-id}~1{destination-id}~1{application-id}~1docs~1{doc-id}/put)
Ãœbermittelt ein Antragsformular oder eine Anlage.
-
-#### Request
-- Body: FIXME
-
-#### Response
-- Body: (leer)
-
-#### Falls Transfer-ID ungültig/Transfer-Timeout
-- HTTP 410 Gone
-- Body: [Error](../models/error.json)
-
-#### Falls der Body bzw. das Dokument kein PDF ist
-- HTTP 415 Unsupported Media Type
-- Body: [Error](../models/error.json)
-
-#### Falls Signaturprüfung nicht erfolgreich - Signatur passt nicht zum Dokument
-- HTTP 400 Bad Request
-- Body: [Error](../models/error.json)
-
-
-
-### [Commit Transfer](../reference/sender.json/paths/~1{source-id}~1{destination-id}~1{application-id}/post)
+- [Send Application](../reference/sender.json/paths/~1{source-id}~1{destination-id}~1{application-id}/post)
Beendet die Übertragung des Antrags und löst seinen Versand aus.
-
-#### Request
-- Body: (leer)
-
-#### Response
-- Body: [Status](../models/status.json)
-
-#### Falls die Übertragung unvollständig ist
-- HTTP 400 Bad Request
-- Body: [Error](../models/error.json)
-
-#### Falls die Application-ID ungültig ist
-- HTTP 410 Gone
-- Body: [Error](../models/error.json)
-
-#### Falls die Gesamtübertragung zu groß ist
-- HTTP 413 Request Entity Too Large
-- Body: [Error](../models/error.json)
-
-
-
-### [Get Application Upload Status](../reference/sender.json/paths/~1{source-id}~1{destination-id}~1{application-id}~1upload-status/get)
+- [Get Application Upload Status](../reference/sender.json/paths/~1{source-id}~1{destination-id}~1{application-id}~1upload-status/get)
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. Der Status kann folgende Werte haben:
-- `missing`: Es wurden noch keine Daten hochgeladen (`length` = 0).
-- `partial`: Es wurden bereits Daten hochgeladen, jedoch weniger als in den Metadaten angegeben (0 < `length` < `size` aus Metadaten).
-- `complete`: Die Übertragung ist vollständig (`length` = `size` aus Metadaten).
+ - `missing`: Es wurden noch keine Daten hochgeladen (`length` = 0).
+ - `partial`: Es wurden bereits Daten hochgeladen, jedoch weniger als in den Metadaten angegeben (0 < `length` < `size` aus Metadaten).
+ - `complete`: Die Übertragung ist vollständig (`length` = `size` aus Metadaten).
diff --git a/docs/subscriber.md b/docs/subscriber.md
index b61a1e5f60572bb308735b0e88c311c487eba270..83b97eb37c3fbac317bb84ea73c51206ae19a292 100644
--- a/docs/subscriber.md
+++ b/docs/subscriber.md
@@ -1,100 +1,27 @@
# Application Subscriber API
## Subscriber Operationen
+### Destination Operationen
Mit diesem Satz von Operationen werden die Abonnements (Subscriptions bzw. Destinations) des Backends/Subscribers verwaltet.
-
-
-
-### [Create Destination](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations/post)
+- [Create Destination](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations/post)
Legt ein neues Ãœbertragungsziel (Destination) an.
-
-#### Request
-- Body: [Destination](../models/destination.json)
-
-#### Response
-- Body: destination-id
-
-Beispiel:
-```json
-{ "destination-id": "123e4567-e89b-12d3-a456-426655440000" }
-```
-**Hinweis:** Die `destination-id` kann, muss aber keine UUID sein. Der Subscriber hat sie als einen beliebigen String zu behandeln.
-
-
-
-### [List Destinations](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations/get)
+- [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)
+- [Get Destination](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}/get)
Ruf die Daten eines Ãœbertragungsziels (Destination) ab.
-
-
-
-### [Update Destination](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}/put)
+- [Update Destination](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}/put)
Aktualisiert ein Ãœbertragungsziel (Destination).
-
-
-
-### [Delete Destination](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}/delete)
+- [Delete Destination](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}/delete)
Löscht ein Übertragungsziel (Destination).
-
-
-## Application Operationen
+### Application Operationen
Mit diesem Satz von Operationen wird nach wartenden Transfers/Applications gesucht und diese abgeholt.
-
-
-
-### [List Applications](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}~1applications/get)
+- [List Applications](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}~1applications/get)
Ruft die Liste der wartenden Ãœbertragungen (Applications) ab.
-
-
-
-### [Get Application](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}~1applications~1{application-id}/get)
+- [Get Application](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}~1applications~1{application-id}/get)
Ruft eine wartende Ãœbertragung (Application) ab.
-
-
-
-### [Get Application Data](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}~1applications~1{application-id}~1application-data/get)
+- [Get Application Data](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}~1applications~1{application-id}~1application-data/get)
Ruft die Fachdaten einer Ãœbertragung (Application Data) ab.
-
-Beispiele:
-#### JSON
-```json
-{
- "F99000001": "Eins",
- "G99000001": {
- "F99000002": "Zwei",
- "F99000003": "Drei"
- }
-}
-```
-
-#### XML
-```xml
-<S99000001>
- <F99000001>Eins</F99000001>
- <G99000001>
- <F99000002>Zwei</F99000002>
- <F99000003>Drei</F99000003>
- </G99000001>
-</S99000001>
-```
-
-
-
-### [Get Application Form](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}~1applications~1{application-id}~1application-forms~1{form-id}/get)
-Ruft ein Antragsformular einer Ãœbertragung (Application Form) ab.
-
-
-
-### [Get Attachment](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}~1applications~1{application-id}~1attachments~1{attachment-id}/get)
-Ruft eine Anlage einer Ãœbertragung (Attachment) ab.
-
-
-
-### [Commit Application](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}~1applications~1{application-id}/post)
+- [Get Application Document](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}~1applications~1{application-id}~1docs~1{doc-id}/get)
+Ruf ein Dokument (Formular oder Anlage) der Application ab.
+- [Acknowledge Application](../reference/subscriber.json/paths/~1{subscriber-id}~1destinations~1{destination-id}~1applications~1{application-id}/post)
Quittiert die Abholung der Ãœbertragung.
-
-
diff --git a/reference/sender.json b/reference/sender.json
index 7476433bd5065a0e80471bf330f5db8bbd7a9182..0b725f0cf5bf0efd080bf05130107b8ec8291628 100644
--- a/reference/sender.json
+++ b/reference/sender.json
@@ -64,7 +64,7 @@
}
},
"410": {
- "description": "Gone - Transfer-ID ungültig/Transfer-Timeout",
+ "description": "Gone - Application-ID ungültig/Transfer-Timeout",
"content": {
"application/json": {
"schema": {
@@ -170,7 +170,7 @@
}
},
"410": {
- "description": "Gone - Transfer-ID ungültig/Transfer-Timeout",
+ "description": "Gone - Application-ID ungültig/Transfer-Timeout",
"content": {
"application/json": {
"schema": {
@@ -468,8 +468,8 @@
}
],
"post": {
- "summary": "Create Transfer",
- "operationId": "create-transfer",
+ "summary": "Create Application",
+ "operationId": "create-application",
"responses": {
"201": {
"description": "Created",
@@ -518,7 +518,7 @@
}
}
},
- "description": "Transfer"
+ "description": "Metadaten des Antrags"
},
"description": "Ãœbertragung initiieren"
},
@@ -581,8 +581,8 @@
}
],
"post": {
- "summary": "Commit Transfer",
- "operationId": "commit-transfer",
+ "summary": "Send Application",
+ "operationId": "commit-application",
"responses": {
"200": {
"description": "OK",
@@ -605,7 +605,7 @@
}
},
"410": {
- "description": "Gone - Transfer-ID ungültig/Transfer-Timeout",
+ "description": "Gone - Application-ID ungültig/Transfer-Timeout",
"content": {
"application/json": {
"schema": {
@@ -625,7 +625,7 @@
}
}
},
- "description": "Übertragung abschließen",
+ "description": "Übertragung abschließen, Antrag absenden",
"parameters": [],
"tags": [
"transfer"
diff --git a/reference/subscriber.json b/reference/subscriber.json
index de926c089fa46d11f105dd1f4a86194fc8dfd43f..d8cb63c49b8e421753dbabaf5ec4dfc4f82d829b 100644
--- a/reference/subscriber.json
+++ b/reference/subscriber.json
@@ -119,13 +119,25 @@
"schema": {
"type": "object",
"properties": {}
+ },
+ "examples": {
+ "example-1": {
+ "value": {
+ "F99000001": "Eins",
+ "G99000001": {
+ "F99000002": "Zwei",
+ "F99000003": "Drei"
+ }
+ }
+ }
}
},
"application/xml": {
"schema": {
"type": "object",
"properties": {}
- }
+ },
+ "examples": {}
}
}
},
@@ -134,7 +146,7 @@
}
},
"operationId": "get-application-data",
- "description": "Ruft die Fachdaten der Application ab."
+ "description": "Ruft die Fachdaten der Application ab.\n\nBeispiele:\n#### JSON\n```json\n{\n \"F99000001\": \"Eins\",\n \"G99000001\": {\n \"F99000002\": \"Zwei\",\n \"F99000003\": \"Drei\"\n }\n}\n```\n\n#### XML\n```xml\n<S99000001>\n <F99000001>Eins</F99000001>\n <G99000001>\n <F99000002>Zwei</F99000002>\n <F99000003>Drei</F99000003>\n </G99000001>\n</S99000001>\n```"
}
},
"/{subscriber-id}/destinations/{destination-id}/applications/{application-id}": {
@@ -294,8 +306,8 @@
"description": "Ruft eine wartende Application ab."
},
"post": {
- "summary": "Commit Application",
- "operationId": "commit-application",
+ "summary": "Acknowledge Application",
+ "operationId": "ack-application",
"responses": {
"200": {
"description": "OK"