diff --git a/assets/images/api_overview/destination-id_publishing_jurisdiction-finder.png b/assets/images/api_overview/destination-id_publishing_jurisdiction-finder.png
index 78575e5c84ef95f0ff15cf97407c022d8cb8e707..890ddd8052401d954a3bd192c2531bdd70ea0a56 100644
Binary files a/assets/images/api_overview/destination-id_publishing_jurisdiction-finder.png and b/assets/images/api_overview/destination-id_publishing_jurisdiction-finder.png differ
diff --git a/assets/images/oauth/01_portal.png b/assets/images/oauth/01_portal.png
new file mode 100644
index 0000000000000000000000000000000000000000..7a00fdf8078ef6563f954f47c59ed6fe9cdb4354
Binary files /dev/null and b/assets/images/oauth/01_portal.png differ
diff --git a/assets/images/oauth/02_register.png b/assets/images/oauth/02_register.png
new file mode 100644
index 0000000000000000000000000000000000000000..811df4d1753d78504a11473495a75eb03f7433e5
Binary files /dev/null and b/assets/images/oauth/02_register.png differ
diff --git a/assets/images/oauth/03_registered.png b/assets/images/oauth/03_registered.png
new file mode 100644
index 0000000000000000000000000000000000000000..459100d33bc858d9e5b6a213b8b16bc0ec57025a
Binary files /dev/null and b/assets/images/oauth/03_registered.png differ
diff --git a/assets/images/oauth/04_settings.png b/assets/images/oauth/04_settings.png
new file mode 100644
index 0000000000000000000000000000000000000000..941191f28f6f90fdefe7449f93d4f00aa0870896
Binary files /dev/null and b/assets/images/oauth/04_settings.png differ
diff --git a/assets/images/oauth/05_language.png b/assets/images/oauth/05_language.png
new file mode 100644
index 0000000000000000000000000000000000000000..646e4c5095599e706bb1e4c79b50de12c20e4850
Binary files /dev/null and b/assets/images/oauth/05_language.png differ
diff --git a/assets/images/oauth/06_apis.png b/assets/images/oauth/06_apis.png
new file mode 100644
index 0000000000000000000000000000000000000000..97ec3ceb962f55781536b5cc7205071d45fc4ec8
Binary files /dev/null and b/assets/images/oauth/06_apis.png differ
diff --git a/assets/images/oauth/07_select_api.png b/assets/images/oauth/07_select_api.png
new file mode 100644
index 0000000000000000000000000000000000000000..e2b3c620d6de7e2803d14e25737e62bad92e08d4
Binary files /dev/null and b/assets/images/oauth/07_select_api.png differ
diff --git a/assets/images/oauth/08_register_client.png b/assets/images/oauth/08_register_client.png
new file mode 100644
index 0000000000000000000000000000000000000000..fc4bbd165f43f06bf1e7f03090d4dd8a5bc4d939
Binary files /dev/null and b/assets/images/oauth/08_register_client.png differ
diff --git a/assets/images/oauth/09_request_token.png b/assets/images/oauth/09_request_token.png
new file mode 100644
index 0000000000000000000000000000000000000000..071f090fd4d78275cd7d1d41aa26db6285ae41ba
Binary files /dev/null and b/assets/images/oauth/09_request_token.png differ
diff --git a/assets/images/oauth/10_goto_applications.png b/assets/images/oauth/10_goto_applications.png
new file mode 100644
index 0000000000000000000000000000000000000000..d33a4ec0dd94dd7fd6fc53930e4272d443dfc12e
Binary files /dev/null and b/assets/images/oauth/10_goto_applications.png differ
diff --git a/assets/images/oauth/11_applications.png b/assets/images/oauth/11_applications.png
new file mode 100644
index 0000000000000000000000000000000000000000..6aba41381cf832e026dbdfdbfc97e3f55151de5a
Binary files /dev/null and b/assets/images/oauth/11_applications.png differ
diff --git a/assets/images/oauth/12_application_details.png b/assets/images/oauth/12_application_details.png
new file mode 100644
index 0000000000000000000000000000000000000000..e60132727a629782ae726a322fc55505090da716
Binary files /dev/null and b/assets/images/oauth/12_application_details.png differ
diff --git a/assets/images/oauth/13_api_zugriff.png b/assets/images/oauth/13_api_zugriff.png
new file mode 100644
index 0000000000000000000000000000000000000000..84f9c1dc74a9f80e9389f7b43e9ff4ee96d390e1
Binary files /dev/null and b/assets/images/oauth/13_api_zugriff.png differ
diff --git a/assets/images/oauth/14_authorization.png b/assets/images/oauth/14_authorization.png
new file mode 100644
index 0000000000000000000000000000000000000000..949d486074a26e9bb176eceba75886463ebf3304
Binary files /dev/null and b/assets/images/oauth/14_authorization.png differ
diff --git a/assets/images/oauth/15_request_token.png b/assets/images/oauth/15_request_token.png
new file mode 100644
index 0000000000000000000000000000000000000000..78eb92bcccf586d3c3486923b99d944c0c071ca4
Binary files /dev/null and b/assets/images/oauth/15_request_token.png differ
diff --git a/assets/images/oauth/16_use_token.png b/assets/images/oauth/16_use_token.png
new file mode 100644
index 0000000000000000000000000000000000000000..7ec8e6fa2536c6672ddb6290c9f101d40ff50a6a
Binary files /dev/null and b/assets/images/oauth/16_use_token.png differ
diff --git a/assets/images/oauth/17_api_call.png b/assets/images/oauth/17_api_call.png
new file mode 100644
index 0000000000000000000000000000000000000000..43cf84b2d8cf8fb93a98e1617263533554921a80
Binary files /dev/null and b/assets/images/oauth/17_api_call.png differ
diff --git a/assets/images/oauth/18_zwei_scopes.png b/assets/images/oauth/18_zwei_scopes.png
new file mode 100644
index 0000000000000000000000000000000000000000..06f423ad28bd1dbf17d7cb6a11e85b67d3e8d72d
Binary files /dev/null and b/assets/images/oauth/18_zwei_scopes.png differ
diff --git a/assets/postman/FIT-Connect.postman_collection.json b/assets/postman/FIT-Connect.postman_collection.json
new file mode 100644
index 0000000000000000000000000000000000000000..64fa7f761c3852e322fedf6973c90564e2256307
--- /dev/null
+++ b/assets/postman/FIT-Connect.postman_collection.json
@@ -0,0 +1,1795 @@
+{
+ "info": {
+ "_postman_id": "aabcbd18-6782-49fb-8a37-5f3feb9857c2",
+ "name": "FIT-Connect",
+ "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
+ },
+ "item": [
+ {
+ "name": "SenderAPI",
+ "item": [
+ {
+ "name": "Application Transfer",
+ "item": [
+ {
+ "name": "Create Application",
+ "event": [
+ {
+ "listen": "prerequest",
+ "script": {
+ "id": "8d9e68fe-65d7-49b4-b638-e88d598b726d",
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "test",
+ "script": {
+ "id": "f54c8eae-9e73-4ca1-a02a-a061091db619",
+ "exec": [
+ "pm.test(\"response must be 200 and has a body\", function () {",
+ " // assert that the status code is 200",
+ " pm.response.to.have.status(200);",
+ " // assert that the response has a valid JSON body",
+ " pm.response.to.be.withBody;",
+ " pm.response.to.have.jsonBody(\"applicationId\");",
+ "});",
+ "",
+ "// extract body",
+ "var jsonData = JSON.parse(responseBody);",
+ "// set application-id",
+ "pm.collectionVariables.set('application_id', jsonData['applicationId']);",
+ "",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "name": "Content-Type",
+ "value": "application/json",
+ "type": "text"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"additionalReferenceInfo\": {\n \"subject\": \"Anmeldung eines Gewerbes in Musterstadt\",\n \"caseId\": \"DF/8923\"\n },\n \"contentStructure\": {\n \"data\": {\n \"schema\": {\n \"mimeType\": \"json\",\n \"schemaSource\": \"none\"\n }\n },\n \"docs\": [\n {\n \"docId\": \"1\",\n \"purpose\": \"form\",\n \"size\": 13046,\n \"mimeType\": \"application/pdf\",\n \"filename\": \"test.pdf\",\n \"description\": \"Das Antragsformular\",\n \"lang\": {\n \"lang\": \"de\",\n \"region\": \"DE\"\n },\n \"hash\": {\n \"algorithm\": \"SHA-256\",\n \"digest\": \"bf37d894fdf9aeade63975ed648d49c3e8a7a773923597d2418915f54cd7c3b9\"\n }\n }\n ]\n },\n \"publicServiceType\": {\n \"name\": \"Gewerbeanmeldung\",\n \"description\": \"Eine Gewerbeanmeldung ist immer dann notwendig, wenn Sie einen stehenden Gewerbebetrieb beginnen.\",\n \"leikaId\": \"99050012104000\",\n \"otherIdentifiers\": [\n {\n \"id\": \"8664844\",\n \"schemeId\": \"service.niedersachsen.de\",\n \"schemeName\": \"Serviceportal Niedersachsen\"\n },\n {\n \"id\": \"354824\",\n \"schemeId\": \"buerger.thueringen.de\",\n \"schemeName\": \"Zuständigkeitsfinder Thüringen\"\n }\n ]\n },\n \"applicants\": [\n {\n \t\"type\": \"person\",\n \"authentificationInfo\": {\n \"assuranceLevel\": \"high\",\n \"authentificationMethod\": \"eID\",\n \"timestamp\": \"2020-03-03T12:38:23Z\"\n },\n \"identityInfo\": {\n \"dateOfBirth\": \"1970-09-13\",\n \"gender\": \"m\",\n \"givenName\": \"WERNER\",\n \"familyName\": \"MUSTERMANN\",\n \"placeOfResidence\": {\n \t\"type\": \"national\",\n \"street\": \"KURZER WEG 7\",\n \"postalCode\": \"12345\",\n \"city\": \"ANKH-MORPORK\"\n }\n },\n \"contactInfo\": {\n \"electronicAddresses\": [\n {\n \"channelType\": \"Service-Account-Mailbox\",\n \"address\": \"3b0c9c8c-0801-45f0-a331-2abfc9db78d0\"\n }\n ],\n \"physicalAddress\": {\n \t\"type\": \"national\",\n \"street\": \"Kurzer Weg\",\n \"houseNumber\": \"7\",\n \"postalCode\": \"12345\",\n \"city\": \"Ankh-Morpork\"\n },\n \"telephone\": [\n {\n \"number\": \"+49 89 32168-42\",\n \"mobile\": true,\n \"description\": \"work\"\n }\n ]\n }\n }\n ],\n \"paymentInfo\": {\n \"reference\": \"TP/93/GDP\",\n \"usage\": \"Gewerbeanmeldung\",\n \"amount\": 17.3,\n \"timestamp\": \"2020-03-03T12:38:23Z\",\n \"status\": \"success\",\n \"transaction\": \"1f77c5f9b759db9cdce59988b24974d465c7be5e462a6185485559ff6e2dea82\"\n }\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ },
+ "url": {
+ "raw": "{{sender_url}}{{sender_id}}/{{destination_id}}",
+ "host": [
+ "{{sender_url}}{{sender_id}}"
+ ],
+ "path": [
+ "{{destination_id}}"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "Create Application",
+ "originalRequest": {
+ "method": "POST",
+ "header": [
+ {
+ "key": "Content-Type",
+ "name": "Content-Type",
+ "value": "application/json",
+ "type": "text"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"additionalReferenceInfo\": {\n \"subject\": \"Anmeldung eines Gewerbes in Musterstadt\",\n \"caseId\": \"DF/8923\"\n },\n \"contentStructure\": {\n \"data\": {\n \"schema\": {\n \"mimeType\": \"json\",\n \"schemaSource\": \"none\"\n }\n },\n \"docs\": [\n {\n \"docId\": \"1\",\n \"purpose\": \"form\",\n \"size\": 13046,\n \"mimeType\": \"application/pdf\",\n \"filename\": \"test.pdf\",\n \"description\": \"Das Antragsformular\",\n \"lang\": {\n \"lang\": \"de\",\n \"region\": \"DE\"\n },\n \"hash\": {\n \"algorithm\": \"SHA-256\",\n \"digest\": \"bf37d894fdf9aeade63975ed648d49c3e8a7a773923597d2418915f54cd7c3b9\"\n }\n }\n ]\n },\n \"publicServiceType\": {\n \"name\": \"Gewerbeanmeldung\",\n \"description\": \"Eine Gewerbeanmeldung ist immer dann notwendig, wenn Sie einen stehenden Gewerbebetrieb beginnen.\",\n \"leikaId\": \"99050012104000\",\n \"otherIdentifiers\": [\n {\n \"id\": \"8664844\",\n \"schemeId\": \"service.niedersachsen.de\",\n \"schemeName\": \"Serviceportal Niedersachsen\"\n },\n {\n \"id\": \"354824\",\n \"schemeId\": \"buerger.thueringen.de\",\n \"schemeName\": \"Zuständigkeitsfinder Thüringen\"\n }\n ]\n },\n \"applicants\": [\n {\n \t\"type\": \"person\",\n \"authentificationInfo\": {\n \"assuranceLevel\": \"high\",\n \"authentificationMethod\": \"eID\",\n \"timestamp\": \"2020-03-03T12:38:23Z\"\n },\n \"identityInfo\": {\n \"dateOfBirth\": \"1970-09-13\",\n \"gender\": \"m\",\n \"givenName\": \"WERNER\",\n \"familyName\": \"MUSTERMANN\",\n \"placeOfResidence\": {\n \t\"type\": \"national\",\n \"street\": \"KURZER WEG 7\",\n \"postalCode\": \"12345\",\n \"city\": \"ANKH-MORPORK\"\n }\n },\n \"contactInfo\": {\n \"electronicAddresses\": [\n {\n \"channelType\": \"Service-Account-Mailbox\",\n \"address\": \"3b0c9c8c-0801-45f0-a331-2abfc9db78d0\"\n }\n ],\n \"physicalAddress\": {\n \t\"type\": \"national\",\n \"street\": \"Kurzer Weg\",\n \"houseNumber\": \"7\",\n \"postalCode\": \"12345\",\n \"city\": \"Ankh-Morpork\"\n },\n \"telephone\": [\n {\n \"number\": \"+49 89 32168-42\",\n \"mobile\": true,\n \"description\": \"work\"\n }\n ]\n }\n }\n ],\n \"paymentInfo\": {\n \"reference\": \"TP/93/GDP\",\n \"usage\": \"Gewerbeanmeldung\",\n \"amount\": 17.3,\n \"timestamp\": \"2020-03-03T12:38:23Z\",\n \"status\": \"success\",\n \"transaction\": \"1f77c5f9b759db9cdce59988b24974d465c7be5e462a6185485559ff6e2dea82\"\n }\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ },
+ "url": {
+ "raw": "{{sender_url}}{{sender_id}}/{{destination_id}}",
+ "host": [
+ "{{sender_url}}{{sender_id}}"
+ ],
+ "path": [
+ "{{destination_id}}"
+ ]
+ }
+ },
+ "status": "Created",
+ "code": 201,
+ "_postman_previewlanguage": "json",
+ "header": [
+ {
+ "key": "Access-Control-Allow-Origin",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Headers",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Credentials",
+ "value": "true"
+ },
+ {
+ "key": "Access-Control-Expose-Headers",
+ "value": "*"
+ },
+ {
+ "key": "content-type",
+ "value": "application/json"
+ },
+ {
+ "key": "date",
+ "value": "Wed, 20 May 2020 06:30:08 GMT"
+ },
+ {
+ "key": "Content-Length",
+ "value": "56"
+ },
+ {
+ "key": "Connection",
+ "value": "keep-alive"
+ }
+ ],
+ "cookie": [],
+ "body": "{\n \"applicationId\": \"0c508e3f-2353-4206-9a1e-34b2e864d5a8\"\n}"
+ }
+ ]
+ },
+ {
+ "name": "Add Applicaiton Data",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "c110688c-44b0-4b0d-a997-8f5f432ba340",
+ "exec": [
+ "pm.test(\"response must be 202 Accepted and without body\", function () {",
+ " // assert that the status code is 200",
+ " pm.response.to.have.status(202); ",
+ "});"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "PUT",
+ "header": [
+ {
+ "key": "Content-Type",
+ "name": "Content-Type",
+ "value": "application/json",
+ "type": "text"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"F99000001\": \"string\",\n \"G99000001\": {\n \"F99000002\": \"string\",\n \"F99000003\": 42\n },\n \"G99000002\": [\n {\n \"F99000004\": true,\n \"G99000001\": {\n \"F99000002\": \"string\",\n \"F99000003\": 17\n }\n },\n {\n \"F99000004\": true,\n \"G99000001\": {\n \"F99000002\": \"string\",\n \"F99000003\": 24\n }\n }\n ]\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ },
+ "url": {
+ "raw": "{{sender_url}}{{sender_id}}/{{destination_id}}/{{application_id}}/data",
+ "host": [
+ "{{sender_url}}{{sender_id}}"
+ ],
+ "path": [
+ "{{destination_id}}",
+ "{{application_id}}",
+ "data"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "Add Applicaiton Data",
+ "originalRequest": {
+ "method": "PUT",
+ "header": [
+ {
+ "key": "Content-Type",
+ "name": "Content-Type",
+ "value": "application/json",
+ "type": "text"
+ }
+ ],
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"F99000001\": \"string\",\n \"G99000001\": {\n \"F99000002\": \"string\",\n \"F99000003\": 42\n },\n \"G99000002\": [\n {\n \"F99000004\": true,\n \"G99000001\": {\n \"F99000002\": \"string\",\n \"F99000003\": 17\n }\n },\n {\n \"F99000004\": true,\n \"G99000001\": {\n \"F99000002\": \"string\",\n \"F99000003\": 24\n }\n }\n ]\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ },
+ "url": {
+ "raw": "{{sender_url}}{{sender_id}}/{{destination_id}}/{{application_id}}/data",
+ "host": [
+ "{{sender_url}}{{sender_id}}"
+ ],
+ "path": [
+ "{{destination_id}}",
+ "{{application_id}}",
+ "data"
+ ]
+ }
+ },
+ "status": "Accepted",
+ "code": 202,
+ "_postman_previewlanguage": "plain",
+ "header": [
+ {
+ "key": "Access-Control-Allow-Origin",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Headers",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Credentials",
+ "value": "true"
+ },
+ {
+ "key": "Access-Control-Expose-Headers",
+ "value": "*"
+ },
+ {
+ "key": "content-length",
+ "value": "0"
+ },
+ {
+ "key": "date",
+ "value": "Wed, 20 May 2020 06:30:24 GMT"
+ },
+ {
+ "key": "Connection",
+ "value": "keep-alive"
+ }
+ ],
+ "cookie": [],
+ "body": null
+ }
+ ]
+ },
+ {
+ "name": "Add Application Document",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "726f1b84-acd9-4bc7-a0cc-78e4d788e5ea",
+ "exec": [
+ "pm.test(\"response must be 202 Accepted and without body\", function () {",
+ " // assert that the status code is 200",
+ " pm.response.to.have.status(202);",
+ "});"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "protocolProfileBehavior": {
+ "disabledSystemHeaders": {}
+ },
+ "request": {
+ "method": "PUT",
+ "header": [
+ {
+ "key": "file",
+ "value": "",
+ "type": "text",
+ "disabled": true
+ }
+ ],
+ "body": {
+ "mode": "file",
+ "file": {
+ "src": "test.pdf"
+ },
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ },
+ "url": {
+ "raw": "{{sender_url2}}{{sender_id}}/{{destination_id}}/{{application_id}}/docs/{{doc_id}}",
+ "host": [
+ "{{sender_url2}}{{sender_id}}"
+ ],
+ "path": [
+ "{{destination_id}}",
+ "{{application_id}}",
+ "docs",
+ "{{doc_id}}"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "Add Application Document",
+ "originalRequest": {
+ "method": "PUT",
+ "header": [
+ {
+ "key": "file",
+ "value": "",
+ "type": "text",
+ "disabled": true
+ }
+ ],
+ "body": {
+ "mode": "file",
+ "file": {
+ "src": "test.pdf"
+ },
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ },
+ "url": {
+ "raw": "{{sender_url2}}{{sender_id}}/{{destination_id}}/{{application_id}}/docs/{{doc_id}}",
+ "host": [
+ "{{sender_url2}}{{sender_id}}"
+ ],
+ "path": [
+ "{{destination_id}}",
+ "{{application_id}}",
+ "docs",
+ "{{doc_id}}"
+ ]
+ }
+ },
+ "status": "Accepted",
+ "code": 202,
+ "_postman_previewlanguage": "plain",
+ "header": [
+ {
+ "key": "Content-Length",
+ "value": "0"
+ },
+ {
+ "key": "Date",
+ "value": "Wed, 20 May 2020 06:30:50 GMT"
+ },
+ {
+ "key": "Keep-Alive",
+ "value": "timeout=60"
+ },
+ {
+ "key": "Connection",
+ "value": "keep-alive"
+ }
+ ],
+ "cookie": [],
+ "body": null
+ }
+ ]
+ },
+ {
+ "name": "Send Application",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "c839dbc4-8af9-49ff-940d-95f496a40a5a",
+ "exec": [
+ "pm.test(\"response must be 200 and have a body\", function () {",
+ " // assert that the status code is 200",
+ " pm.response.to.have.status(200); ",
+ " // assert that the response has a valid JSON body",
+ " pm.response.to.be.withBody;",
+ "});",
+ "",
+ "// extract body",
+ "var jsonData = JSON.parse(responseBody);",
+ "// set application-id",
+ "pm.test(\"Application current status should be Queued\", function(){",
+ " // assert that application current status is \"queued\"",
+ " pm.expect(jsonData.code).to.equal(\"queued\");",
+ "})",
+ "",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [],
+ "url": {
+ "raw": "{{sender_url}}{{sender_id}}/{{destination_id}}/{{application_id}}",
+ "host": [
+ "{{sender_url}}{{sender_id}}"
+ ],
+ "path": [
+ "{{destination_id}}",
+ "{{application_id}}"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "Send Application",
+ "originalRequest": {
+ "method": "POST",
+ "header": [],
+ "url": {
+ "raw": "{{sender_url}}{{sender_id}}/{{destination_id}}/{{application_id}}",
+ "host": [
+ "{{sender_url}}{{sender_id}}"
+ ],
+ "path": [
+ "{{destination_id}}",
+ "{{application_id}}"
+ ]
+ }
+ },
+ "status": "OK",
+ "code": 200,
+ "_postman_previewlanguage": "json",
+ "header": [
+ {
+ "key": "Access-Control-Allow-Origin",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Headers",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Credentials",
+ "value": "true"
+ },
+ {
+ "key": "Access-Control-Expose-Headers",
+ "value": "*"
+ },
+ {
+ "key": "content-type",
+ "value": "application/json"
+ },
+ {
+ "key": "date",
+ "value": "Wed, 20 May 2020 06:31:01 GMT"
+ },
+ {
+ "key": "Content-Length",
+ "value": "75"
+ },
+ {
+ "key": "Connection",
+ "value": "keep-alive"
+ }
+ ],
+ "cookie": [],
+ "body": "{\n \"code\": \"queued\",\n \"timestamp\": \"2020-05-20T08:31:01.135842+02:00\",\n \"number\": 2\n}"
+ }
+ ]
+ }
+ ],
+ "protocolProfileBehavior": {},
+ "_postman_isSubFolder": true
+ },
+ {
+ "name": "Transfer Related Information",
+ "item": [
+ {
+ "name": "Get Application Upload Status",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "c110688c-44b0-4b0d-a997-8f5f432ba340",
+ "exec": [
+ "pm.test(\"response must be 202 Accepted and without body\", function () {",
+ " // assert that the status code is 200",
+ " pm.response.to.have.status(202);",
+ "});"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{sender_url}}{{sender_id}}/{{destination_id}}/{{application_id}}/upload-status",
+ "host": [
+ "{{sender_url}}{{sender_id}}"
+ ],
+ "path": [
+ "{{destination_id}}",
+ "{{application_id}}",
+ "upload-status"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "Get Application Upload Status",
+ "originalRequest": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{sender_url}}{{sender_id}}/{{destination_id}}/{{application_id}}/upload-status",
+ "host": [
+ "{{sender_url}}{{sender_id}}"
+ ],
+ "path": [
+ "{{destination_id}}",
+ "{{application_id}}",
+ "upload-status"
+ ]
+ }
+ },
+ "status": "OK",
+ "code": 200,
+ "_postman_previewlanguage": "json",
+ "header": [
+ {
+ "key": "Access-Control-Allow-Origin",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Headers",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Credentials",
+ "value": "true"
+ },
+ {
+ "key": "Access-Control-Expose-Headers",
+ "value": "*"
+ },
+ {
+ "key": "content-type",
+ "value": "application/json"
+ },
+ {
+ "key": "date",
+ "value": "Wed, 20 May 2020 06:31:16 GMT"
+ },
+ {
+ "key": "Content-Length",
+ "value": "99"
+ },
+ {
+ "key": "Connection",
+ "value": "keep-alive"
+ }
+ ],
+ "cookie": [],
+ "body": "{\n \"data\": {\n \"status\": \"complete\",\n \"length\": 0\n },\n \"docs\": [\n {\n \"status\": \"complete\",\n \"docId\": \"1\",\n \"length\": 13046\n }\n ]\n}"
+ }
+ ]
+ },
+ {
+ "name": "Get Destination Info",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "c110688c-44b0-4b0d-a997-8f5f432ba340",
+ "exec": [
+ "pm.test(\"response must be 202 Accepted and without body\", function () {",
+ " // assert that the status code is 200",
+ " pm.response.to.have.status(202); ",
+ "});"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{sender_url}}{{sender_id}}/{{destination_id}}",
+ "host": [
+ "{{sender_url}}{{sender_id}}"
+ ],
+ "path": [
+ "{{destination_id}}"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "Get Destination (Sender)",
+ "originalRequest": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{sender_url}}{{sender_id}}/{{destination_id}}",
+ "host": [
+ "{{sender_url}}{{sender_id}}"
+ ],
+ "path": [
+ "{{destination_id}}"
+ ]
+ }
+ },
+ "status": "OK",
+ "code": 200,
+ "_postman_previewlanguage": "json",
+ "header": [
+ {
+ "key": "Access-Control-Allow-Origin",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Headers",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Credentials",
+ "value": "true"
+ },
+ {
+ "key": "Access-Control-Expose-Headers",
+ "value": "*"
+ },
+ {
+ "key": "content-type",
+ "value": "application/json"
+ },
+ {
+ "key": "date",
+ "value": "Wed, 20 May 2020 06:35:18 GMT"
+ },
+ {
+ "key": "Content-Length",
+ "value": "778"
+ },
+ {
+ "key": "Connection",
+ "value": "keep-alive"
+ }
+ ],
+ "cookie": [],
+ "body": "{\n \"publicOrganization\": {\n \"organizationName\": \"Gewerbeamt Musterstadt\",\n \"address\": {\n \"type\": \"national\",\n \"street\": \"Kurzer Weg\",\n \"houseNumber\": \"7\",\n \"postalCode\": \"12345\",\n \"city\": \"Ankh-Morpork\"\n },\n \"contact\": {\n \"telephone\": [\n {\n \"number\": \"+49 89 32168-0\",\n \"mobile\": false,\n \"description\": \"work\"\n }\n ],\n \"email\": \"behoerde@example.com\"\n }\n },\n \"technicalContact\": [\n {\n \"formOfAddress\": \"Herr\",\n \"academicTitle\": \"Dr.\",\n \"firstName\": \"Kunibert\",\n \"lastName\": \"Vonundzu\",\n \"contact\": {\n \"telephone\": [\n {\n \"number\": \"+49 89 32168-42\",\n \"mobile\": false,\n \"description\": \"work\"\n },\n {\n \"number\": \"+49 123 456789\",\n \"mobile\": true,\n \"description\": \"work\"\n }\n ],\n \"email\": \"kunibert.vonundzu@example.com\"\n }\n }\n ],\n \"schemas\": [\n {\n \"mimeType\": \"json\",\n \"schemaSource\": \"none\"\n }\n ],\n \"callback\": {\n \"callbackURI\": \"http://127.0.0.1:4010/voluptas\"\n },\n \"destinationId\": \"7881dba9-4055-4854-8b6d-11ea5b7f3047\"\n}"
+ }
+ ]
+ }
+ ],
+ "protocolProfileBehavior": {},
+ "_postman_isSubFolder": true
+ },
+ {
+ "name": "Status",
+ "item": [
+ {
+ "name": "Get Status",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "c839dbc4-8af9-49ff-940d-95f496a40a5a",
+ "exec": [
+ "pm.test(\"response must be 200 and have a body\", function () {",
+ " // assert that the status code is 200",
+ " pm.response.to.have.status(200); ",
+ " // assert that the response has a valid JSON body",
+ " pm.response.to.be.withBody;",
+ "});",
+ "",
+ "// extract body",
+ "var jsonData = JSON.parse(responseBody);",
+ "// set application-id",
+ "pm.test(\"Application current status should be Queued\", function(){",
+ " // assert that application current status is \"queued\"",
+ " pm.expect(jsonData.code).to.equal(\"queued\");",
+ "})",
+ "",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{sender_url}}{{sender_id}}/{{application_id}}/status",
+ "host": [
+ "{{sender_url}}{{sender_id}}"
+ ],
+ "path": [
+ "{{application_id}}",
+ "status"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "Get Status",
+ "originalRequest": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{sender_url}}{{sender_id}}/{{application_id}}/status",
+ "host": [
+ "{{sender_url}}{{sender_id}}"
+ ],
+ "path": [
+ "{{application_id}}",
+ "status"
+ ]
+ }
+ },
+ "status": "OK",
+ "code": 200,
+ "_postman_previewlanguage": "json",
+ "header": [
+ {
+ "key": "Access-Control-Allow-Origin",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Headers",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Credentials",
+ "value": "true"
+ },
+ {
+ "key": "Access-Control-Expose-Headers",
+ "value": "*"
+ },
+ {
+ "key": "content-type",
+ "value": "application/json"
+ },
+ {
+ "key": "date",
+ "value": "Wed, 20 May 2020 06:31:41 GMT"
+ },
+ {
+ "key": "Content-Length",
+ "value": "165"
+ },
+ {
+ "key": "Connection",
+ "value": "keep-alive"
+ }
+ ],
+ "cookie": [],
+ "body": "{\n \"current\": {\n \"code\": \"queued\",\n \"timestamp\": \"2020-05-20T08:31:01+02:00\",\n \"number\": 2\n },\n \"history\": [\n {\n \"code\": \"incomplete\",\n \"timestamp\": \"2020-05-20T08:30:08+02:00\",\n \"number\": 1\n }\n ]\n}"
+ }
+ ]
+ }
+ ],
+ "protocolProfileBehavior": {},
+ "_postman_isSubFolder": true
+ }
+ ],
+ "protocolProfileBehavior": {}
+ },
+ {
+ "name": "SubscriberAPI",
+ "item": [
+ {
+ "name": "Destination Management",
+ "item": [
+ {
+ "name": "Create Destination",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "5b7682e2-fdec-491d-ac53-915809a7062a",
+ "exec": [
+ "pm.test(\"response must be 200 and have a body\", function () {",
+ " // assert that the status code is 200",
+ " pm.response.to.have.status(200); ",
+ " // assert that the response has a valid JSON body",
+ " pm.response.to.be.withBody;",
+ " pm.response.to.have.jsonBody(\"destinationId\"); ",
+ "});",
+ "",
+ "// extract body",
+ "var jsonData = JSON.parse(responseBody);",
+ "// set application-id",
+ "pm.collectionVariables.set('destination_id', jsonData['destinationId']);",
+ "",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [],
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"publicOrganization\": {\n \"organizationName\": \"Gewerbeamt Musterstadt\",\n \"address\": {\n \t\"type\": \"national\",\n \"street\": \"Kurzer Weg\",\n \"houseNumber\": \"7\",\n \"postalCode\": \"12345\",\n \"city\": \"Ankh-Morpork\"\n },\n \"contact\": {\n \"telephone\": [\n \t{\n \t\"number\": \"+49 89 32168-0\",\n \t\"mobile\": false,\n \t\"description\": \"work\"\n \t}\n ],\n \"email\": \"behoerde@example.com\"\n }\n },\n \"technicalContact\": [\n \t{\n\t \"formOfAddress\": \"Herr\",\n\t \"academicTitle\": \"Dr.\",\n\t \"firstName\": \"Kunibert\",\n\t \"lastName\": \"Vonundzu\",\n\t \"contact\": {\n\t \"telephone\": [\n\t {\n\t \"number\": \"+49 89 32168-42\",\n\t \"mobile\": false,\n\t \"description\": \"work\"\n\t },\n\t {\n\t \"number\": \"+49 123 456789\",\n\t \"mobile\": true,\n\t \"description\": \"work\"\n\t }\n\t ],\n\t \"email\": \"kunibert.vonundzu@example.com\"\n\t }\n \t}\n ],\n \"schemas\": [\n {\n \"mimeType\": \"json\",\n \"schemaSource\": \"none\"\n }\n ],\n \"callback\": {\n \"callbackURI\": \"http://127.0.0.1:4010/voluptas\"\n }\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ },
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "Create Destination",
+ "originalRequest": {
+ "method": "POST",
+ "header": [],
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"publicOrganization\": {\n \"organizationName\": \"Gewerbeamt Musterstadt\",\n \"address\": {\n \t\"type\": \"national\",\n \"street\": \"Kurzer Weg\",\n \"houseNumber\": \"7\",\n \"postalCode\": \"12345\",\n \"city\": \"Ankh-Morpork\"\n },\n \"contact\": {\n \"telephone\": [\n \t{\n \t\"number\": \"+49 89 32168-0\",\n \t\"mobile\": false,\n \t\"description\": \"work\"\n \t}\n ],\n \"email\": \"behoerde@example.com\"\n }\n },\n \"technicalContact\": [\n \t{\n\t \"formOfAddress\": \"Herr\",\n\t \"academicTitle\": \"Dr.\",\n\t \"firstName\": \"Kunibert\",\n\t \"lastName\": \"Vonundzu\",\n\t \"contact\": {\n\t \"telephone\": [\n\t {\n\t \"number\": \"+49 89 32168-42\",\n\t \"mobile\": false,\n\t \"description\": \"work\"\n\t },\n\t {\n\t \"number\": \"+49 123 456789\",\n\t \"mobile\": true,\n\t \"description\": \"work\"\n\t }\n\t ],\n\t \"email\": \"kunibert.vonundzu@example.com\"\n\t }\n \t}\n ],\n \"schemas\": [\n {\n \"mimeType\": \"json\",\n \"schemaSource\": \"none\"\n }\n ],\n \"callback\": {\n \"callbackURI\": \"http://127.0.0.1:4010/voluptas\"\n }\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ },
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations"
+ ]
+ }
+ },
+ "status": "Created",
+ "code": 201,
+ "_postman_previewlanguage": "json",
+ "header": [
+ {
+ "key": "Access-Control-Allow-Origin",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Headers",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Credentials",
+ "value": "true"
+ },
+ {
+ "key": "Access-Control-Expose-Headers",
+ "value": "*"
+ },
+ {
+ "key": "content-type",
+ "value": "application/json"
+ },
+ {
+ "key": "date",
+ "value": "Wed, 20 May 2020 06:16:27 GMT"
+ },
+ {
+ "key": "Content-Length",
+ "value": "56"
+ },
+ {
+ "key": "Connection",
+ "value": "keep-alive"
+ }
+ ],
+ "cookie": [],
+ "body": "{\n \"destinationId\": \"7881dba9-4055-4854-8b6d-11ea5b7f3047\"\n}"
+ }
+ ]
+ },
+ {
+ "name": "Get Destination",
+ "request": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations/{{destination_id}}",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations",
+ "{{destination_id}}"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "Get Destination",
+ "originalRequest": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations/{{destination_id}}",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations",
+ "{{destination_id}}"
+ ]
+ }
+ },
+ "status": "OK",
+ "code": 200,
+ "_postman_previewlanguage": "json",
+ "header": [
+ {
+ "key": "Access-Control-Allow-Origin",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Headers",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Credentials",
+ "value": "true"
+ },
+ {
+ "key": "Access-Control-Expose-Headers",
+ "value": "*"
+ },
+ {
+ "key": "content-type",
+ "value": "application/json"
+ },
+ {
+ "key": "date",
+ "value": "Wed, 20 May 2020 06:38:22 GMT"
+ },
+ {
+ "key": "Content-Length",
+ "value": "778"
+ },
+ {
+ "key": "Connection",
+ "value": "keep-alive"
+ }
+ ],
+ "cookie": [],
+ "body": "{\n \"publicOrganization\": {\n \"organizationName\": \"Gewerbeamt Musterstadt\",\n \"address\": {\n \"type\": \"national\",\n \"street\": \"Kurzer Weg\",\n \"houseNumber\": \"7\",\n \"postalCode\": \"12345\",\n \"city\": \"Ankh-Morpork\"\n },\n \"contact\": {\n \"telephone\": [\n {\n \"number\": \"+49 89 32168-0\",\n \"mobile\": false,\n \"description\": \"work\"\n }\n ],\n \"email\": \"behoerde@example.com\"\n }\n },\n \"technicalContact\": [\n {\n \"formOfAddress\": \"Herr\",\n \"academicTitle\": \"Dr.\",\n \"firstName\": \"Kunibert\",\n \"lastName\": \"Vonundzu\",\n \"contact\": {\n \"telephone\": [\n {\n \"number\": \"+49 89 32168-42\",\n \"mobile\": false,\n \"description\": \"work\"\n },\n {\n \"number\": \"+49 123 456789\",\n \"mobile\": true,\n \"description\": \"work\"\n }\n ],\n \"email\": \"kunibert.vonundzu@example.com\"\n }\n }\n ],\n \"schemas\": [\n {\n \"mimeType\": \"json\",\n \"schemaSource\": \"none\"\n }\n ],\n \"callback\": {\n \"callbackURI\": \"http://127.0.0.1:4010/voluptas\"\n },\n \"destinationId\": \"7881dba9-4055-4854-8b6d-11ea5b7f3047\"\n}"
+ }
+ ]
+ },
+ {
+ "name": "Update Destination",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "5b7682e2-fdec-491d-ac53-915809a7062a",
+ "exec": [
+ "pm.test(\"response must be 200 and have a body\", function () {",
+ " // assert that the status code is 200",
+ " pm.response.to.have.status(200); ",
+ "});",
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "PUT",
+ "header": [],
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"destinationId\": \"{{destination_id}}\",\n \"publicOrganization\": {\n \"organizationName\": \"Gewerbeamt Ankh-Morpork\",\n \"address\": {\n \t\"type\": \"national\",\n \"street\": \"Kurzer Weg\",\n \"houseNumber\": \"7\",\n \"postalCode\": \"12345\",\n \"city\": \"Ankh-Morpork\"\n },\n \"contact\": {\n \"telephone\": [\n \t{\n\t \"number\": \"+49 89 32168-0\",\n\t \"mobile\": false,\n\t \"description\": \"work\"\n\t }\n\t ],\n \"email\": \"behoerde@example.com\"\n }\n },\n \"technicalContact\": [\n \t{\n\t \"formOfAddress\": \"Herr\",\n\t \"academicTitle\": \"Dr.\",\n\t \"firstName\": \"Kunibert\",\n\t \"lastName\": \"Vonundzu\",\n\t \"contact\": {\n\t \"telephone\": [\n\t {\n\t \"number\": \"+49 89 32168-42\",\n\t \"mobile\": false,\n\t \"description\": \"work\"\n\t },\n\t {\n\t \"number\": \"+49 123 456789\",\n\t \"mobile\": true,\n\t \"description\": \"work\"\n\t }\n\t ],\n\t \"email\": \"kunibert.vonundzu@example.com\"\n\t }\n \t}\n ],\n \"schemas\": [\n {\n \"mimeType\": \"json\",\n \"schemaSource\": \"none\"\n }\n ],\n \"callback\": {\n \"callbackURI\": \"http://127.0.0.1:4010/voluptas\"\n }\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ },
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations/{{destination_id}}",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations",
+ "{{destination_id}}"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "Update Destination",
+ "originalRequest": {
+ "method": "PUT",
+ "header": [],
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"destinationId\": \"{{destination_id}}\",\n \"publicOrganization\": {\n \"organizationName\": \"Gewerbeamt Ankh-Morpork\",\n \"address\": {\n \t\"type\": \"national\",\n \"street\": \"Kurzer Weg\",\n \"houseNumber\": \"7\",\n \"postalCode\": \"12345\",\n \"city\": \"Ankh-Morpork\"\n },\n \"contact\": {\n \"telephone\": [\n \t{\n\t \"number\": \"+49 89 32168-0\",\n\t \"mobile\": false,\n\t \"description\": \"work\"\n\t }\n\t ],\n \"email\": \"behoerde@example.com\"\n }\n },\n \"technicalContact\": [\n \t{\n\t \"formOfAddress\": \"Herr\",\n\t \"academicTitle\": \"Dr.\",\n\t \"firstName\": \"Kunibert\",\n\t \"lastName\": \"Vonundzu\",\n\t \"contact\": {\n\t \"telephone\": [\n\t {\n\t \"number\": \"+49 89 32168-42\",\n\t \"mobile\": false,\n\t \"description\": \"work\"\n\t },\n\t {\n\t \"number\": \"+49 123 456789\",\n\t \"mobile\": true,\n\t \"description\": \"work\"\n\t }\n\t ],\n\t \"email\": \"kunibert.vonundzu@example.com\"\n\t }\n \t}\n ],\n \"schemas\": [\n {\n \"mimeType\": \"json\",\n \"schemaSource\": \"none\"\n }\n ],\n \"callback\": {\n \"callbackURI\": \"http://127.0.0.1:4010/voluptas\"\n }\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ },
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations/{{destination_id}}",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations",
+ "{{destination_id}}"
+ ]
+ }
+ },
+ "status": "OK",
+ "code": 200,
+ "_postman_previewlanguage": "plain",
+ "header": [
+ {
+ "key": "Access-Control-Allow-Origin",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Headers",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Credentials",
+ "value": "true"
+ },
+ {
+ "key": "Access-Control-Expose-Headers",
+ "value": "*"
+ },
+ {
+ "key": "content-length",
+ "value": "0"
+ },
+ {
+ "key": "date",
+ "value": "Wed, 20 May 2020 06:39:35 GMT"
+ },
+ {
+ "key": "Connection",
+ "value": "keep-alive"
+ }
+ ],
+ "cookie": [],
+ "body": null
+ }
+ ]
+ },
+ {
+ "name": "Delete Destination",
+ "request": {
+ "method": "DELETE",
+ "header": [],
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations/{{destination_id}}",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations",
+ "{{destination_id}}"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "Delete Destination",
+ "originalRequest": {
+ "method": "DELETE",
+ "header": [],
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations/{{destination_id}}",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations",
+ "{{destination_id}}"
+ ]
+ }
+ },
+ "status": "OK",
+ "code": 200,
+ "_postman_previewlanguage": "plain",
+ "header": [
+ {
+ "key": "Access-Control-Allow-Origin",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Headers",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Credentials",
+ "value": "true"
+ },
+ {
+ "key": "Access-Control-Expose-Headers",
+ "value": "*"
+ },
+ {
+ "key": "content-length",
+ "value": "0"
+ },
+ {
+ "key": "date",
+ "value": "Wed, 20 May 2020 06:39:51 GMT"
+ },
+ {
+ "key": "Connection",
+ "value": "keep-alive"
+ }
+ ],
+ "cookie": [],
+ "body": null
+ }
+ ]
+ },
+ {
+ "name": "List Destinations",
+ "request": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "List Destinations",
+ "originalRequest": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations"
+ ]
+ }
+ },
+ "status": "OK",
+ "code": 200,
+ "_postman_previewlanguage": "json",
+ "header": [
+ {
+ "key": "Access-Control-Allow-Origin",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Headers",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Credentials",
+ "value": "true"
+ },
+ {
+ "key": "Access-Control-Expose-Headers",
+ "value": "*"
+ },
+ {
+ "key": "content-type",
+ "value": "application/json"
+ },
+ {
+ "key": "date",
+ "value": "Wed, 20 May 2020 06:38:04 GMT"
+ },
+ {
+ "key": "Content-Length",
+ "value": "1559"
+ },
+ {
+ "key": "Connection",
+ "value": "keep-alive"
+ }
+ ],
+ "cookie": [],
+ "body": "[\n {\n \"publicOrganization\": {\n \"organizationName\": \"Gewerbeamt Musterstadt\",\n \"address\": {\n \"type\": \"national\",\n \"street\": \"Kurzer Weg\",\n \"houseNumber\": \"7\",\n \"postalCode\": \"12345\",\n \"city\": \"Ankh-Morpork\"\n },\n \"contact\": {\n \"telephone\": [\n {\n \"number\": \"+49 89 32168-0\",\n \"mobile\": false,\n \"description\": \"work\"\n }\n ],\n \"email\": \"behoerde@example.com\"\n }\n },\n \"technicalContact\": [\n {\n \"formOfAddress\": \"Herr\",\n \"academicTitle\": \"Dr.\",\n \"firstName\": \"Kunibert\",\n \"lastName\": \"Vonundzu\",\n \"contact\": {\n \"telephone\": [\n {\n \"number\": \"+49 89 32168-42\",\n \"mobile\": false,\n \"description\": \"work\"\n },\n {\n \"number\": \"+49 123 456789\",\n \"mobile\": true,\n \"description\": \"work\"\n }\n ],\n \"email\": \"kunibert.vonundzu@example.com\"\n }\n }\n ],\n \"schemas\": [\n {\n \"mimeType\": \"json\",\n \"schemaSource\": \"none\"\n }\n ],\n \"callback\": {\n \"callbackURI\": \"http://127.0.0.1:4010/voluptas\"\n },\n \"destinationId\": \"0ddf3ab5-dd89-4e04-9ecd-b2c50b0b4efd\"\n },\n {\n \"publicOrganization\": {\n \"organizationName\": \"Gewerbeamt Musterstadt\",\n \"address\": {\n \"type\": \"national\",\n \"street\": \"Kurzer Weg\",\n \"houseNumber\": \"7\",\n \"postalCode\": \"12345\",\n \"city\": \"Ankh-Morpork\"\n },\n \"contact\": {\n \"telephone\": [\n {\n \"number\": \"+49 89 32168-0\",\n \"mobile\": false,\n \"description\": \"work\"\n }\n ],\n \"email\": \"behoerde@example.com\"\n }\n },\n \"technicalContact\": [\n {\n \"formOfAddress\": \"Herr\",\n \"academicTitle\": \"Dr.\",\n \"firstName\": \"Kunibert\",\n \"lastName\": \"Vonundzu\",\n \"contact\": {\n \"telephone\": [\n {\n \"number\": \"+49 89 32168-42\",\n \"mobile\": false,\n \"description\": \"work\"\n },\n {\n \"number\": \"+49 123 456789\",\n \"mobile\": true,\n \"description\": \"work\"\n }\n ],\n \"email\": \"kunibert.vonundzu@example.com\"\n }\n }\n ],\n \"schemas\": [\n {\n \"mimeType\": \"json\",\n \"schemaSource\": \"none\"\n }\n ],\n \"callback\": {\n \"callbackURI\": \"http://127.0.0.1:4010/voluptas\"\n },\n \"destinationId\": \"7881dba9-4055-4854-8b6d-11ea5b7f3047\"\n }\n]"
+ }
+ ]
+ }
+ ],
+ "protocolProfileBehavior": {},
+ "_postman_isSubFolder": true
+ },
+ {
+ "name": "Application Retrieval",
+ "item": [
+ {
+ "name": "List Applications",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "0d082c8d-1593-4789-babc-b8c04e277f8d",
+ "exec": [
+ "pm.test(\"response must be 200 Ok and has a body\", function () {",
+ " // assert that the status code is 200",
+ " pm.response.to.have.status(200); ",
+ " // assert that the response has a valid JSON body",
+ " pm.response.to.be.withBody;",
+ "});",
+ "",
+ "var jsonData = pm.response.json();",
+ "",
+ "pm.test(\"Content-Type header is present\", function () {",
+ " pm.expect(jsonData[0], pm.collectionVariables.get(\"application_id\"));",
+ "});"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations/{{destination_id}}/applications",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations",
+ "{{destination_id}}",
+ "applications"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "List Applications",
+ "originalRequest": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations/{{destination_id}}/applications",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations",
+ "{{destination_id}}",
+ "applications"
+ ]
+ }
+ },
+ "status": "OK",
+ "code": 200,
+ "_postman_previewlanguage": "json",
+ "header": [
+ {
+ "key": "Access-Control-Allow-Origin",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Headers",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Credentials",
+ "value": "true"
+ },
+ {
+ "key": "Access-Control-Expose-Headers",
+ "value": "*"
+ },
+ {
+ "key": "content-type",
+ "value": "application/json"
+ },
+ {
+ "key": "date",
+ "value": "Wed, 20 May 2020 06:36:19 GMT"
+ },
+ {
+ "key": "Content-Length",
+ "value": "1831"
+ },
+ {
+ "key": "Connection",
+ "value": "keep-alive"
+ }
+ ],
+ "cookie": [],
+ "body": "[\n {\n \"additionalReferenceInfo\": {\n \"subject\": \"Anmeldung eines Gewerbes in Musterstadt\",\n \"caseId\": \"DF/8923\"\n },\n \"contentStructure\": {\n \"data\": {\n \"schema\": {\n \"mimeType\": \"json\",\n \"schemaSource\": \"none\"\n }\n },\n \"docs\": [\n {\n \"docId\": \"1\",\n \"purpose\": \"form\",\n \"size\": 13046,\n \"mimeType\": \"application/pdf\",\n \"filename\": \"test.pdf\",\n \"description\": \"Das Antragsformular\",\n \"lang\": {\n \"lang\": \"de\",\n \"region\": \"DE\"\n },\n \"hash\": {\n \"algorithm\": \"SHA-256\",\n \"digest\": \"bf37d894fdf9aeade63975ed648d49c3e8a7a773923597d2418915f54cd7c3b9\"\n }\n }\n ]\n },\n \"publicServiceType\": {\n \"name\": \"Gewerbeanmeldung\",\n \"description\": \"Eine Gewerbeanmeldung ist immer dann notwendig, wenn Sie einen stehenden Gewerbebetrieb beginnen.\",\n \"leikaId\": \"99050012104000\",\n \"otherIdentifiers\": [\n {\n \"id\": \"8664844\",\n \"schemeId\": \"service.niedersachsen.de\",\n \"schemeName\": \"Serviceportal Niedersachsen\"\n },\n {\n \"id\": \"354824\",\n \"schemeId\": \"buerger.thueringen.de\",\n \"schemeName\": \"Zuständigkeitsfinder Thüringen\"\n }\n ]\n },\n \"applicants\": [\n {\n \"type\": \"person\",\n \"authentificationInfo\": {\n \"assuranceLevel\": \"high\",\n \"authentificationMethod\": \"eID\",\n \"timestamp\": \"2020-03-03T12:38:23Z\"\n },\n \"identityInfo\": {\n \"dateOfBirth\": \"1970-09-13\",\n \"gender\": \"m\",\n \"givenName\": \"WERNER\",\n \"familyName\": \"MUSTERMANN\",\n \"placeOfResidence\": {\n \"type\": \"national\",\n \"street\": \"KURZER WEG 7\",\n \"postalCode\": \"12345\",\n \"city\": \"ANKH-MORPORK\"\n }\n },\n \"contactInfo\": {\n \"electronicAddresses\": [\n {\n \"channelType\": \"Service-Account-Mailbox\",\n \"address\": \"3b0c9c8c-0801-45f0-a331-2abfc9db78d0\"\n }\n ],\n \"physicalAddress\": {\n \"type\": \"national\",\n \"street\": \"Kurzer Weg\",\n \"houseNumber\": \"7\",\n \"postalCode\": \"12345\",\n \"city\": \"Ankh-Morpork\"\n },\n \"telephone\": [\n {\n \"number\": \"+49 89 32168-42\",\n \"mobile\": true,\n \"description\": \"work\"\n }\n ]\n }\n }\n ],\n \"paymentInfo\": {\n \"reference\": \"TP/93/GDP\",\n \"usage\": \"Gewerbeanmeldung\",\n \"amount\": 17.3,\n \"timestamp\": \"2020-03-03T12:38:23Z\",\n \"status\": \"success\",\n \"transaction\": \"1f77c5f9b759db9cdce59988b24974d465c7be5e462a6185485559ff6e2dea82\"\n },\n \"applicationId\": \"0c508e3f-2353-4206-9a1e-34b2e864d5a8\"\n }\n]"
+ }
+ ]
+ },
+ {
+ "name": "Get Application Metadata",
+ "event": [
+ {
+ "listen": "prerequest",
+ "script": {
+ "id": "79511f73-464f-40a7-90c6-2b5176473cce",
+ "exec": [
+ ""
+ ],
+ "type": "text/javascript"
+ }
+ },
+ {
+ "listen": "test",
+ "script": {
+ "id": "bafba620-d3a3-45c3-b3b9-1afabc26885d",
+ "exec": [
+ "pm.test(\"response must be 200 Ok and has a body\", function () {",
+ " // assert that the status code is 200",
+ " pm.response.to.have.status(200); ",
+ " // assert that the response has a valid JSON body",
+ " pm.response.to.be.withBody;",
+ "});",
+ "",
+ "// extract body",
+ "var jsonData = pm.response.json();",
+ "",
+ "// todo extend tests."
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations/{{destination_id}}/applications/{{application_id}}",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations",
+ "{{destination_id}}",
+ "applications",
+ "{{application_id}}"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "Get Application Metadata",
+ "originalRequest": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations/{{destination_id}}/applications/{{application_id}}",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations",
+ "{{destination_id}}",
+ "applications",
+ "{{application_id}}"
+ ]
+ }
+ },
+ "status": "OK",
+ "code": 200,
+ "_postman_previewlanguage": "json",
+ "header": [
+ {
+ "key": "Access-Control-Allow-Origin",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Headers",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Credentials",
+ "value": "true"
+ },
+ {
+ "key": "Access-Control-Expose-Headers",
+ "value": "*"
+ },
+ {
+ "key": "content-type",
+ "value": "application/json"
+ },
+ {
+ "key": "date",
+ "value": "Wed, 20 May 2020 06:36:36 GMT"
+ },
+ {
+ "key": "Content-Length",
+ "value": "1829"
+ },
+ {
+ "key": "Connection",
+ "value": "keep-alive"
+ }
+ ],
+ "cookie": [],
+ "body": "{\n \"additionalReferenceInfo\": {\n \"subject\": \"Anmeldung eines Gewerbes in Musterstadt\",\n \"caseId\": \"DF/8923\"\n },\n \"contentStructure\": {\n \"data\": {\n \"schema\": {\n \"mimeType\": \"json\",\n \"schemaSource\": \"none\"\n }\n },\n \"docs\": [\n {\n \"docId\": \"1\",\n \"purpose\": \"form\",\n \"size\": 13046,\n \"mimeType\": \"application/pdf\",\n \"filename\": \"test.pdf\",\n \"description\": \"Das Antragsformular\",\n \"lang\": {\n \"lang\": \"de\",\n \"region\": \"DE\"\n },\n \"hash\": {\n \"algorithm\": \"SHA-256\",\n \"digest\": \"bf37d894fdf9aeade63975ed648d49c3e8a7a773923597d2418915f54cd7c3b9\"\n }\n }\n ]\n },\n \"publicServiceType\": {\n \"name\": \"Gewerbeanmeldung\",\n \"description\": \"Eine Gewerbeanmeldung ist immer dann notwendig, wenn Sie einen stehenden Gewerbebetrieb beginnen.\",\n \"leikaId\": \"99050012104000\",\n \"otherIdentifiers\": [\n {\n \"id\": \"8664844\",\n \"schemeId\": \"service.niedersachsen.de\",\n \"schemeName\": \"Serviceportal Niedersachsen\"\n },\n {\n \"id\": \"354824\",\n \"schemeId\": \"buerger.thueringen.de\",\n \"schemeName\": \"Zuständigkeitsfinder Thüringen\"\n }\n ]\n },\n \"applicants\": [\n {\n \"type\": \"person\",\n \"authentificationInfo\": {\n \"assuranceLevel\": \"high\",\n \"authentificationMethod\": \"eID\",\n \"timestamp\": \"2020-03-03T12:38:23Z\"\n },\n \"identityInfo\": {\n \"dateOfBirth\": \"1970-09-13\",\n \"gender\": \"m\",\n \"givenName\": \"WERNER\",\n \"familyName\": \"MUSTERMANN\",\n \"placeOfResidence\": {\n \"type\": \"national\",\n \"street\": \"KURZER WEG 7\",\n \"postalCode\": \"12345\",\n \"city\": \"ANKH-MORPORK\"\n }\n },\n \"contactInfo\": {\n \"electronicAddresses\": [\n {\n \"channelType\": \"Service-Account-Mailbox\",\n \"address\": \"3b0c9c8c-0801-45f0-a331-2abfc9db78d0\"\n }\n ],\n \"physicalAddress\": {\n \"type\": \"national\",\n \"street\": \"Kurzer Weg\",\n \"houseNumber\": \"7\",\n \"postalCode\": \"12345\",\n \"city\": \"Ankh-Morpork\"\n },\n \"telephone\": [\n {\n \"number\": \"+49 89 32168-42\",\n \"mobile\": true,\n \"description\": \"work\"\n }\n ]\n }\n }\n ],\n \"paymentInfo\": {\n \"reference\": \"TP/93/GDP\",\n \"usage\": \"Gewerbeanmeldung\",\n \"amount\": 17.3,\n \"timestamp\": \"2020-03-03T12:38:23Z\",\n \"status\": \"success\",\n \"transaction\": \"1f77c5f9b759db9cdce59988b24974d465c7be5e462a6185485559ff6e2dea82\"\n },\n \"applicationId\": \"0c508e3f-2353-4206-9a1e-34b2e864d5a8\"\n}"
+ }
+ ]
+ },
+ {
+ "name": "Get Application Data",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "ba8692bc-106f-41f6-b484-5a36f655d691",
+ "exec": [
+ "pm.test(\"response must be 200 Ok and has a body\", function () {",
+ " // assert that the status code is 200",
+ " pm.response.to.have.status(200); ",
+ " // assert that the response has a valid JSON body",
+ " pm.response.to.be.withBody;",
+ "});",
+ "",
+ "// extract body",
+ "var jsonData = pm.response.json();",
+ "",
+ "pm.test(\"correct application-id\", function () {",
+ " // assert that application-id is correct",
+ " pm.expect(jsonData['application-id']).to.eql(pm.collectionVariables.get(\"application_id\"));",
+ "});",
+ "",
+ "// todo extend tests."
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations/{{destination_id}}/applications/{{application_id}}/data",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations",
+ "{{destination_id}}",
+ "applications",
+ "{{application_id}}",
+ "data"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "Get Application Data",
+ "originalRequest": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations/{{destination_id}}/applications/{{application_id}}/data",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations",
+ "{{destination_id}}",
+ "applications",
+ "{{application_id}}",
+ "data"
+ ]
+ }
+ },
+ "status": "OK",
+ "code": 200,
+ "_postman_previewlanguage": "json",
+ "header": [
+ {
+ "key": "Access-Control-Allow-Origin",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Headers",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Credentials",
+ "value": "true"
+ },
+ {
+ "key": "Access-Control-Expose-Headers",
+ "value": "*"
+ },
+ {
+ "key": "content-type",
+ "value": "application/json"
+ },
+ {
+ "key": "date",
+ "value": "Wed, 20 May 2020 06:37:17 GMT"
+ },
+ {
+ "key": "Content-Length",
+ "value": "224"
+ },
+ {
+ "key": "Connection",
+ "value": "keep-alive"
+ }
+ ],
+ "cookie": [],
+ "body": "{\n \"F99000001\": \"string\",\n \"G99000001\": {\n \"F99000002\": \"string\",\n \"F99000003\": 42\n },\n \"G99000002\": [\n {\n \"F99000004\": true,\n \"G99000001\": {\n \"F99000002\": \"string\",\n \"F99000003\": 17\n }\n },\n {\n \"F99000004\": true,\n \"G99000001\": {\n \"F99000002\": \"string\",\n \"F99000003\": 24\n }\n }\n ]\n}"
+ }
+ ]
+ },
+ {
+ "name": "Get Application Document",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "eb502bfa-b763-4f16-b76f-c0c8ef5e0228",
+ "exec": [
+ "pm.test(\"response must be 200 Ok and has a body\", function () {",
+ " // assert that the status code is 200",
+ " pm.response.to.have.status(200); ",
+ " // assert that the response has a valid JSON body",
+ " pm.response.to.be.withBody;",
+ "});",
+ "",
+ "pm.test(\"Content-Type header is present\", function () {",
+ " pm.response.to.have.header(\"Content-Type\");",
+ "});",
+ "",
+ "pm.test(\"Content-Type header is application/octet-stream\", function () {",
+ " pm.response.to.have.header(\"Content-Type\");",
+ " pm.response.to.be.header(\"Content-Type\",\"application/octet-stream\");",
+ "});"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "GET",
+ "header": [],
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations/{{destination_id}}/applications/{{application_id}}/docs/{{doc_id}}",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations",
+ "{{destination_id}}",
+ "applications",
+ "{{application_id}}",
+ "docs",
+ "{{doc_id}}"
+ ]
+ }
+ },
+ "response": []
+ },
+ {
+ "name": "Acknowledge Application",
+ "event": [
+ {
+ "listen": "test",
+ "script": {
+ "id": "13f5e55a-6984-4505-bbae-61a229d5d571",
+ "exec": [
+ "pm.test(\"response must be 200 Ok and has a body\", function () {",
+ " // assert that the status code is 200",
+ " pm.response.to.have.status(200); ",
+ "});"
+ ],
+ "type": "text/javascript"
+ }
+ }
+ ],
+ "request": {
+ "method": "POST",
+ "header": [],
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"finalDelivery\": false\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ },
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations/{{destination_id}}/applications/{{application_id}}",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations",
+ "{{destination_id}}",
+ "applications",
+ "{{application_id}}"
+ ]
+ }
+ },
+ "response": [
+ {
+ "name": "Acknowledge Application",
+ "originalRequest": {
+ "method": "POST",
+ "header": [],
+ "body": {
+ "mode": "raw",
+ "raw": "{\n \"finalDelivery\": false\n}",
+ "options": {
+ "raw": {
+ "language": "json"
+ }
+ }
+ },
+ "url": {
+ "raw": "{{subscriber_url}}{{subscriber_id}}/destinations/{{destination_id}}/applications/{{application_id}}",
+ "host": [
+ "{{subscriber_url}}{{subscriber_id}}"
+ ],
+ "path": [
+ "destinations",
+ "{{destination_id}}",
+ "applications",
+ "{{application_id}}"
+ ]
+ }
+ },
+ "status": "OK",
+ "code": 200,
+ "_postman_previewlanguage": "plain",
+ "header": [
+ {
+ "key": "Access-Control-Allow-Origin",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Headers",
+ "value": "*"
+ },
+ {
+ "key": "Access-Control-Allow-Credentials",
+ "value": "true"
+ },
+ {
+ "key": "Access-Control-Expose-Headers",
+ "value": "*"
+ },
+ {
+ "key": "content-length",
+ "value": "0"
+ },
+ {
+ "key": "date",
+ "value": "Wed, 20 May 2020 06:37:50 GMT"
+ },
+ {
+ "key": "Connection",
+ "value": "keep-alive"
+ }
+ ],
+ "cookie": [],
+ "body": null
+ }
+ ]
+ }
+ ],
+ "protocolProfileBehavior": {},
+ "_postman_isSubFolder": true
+ }
+ ],
+ "protocolProfileBehavior": {}
+ }
+ ],
+ "auth": {
+ "type": "oauth2",
+ "oauth2": [
+ {
+ "key": "accessToken",
+ "value": "710a318d7c924956bc8c6b9cb8383c4f",
+ "type": "string"
+ },
+ {
+ "key": "tokenType",
+ "value": "Bearer",
+ "type": "string"
+ },
+ {
+ "key": "addTokenTo",
+ "value": "header",
+ "type": "string"
+ }
+ ]
+ },
+ "event": [
+ {
+ "listen": "prerequest",
+ "script": {
+ "id": "0e99dc85-2204-4578-8167-86b21566527a",
+ "type": "text/javascript",
+ "exec": [
+ ""
+ ]
+ }
+ },
+ {
+ "listen": "test",
+ "script": {
+ "id": "462d5817-f944-4c28-85a8-170e20d9f7b7",
+ "type": "text/javascript",
+ "exec": [
+ ""
+ ]
+ }
+ }
+ ],
+ "variable": [
+ {
+ "id": "60480d32-ccd5-46f1-8c6f-d4dfc20cf0c4",
+ "key": "doc_id",
+ "value": "1",
+ "type": "string"
+ },
+ {
+ "id": "720753c3-65d9-4c05-8250-1ef8588a805b",
+ "key": "destination_id",
+ "value": "",
+ "type": "string"
+ },
+ {
+ "id": "32a06035-f6f4-4ab1-b1f5-bc661fbba111",
+ "key": "application_id",
+ "value": "",
+ "type": "string"
+ }
+ ],
+ "protocolProfileBehavior": {}
+}
\ No newline at end of file
diff --git a/assets/postman/FIT-Connect.postman_environment.json b/assets/postman/FIT-Connect.postman_environment.json
new file mode 100644
index 0000000000000000000000000000000000000000..a6d7efc18bc5690472b5b540804fb8e312b890d1
--- /dev/null
+++ b/assets/postman/FIT-Connect.postman_environment.json
@@ -0,0 +1,34 @@
+{
+ "id": "44204631-99ff-4de7-92e1-76fc41b2b798",
+ "name": "FIT-Connect",
+ "values": [
+ {
+ "key": "sender_url",
+ "value": "https://sender.fiep-poc.de/",
+ "enabled": true
+ },
+ {
+ "key": "subscriber_url",
+ "value": "https://subscriber.fiep-poc.de/",
+ "enabled": true
+ },
+ {
+ "key": "sender_id",
+ "value": "sender-c94ae37e-dcc5-345e-a530-8651bdfa5f2c",
+ "enabled": true
+ },
+ {
+ "key": "subscriber_id",
+ "value": "subscriber-c94ae37e-dcc5-345e-a530-8651bdfa5f2c",
+ "enabled": true
+ },
+ {
+ "key": "sender_url2",
+ "value": "https://sender.fiep-poc.de/",
+ "enabled": true
+ }
+ ],
+ "_postman_variable_scope": "environment",
+ "_postman_exported_at": "2020-05-19T06:38:54.721Z",
+ "_postman_exported_using": "Postman/7.24.0"
+}
\ No newline at end of file
diff --git a/docs/2_Quick_Reference.md b/docs/2_Quick_Reference.md
index 0f1ec25886a2842ee1bf1a5bdf1e67996cbab2bc..8265cd811ae18fe417492d74fe58bc070d79044a 100644
--- a/docs/2_Quick_Reference.md
+++ b/docs/2_Quick_Reference.md
@@ -17,50 +17,50 @@ Anhänge können entweder klassische Anhänge (bspw. Nachweise) oder oder eine P
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
-Der Zustelldienst weist jedem übertragenen Antrag (`application`) eine global eindeutige `application-id` zu, die diesen Antrag dauerhaft über den gesamten Bearbeitungsverlauf eindeutig identifiziert.
+#### applicationId
+Der Zustelldienst weist jedem übertragenen Antrag (`application`) eine global eindeutige `applicationId` zu, die diesen Antrag dauerhaft über den gesamten Bearbeitungsverlauf eindeutig identifiziert.
-#### destination-id
-Die `destination-id` ist eine vom Zustelldienst vergebene ID für einen durch den Subscriber angelegten Zustellpunkt (`destination`). Diese ID wird dem Sender über externe Systeme (bspw. Zuständigkeitsfinder) oder bilaterale Absprachen zwischen beiden Seiten mitgeteilt.
+#### destinationId
+Die `destinationId` ist eine vom Zustelldienst vergebene ID für einen durch den Subscriber angelegten Zustellpunkt (`destination`). Diese ID wird dem Sender über externe Systeme (bspw. Zuständigkeitsfinder) oder bilaterale Absprachen zwischen beiden Seiten mitgeteilt.
### Vom API-Portal bereitgestellte IDs
-#### source-id
-Die `source-id` ist die ID des Accounts, der die Übertragung absendet. Sie wird vom genutzten Identitätssystem vergeben und muss global eindeutig sein.
+#### senderId
+Die `senderId` ist die ID des Accounts, der die Übertragung absendet. Sie wird vom genutzten Identitätssystem vergeben und muss global eindeutig sein.
-#### subscriber-id
-Die `subscriber-id` ist die ID des Accounts, der die Übertragung empfängt. Sie wird vom genutzten Identitätssystem vergeben und muss global eindeutig sein.
+#### subscriberId
+Die `subscriberId` ist die ID des Accounts, der die Übertragung empfängt. Sie wird vom genutzten Identitätssystem vergeben und muss global eindeutig sein.
### Vom Sender vergebene Identifikatoren
-#### doc-id
-Der Sender vergibt für jedes Antragsformular und jede Anlage in einer Übertragung eine `doc-id`. Diese muss für alle Dokumente (PDF-Antragsformulare und beliebige Anlagen) in der Übertragung eindeutig sein. Es wird empfohlen, die IDs `1`, `2` etc. zu verwenden.
+#### docId
+Der Sender vergibt für jedes Antragsformular und jede Anlage in einer Übertragung eine `docId`. Diese muss für alle Dokumente (PDF-Antragsformulare und beliebige Anlagen) in der Übertragung eindeutig sein. Es wird empfohlen, die IDs `1`, `2` etc. zu verwenden.
## Operation der Application Sender API
Mit folgenden Operationen kann der Sender eine Application übertragen und die Übertragung verwalten:
-- [Create Application](../reference/sender.json/paths/~1{source-id}~1{destination-id}/post) - Legt eine neue Ãœbertragung durch Ãœbermittlung der Metadaten an.
-- [Add Application Data](../reference/sender.json/paths/~1{source-id}~1{destination-id}~1{application-id}~1data/put) - Fügt dem Antrag strukturierte Daten (Fachdaten) hinzu.
-- [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.
-- [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.
-- [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.
+- [Create Application](../reference/sender.json/paths/~1{senderId}~1{destinationId}/post) - Legt eine neue Ãœbertragung durch Ãœbermittlung der Metadaten an.
+- [Add Application Data](../reference/sender.json/paths/~1{senderId}~1{destinationId}~1{applicationId}~1data/put) - Fügt dem Antrag strukturierte Daten (Fachdaten) hinzu.
+- [Add Application Document](../reference/sender.json/paths/~1{senderId}~1{destinationId}~1{applicationId}~1docs~1{docId}/put) - Ãœbermittelt ein Antragsformular oder eine Anlage.
+- [Send Application](../reference/sender.json/paths/~1{senderId}~1{destinationId}~1{applicationId}/post) - Beendet die Übertragung des Antrags und löst seinen Versand aus.
+- [Get Application Upload Status](../reference/sender.json/paths/~1{senderId}~1{destinationId}~1{applicationId}~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.
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.
+- [Get Destination Info](../reference/sender.json/paths/~1{senderId}~1{destinationId}/get) - Ruft übertragungsrelevante Informationen über den Zustellpunkt (bspw. zulässige Schemata oder Datentypen) ab.
+- [Get Status](../reference/sender.json/paths/~1{senderId}~1{applicationId}~1status/get) - Ruft den Status sowie die Statushistorie der Zustellung des Antrags ab.
## Operation der Application Subscriber API
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.
-- [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) - Löscht ein Übertragungsziel (Destination).
+- [Create Destination](../reference/subscriber.json/paths/~1{subscriberId}~1destinations/post) - Legt ein neues Ãœbertragungsziel (Destination) an.
+- [List Destinations](../reference/subscriber.json/paths/~1{subscriberId}~1destinations/get) - Listet alle Ãœbertragungsziele (Destinations) eines Subscribers auf.
+- [Get Destination](../reference/subscriber.json/paths/~1{subscriberId}~1destinations~1{destinationId}/get) - Ruf die Daten eines Ãœbertragungsziels (Destination) ab.
+- [Update Destination](../reference/subscriber.json/paths/~1{subscriberId}~1destinations~1{destinationId}/put) - Aktualisiert ein Ãœbertragungsziel (Destination).
+- [Delete Destination](../reference/subscriber.json/paths/~1{subscriberId}~1destinations~1{destinationId}/delete) - Löscht ein Übertragungsziel (Destination).
Mit diesen Operationen wird nach wartenden Applications gesucht und diese abgeholt:
-- [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) - 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) - Ruft die Fachdaten einer Ãœbertragung (Application Data) ab.
-- [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.
+- [List Applications](../reference/subscriber.json/paths/~1{subscriberId}~1destinations~1{destinationId}~1applications/get) - Ruft die Liste der wartenden Ãœbertragungen (Applications) ab.
+- [Get Application Metadata](../reference/subscriber.json/paths/~1{subscriberId}~1destinations~1{destinationId}~1applications~1{applicationId}/get) - Ruft eine wartende Ãœbertragung (Application) ab.
+- [Get Application Data](../reference/subscriber.json/paths/~1{subscriberId}~1destinations~1{destinationId}~1applications~1{applicationId}~1data/get) - Ruft die Fachdaten einer Ãœbertragung (Application Data) ab.
+- [Get Application Document](../reference/subscriber.json/paths/~1{subscriberId}~1destinations~1{destinationId}~1applications~1{applicationId}~1docs~1{docId}/get) - Ruf ein Dokument (Formular oder Anlage) der Application ab.
+- [Acknowledge Application](../reference/subscriber.json/paths/~1{subscriberId}~1destinations~1{destinationId}~1applications~1{applicationId}/post) - Quittiert die Abholung der Ãœbertragung.
diff --git a/docs/4_Authentifizierung_und_Autorisierung.md b/docs/4_Authentifizierung_und_Autorisierung.md
index 2aa66cb98f7d9a1a1e9961462a23f59193ea46e7..d76d9193d59640576e4d9f3b57ddce5b6987e934 100644
--- a/docs/4_Authentifizierung_und_Autorisierung.md
+++ b/docs/4_Authentifizierung_und_Autorisierung.md
@@ -1,7 +1,235 @@
# Authentifizierung und Autorisierung
-...
+## Anwender Registrierung
-**Noch in Arbeit**
+Das FIT-Connect API Portal ist unter der folgenden URL erreichbar:
-...
\ No newline at end of file
+https://portal.fiep-poc.de
+
+Eine Behörde, die ein Verfahren anbieten möchte, registriert sich zunächst am Portal mit dem Button "Registrieren". Diese Funktion steht auch rechts oben unter "Mein Konto" zur Verfügung.
+
+
+
+
+
+
+
+Im Anschluss erhalten Sie zwei verschiedene E-Mails.
+Die zweite E-Mail kommt mit einer zeitlichen Verzögerung von bis zu 30 Minuten.
+
+In der ersten Email wird ihre Registrierungsanfrage bestätigt:
+
+> Hallo Werner Mustermann,
+>
+> ihre Anfrage zur Registrierung ist aufgenommen worden. Sie erhalten noch zwei weitere Bestätigungsmails.
+>
+> Mit besten Grüßen,
+> Ihr FIT-Connect API Portal Team
+>
+> *** Diese Benachrichtigung wurde automatisch erstellt. Antworten Sie nicht auf diese Email.***
+
+In der zweiten Email wird ihnen noch die Anwender-ID mitgeteilt.
+
+Diese Anwender-ID ist essenziell für die weitere Arbeit mit den APIs.
+Sie ist Bestandteil sowohl der Aufruf URLs als auch Bestandteil der Scopes für die OAuth 2.0. Authorization / Authentication.
+
+**Erst nach Erhalt der Email können sie sich anmelden!**
+
+Hier ein Beispiel einer solchen Email:
+
+> Sehr geehrter Herr Mustermann,
+>
+> wir freuen uns über ihre Teilnahme an dem POC Fit-Connect.
+>
+> Ihre Anwender-ID lautet: c94ae37e-dcc5-345e-a530-8651bdfa5f2c
+>
+> Mit freundlichem Gruß
+> Ihr FIT-Connect Team.
+
+## Client (Anwendung) Registrierung auf ein API
+
+<!-- theme: warning -->
+> **Hinweis:** Im Zuge der ersten Anmeldung empfehlen wir die Umstellung der Sprache auf Deutsch.
+
+
+
+
+
+Im zweiten Schritt wird die von ihrer Behörde angebotene Anwendung (auch Client genannt) registriert.
+
+Dies erfolgt durch Aufruf der Details des für die Anwendung gewünschten API
+
+Dazu klicken sie in der Titelleiste auf "APIs":
+
+
+
+In der nun angezeigten Liste klicken Sie beim API "SubscriberAPI" auf den Button "Details anzeigen >>"
+
+
+
+In der Detailanzeige klicken sie rechts oben unter "Was als Nächstes?" auf "Client anmelden und Zugriffs-Token auswählen".
+
+
+
+Nun erscheint der folgende Dialog:
+
+
+
+Hier vergeben Sie einen Anwendungsnamen und eine Beschreibung. Die Angabe einer Umleitungs-URI ist optional.
+
+Mit dem Button "Token anfordern" lösen Sie die Erstellung der Anwendung (Client) und der für Sie gültigen Subscriber-ID (subscriber-id) und/oder Source/Sender-ID (source-id) aus. Diese Subscriber-ID wird für alle weiteren API Aufrufe benötigt.
+
+Im Hintergrund wird nun automatisch eine nur für ihre Behörde und diese Anwendung gültige Scope Konfiguration erstellt. Dies Konfiguration kann über den Menüpunkt "Applications" eingesehen werden.
+
+
+
+
+
+Aus dieser Liste heraus können sie die Details der Anwendung durch Klick auf den Namen der Anwendung ansehen.
+
+
+
+Für die Nutzung des API sind die Angaben unter "OAuth2-Anmeldeinformationen" wichtig.
+
+Der für Sie und Ihre Anwendung gültige OAuth2 Scope wird ihnen in einer E-Mail mitgeteilt.
+
+Hier ein Beispiel einer solchen E-Mail:
+
+> Sehr geehrter Herr Mustermann,
+>
+> Für ihren Client (Application) steht ihnen folgender Scope zur Verfügung
+>
+> Scope: subscriber-c1785a90-b3e7-3022-9c70-e1714cb8e8c6:manage
+>
+> Zusammen mit der „client_id“ und dem für uns nicht sichtbaren „client_secret“ können Sie in der Folge einen „access token“ für das API „SubscriberAPI“ abholen.
+>
+> Die URL dafür lautet:
+> https://oauth.fiep-poc.de/invoke/pub.apigateway.oauth2/authorize
+>
+> Die weiteren Details zur entnehmen Sie bitte der FIT-Connect Anwenderdokumentation“.
+>
+> Mit freundlichem Gruß
+> Ihr FIT-Connect Team.
+
+## Hinweise zum Aufruf des API mit OAuth2
+
+Um das von ihnen gewünschte API im Rahmen ihrer Anwendung aufzurufen, Gehen sie wie folgt vor:
+
+
+
+Verfahrensschritte:
+
+1) Der Endbenutzer meldet sich an, die Clientanwendung sendet die Authentifizierungsanforderung an den Autorisierungsserver, um ein Zugriffstoken zu erhalten.
+
+2) Der Autorisierungsserver überprüft die Anforderung und generiert ein Zugriffstoken für den Client.
+
+3) Der Client verwendet dieses Zugriffstoken, um HTTP-Anforderungen an das API-Gateway zu senden.
+
+4) Das API-Gateway führt dann folgendes aus:
+ - Identifiziert die Anwendung anhand der client_Id.
+ - Überprüft das Token lokal oder remote, wenn es lokal nicht möglich ist.
+ - Überprüft, ob die angeforderte Ressource Teil des Bereichs im Token ist.
+
+Wurden alle Prüfschritte erfolgreich absolviert, wird die Anfrage an den Zustelldienst übergeben.
+
+Nach Bearbeitung der Anfrage im Zustelldienst wird die Antwort des Zustelldienstes an den Client zurückgesendet.
+
+## Testverfahren mit dem Tool Postman
+
+Für Tests kann auch SoapUI oder jeder andere REST Client mit OAuth 2.0 Unterstützung eingesetzt werden.
+Unter diesen beiden Adressen können Sie eine Postman Collection und eine Postman Environment herunterladen:
+- [Collection](https://raw.githubusercontent.com/fiep-poc/assets/master/postman/FIT-Connect.postman_collection.json)
+- [Environment](https://raw.githubusercontent.com/fiep-poc/assets/master/postman/FIT-Connect.postman_environment.json)
+
+### API Aufruf mit Postman OAuth 2.0 Konfiguration
+
+Mit diesen Angaben können Sie das API z.B. via Postman nutzen. Dazu wählen sie zunächst den Bereich "Authorization" aus. Danach kann der Button "Get New Access Token" genutzt werden.
+
+
+
+
+
+
+
+Mit diesem Token kann das API erfolgreich aufgerufen werden.
+
+
+
+In diesem Beispiel wurde eine neue Destination angelegt.
+
+### API Aufruf mit wget
+
+Sie können auch mit dem Kommandozeilentool "wget" testen. In diesem Beispiel wird die Liste aller Destinations abgerufen:
+
+```bash
+wget --quiet --output-document - \
+ --method GET \
+ --timeout=0 \
+ --header 'Accept: application/json' \
+ --header 'Authorization: Bearer 5eadf042ef434913a5724d5e5ce38bc0' \
+ 'https://subscriber.fiep-poc.de/subscriber-c94ae37e-dcc5-345e-a530-8651bdfa5f2c/destinations'
+```
+
+### Manueller OAuth 2.0 Fluss
+
+Ein Entwickler hat in der Regel keine OAuth 2.0 Funktion direkt zur Verfügung. Daher müssen die Schritte einzeln durchgeführt werden. Um Zugriff auf die APIs zu erhalten muss Ihr Client zuerst einen OAuth Zugriff machen, um mit “client_id“, “client_secret“ ein Zugriffs-Token zu erhalten.
+
+Die URL für den OAuth Zugriff lautet:
+https://oauth.fiep-poc.de/invoke/pub.apigateway.oauth2/getAccessToken
+
+Folgende Query Parameter sind dabei mitzugeben:
+- grant_type: client_credentials (fix)
+- client_id: c1bbee16-fae1-4dc1-b0c6-b75a02b359b0 (Beispiel)
+- client_secret: 91e7f6dd-5567-456f-a8be-aac10237c4c8 (Beispiel)
+- scope: subscriber-c94ae37e-dcc5-345e-a530-8651bdfa5f2c:manage (Beispiel)
+
+<!-- theme: warning -->
+> **Hinweis zu den Token:**
+> Für den Zugriff auf die beiden APIs sind zwei unterschiedliche Scopes erforderlich. Diese enthalten beide Ihre Anwender-ID und könnten beispielsweise wie folgt aussehen:
+> - Für die Application Subscriber API: **subscriber-**c94ae37e-dcc5-345e-a530-8651bdfa5f2c:manage
+> - Für die Application Sender API: **sender-**c94ae37e-dcc5-345e-a530-8651bdfa5f2c:manage
+>
+> Sie können beim holen des Access Token das richtige Scope einsetzen oder ein Token für beide Scopes/APIs beziehen. Dazu schreiben Sie beide Scopes mit einem Leerzeichen dazwischen hintereinander:
+>
+> `subscriber-c94ae37e-dcc5-345e-a530-8651bdfa5f2c:manage sender-c94ae37e-dcc5-345e-a530-8651bdfa5f2c:manage`
+>
+> 
+>
+> Bitte beachten Sie, dass Sie statt "c94ae37e-dcc5-345e-a530-8651bdfa5f2c" Ihre Anwender-ID einsetzen müssen.
+
+Ein Aufruf mit dem Werkzeug "wget" sieht z.B. wie folgt aus:
+
+```bash
+wget --quiet --output-document - \
+ --method GET \
+ 'https://oauth.fiep-poc.de/invoke/pub.apigateway.oauth2/getAccessToken?grant_type=client_credentials&client_id=c1bbee16-fae1-4dc1-b0c6-b75a02b359b0&client_secret=91e7f6dd-5567-456f-a8be-aac10237c4c8&scope=subscriber-c94ae37e-dcc5-345e-a530-8651bdfa5f2c:manage'
+```
+
+Alternativ kann der Request auch per POST durchgeführt werden:
+
+```bash
+wget --quiet --output-document - \
+ --post-data 'grant_type=client_credentials&client_id=c1bbee16-fae1-4dc1-b0c6-b75a02b359b0&client_secret=91e7f6dd-5567-456f-a8be-aac10237c4c8&scope=subscriber-c94ae37e-dcc5-345e-a530-8651bdfa5f2c:manage' \
+ 'https://oauth.fiep-poc.de/invoke/pub.apigateway.oauth2/getAccessToken'
+```
+
+Die Antwort sieht in etwa wie folgt aus:
+
+```json
+{
+ "access_token": "0bd226153b394d209a9d57bd7a42ee70",
+ "token_type": "Bearer",
+ "expires_in": 3600
+}
+```
+
+Der Wert für "access_token" wird dann als Header Parameter "Authorization" zusammen mit dem Text "Bearer" verwendet.
+
+Hier wieder ein Beispiel mit dem Tool "wget":
+
+```bash
+wget --quiet --output-document - \
+ --method GET \
+ --header 'Authorization: Bearer 0bd226153b394d209a9d57bd7a42ee70' \
+ 'https://subscriber.fiep-poc.de/subscriber-c94ae37e-dcc5-345e-a530-8651bdfa5f2c/destinations'
+```
diff --git a/docs/5_Status-_und_Fehlercodes.md b/docs/5_Status-_und_Fehlercodes.md
index e79a83003af756b8c279ceeda8d5fc5c36c02975..6b3b775d59f002fff7ac0387a3a04cdfc6d4dc16 100644
--- a/docs/5_Status-_und_Fehlercodes.md
+++ b/docs/5_Status-_und_Fehlercodes.md
@@ -34,12 +34,10 @@ Bei durch den API-Client verursachte Fehler (HTTP Statusklasse 4XX), liefert die
Eine Error Mitteilung enthält folgende Angaben:
- code: Standardisierter Fehlercode
-
- msg: Textuelle Fehlermeldung
-
- ref: Referenz auf fehlerhafte Stelle
+- `code`: Standardisierter Fehlercode
+- `msg`: Textuelle Fehlermeldung
+- `ref`: Referenz auf fehlerhafte Stelle
### Liste der Fehlercodes
-**... Noch in der Erstellung ...**
\ No newline at end of file
+**... Noch in der Erstellung ...**
diff --git a/docs/Release Notes/Version_0.2.md b/docs/Release Notes/Version_0.2.md
new file mode 100644
index 0000000000000000000000000000000000000000..b6c72f3a79080507ac8e4b226236f0945c0bb3d6
--- /dev/null
+++ b/docs/Release Notes/Version_0.2.md
@@ -0,0 +1,64 @@
+# Version 0.2
+Veröffentlicht 2020-03-31
+
+## Modelle
+### Antragsteller - Organisation
+models/application/applicant-organization.json
+- Property "role" entfernt
+- Property "org-validation/validated" entfernt
+- Property "legal-representatives" ist jetzt eine $ref auf models/common/individual.json
+
+### Antragsteller - Natürliche Person
+models/application/applicant-person.json
+- Property "role" entfernt
+
+### Application Schema
+Das Schema wurde umgebaut und enthält jetzt drei Angaben:
+- mime-type: ist entweder "json" oder "xml"
+- schema-source: Quelle für das Schema. Kann "fim" oder "none" sein. Bei "none" dürfen beliebige Datenstrukturen übertragen werden.
+- schema-id: ID des Schemas, ist von der Schema Quelle (schema-source) abhängig.
+
+### Person
+Die Person (Verzeichnis models/person/) wurde weitestgehend entfernt. Es gibt nur noch das Modell models/common/individual.json für eine natürliche Person.
+
+### Phone
+models/common/phone.json
+- Properties "number" und "type" sind jetzt verpflichtend
+
+### Destination
+Die Destination wurde in mehrere Modelle zerlegt, um dem Sender einen anderen Umfang zu zeigen als dem Subscriber.
+
+### Statusübersicht
+models/status-overview.json
+- Umbenannt: models/status.json → models/status-overview.json
+- Enum Wert "sending" entfernt
+- Property "since" in "timestamp" umbenannt
+- Property "number" ergänzt
+
+### Error Body
+models/error-body.json
+- Umbenannt: models/error.json → models/error-body.json
+- Enthält jetzt ein Array von Fehlern, statt nur einem.
+
+### Neue Modelle
+- base64: models/common/base64.json
+- JSON Web Encryption (JWE): models/common/jwe.json
+- JSON Web Key (JWK): models/common/jwk.json
+
+## Application Sender API
+reference/sender.json
+- Vorkommen von "Transfer" in "Application" umbenannt
+ - Dadurch sind auch Operation-IDs geändert worden (siehe unten)
+- OAuth2 Scopes ergänzt
+- Operation "Get Status Entry" (get-application-status-entry) entfernt
+- Operation "Get Application Upload Status"
+ - Property "docs/doc-id" ergänzt
+- Operation "Create Application": ID in create-application geändert
+- Operation "Send Application" (früher "Commit Application"): ID in commit-application geändert
+
+## Application Subscriber API
+- OAuth2 Scopes ergänzt
+- Operation "Acknowledge Application" (früher "Commit Application"): ID in ack-application geändert
+
+## Dokumentation
+Die Dokumentation im Verzeichnis "docs" wurde erstellt.
diff --git a/docs/Release Notes/Version_0.3.md b/docs/Release Notes/Version_0.3.md
new file mode 100644
index 0000000000000000000000000000000000000000..b454f67ecbe1d4eaa61ed13a53ebfd810a6d6a1e
--- /dev/null
+++ b/docs/Release Notes/Version_0.3.md
@@ -0,0 +1,34 @@
+# Version 0.3
+## Modelle
+
+### Application Metadata
+models/application/metadata-no-id.json
+- Property "data/size" ergänzt
+
+### eID
+models/common/eID-org-acting-person.json
+- Property "artictic-name" in "artistic-name" umbenannt
+
+### Internationale Adresse
+models/common/address-international.json
+- Property "lines":
+ - Es müssen mindestens zwei Zeilen angegeben werden
+ - Maximallänge 35 Zeichen
+
+### Nationale Adresse
+models/common/address-national.json
+- Alle Propertys mit weiteren Einschränkungen wir Maximallänge oder Pattern versehen
+
+### eID
+models/common/eID-org-acting-person.json
+- Property "academic-title" in "doctoral-degrees" umbenannt
+
+### Phone
+models/common/phone.json
+- Property "number": Formatbeschränkung gelockert
+- Property "type" entfernt
+- Property "description" hinzugefügt
+
+### Phone Number
+models/common/phonenr.json
+- Unbenutztes Modell gelöscht
diff --git a/docs/Release Notes/Version_0.4.md b/docs/Release Notes/Version_0.4.md
new file mode 100644
index 0000000000000000000000000000000000000000..f301f5e91c0c4a246dff6aa9ccff444c436dece1
--- /dev/null
+++ b/docs/Release Notes/Version_0.4.md
@@ -0,0 +1,16 @@
+# Version 0.4
+## Modelle
+- Alle Bezeichner auf CamelCase umgestellt.
+- Beispiele angepasst.
+
+### Application Metadata
+models/application/metadata-no-id.json
+- data/mimeType entfernt, da redundant zu data/schema/mimeType
+
+## Application Sender API
+- Alle Bezeichner auf CamelCase umgestellt.
+- Beispiele angepasst.
+
+## Application Subscriber API
+- Alle Bezeichner auf CamelCase umgestellt.
+- Beispiele angepasst.
diff --git a/docs/Release Notes/Version_0.5.md b/docs/Release Notes/Version_0.5.md
new file mode 100644
index 0000000000000000000000000000000000000000..b8f01c980588746b9d35c164997b895da17d1d34
--- /dev/null
+++ b/docs/Release Notes/Version_0.5.md
@@ -0,0 +1,61 @@
+# Nächste Version (0.5)
+
+## Übergreifende Änderungen
+
+### Basis-URLs
+Die Basis-URLs werden ab sofort mit jeder neuen Version geändert, damit ein paralleler Betrieb mehrerer API-Versionen möglich ist.
+Die Basis-URLs für diese Version sind:
+- https://sender.fiep-poc.de/beta5/
+- https://subscriber.fiep-poc.de/beta5/
+
+### CR-1: Diversen Modellen den Discriminator "type" hinzugefügt:
+- models/application/applicant-contact-info.json
+- models/application/applicant-contact-info.json
+- models/application/applicant-person.json
+- models/application/applicant.json
+- models/common/address-international.json
+- models/common/address-national.json
+- models/common/address-postbox.json
+- models/common/individual.json
+- models/destination-no-id.json
+
+### CR-3: Source in Sender ändern
+In der Dokumentation werden die Begriffe "Source" und "Sender" synonym verwendet. Um die Dokumentation klarer zu machen, wurden alle Vorkommen von "Source" in "Sender" geändert.
+
+<!-- theme: warning -->
+> **Hinweis:** Dies wirkt sich auch auf die OAuth-Scopes aus. Der Scope `{senderId}:source:manage` wurde in `{senderId}:sender:manage` geändert.
+
+### CR-5: Zusätzliche Properties verbieten
+- Wo möglich wurde `"additionalProperties": false` gesetzt um weitere Properties zu verbieten.
+- Bei den Metadaten und der Destination ohne ID musste `"additionalProperties": false` wieder entfernt werden da sonst keine Ableitung mit `allOf` möglich ist.
+
+## Dokumentation
+- Release Notes mit aufgenommen
+- Dokumentation zu OAuth integriert
+- Token- und Refresh-URL eingetragen
+- Postman Collection & Environment integriert
+
+## Modelle
+
+### Destination
+models/destination-no-id.json
+
+### eID
+- eID-org-acting-person.json aufgelöst und in eID-natural-person.json integriert.
+
+### Postfachadresse
+models/common/address-national.json
+models/common/address-postbox.json
+- Um ein doppeltes `oneOf` zu vermeiden wurde die Postfach Adresse aus der nationalen Adresse herausgelöst.
+
+## Application Sender API
+
+### Application Document
+models/application/document.json
+- Regex Pattern für SHA-256/512 Hash präzisiert: "`[0-9A-F]{64,128}`" -> "`^[A-Fa-f0-9]{64}([A-Fa-f0-9]{64})?$`"
+
+## Application Subscriber API
+
+### Acknowledge Application
+- Bugfix: Property `final-delivery` auf Camelcase umgestellt.
+- Bugfix: Angaben von `finalDelivery` in Acknowledge Application ist verpflichtend.
diff --git a/models/application/applicant-contact-info.json b/models/application/applicant-contact-info.json
index 20d3e9bc9b97af8b62399d7d80e98021b8c742d6..7608c9f1353100267c21584bf9210ee03cb38b69 100644
--- a/models/application/applicant-contact-info.json
+++ b/models/application/applicant-contact-info.json
@@ -1,18 +1,53 @@
{
- "title": "Applicant Contact Info",
"type": "object",
+ "title": "Applicant Contact Info",
"description": "Kontaktdaten des Antragstellers",
+ "additionalProperties": false,
+ "x-examples": {
+ "example-1": {
+ "electronicAdresses": [
+ {
+ "channelType": "Service-Account-Mailbox",
+ "address": "3b0c9c8c-0801-45f0-a331-2abfc9db78d0"
+ }
+ ],
+ "physicalAdress": {
+ "street": "Kurzer Weg",
+ "houseNumber": "7",
+ "postalCode": "12345",
+ "city": "Ankh-Morpork"
+ },
+ "telephone": [
+ {
+ "number": "+49 89 32168-42",
+ "mobile": true,
+ "description": "work"
+ }
+ ]
+ }
+ },
"properties": {
"physicalAddress": {
"oneOf": [
{
"$ref": "../common/address-national.json"
},
+ {
+ "$ref": "../common/address-postbox.json"
+ },
{
"$ref": "../common/address-international.json"
}
],
- "description": "Physikalische (Post-)Adresse"
+ "description": "Physikalische (Post-)Adresse",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "national": "../common/address-national.json",
+ "postbox": "../common/address-postbox.json",
+ "international": "../common/address-international.json"
+ }
+ }
},
"telephone": {
"type": "array",
@@ -27,6 +62,7 @@
"items": {
"type": "object",
"description": "",
+ "additionalProperties": false,
"properties": {
"channelType": {
"type": "string",
diff --git a/models/application/applicant-organization.json b/models/application/applicant-organization.json
index 5f7f3c7d12c8738be1617fe343e7b6371fe1c61f..41a56c6be09ff057f2e55f3d46f651bc86feea7d 100644
--- a/models/application/applicant-organization.json
+++ b/models/application/applicant-organization.json
@@ -1,7 +1,8 @@
{
- "title": "Applicant Organisation",
"type": "object",
+ "title": "Applicant Organisation",
"description": "Antragsteller in Form von einer Organisation, z.B. einem Unternehmen",
+ "additionalProperties": false,
"properties": {
"identifier": {
"type": "array",
@@ -18,6 +19,7 @@
"description": "Im Namen der Organisation auftretende natürliche Personen, wie z.B. Geschäftsführer, Vorstände oder Prokuristen",
"items": {
"type": "object",
+ "additionalProperties": false,
"properties": {
"identityInfo": {
"$ref": "../common/eID-natural-person.json"
@@ -31,6 +33,7 @@
"organizationInfo": {
"type": "object",
"description": "Informationen über die Organisation",
+ "additionalProperties": false,
"properties": {
"legalName": {
"type": "string",
@@ -57,11 +60,22 @@
{
"$ref": "../common/address-national.json"
},
+ {
+ "$ref": "../common/address-postbox.json"
+ },
{
"$ref": "../common/address-international.json"
}
],
- "description": "Offizielle Adresse"
+ "description": "Offizielle Adresse",
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "national": "../common/address-national.json",
+ "postbox": "../common/address-postbox.json",
+ "international": "../common/address-international.json"
+ }
+ }
},
"legalRepresentatives": {
"type": "array",
@@ -75,6 +89,7 @@
"orgValidation": {
"type": "object",
"description": "Informationen, ob diese Organisation vom sendenden System identifiziert wurde",
+ "additionalProperties": false,
"properties": {
"method": {
"type": "string",
@@ -84,6 +99,15 @@
"required": [
"method"
]
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "organization"
+ ]
}
- }
+ },
+ "required": [
+ "type"
+ ]
}
\ No newline at end of file
diff --git a/models/application/applicant-person.json b/models/application/applicant-person.json
index 3b5a780f9017d075bcde51c3d0f6334b9e9707e2..a64e4d71c89bd90be66896cfcd905d20a11dc7d0 100644
--- a/models/application/applicant-person.json
+++ b/models/application/applicant-person.json
@@ -1,7 +1,8 @@
{
- "title": "Applicant Person",
"type": "object",
+ "title": "Applicant Person",
"description": "Antragstellerdaten für eine natürliche Person",
+ "additionalProperties": false,
"properties": {
"identifier": {
"type": "array",
@@ -18,63 +19,57 @@
},
"contactInfo": {
"$ref": "./applicant-contact-info.json"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "person"
+ ]
}
},
+ "required": [
+ "type"
+ ],
"x-examples": {
"example-1": {
- "identifier": [
- {
- "id": "918",
- "schemeName": "Antragsportal",
- "schemeId": "urn:com:example:antragsportal:user"
+ "type": "person",
+ "authentificationInfo": {
+ "assuranceLevel": "high",
+ "authentificationMethod": "eID",
+ "timestamp": "2020-03-03T12:38:23Z"
+ },
+ "identityInfo": {
+ "dateOfBirth": "1970-09-13",
+ "gender": "m",
+ "givenName": "WERNER",
+ "familyName": "MUSTERMANN",
+ "placeOfResidence": {
+ "type": "national",
+ "street": "KURZER WEG 7",
+ "postalCode": "12345",
+ "city": "ANKH-MORPORK"
}
- ],
+ },
"contactInfo": {
- "physicalAddress": {
+ "electronicAdresses": [
+ {
+ "channelType": "Service-Account-Mailbox",
+ "address": "3b0c9c8c-0801-45f0-a331-2abfc9db78d0"
+ }
+ ],
+ "physicalAdress": {
"street": "Kurzer Weg",
- "houseNumber": 7,
+ "houseNumber": "7",
"postalCode": "12345",
- "city": "string",
- "addressSupplement": "string"
+ "city": "Ankh-Morpork"
},
"telephone": [
{
"number": "+49 89 32168-42",
"mobile": true,
- "description": "string"
- }
- ],
- "electronicAddresses": [
- {
- "channelType": "Service-Account-Mailbox",
- "address": "string"
+ "description": "work"
}
]
- },
- "identityInfo": {
- "gender": "m",
- "nationality": "string",
- "familyName": "string",
- "givenName": "string",
- "birthName": "string",
- "doctoralDegrees": "string",
- "artisticName": "string",
- "dateOfBirth": "2020-04-16",
- "placeOfBirth": "string",
- "placeOfResidence": {
- "street": "string",
- "houseNumber": null,
- "houseNumberSuffix": "st",
- "postalCode": "strin",
- "city": "string",
- "addressSupplement": "string"
- }
- },
- "authentificationInfo": {
- "timestamp": "2020-04-16T06:50:39Z",
- "authentificationToken": {},
- "authentificationMethod": "string",
- "assuranceLevel": "low"
}
}
}
diff --git a/models/application/applicant.json b/models/application/applicant.json
index a07958d62ee87719a84fdc328f2b1e2ad324d475..8a7b21172062a4e333f6fe2237ed427cfb9fd1f7 100644
--- a/models/application/applicant.json
+++ b/models/application/applicant.json
@@ -1,4 +1,6 @@
{
+ "title": "Applicant",
+ "description": "Ein Antragsteller, entweder eine Organisation oder eine natürliche Person",
"oneOf": [
{
"$ref": "./applicant-person.json"
@@ -7,6 +9,11 @@
"$ref": "./applicant-organization.json"
}
],
- "title": "Applicant",
- "description": "Ein Antragsteller, entweder eine Organisation oder eine natürliche Person"
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "person": "./applicant-person.json",
+ "organization": "./applicant-organization.json"
+ }
+ }
}
\ No newline at end of file
diff --git a/models/application/document.json b/models/application/document.json
index 82321023b07265dea00dd1f664c6cb63d79b6add..df5106a975faca8c6d8e6846ae11e2d1a4373094 100644
--- a/models/application/document.json
+++ b/models/application/document.json
@@ -1,37 +1,8 @@
{
- "title": "Application Document",
"type": "object",
+ "title": "Application Document",
"description": "Ein im Antrag (Application) enthaltenes Dokument (z.B. Antragsformular oder hochgeladene Anlage)",
- "x-examples": {
- "example-1": {
- "docId": "1",
- "purpose": "form",
- "size": 39273,
- "mimeType": "application/pdf",
- "filename": "antrag.pdf",
- "description": "Das Antragsformular",
- "lang": {
- "lang": "de",
- "region": "DE"
- },
- "hash": {
- "algorithm": "SHA-256",
- "digest": "03ba204e50d126e4674c005e04d82e84c21366780af1f43bd54a37816b6ab340"
- }
- },
- "example-2": {
- "docId": "2",
- "purpose": "attachment",
- "size": 894834874,
- "mimeType": "image/jpeg",
- "filename": "scan.jpg",
- "description": "Scan der Bescheinigung",
- "hash": {
- "algorithm": "SHA-256",
- "digest": "e1762f14d9924e37b32f1c81dfd256410af462f5136415c96877efa8c80345d0"
- }
- }
- },
+ "additionalProperties": false,
"properties": {
"purpose": {
"type": "string",
@@ -73,7 +44,7 @@
"digest": {
"type": "string",
"description": "Prüfsumme, hexadezimal codiert",
- "pattern": "[0-9A-F]{64,128}"
+ "pattern": "^[A-Fa-f0-9]{64}([A-Fa-f0-9]{64})?$"
}
},
"required": [
@@ -101,5 +72,23 @@
"purpose",
"size",
"mimeType"
- ]
+ ],
+ "x-examples": {
+ "example-1": {
+ "docId": "1",
+ "purpose": "form",
+ "size": 13046,
+ "mimeType": "application/pdf",
+ "filename": "test.pdf",
+ "description": "Das Antragsformular",
+ "lang": {
+ "lang": "de",
+ "region": "DE"
+ },
+ "hash": {
+ "algorithm": "SHA-256",
+ "digest": "bf37d894fdf9aeade63975ed648d49c3e8a7a773923597d2418915f54cd7c3b9"
+ }
+ }
+ }
}
\ No newline at end of file
diff --git a/models/application/metadata-no-id.json b/models/application/metadata-no-id.json
index e133c27ea2af2ffd442de8f62e560c5151b66691..fa493552c2a2c66c5a9f05f3edbfb7a1cfd6aa37 100644
--- a/models/application/metadata-no-id.json
+++ b/models/application/metadata-no-id.json
@@ -1,6 +1,6 @@
{
- "title": "Application Metadata without ID",
"type": "object",
+ "title": "Application Metadata without ID",
"description": "Metadaten eines Antrags noch ohne ID, zum Anlegen eines neuen Antrags. Nach dem Zuweisen der `application-id` wird das Modell [Application Metadata](metadata.json) verwendet.",
"x-examples": {
"example-1": {
@@ -10,7 +10,6 @@
},
"contentStructure": {
"data": {
- "size": 9438,
"schema": {
"mimeType": "json",
"schemaSource": "none"
@@ -20,9 +19,9 @@
{
"docId": "1",
"purpose": "form",
- "size": 39273,
+ "size": 13046,
"mimeType": "application/pdf",
- "filename": "antrag.pdf",
+ "filename": "test.pdf",
"description": "Das Antragsformular",
"lang": {
"lang": "de",
@@ -30,19 +29,7 @@
},
"hash": {
"algorithm": "SHA-256",
- "digest": "03ba204e50d126e4674c005e04d82e84c21366780af1f43bd54a37816b6ab340"
- }
- },
- {
- "docId": "2",
- "purpose": "attachment",
- "size": 894834874,
- "mimeType": "image/jpeg",
- "filename": "scan.jpg",
- "description": "Scan der Bescheinigung",
- "hash": {
- "algorithm": "SHA-256",
- "digest": "e1762f14d9924e37b32f1c81dfd256410af462f5136415c96877efa8c80345d0"
+ "digest": "bf37d894fdf9aeade63975ed648d49c3e8a7a773923597d2418915f54cd7c3b9"
}
}
]
@@ -54,75 +41,60 @@
"otherIdentifiers": [
{
"id": "8664844",
- "schemeURI": "service.niedersachsen.de",
+ "schemeID": "service.niedersachsen.de",
"schemeName": "Serviceportal Niedersachsen"
},
{
"id": "354824",
- "schemeURI": "buerger.thueringen.de",
+ "schemeID": "buerger.thueringen.de",
"schemeName": "Zuständigkeitsfinder Thüringen"
}
]
},
"applicants": [
{
- "identifier": [
- {
- "id": "918",
- "schemeName": "Antragsportal",
- "schemeId": "urn:com:example:antragsportal:user"
+ "type": "person",
+ "authentificationInfo": {
+ "assuranceLevel": "high",
+ "authentificationMethod": "eID",
+ "timestamp": "2020-03-03T12:38:23Z"
+ },
+ "identityInfo": {
+ "dateOfBirth": "1970-09-13",
+ "gender": "m",
+ "givenName": "WERNER",
+ "familyName": "MUSTERMANN",
+ "placeOfResidence": {
+ "type": "national",
+ "street": "KURZER WEG 7",
+ "postalCode": "12345",
+ "city": "ANKH-MORPORK"
}
- ],
+ },
"contactInfo": {
- "physicalAddress": {
+ "electronicAdresses": [
+ {
+ "channelType": "Service-Account-Mailbox",
+ "address": "3b0c9c8c-0801-45f0-a331-2abfc9db78d0"
+ }
+ ],
+ "physicalAdress": {
"street": "Kurzer Weg",
- "houseNumber": 7,
+ "houseNumber": "7",
"postalCode": "12345",
- "city": "string",
- "addressSupplement": "string"
+ "city": "Ankh-Morpork"
},
"telephone": [
{
"number": "+49 89 32168-42",
"mobile": true,
- "description": "string"
- }
- ],
- "electronicAddresses": [
- {
- "channelType": "Service-Account-Mailbox",
- "address": "string"
+ "description": "work"
}
]
- },
- "identityInfo": {
- "gender": "m",
- "nationality": "string",
- "familyName": "string",
- "givenName": "string",
- "birthName": "string",
- "doctoralDegrees": "string",
- "artisticName": "string",
- "dateOfBirth": "2020-04-16",
- "placeOfBirth": "string",
- "placeOfResidence": {
- "street": "string",
- "houseNumber": null,
- "houseNumberSuffix": "st",
- "postalCode": "strin",
- "city": "string",
- "addressSupplement": "string"
- }
- },
- "authentificationInfo": {
- "timestamp": "2020-04-16T06:50:39Z",
- "authentificationToken": {},
- "authentificationMethod": "string",
- "assuranceLevel": "low"
}
}
],
- "payment-info": {
+ "paymentInfo": {
"reference": "TP/93/GDP",
"usage": "Gewerbeanmeldung",
"amount": 17.3,
@@ -147,6 +119,7 @@
},
"contentStructure": {
"type": "object",
+ "additionalProperties": false,
"required": [
"data",
"docs"
@@ -154,6 +127,7 @@
"properties": {
"data": {
"type": "object",
+ "additionalProperties": false,
"required": [
"schema"
],
@@ -177,6 +151,7 @@
},
"additionalReferenceInfo": {
"type": "object",
+ "additionalProperties": false,
"properties": {
"subject": {
"type": "string"
diff --git a/models/application/metadata.json b/models/application/metadata.json
index b39c1ae363952c3bc4064d0abbaaa817339aa3aa..22a0c3fbd1fe1f5603c7e595672cdd815f39a286 100644
--- a/models/application/metadata.json
+++ b/models/application/metadata.json
@@ -21,14 +21,12 @@
"description": "Metadaten zu einem Antrag.",
"x-examples": {
"example-1": {
- "applicationId": "7236",
"additionalReferenceInfo": {
"subject": "Anmeldung eines Gewerbes in Musterstadt",
"caseId": "DF/8923"
},
"contentStructure": {
"data": {
- "size": 9438,
"schema": {
"mimeType": "json",
"schemaSource": "none"
@@ -38,9 +36,9 @@
{
"docId": "1",
"purpose": "form",
- "size": 39273,
+ "size": 13046,
"mimeType": "application/pdf",
- "filename": "antrag.pdf",
+ "filename": "test.pdf",
"description": "Das Antragsformular",
"lang": {
"lang": "de",
@@ -48,19 +46,7 @@
},
"hash": {
"algorithm": "SHA-256",
- "digest": "03ba204e50d126e4674c005e04d82e84c21366780af1f43bd54a37816b6ab340"
- }
- },
- {
- "docId": "2",
- "purpose": "attachment",
- "size": 894834874,
- "mimeType": "image/jpeg",
- "filename": "scan.jpg",
- "description": "Scan der Bescheinigung",
- "hash": {
- "algorithm": "SHA-256",
- "digest": "e1762f14d9924e37b32f1c81dfd256410af462f5136415c96877efa8c80345d0"
+ "digest": "bf37d894fdf9aeade63975ed648d49c3e8a7a773923597d2418915f54cd7c3b9"
}
}
]
@@ -72,82 +58,68 @@
"otherIdentifiers": [
{
"id": "8664844",
- "schemeURI": "service.niedersachsen.de",
+ "schemeID": "service.niedersachsen.de",
"schemeName": "Serviceportal Niedersachsen"
},
{
"id": "354824",
- "schemeURI": "buerger.thueringen.de",
+ "schemeID": "buerger.thueringen.de",
"schemeName": "Zuständigkeitsfinder Thüringen"
}
]
},
"applicants": [
{
- "identifier": [
- {
- "id": "918",
- "schemeName": "Antragsportal",
- "schemeId": "urn:com:example:antragsportal:user"
+ "type": "person",
+ "authentificationInfo": {
+ "assuranceLevel": "high",
+ "authentificationMethod": "eID",
+ "timestamp": "2020-03-03T12:38:23Z"
+ },
+ "identityInfo": {
+ "dateOfBirth": "1970-09-13",
+ "gender": "m",
+ "givenName": "WERNER",
+ "familyName": "MUSTERMANN",
+ "placeOfResidence": {
+ "type": "national",
+ "street": "KURZER WEG 7",
+ "postalCode": "12345",
+ "city": "ANKH-MORPORK"
}
- ],
+ },
"contactInfo": {
- "physicalAddress": {
+ "electronicAdresses": [
+ {
+ "channelType": "Service-Account-Mailbox",
+ "address": "3b0c9c8c-0801-45f0-a331-2abfc9db78d0"
+ }
+ ],
+ "physicalAdress": {
"street": "Kurzer Weg",
- "houseNumber": 7,
+ "houseNumber": "7",
"postalCode": "12345",
- "city": "string",
- "addressSupplement": "string"
+ "city": "Ankh-Morpork"
},
"telephone": [
{
"number": "+49 89 32168-42",
"mobile": true,
- "description": "string"
- }
- ],
- "electronicAddresses": [
- {
- "channelType": "Service-Account-Mailbox",
- "address": "string"
+ "description": "work"
}
]
- },
- "identityInfo": {
- "gender": "m",
- "nationality": "string",
- "familyName": "string",
- "givenName": "string",
- "birthName": "string",
- "doctoralDegrees": "string",
- "artisticName": "string",
- "dateOfBirth": "2020-04-16",
- "placeOfBirth": "string",
- "placeOfResidence": {
- "street": "string",
- "houseNumber": null,
- "houseNumberSuffix": "st",
- "postalCode": "strin",
- "city": "string",
- "addressSupplement": "string"
- }
- },
- "authentificationInfo": {
- "timestamp": "2020-04-16T06:50:39Z",
- "authentificationToken": {},
- "authentificationMethod": "string",
- "assuranceLevel": "low"
}
}
],
- "payment-info": {
+ "paymentInfo": {
"reference": "TP/93/GDP",
"usage": "Gewerbeanmeldung",
"amount": 17.3,
"timestamp": "2020-03-03T12:38:23Z",
"status": "success",
"transaction": "1f77c5f9b759db9cdce59988b24974d465c7be5e462a6185485559ff6e2dea82"
- }
+ },
+ "applicationId": "ce75a6b8-d72f-4b94-b09e-af6be35bc2ae"
}
}
}
\ No newline at end of file
diff --git a/models/application/public-service-type.json b/models/application/public-service-type.json
index b6db00df2e77e53ff8aaea8da17f580888ef1ef6..bdb4d7f18e370abf04258b3aedc9917576c66aa0 100644
--- a/models/application/public-service-type.json
+++ b/models/application/public-service-type.json
@@ -5,25 +5,25 @@
"additionalProperties": false,
"x-examples": {
"example-1": {
- "name": "Gewerbeanmeldung",
- "leikaId": "99050012104000"
- },
- "example-2": {
"name": "Gewerbeanmeldung",
"description": "Eine Gewerbeanmeldung ist immer dann notwendig, wenn Sie einen stehenden Gewerbebetrieb beginnen.",
"leikaId": "99050012104000",
"otherIdentifiers": [
{
"id": "8664844",
- "schemeURI": "service.niedersachsen.de",
+ "schemeID": "service.niedersachsen.de",
"schemeName": "Serviceportal Niedersachsen"
},
{
"id": "354824",
- "schemeURI": "buerger.thueringen.de",
+ "schemeID": "buerger.thueringen.de",
"schemeName": "Zuständigkeitsfinder Thüringen"
}
]
+ },
+ "example-2": {
+ "name": "Gewerbeanmeldung",
+ "leikaId": "99050012104000"
}
},
"properties": {
diff --git a/models/common/address-international.json b/models/common/address-international.json
index 1d9067e80cff697974966ccd8ba684030efd4218..9e2a9c3ebbae39c9fd9ae4b9fd9ae988229890f4 100644
--- a/models/common/address-international.json
+++ b/models/common/address-international.json
@@ -3,6 +3,24 @@
"title": "International Address",
"description": "Eine internationale Adresse, bestehend aus ein bis fünf Adresszeilen.",
"additionalProperties": false,
+ "x-examples": {
+ "example-1": {
+ "type": "international",
+ "lines": [
+ "760 United Nations Plaza",
+ "Manhattan, New York City, New York 10017"
+ ],
+ "country": "368"
+ },
+ "example-2": {
+ "type": "international",
+ "lines": [
+ "Threadneedle Street",
+ "London EC2R 8AH"
+ ],
+ "country": "168"
+ }
+ },
"properties": {
"lines": {
"type": "array",
@@ -20,26 +38,17 @@
"minLength": 3,
"maxLength": 3,
"pattern": "^[0-9]{3}$"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "international"
+ ]
}
},
"required": [
"lines",
- "country"
- ],
- "x-examples": {
- "example-1": {
- "lines": [
- "760 United Nations Plaza",
- "Manhattan, New York City, New York 10017"
- ],
- "country": "368"
- },
- "example-2": {
- "lines": [
- "Threadneedle Street",
- "London EC2R 8AH"
- ],
- "country": "168"
- }
- }
+ "country",
+ "type"
+ ]
}
\ No newline at end of file
diff --git a/models/common/address-national.json b/models/common/address-national.json
index 6dd957511040b4547f9d318fb46a5333a579db7e..7f19e7af8fe1051ccdba9fd7b4f7ed0860b7372f 100644
--- a/models/common/address-national.json
+++ b/models/common/address-national.json
@@ -3,85 +3,64 @@
"description": "Eine nationale (deutsche) Adresse, bestehend aus Straße, Hausnummer, PLZ und Ort.",
"x-examples": {
"example-1": {
+ "type": "national",
"street": "Kurzer Weg",
- "houseNumber": 7,
+ "houseNumber": "7",
"postalCode": "12345",
"city": "Ankh-Morpork"
}
},
- "oneOf": [
- {
- "additionalProperties": false,
- "properties": {
- "street": {
- "type": "string",
- "description": "Straße",
- "maxLength": 55
- },
- "houseNumber": {
- "type": [
- "string",
- "integer"
- ],
- "description": "Hausnummer",
- "maxLength": 9,
- "pattern": "^[1-9][0-9]{0,3}(-[1-9][0-9]{0,3})?$",
- "minimum": 1
- },
- "houseNumberSuffix": {
- "type": "string",
- "description": "Hausnummerzusatz",
- "maxLength": 2,
- "pattern": "^[\\p{L}0-9. ]*$"
- },
- "postalCode": {
- "type": "string",
- "description": "Postleitzahl",
- "minLength": 5,
- "maxLength": 5,
- "pattern": "^([0]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{3}$"
- },
- "city": {
- "type": "string",
- "description": "Ort",
- "maxLength": 50
- },
- "addressSupplement": {
- "type": "string",
- "description": "Adresszusatz"
- }
- },
- "required": [
- "street",
- "postalCode",
- "city"
- ]
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "street": {
+ "type": "string",
+ "description": "Straße",
+ "maxLength": 55
+ },
+ "houseNumber": {
+ "type": [
+ "string",
+ "integer"
+ ],
+ "description": "Hausnummer",
+ "maxLength": 9,
+ "pattern": "^[1-9][0-9]{0,3}(-[1-9][0-9]{0,3})?$",
+ "minimum": 1
+ },
+ "houseNumberSuffix": {
+ "type": "string",
+ "description": "Hausnummerzusatz",
+ "maxLength": 2,
+ "pattern": "^[\\p{L}0-9. ]*$"
+ },
+ "postalCode": {
+ "type": "string",
+ "description": "Postleitzahl",
+ "minLength": 5,
+ "maxLength": 5,
+ "pattern": "^([0]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{3}$"
},
- {
- "additionalProperties": false,
- "properties": {
- "postOfficeBox": {
- "type": "string",
- "description": "Postfach"
- },
- "postalCode": {
- "type": "string",
- "description": "Postleitzahl",
- "minLength": 5,
- "maxLength": 5,
- "pattern": "^([0]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{3}$"
- },
- "city": {
- "type": "string",
- "description": "Ort",
- "maxLength": 50
- }
- },
- "required": [
- "postalCode",
- "city"
+ "city": {
+ "type": "string",
+ "description": "Ort",
+ "maxLength": 50
+ },
+ "addressSupplement": {
+ "type": "string",
+ "description": "Adresszusatz"
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "national"
]
}
- ],
- "type": "object"
+ },
+ "required": [
+ "street",
+ "postalCode",
+ "city",
+ "type"
+ ]
}
\ No newline at end of file
diff --git a/models/common/address-postbox.json b/models/common/address-postbox.json
new file mode 100644
index 0000000000000000000000000000000000000000..a2aee5ac854ac06428dc0433d1df4e8874a65113
--- /dev/null
+++ b/models/common/address-postbox.json
@@ -0,0 +1,43 @@
+{
+ "title": "Postfach Address",
+ "description": "Eine Adresse eines Postfachs.",
+ "x-examples": {
+ "example-1": {
+ "type": "postbox",
+ "postOfficeBox": "987",
+ "postalCode": "12345",
+ "city": "Ankh-Morpork"
+ }
+ },
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "postOfficeBox": {
+ "type": "string",
+ "description": "Postfach"
+ },
+ "postalCode": {
+ "type": "string",
+ "description": "Postleitzahl",
+ "minLength": 5,
+ "maxLength": 5,
+ "pattern": "^([0]{1}[1-9]{1}|[1-9]{1}[0-9]{1})[0-9]{3}$"
+ },
+ "city": {
+ "type": "string",
+ "description": "Ort",
+ "maxLength": 50
+ },
+ "type": {
+ "type": "string",
+ "enum": [
+ "postbox"
+ ]
+ }
+ },
+ "required": [
+ "postalCode",
+ "city",
+ "type"
+ ]
+}
\ No newline at end of file
diff --git a/models/common/authentification-info.json b/models/common/authentification-info.json
index 69665660f20d3c0efe97935ab60f6b9b65197870..c67b3c2862a8823afdc37577b3fb861b7213f23f 100644
--- a/models/common/authentification-info.json
+++ b/models/common/authentification-info.json
@@ -1,6 +1,7 @@
{
- "title": "authentification-info",
"type": "object",
+ "title": "Authentifikation",
+ "additionalProperties": false,
"properties": {
"assuranceLevel": {
"type": "string",
@@ -24,5 +25,13 @@
"required": [
"assuranceLevel",
"authentificationMethod"
- ]
+ ],
+ "description": "Informationen über die Authentifikation der Person.",
+ "x-examples": {
+ "example-1": {
+ "assuranceLevel": "high",
+ "authentificationMethod": "eID",
+ "timestamp": "2020-03-03T12:38:23Z"
+ }
+ }
}
\ No newline at end of file
diff --git a/models/common/eID-natural-person.json b/models/common/eID-natural-person.json
index 429d6ce6a34158eb66c2563c6b2203cb6d378975..db4db9d13b55193ad6c130ee72919a7946b27974 100644
--- a/models/common/eID-natural-person.json
+++ b/models/common/eID-natural-person.json
@@ -1,17 +1,67 @@
{
- "title": "Identity Information with Address",
- "description": "",
- "allOf": [
- {
- "$ref": "./eID-org-acting-person.json"
- },
- {
- "type": "object",
- "properties": {
- "placeOfResidence": {
- "$ref": "./address-national.json"
- }
+ "title": "Identity Information",
+ "description": "Informationen aus dem eID Funktion des Personalausweises",
+ "type": "object",
+ "x-examples": {
+ "example-1": {
+ "dateOfBirth": "1970-09-13",
+ "gender": "m",
+ "givenName": "WERNER",
+ "familyName": "MUSTERMANN",
+ "placeOfResidence": {
+ "type": "national",
+ "street": "KURZER WEG 7",
+ "postalCode": "12345",
+ "city": "ANKH-MORPORK"
}
}
- ]
+ },
+ "properties": {
+ "placeOfBirth": {
+ "type": "string",
+ "description": "Geburtsort"
+ },
+ "dateOfBirth": {
+ "type": "string",
+ "format": "date",
+ "description": "Geburtsdatum"
+ },
+ "gender": {
+ "type": "string",
+ "enum": [
+ "m",
+ "w",
+ "x",
+ "d"
+ ],
+ "description": "Geschlecht (m=männlich, w=weiblich, x=keine Angabe, d=divers)"
+ },
+ "nationality": {
+ "type": "string",
+ "description": "Nationalität"
+ },
+ "artisticName": {
+ "type": "string",
+ "description": "Künstler- oder Ordensname"
+ },
+ "doctoralDegrees": {
+ "type": "string",
+ "description": "Akademischer Titel, z.B. \"Dr.\" oder \"Prof.\""
+ },
+ "birthName": {
+ "type": "string",
+ "description": "Geburtsname"
+ },
+ "givenName": {
+ "type": "string",
+ "description": "Vorname(n)"
+ },
+ "familyName": {
+ "type": "string",
+ "description": "Familienname"
+ },
+ "placeOfResidence": {
+ "$ref": "./address-national.json"
+ }
+ }
}
\ No newline at end of file
diff --git a/models/common/eID-org-acting-person.json b/models/common/eID-org-acting-person.json
deleted file mode 100644
index ce2545555cbecc53314dfe5f74df4c1cd10b6196..0000000000000000000000000000000000000000
--- a/models/common/eID-org-acting-person.json
+++ /dev/null
@@ -1,49 +0,0 @@
-{
- "title": "Identity Information without Address",
- "type": "object",
- "properties": {
- "placeOfBirth": {
- "type": "string",
- "description": "Geburtsort"
- },
- "dateOfBirth": {
- "type": "string",
- "format": "date",
- "description": "Geburtsdatum"
- },
- "gender": {
- "type": "string",
- "enum": [
- "m",
- "w",
- "x",
- "d"
- ],
- "description": "Geschlecht (m=männlich, w=weiblich, x=keine Angabe, d=divers)"
- },
- "nationality": {
- "type": "string",
- "description": "Nationalität"
- },
- "artisticName": {
- "type": "string",
- "description": "Künstler- oder Ordensname"
- },
- "doctoralDegrees": {
- "type": "string",
- "description": "Akademischer Titel, z.B. \"Dr.\" oder \"Prof.\""
- },
- "birthName": {
- "type": "string",
- "description": "Geburtsname"
- },
- "givenName": {
- "type": "string",
- "description": "Vorname(n)"
- },
- "familyName": {
- "type": "string",
- "description": "Familienname"
- }
- }
-}
\ No newline at end of file
diff --git a/models/common/identifier.json b/models/common/identifier.json
index 25caf8da6d61b43412b2de520db4013a629563e5..977f430f30e3307738d319de041a57852102b98d 100644
--- a/models/common/identifier.json
+++ b/models/common/identifier.json
@@ -1,22 +1,8 @@
{
- "title": "Identifier",
"type": "object",
+ "title": "Identifier",
"description": "Identifiers are keys that are owned by either the sender, receiver or a third party. If the keys used are owned by either sender or receiver, no meta data has to be specified by means of attributes. The table below specifies the use of attributes for the identifier types when they are owned by a third party.",
- "x-examples": {
- "example-1": {
- "id": "978-1-894049-23-8",
- "schemeId": "ISBN"
- },
- "example-2": {
- "id": "99050012104000",
- "schemeURI": "https://www.xrepository.de/details/urn:de:gkleika:leika:leistung",
- "schemeDataURI": "https://www.xrepository.de/details/urn:de:gkleika:leika:leistung_20180705#version",
- "schemeVersionId": "urn:de:gkleika:leika:leistung_20180705",
- "schemeAgencyName": "Geschäfts- und Koordinierungsstelle LeiKa beim Ministerium der Finanzen des Landes Sachsen-Anhalt (GK_LEIKA)",
- "schemeName": "Leistungen des LeiKa",
- "schemeId": "urn:de:gkleika:leika:leistung"
- }
- },
+ "additionalProperties": false,
"properties": {
"id": {
"type": "string",
@@ -55,5 +41,12 @@
},
"required": [
"id"
- ]
+ ],
+ "x-examples": {
+ "example-1": {
+ "id": "8664844",
+ "schemeId": "service.niedersachsen.de",
+ "schemeName": "Serviceportal Niedersachsen"
+ }
+ }
}
\ No newline at end of file
diff --git a/models/common/individual.json b/models/common/individual.json
index 123e4cf7a80988145200bea3e1a5ef9cd4545c37..cc3cba82820cf9652508bb268107310c5cadd14d 100644
--- a/models/common/individual.json
+++ b/models/common/individual.json
@@ -1,24 +1,8 @@
{
- "title": "Individual",
"type": "object",
+ "title": "Individual",
"description": "Natürliche Person",
- "x-examples": {
- "example-1": {
- "formOfAddress": "Herr",
- "academicTitle": "Dr.",
- "firstName": "Werner",
- "lastName": "Mustermann",
- "contact": {
- "telephone": [
- {
- "number": "+49 89 32168-42",
- "mobile": false,
- "description": "Dienstliche Telefonnummer"
- }
- ]
- }
- }
- },
+ "additionalProperties": false,
"properties": {
"formOfAddress": {
"type": "string",
@@ -40,12 +24,23 @@
"description": "Adresse als Alternative (Choice) von nationaler und internationaler Adresse.",
"oneOf": [
{
- "$ref": "../common/address-national.json"
+ "$ref": "./address-national.json"
+ },
+ {
+ "$ref": "./address-postbox.json"
},
{
- "$ref": "../common/address-international.json"
+ "$ref": "./address-international.json"
+ }
+ ],
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "national": "./address-national.json",
+ "postbox": "./address-postbox.json",
+ "international": "./address-international.json"
}
- ]
+ }
},
"identifiers": {
"type": "array",
@@ -55,8 +50,9 @@
}
},
"contact": {
- "description": "Kontaktmöglichkeiten einer Person (natürliche Person oder Organisation)",
"type": "object",
+ "description": "Kontaktmöglichkeiten einer Person (natürliche Person oder Organisation)",
+ "additionalProperties": false,
"properties": {
"telephone": {
"type": "array",
@@ -80,5 +76,28 @@
}
}
}
+ },
+ "x-examples": {
+ "example-1": {
+ "formOfAddress": "Herr",
+ "academicTitle": "Dr.",
+ "firstName": "Kunibert",
+ "lastName": "Vonundzu",
+ "contact": {
+ "telephone": [
+ {
+ "number": "+49 89 32168-42",
+ "mobile": false,
+ "description": "work"
+ },
+ {
+ "number": "+49 123 456789",
+ "mobile": true,
+ "description": "work"
+ }
+ ],
+ "email": "kunibert.vonundzu@example.com"
+ }
+ }
}
}
\ No newline at end of file
diff --git a/models/destination-no-id.json b/models/destination-no-id.json
index 8e9860a2eb02be8f745b9fdc278673e053930e1f..e26702b1d19670d89a5625d8c6981444e82fc81f 100644
--- a/models/destination-no-id.json
+++ b/models/destination-no-id.json
@@ -1,32 +1,7 @@
{
- "title": "Destination without ID",
"type": "object",
+ "title": "Destination without ID",
"description": "Daten eines technischen Ãœbergabepunkts (Ziel der Ãœbertragung - z.B. ein Fachverfahren) noch ohne ID, zum Anlegen eines neuen Ãœbergabepunkts. Nach dem Zuweisen der `destination-id` wird das Modell [Destination](destination.json) verwendet.",
- "x-examples": {
- "example-1": {
- "public-organization": {
- "organizationName": "Gewerbeamt Musterhausen"
- },
- "technicalContact": [
- {
- "firstName": "Werner",
- "lastName": "Mustermann",
- "contact": {
- "telephone": [
- {
- "number": "+49 89 32168-42",
- "mobile": false,
- "description": "Dienstliches Festnetz"
- }
- ]
- }
- }
- ],
- "callback": {
- "callbackURI": "https://www.example.com/callback"
- }
- }
- },
"properties": {
"publicOrganization": {
"type": "object",
@@ -40,10 +15,21 @@
{
"$ref": "./common/address-national.json"
},
+ {
+ "$ref": "./common/address-postbox.json"
+ },
{
"$ref": "./common/address-international.json"
}
- ]
+ ],
+ "discriminator": {
+ "propertyName": "type",
+ "mapping": {
+ "national": "./common/address-national.json",
+ "international": "./common/address-international.json",
+ "postbox": "./common/address-postbox.json"
+ }
+ }
},
"identifiers": {
"type": "array",
@@ -108,5 +94,61 @@
"callbackURI"
]
}
+ },
+ "x-examples": {
+ "example-1": {
+ "publicOrganization": {
+ "organizationName": "Gewerbeamt Musterstadt",
+ "address": {
+ "type": "national",
+ "street": "Kurzer Weg",
+ "houseNumber": "7",
+ "postalCode": "12345",
+ "city": "Ankh-Morpork"
+ },
+ "contact": {
+ "telephone": [
+ {
+ "number": "+49 89 32168-0",
+ "mobile": false,
+ "description": "work"
+ }
+ ],
+ "email": "behoerde@example.com"
+ }
+ },
+ "technicalContact": [
+ {
+ "formOfAddress": "Herr",
+ "academicTitle": "Dr.",
+ "firstName": "Kunibert",
+ "lastName": "Vonundzu",
+ "contact": {
+ "telephone": [
+ {
+ "number": "+49 89 32168-42",
+ "mobile": false,
+ "description": "work"
+ },
+ {
+ "number": "+49 123 456789",
+ "mobile": true,
+ "description": "work"
+ }
+ ],
+ "email": "kunibert.vonundzu@example.com"
+ }
+ }
+ ],
+ "schemas": [
+ {
+ "mimeType": "json",
+ "schemaSource": "none"
+ }
+ ],
+ "callback": {
+ "callbackURI": "http://127.0.0.1:4010/voluptas"
+ }
+ }
}
}
\ No newline at end of file
diff --git a/models/destination.json b/models/destination.json
index 763bb63ab1cb837242daa40035a1d4a36eadd500..e5f1d52c5deb6279aeab11baf97c7a4faef550c8 100644
--- a/models/destination.json
+++ b/models/destination.json
@@ -21,28 +21,59 @@
"description": "Beschreibung eines technischen Ãœbergabepunkts",
"x-examples": {
"example-1": {
- "destination-id": "83578",
- "public-organization": {
- "organizationName": "Gewerbeamt Musterhausen"
+ "publicOrganization": {
+ "organizationName": "Gewerbeamt Musterstadt",
+ "address": {
+ "type": "national",
+ "street": "Kurzer Weg",
+ "houseNumber": "7",
+ "postalCode": "12345",
+ "city": "Ankh-Morpork"
+ },
+ "contact": {
+ "telephone": [
+ {
+ "number": "+49 89 32168-0",
+ "mobile": false,
+ "description": "work"
+ }
+ ],
+ "email": "behoerde@example.com"
+ }
},
"technicalContact": [
{
- "firstName": "Werner",
- "lastName": "Mustermann",
+ "formOfAddress": "Herr",
+ "academicTitle": "Dr.",
+ "firstName": "Kunibert",
+ "lastName": "Vonundzu",
"contact": {
"telephone": [
{
"number": "+49 89 32168-42",
"mobile": false,
- "description": "Dienstliches Festnetz"
+ "description": "work"
+ },
+ {
+ "number": "+49 123 456789",
+ "mobile": true,
+ "description": "work"
}
- ]
+ ],
+ "email": "kunibert.vonundzu@example.com"
}
}
],
+ "schemas": [
+ {
+ "mimeType": "json",
+ "schemaSource": "none"
+ }
+ ],
"callback": {
- "callbackURI": "https://www.example.com/callback"
- }
+ "callbackURI": "http://127.0.0.1:4010/voluptas"
+ },
+ "destinationId": "7881dba9-4055-4854-8b6d-11ea5b7f3047"
}
}
}
\ No newline at end of file
diff --git a/models/error-body.json b/models/error-body.json
index fef50dd99ab4569433ff10cce5984d1fe76ea2c0..8c566ad31a7b358d024c6bffeebb8c6c037c2173 100644
--- a/models/error-body.json
+++ b/models/error-body.json
@@ -1,11 +1,13 @@
{
- "title": "Error Body",
"type": "array",
+ "title": "Error Body",
"description": "Der Inhalt (Body) von HTTP Responses bei Fehlern.",
+ "minItems": 1,
"items": {
- "title": "Error",
"type": "object",
+ "title": "Error",
"description": "Rückmeldung zu einer nicht erfolgreichen Operation",
+ "additionalProperties": false,
"properties": {
"code": {
"type": "integer",
@@ -24,5 +26,13 @@
"code",
"msg"
]
+ },
+ "x-examples": {
+ "example-1": [
+ {
+ "code": 400,
+ "msg": "Document with id 1 already exists for application : 0c508e3f-2353-4206-9a1e-34b2e864d5a8"
+ }
+ ]
}
}
\ No newline at end of file
diff --git a/models/status-overview.json b/models/status-overview.json
index a2767e0f7f7206f8993419e396b0fa5cc505413a..b66ff11b2e11c40d6705bcb8783390c89de2f00c 100644
--- a/models/status-overview.json
+++ b/models/status-overview.json
@@ -29,5 +29,12 @@
"code",
"timestamp",
"number"
- ]
+ ],
+ "x-examples": {
+ "example-1": {
+ "code": "queued",
+ "timestamp": "2020-05-20T08:31:01+02:00",
+ "number": 2
+ }
+ }
}
\ No newline at end of file
diff --git a/reference/callback.json b/reference/callback.json
index 65d28286fc8a833c9211a68f8516e81297c0b232..85d7d65f94faa80afd7f7ebfad4d8de6c6cc4285 100644
--- a/reference/callback.json
+++ b/reference/callback.json
@@ -2,7 +2,7 @@
"openapi": "3.0.0",
"info": {
"title": "Notification Callback",
- "version": "0.4",
+ "version": "DEV",
"contact": {
"name": "FITKO",
"url": "https://www.fitko.de/"
@@ -44,6 +44,7 @@
"application/json": {
"schema": {
"type": "object",
+ "additionalProperties": false,
"properties": {
"destinationId": {
"type": "string"
@@ -52,14 +53,22 @@
"type": "array",
"items": {
"type": "object",
+ "additionalProperties": false,
"properties": {
"applicationId": {
"type": "string"
}
- }
+ },
+ "required": [
+ "applicationId"
+ ]
}
}
- }
+ },
+ "required": [
+ "destinationId",
+ "applications"
+ ]
},
"examples": {
"example-1": {
@@ -71,6 +80,19 @@
}
]
}
+ },
+ "example-2": {
+ "value": {
+ "destinationId": "123",
+ "applications": [
+ {
+ "applicationId": "456"
+ },
+ {
+ "applicationId": "789"
+ }
+ ]
+ }
}
}
}
diff --git a/reference/sender.json b/reference/sender.json
index 93a0e6ef7bbda60d94a85d6add7814826d23992e..6c4f63e4e34826f9ab0f3e45db08dc86d829992b 100644
--- a/reference/sender.json
+++ b/reference/sender.json
@@ -2,7 +2,7 @@
"openapi": "3.0.0",
"info": {
"title": "Application Sender API",
- "version": "0.4",
+ "version": "DEV",
"description": "API vom Onlineantragsdienst zum Zustelldienst",
"contact": {
"name": "FITKO",
@@ -15,18 +15,18 @@
},
"servers": [
{
- "url": "https://sender.fiep-poc.de",
+ "url": "https://sender.fiep-poc.de/beta5",
"description": "Produktionsumgebung der API."
}
],
"paths": {
- "/{sourceId}/{destinationId}/{applicationId}/upload-status": {
+ "/{senderId}/{destinationId}/{applicationId}": {
"parameters": [
{
"schema": {
"type": "string"
},
- "name": "sourceId",
+ "name": "senderId",
"in": "path",
"required": true
},
@@ -47,66 +47,23 @@
"required": true
}
],
- "get": {
- "summary": "Get Application Upload Status",
+ "post": {
+ "summary": "Send Application",
+ "operationId": "commit-application",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
- "type": "object",
- "properties": {
- "data": {
- "type": "object",
- "properties": {
- "status": {
- "type": "string",
- "enum": [
- "missing",
- "partial",
- "complete"
- ]
- },
- "length": {
- "type": "integer",
- "minimum": 0
- }
- },
- "required": [
- "status",
- "length"
- ]
- },
- "docs": {
- "type": "array",
- "items": {
- "type": "object",
- "properties": {
- "docId": {
- "type": "string",
- "pattern": "^[-_.A-Za-z0-9]+$",
- "description": "Id des Dokuments. Diese muss nur innerhalb des Antrags (Application) eindeutig sein. Es wird daher empfohlen, die IDs fortlaufend (1, 2 etc.) zu vergeben."
- },
- "status": {
- "type": "string",
- "enum": [
- "missing",
- "partial",
- "complete"
- ]
- },
- "length": {
- "type": "integer",
- "minimum": 0
- }
- },
- "required": [
- "docId",
- "status",
- "length"
- ]
- }
+ "$ref": "../models/status-overview.json"
+ },
+ "examples": {
+ "example-1": {
+ "value": {
+ "code": "queued",
+ "timestamp": "2020-05-20T08:31:01.135842+02:00",
+ "number": 2
}
}
}
@@ -152,30 +109,51 @@
}
}
}
+ },
+ "413": {
+ "description": "Request Entity Too Large",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "../models/error-body.json"
+ }
+ }
+ }
}
},
- "operationId": "get-application-upload-status",
- "description": "Abfrage des Ãœbermittlungsstatus. Listet alle Unterresourcen (data und docs) mit Ãœbermittlungsstatus auf.",
+ "description": "Übertragung abschließen, Antrag absenden",
+ "parameters": [],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {}
+ }
+ }
+ },
+ "description": ""
+ },
"tags": [
- "Transfer related Information"
+ "Application Transfer"
],
"security": [
{
- "API Key": [
- "{sourceId}:application:apply",
- "{sourceId}:source:manage"
+ "OAuth 2.0": [
+ "{senderId}:application:apply",
+ "{senderId}:sender:manage"
]
}
]
}
},
- "/{sourceId}/{applicationId}/status": {
+ "/{senderId}/{destinationId}": {
"parameters": [
{
"schema": {
"type": "string"
},
- "name": "sourceId",
+ "name": "senderId",
"in": "path",
"required": true
},
@@ -183,32 +161,35 @@
"schema": {
"type": "string"
},
- "name": "applicationId",
+ "name": "destinationId",
"in": "path",
"required": true
}
],
- "get": {
- "summary": "Get Status",
- "tags": [
- "status"
- ],
+ "post": {
+ "summary": "Create Application",
+ "operationId": "create-application",
"responses": {
- "200": {
- "description": "OK",
+ "201": {
+ "description": "Created",
"content": {
"application/json": {
"schema": {
"type": "object",
+ "additionalProperties": false,
"properties": {
- "current": {
- "$ref": "../models/status-overview.json"
- },
- "history": {
- "type": "array",
- "items": {
- "$ref": "../models/status-overview.json"
- }
+ "applicationId": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "applicationId"
+ ]
+ },
+ "examples": {
+ "example-1": {
+ "value": {
+ "applicationId": "0c508e3f-2353-4206-9a1e-34b2e864d5a8"
}
}
}
@@ -245,8 +226,18 @@
}
}
},
- "404": {
- "description": "Not Found",
+ "406": {
+ "description": "Not Acceptable",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "../models/error-body.json"
+ }
+ }
+ }
+ },
+ "413": {
+ "description": "Request Entity Too Large",
"content": {
"application/json": {
"schema": {
@@ -256,64 +247,209 @@
}
}
},
- "operationId": "get-application-status",
- "description": "Ruft den aktuellen Status der Ãœbermittlung sowie einer Ãœbersicht der bisherigen Ãœbertragungshistorie ab.",
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "../models/application/metadata-no-id.json"
+ },
+ "examples": {
+ "example-1": {
+ "value": {
+ "additionalReferenceInfo": {
+ "subject": "Anmeldung eines Gewerbes in Musterstadt",
+ "caseId": "DF/8923"
+ },
+ "contentStructure": {
+ "data": {
+ "schema": {
+ "mimeType": "json",
+ "schemaSource": "none"
+ }
+ },
+ "docs": [
+ {
+ "docId": "1",
+ "purpose": "form",
+ "size": 13046,
+ "mimeType": "application/pdf",
+ "filename": "test.pdf",
+ "description": "Das Antragsformular",
+ "lang": {
+ "lang": "de",
+ "region": "DE"
+ },
+ "hash": {
+ "algorithm": "SHA-256",
+ "digest": "bf37d894fdf9aeade63975ed648d49c3e8a7a773923597d2418915f54cd7c3b9"
+ }
+ }
+ ]
+ },
+ "publicServiceType": {
+ "name": "Gewerbeanmeldung",
+ "description": "Eine Gewerbeanmeldung ist immer dann notwendig, wenn Sie einen stehenden Gewerbebetrieb beginnen.",
+ "leikaId": "99050012104000",
+ "otherIdentifiers": [
+ {
+ "id": "8664844",
+ "schemeId": "service.niedersachsen.de",
+ "schemeName": "Serviceportal Niedersachsen"
+ },
+ {
+ "id": "354824",
+ "schemeId": "buerger.thueringen.de",
+ "schemeName": "Zuständigkeitsfinder Thüringen"
+ }
+ ]
+ },
+ "applicants": [
+ {
+ "type": "person",
+ "authentificationInfo": {
+ "assuranceLevel": "high",
+ "authentificationMethod": "eID",
+ "timestamp": "2020-03-03T12:38:23Z"
+ },
+ "identityInfo": {
+ "dateOfBirth": "1970-09-13",
+ "gender": "m",
+ "givenName": "WERNER",
+ "familyName": "MUSTERMANN",
+ "placeOfResidence": {
+ "type": "national",
+ "street": "KURZER WEG 7",
+ "postalCode": "12345",
+ "city": "ANKH-MORPORK"
+ }
+ },
+ "contactInfo": {
+ "electronicAddresses": [
+ {
+ "channelType": "Service-Account-Mailbox",
+ "address": "3b0c9c8c-0801-45f0-a331-2abfc9db78d0"
+ }
+ ],
+ "physicalAddress": {
+ "type": "national",
+ "street": "Kurzer Weg",
+ "houseNumber": "7",
+ "postalCode": "12345",
+ "city": "Ankh-Morpork"
+ },
+ "telephone": [
+ {
+ "number": "+49 89 32168-42",
+ "mobile": true,
+ "description": "work"
+ }
+ ]
+ }
+ }
+ ],
+ "paymentInfo": {
+ "reference": "TP/93/GDP",
+ "usage": "Gewerbeanmeldung",
+ "amount": 17.3,
+ "timestamp": "2020-03-03T12:38:23Z",
+ "status": "success",
+ "transaction": "1f77c5f9b759db9cdce59988b24974d465c7be5e462a6185485559ff6e2dea82"
+ }
+ }
+ }
+ }
+ }
+ },
+ "description": "Metadaten des Antrags"
+ },
+ "description": "Ãœbertragung initiieren",
+ "tags": [
+ "Application Transfer"
+ ],
"security": [
{
- "API Key": [
- "{sourceId}:status:read",
- "{sourceId}:source:manage"
+ "OAuth 2.0": [
+ "{senderId}:application:apply",
+ "{senderId}:sender:manage"
]
}
]
- }
- },
- "/{sourceId}/{destinationId}/{applicationId}/data": {
- "parameters": [
- {
- "schema": {
- "type": "string"
- },
- "name": "sourceId",
- "in": "path",
- "required": true
- },
- {
- "schema": {
- "type": "string"
- },
- "name": "destinationId",
- "in": "path",
- "required": true
- },
- {
- "schema": {
- "type": "string"
- },
- "name": "applicationId",
- "in": "path",
- "required": true
- }
- ],
- "put": {
- "summary": "Add Application Data",
- "operationId": "add-application-data",
+ },
+ "get": {
+ "summary": "Get Destination Info",
+ "operationId": "get-destination-info",
"responses": {
- "202": {
- "description": "Accepted"
- },
- "400": {
- "description": "Bad Request",
+ "200": {
+ "description": "OK",
"content": {
"application/json": {
"schema": {
- "$ref": "../models/error-body.json"
+ "$ref": "../models/destination.json"
+ },
+ "examples": {
+ "example-1": {
+ "value": {
+ "publicOrganization": {
+ "organizationName": "Gewerbeamt Musterstadt",
+ "address": {
+ "type": "national",
+ "street": "Kurzer Weg",
+ "houseNumber": "7",
+ "postalCode": "12345",
+ "city": "Ankh-Morpork"
+ },
+ "contact": {
+ "telephone": [
+ {
+ "number": "+49 89 32168-0",
+ "mobile": false,
+ "description": "work"
+ }
+ ],
+ "email": "behoerde@example.com"
+ }
+ },
+ "technicalContact": [
+ {
+ "formOfAddress": "Herr",
+ "academicTitle": "Dr.",
+ "firstName": "Kunibert",
+ "lastName": "Vonundzu",
+ "contact": {
+ "telephone": [
+ {
+ "number": "+49 89 32168-42",
+ "mobile": false,
+ "description": "work"
+ },
+ {
+ "number": "+49 123 456789",
+ "mobile": true,
+ "description": "work"
+ }
+ ],
+ "email": "kunibert.vonundzu@example.com"
+ }
+ }
+ ],
+ "schemas": [
+ {
+ "mimeType": "json",
+ "schemaSource": "none"
+ }
+ ],
+ "callback": {
+ "callbackURI": "http://127.0.0.1:4010/voluptas"
+ },
+ "destinationId": "7881dba9-4055-4854-8b6d-11ea5b7f3047"
+ }
+ }
}
}
}
},
- "401": {
- "description": "Unauthorized",
+ "400": {
+ "description": "Bad Request",
"content": {
"application/json": {
"schema": {
@@ -322,8 +458,8 @@
}
}
},
- "403": {
- "description": "Forbidden",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
"schema": {
@@ -332,8 +468,8 @@
}
}
},
- "410": {
- "description": "Gone",
+ "403": {
+ "description": "Forbidden",
"content": {
"application/json": {
"schema": {
@@ -342,8 +478,8 @@
}
}
},
- "413": {
- "description": "Request Entity Too Large",
+ "404": {
+ "description": "Not Found",
"content": {
"application/json": {
"schema": {
@@ -353,71 +489,27 @@
}
}
},
- "description": "Datensatz übertragen",
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "properties": {},
- "type": "object"
- },
- "examples": {
- "example-1": {
- "value": {
- "F99000001": "string",
- "G99000001": {
- "F99000002": "string",
- "F99000003": 42
- },
- "G99000002": [
- {
- "F99000004": true,
- "G99000001": {
- "F99000002": "string",
- "F99000003": 17
- }
- },
- {
- "F99000004": true,
- "G99000001": {
- "F99000002": "string",
- "F99000003": 24
- }
- }
- ]
- }
- }
- }
- },
- "application/xml": {
- "schema": {
- "type": "object",
- "properties": {}
- }
- }
- },
- "description": "JSON oder XML Daten"
- },
+ "description": "Ruft die Information über eine Destination ab",
"tags": [
- "Application Transfer"
+ "Transfer related Information"
],
"security": [
{
- "API Key": [
- "{sourceId}:application:apply",
- "{sourceId}:source:manage"
+ "OAuth 2.0": [
+ "{senderId}:destination-info:read",
+ "{senderId}:sender:manage"
]
}
]
}
},
- "/{sourceId}/{destinationId}/{applicationId}/docs/{docId}": {
+ "/{senderId}/{destinationId}/{applicationId}/docs/{docId}": {
"parameters": [
{
"schema": {
"type": "string"
},
- "name": "sourceId",
+ "name": "senderId",
"in": "path",
"required": true
},
@@ -540,21 +632,21 @@
],
"security": [
{
- "API Key": [
- "{sourceId}:application:apply",
- "{sourceId}:source:manage"
+ "OAuth 2.0": [
+ "{senderId}:application:apply",
+ "{senderId}:sender:manage"
]
}
]
}
},
- "/{sourceId}/{destinationId}": {
+ "/{senderId}/{destinationId}/{applicationId}/data": {
"parameters": [
{
"schema": {
"type": "string"
},
- "name": "sourceId",
+ "name": "senderId",
"in": "path",
"required": true
},
@@ -565,33 +657,22 @@
"name": "destinationId",
"in": "path",
"required": true
+ },
+ {
+ "schema": {
+ "type": "string"
+ },
+ "name": "applicationId",
+ "in": "path",
+ "required": true
}
],
- "post": {
- "summary": "Create Application",
- "operationId": "create-application",
+ "put": {
+ "summary": "Add Application Data",
+ "operationId": "add-application-data",
"responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "applicationId": {
- "type": "string"
- }
- }
- },
- "examples": {
- "example-1": {
- "value": {
- "applicationId": "45bb5b95-d853-4fc5-b45d-10aa9e15287a"
- }
- }
- }
- }
- }
+ "202": {
+ "description": "Accepted"
},
"400": {
"description": "Bad Request",
@@ -623,8 +704,8 @@
}
}
},
- "406": {
- "description": "Not Acceptable",
+ "410": {
+ "description": "Gone",
"content": {
"application/json": {
"schema": {
@@ -644,171 +725,125 @@
}
}
},
+ "description": "Datensatz übertragen",
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "../models/application/metadata-no-id.json"
+ "properties": {},
+ "type": "object"
},
"examples": {
"example-1": {
- "value": {
- "additionalReferenceInfo": {
- "subject": "Anmeldung eines Gewerbes in Musterstadt",
- "caseId": "DF/8923"
+ "value": {
+ "F99000001": "string",
+ "G99000001": {
+ "F99000002": "string",
+ "F99000003": 42
},
- "contentStructure": {
- "data": {
- "size": 9438,
- "schema": {
- "mimeType": "json",
- "schemaSource": "none"
+ "G99000002": [
+ {
+ "F99000004": true,
+ "G99000001": {
+ "F99000002": "string",
+ "F99000003": 17
}
},
- "docs": [
- {
- "docId": "1",
- "purpose": "form",
- "size": 39273,
- "mimeType": "application/pdf",
- "filename": "antrag.pdf",
- "description": "Das Antragsformular",
- "lang": {
- "lang": "de",
- "region": "DE"
- },
- "hash": {
- "algorithm": "SHA-256",
- "digest": "03ba204e50d126e4674c005e04d82e84c21366780af1f43bd54a37816b6ab340"
- }
- },
- {
- "docId": "2",
- "purpose": "attachment",
- "size": 894834874,
- "mimeType": "image/jpeg",
- "filename": "scan.jpg",
- "description": "Scan der Bescheinigung",
- "hash": {
- "algorithm": "SHA-256",
- "digest": "e1762f14d9924e37b32f1c81dfd256410af462f5136415c96877efa8c80345d0"
- }
- }
- ]
- },
- "publicServiceType": {
- "name": "Gewerbeanmeldung",
- "description": "Eine Gewerbeanmeldung ist immer dann notwendig, wenn Sie einen stehenden Gewerbebetrieb beginnen.",
- "leikaId": "99050012104000",
- "otherIdentifiers": [
- {
- "id": "8664844",
- "schemeURI": "service.niedersachsen.de",
- "schemeName": "Serviceportal Niedersachsen"
- },
- {
- "id": "354824",
- "schemeURI": "buerger.thueringen.de",
- "schemeName": "Zuständigkeitsfinder Thüringen"
- }
- ]
- },
- "applicants": [
{
- "identifier": [
- {
- "id": "918",
- "schemeName": "Antragsportal",
- "schemeId": "urn:com:example:antragsportal:user"
- }
- ],
- "contactInfo": {
- "physicalAddress": {
- "street": "Kurzer Weg",
- "houseNumber": 7,
- "postalCode": "12345",
- "city": "string",
- "addressSupplement": "string"
- },
- "telephone": [
- {
- "number": "+49 89 32168-42",
- "mobile": true,
- "description": "string"
- }
- ],
- "electronicAddresses": [
- {
- "channelType": "Service-Account-Mailbox",
- "address": "string"
- }
- ]
- },
- "identityInfo": {
- "gender": "m",
- "nationality": "string",
- "familyName": "string",
- "givenName": "string",
- "birthName": "string",
- "doctoralDegrees": "string",
- "artisticName": "string",
- "dateOfBirth": "2020-04-16",
- "placeOfBirth": "string",
- "placeOfResidence": {
- "street": "string",
- "houseNumber": null,
- "houseNumberSuffix": "st",
- "postalCode": "strin",
- "city": "string",
- "addressSupplement": "string"
- }
- },
- "authentificationInfo": {
- "timestamp": "2020-04-16T06:50:39Z",
- "authentificationToken": {},
- "authentificationMethod": "string",
- "assuranceLevel": "low"
+ "F99000004": true,
+ "G99000001": {
+ "F99000002": "string",
+ "F99000003": 24
}
}
- ],
- "payment-info": {
- "reference": "TP/93/GDP",
- "usage": "Gewerbeanmeldung",
- "amount": 17.3,
- "timestamp": "2020-03-03T12:38:23Z",
- "status": "success",
- "transaction": "1f77c5f9b759db9cdce59988b24974d465c7be5e462a6185485559ff6e2dea82"
- }
+ ]
}
}
}
+ },
+ "application/xml": {
+ "schema": {
+ "type": "object",
+ "properties": {}
+ }
}
},
- "description": "Metadaten des Antrags"
+ "description": "JSON oder XML Daten"
},
- "description": "Ãœbertragung initiieren",
"tags": [
"Application Transfer"
],
"security": [
{
- "API Key": [
- "{sourceId}:application:apply",
- "{sourceId}:source:manage"
+ "OAuth 2.0": [
+ "{senderId}:application:apply",
+ "{senderId}:sender:manage"
]
}
]
- },
+ }
+ },
+ "/{senderId}/{applicationId}/status": {
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "name": "senderId",
+ "in": "path",
+ "required": true
+ },
+ {
+ "schema": {
+ "type": "string"
+ },
+ "name": "applicationId",
+ "in": "path",
+ "required": true
+ }
+ ],
"get": {
- "summary": "Get Destination Info",
- "operationId": "get-destination-info",
+ "summary": "Get Status",
+ "tags": [
+ "status"
+ ],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
- "$ref": "../models/destination.json"
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "current": {
+ "$ref": "../models/status-overview.json"
+ },
+ "history": {
+ "type": "array",
+ "items": {
+ "$ref": "../models/status-overview.json"
+ }
+ }
+ }
+ },
+ "examples": {
+ "example-1": {
+ "value": {
+ "current": {
+ "code": "queued",
+ "timestamp": "2020-05-20T08:31:01+02:00",
+ "number": 2
+ },
+ "history": [
+ {
+ "code": "incomplete",
+ "timestamp": "2020-05-20T08:30:08+02:00",
+ "number": 1
+ }
+ ]
+ }
+ }
}
}
}
@@ -854,27 +889,25 @@
}
}
},
- "description": "Ruft die Information über eine Destination ab",
- "tags": [
- "Transfer related Information"
- ],
+ "operationId": "get-application-status",
+ "description": "Ruft den aktuellen Status der Ãœbermittlung sowie einer Ãœbersicht der bisherigen Ãœbertragungshistorie ab.",
"security": [
{
- "API Key": [
- "{sourceId}:destination-info:read",
- "{sourceId}:source:manage"
+ "OAuth 2.0": [
+ "{senderId}:status:read",
+ "{senderId}:sender:manage"
]
}
]
}
},
- "/{sourceId}/{destinationId}/{applicationId}": {
+ "/{senderId}/{destinationId}/{applicationId}/upload-status": {
"parameters": [
{
"schema": {
"type": "string"
},
- "name": "sourceId",
+ "name": "senderId",
"in": "path",
"required": true
},
@@ -895,16 +928,88 @@
"required": true
}
],
- "post": {
- "summary": "Send Application",
- "operationId": "commit-application",
+ "get": {
+ "summary": "Get Application Upload Status",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
- "$ref": "../models/status-overview.json"
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "data": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "status": {
+ "type": "string",
+ "enum": [
+ "missing",
+ "partial",
+ "complete"
+ ]
+ },
+ "length": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "status",
+ "length"
+ ]
+ },
+ "docs": {
+ "type": "array",
+ "items": {
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "docId": {
+ "type": "string",
+ "pattern": "^[-_.A-Za-z0-9]+$",
+ "description": "Id des Dokuments. Diese muss nur innerhalb des Antrags (Application) eindeutig sein. Es wird daher empfohlen, die IDs fortlaufend (1, 2 etc.) zu vergeben."
+ },
+ "status": {
+ "type": "string",
+ "enum": [
+ "missing",
+ "partial",
+ "complete"
+ ]
+ },
+ "length": {
+ "type": "integer",
+ "minimum": 0
+ }
+ },
+ "required": [
+ "docId",
+ "status",
+ "length"
+ ]
+ }
+ }
+ }
+ },
+ "examples": {
+ "example-1": {
+ "value": {
+ "data": {
+ "status": "complete",
+ "length": 0
+ },
+ "docs": [
+ {
+ "status": "complete",
+ "docId": "1",
+ "length": 13046
+ }
+ ]
+ }
+ }
}
}
}
@@ -948,39 +1053,18 @@
}
}
}
- },
- "413": {
- "description": "Request Entity Too Large",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "../models/error-body.json"
- }
- }
- }
}
},
- "description": "Übertragung abschließen, Antrag absenden",
- "parameters": [],
- "requestBody": {
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {}
- }
- }
- },
- "description": ""
- },
+ "operationId": "get-application-upload-status",
+ "description": "Abfrage des Ãœbermittlungsstatus. Listet alle Unterresourcen (data und docs) mit Ãœbermittlungsstatus auf.",
"tags": [
- "Application Transfer"
+ "Transfer related Information"
],
"security": [
{
- "API Key": [
- "{sourceId}:application:apply",
- "{sourceId}:source:manage"
+ "OAuth 2.0": [
+ "{senderId}:application:apply",
+ "{senderId}:sender:manage"
]
}
]
@@ -1000,18 +1084,18 @@
],
"components": {
"securitySchemes": {
- "API Key": {
+ "OAuth 2.0": {
"type": "oauth2",
"flows": {
"clientCredentials": {
- "tokenUrl": "beispieltokenURL.de",
+ "tokenUrl": "https://oauth.fiep-poc.de/invoke/pub.apigateway.oauth2/getAccessToken",
+ "refreshUrl": "https://oauth.fiep-poc.de/invoke/pub.oauth/refreshAccessToken",
"scopes": {
- "{sourceId}:application:apply": "Dieser Zugriffsbereich erlaubt es Anträge anzulegen, diesen zu aktualisieren und abzusenden.",
- "{sourceId}:status:read": "Dieser Zufriffsbereich erlaubt es auf Statusmitteilungen zu einem übersendeten Antrag abzurufen.",
- "{sourceId}:destination-info:read": "Dieser Zufriffsbereich erlaubt es Informationen von existierenden Destinationsabzurufen",
- "{sourceId}:source:manage": "Dieser Zufriffsbereich erlaubt es alle Endpunkte einer "
- },
- "refreshUrl": "beispielrefreshURL.de"
+ "{senderId}:sender:manage": "Dieser Zufriffsbereich erlaubt es alle Endpunkte einer ",
+ "{senderId}:destination-info:read": "Dieser Zufriffsbereich erlaubt es Informationen von existierenden Destinationsabzurufen",
+ "{senderId}:status:read": "Dieser Zufriffsbereich erlaubt es auf Statusmitteilungen zu einem übersendeten Antrag abzurufen.",
+ "{senderId}:application:apply": "Dieser Zugriffsbereich erlaubt es Anträge anzulegen, diesen zu aktualisieren und abzusenden."
+ }
}
},
"description": "Dieses Authentifizierungsmethode wird genutzt, um den Zugriff auf die Produktiv API zu autorisieren. "
diff --git a/reference/subscriber.json b/reference/subscriber.json
index 0713dbffb4ba932c1ef1f0091e9a8684a37cda47..a6aca0b110b69fda6ec5225757fbc9bf33cedea9 100644
--- a/reference/subscriber.json
+++ b/reference/subscriber.json
@@ -2,7 +2,7 @@
"openapi": "3.0.0",
"info": {
"title": "Application Subscriber API",
- "version": "0.4",
+ "version": "DEV",
"description": "API vom Fachverfahren zum Zustelldienst",
"contact": {
"name": "FITKO",
@@ -15,21 +15,13 @@
},
"servers": [
{
- "url": "https://subscriber.fiep-poc.de",
+ "url": "https://subscriber.fiep-poc.de/beta5",
"description": "Produktionsumgebung der API."
}
],
"paths": {
- "/{subscriberId}/destinations/{destinationId}": {
+ "/{subscriberId}/destinations": {
"parameters": [
- {
- "schema": {
- "type": "string"
- },
- "name": "destinationId",
- "in": "path",
- "required": true
- },
{
"schema": {
"type": "string"
@@ -40,41 +32,132 @@
}
],
"get": {
- "summary": "Get Destination",
+ "summary": "List Destinations",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
- "$ref": "../models/destination.json"
+ "type": "array",
+ "items": {
+ "$ref": "../models/destination.json"
+ }
},
"examples": {
"example-1": {
- "value": {
- "destination-id": "83578",
- "public-organization": {
- "organizationName": "Gewerbeamt Musterhausen"
+ "value": [
+ {
+ "publicOrganization": {
+ "organizationName": "Gewerbeamt Musterstadt",
+ "address": {
+ "type": "national",
+ "street": "Kurzer Weg",
+ "houseNumber": "7",
+ "postalCode": "12345",
+ "city": "Ankh-Morpork"
+ },
+ "contact": {
+ "telephone": [
+ {
+ "number": "+49 89 32168-0",
+ "mobile": false,
+ "description": "work"
+ }
+ ],
+ "email": "behoerde@example.com"
+ }
+ },
+ "technicalContact": [
+ {
+ "formOfAddress": "Herr",
+ "academicTitle": "Dr.",
+ "firstName": "Kunibert",
+ "lastName": "Vonundzu",
+ "contact": {
+ "telephone": [
+ {
+ "number": "+49 89 32168-42",
+ "mobile": false,
+ "description": "work"
+ },
+ {
+ "number": "+49 123 456789",
+ "mobile": true,
+ "description": "work"
+ }
+ ],
+ "email": "kunibert.vonundzu@example.com"
+ }
+ }
+ ],
+ "schemas": [
+ {
+ "mimeType": "json",
+ "schemaSource": "none"
+ }
+ ],
+ "callback": {
+ "callbackURI": "http://127.0.0.1:4010/voluptas"
+ },
+ "destinationId": "0ddf3ab5-dd89-4e04-9ecd-b2c50b0b4efd"
},
- "technicalContact": [
- {
- "firstName": "Werner",
- "lastName": "Mustermann",
+ {
+ "publicOrganization": {
+ "organizationName": "Gewerbeamt Musterstadt",
+ "address": {
+ "type": "national",
+ "street": "Kurzer Weg",
+ "houseNumber": "7",
+ "postalCode": "12345",
+ "city": "Ankh-Morpork"
+ },
"contact": {
"telephone": [
{
- "number": "+49 89 32168-42",
+ "number": "+49 89 32168-0",
"mobile": false,
- "description": "Dienstliches Festnetz"
+ "description": "work"
}
- ]
+ ],
+ "email": "behoerde@example.com"
}
- }
- ],
- "callback": {
- "callbackURI": "https://www.example.com/callback"
+ },
+ "technicalContact": [
+ {
+ "formOfAddress": "Herr",
+ "academicTitle": "Dr.",
+ "firstName": "Kunibert",
+ "lastName": "Vonundzu",
+ "contact": {
+ "telephone": [
+ {
+ "number": "+49 89 32168-42",
+ "mobile": false,
+ "description": "work"
+ },
+ {
+ "number": "+49 123 456789",
+ "mobile": true,
+ "description": "work"
+ }
+ ],
+ "email": "kunibert.vonundzu@example.com"
+ }
+ }
+ ],
+ "schemas": [
+ {
+ "mimeType": "json",
+ "schemaSource": "none"
+ }
+ ],
+ "callback": {
+ "callbackURI": "http://127.0.0.1:4010/voluptas"
+ },
+ "destinationId": "7881dba9-4055-4854-8b6d-11ea5b7f3047"
}
- }
+ ]
}
}
}
@@ -109,53 +192,55 @@
}
}
}
- },
- "404": {
- "description": "Not Found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "../models/error-body.json"
- }
- }
- }
}
},
- "operationId": "get-destination",
- "description": "Ãœbertragungsziel abfragen",
+ "operationId": "list-destinations",
+ "description": "Ruft die Liste aller Destinations dieses Accounts auf.",
"tags": [
"Destination Management"
],
"security": [
{
- "API Key": [
+ "OAuth 2.0": [
"{subscriberId}:destination:read",
- "{subscriberId}:destination:manage",
"{subscriberId}:manage",
- "{subscriberId}:destination:{destinationId}:read"
+ "{subscriberId}:destination:manage"
]
}
]
},
- "put": {
- "summary": "Update Destination",
- "operationId": "update-destination",
+ "post": {
+ "summary": "Create Destination",
+ "operationId": "create-destination",
"responses": {
- "200": {
- "description": "OK"
- },
- "400": {
- "description": "Bad Request",
+ "201": {
+ "description": "Created",
"content": {
"application/json": {
"schema": {
- "$ref": "../models/error-body.json"
+ "type": "object",
+ "additionalProperties": false,
+ "properties": {
+ "destinationId": {
+ "type": "string"
+ }
+ },
+ "required": [
+ "destinationId"
+ ]
+ },
+ "examples": {
+ "example-1": {
+ "value": {
+ "destinationId": "7881dba9-4055-4854-8b6d-11ea5b7f3047"
+ }
+ }
}
}
}
},
- "401": {
- "description": "Unauthorized",
+ "400": {
+ "description": "Bad Request",
"content": {
"application/json": {
"schema": {
@@ -164,8 +249,8 @@
}
}
},
- "403": {
- "description": "Forbidden",
+ "401": {
+ "description": "Unauthorized",
"content": {
"application/json": {
"schema": {
@@ -174,8 +259,8 @@
}
}
},
- "404": {
- "description": "Not Found",
+ "403": {
+ "description": "Forbidden",
"content": {
"application/json": {
"schema": {
@@ -185,64 +270,163 @@
}
}
},
- "description": "Ãœbertragungsziel aktualisieren",
+ "description": "Legt eine neue Destination an.",
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "../models/destination.json"
+ "$ref": "../models/destination-no-id.json"
},
"examples": {
"example-1": {
"value": {
- "destination-id": "83578",
- "public-organization": {
- "organizationName": "Gewerbeamt Musterhausen"
+ "publicOrganization": {
+ "organizationName": "Gewerbeamt Musterstadt",
+ "address": {
+ "type": "national",
+ "street": "Kurzer Weg",
+ "houseNumber": "7",
+ "postalCode": "12345",
+ "city": "Ankh-Morpork"
+ },
+ "contact": {
+ "telephone": [
+ {
+ "number": "+49 89 32168-0",
+ "mobile": false,
+ "description": "work"
+ }
+ ],
+ "email": "behoerde@example.com"
+ }
},
"technicalContact": [
{
- "firstName": "Werner",
- "lastName": "Mustermann",
+ "formOfAddress": "Herr",
+ "academicTitle": "Dr.",
+ "firstName": "Kunibert",
+ "lastName": "Vonundzu",
"contact": {
"telephone": [
{
"number": "+49 89 32168-42",
"mobile": false,
- "description": "Dienstliches Festnetz"
+ "description": "work"
+ },
+ {
+ "number": "+49 123 456789",
+ "mobile": true,
+ "description": "work"
}
- ]
+ ],
+ "email": "kunibert.vonundzu@example.com"
}
}
],
+ "schemas": [
+ {
+ "mimeType": "json",
+ "schemaSource": "none"
+ }
+ ],
"callback": {
- "callbackURI": "https://www.example.com/callback"
+ "callbackURI": "http://127.0.0.1:4010/voluptas"
}
}
}
}
}
- }
+ },
+ "description": "Anzulegende Destination"
},
"tags": [
"Destination Management"
],
"security": [
{
- "API Key": [
+ "OAuth 2.0": [
"{subscriberId}:manage",
- "{subscriberId}:destination:update",
"{subscriberId}:destination:manage",
- "{subscriberId}:destination:{destinationId}:update"
+ "{subscriberId}:destination:create"
]
}
]
- },
- "delete": {
- "summary": "Delete Destination",
- "operationId": "delete-destination",
+ }
+ },
+ "/{subscriberId}/destinations/{destinationId}/applications/{applicationId}/data": {
+ "parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "name": "subscriberId",
+ "in": "path",
+ "required": true
+ },
+ {
+ "schema": {
+ "type": "string"
+ },
+ "name": "destinationId",
+ "in": "path",
+ "required": true
+ },
+ {
+ "schema": {
+ "type": "string"
+ },
+ "name": "applicationId",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "get": {
+ "summary": "Get Application Data",
"responses": {
"200": {
- "description": "OK"
+ "description": "OK",
+ "content": {
+ "application/json": {
+ "schema": {
+ "type": "object",
+ "properties": {}
+ },
+ "examples": {
+ "example-1": {
+ "value": {
+ "F99000001": "string",
+ "G99000001": {
+ "F99000002": "string",
+ "F99000003": 42
+ },
+ "G99000002": [
+ {
+ "F99000004": true,
+ "G99000001": {
+ "F99000002": "string",
+ "F99000003": 17
+ }
+ },
+ {
+ "F99000004": true,
+ "G99000001": {
+ "F99000002": "string",
+ "F99000003": 24
+ }
+ }
+ ]
+ }
+ }
+ }
+ },
+ "application/xml": {
+ "schema": {
+ "type": "object",
+ "properties": {}
+ },
+ "examples": {}
+ }
+ }
},
"400": {
"description": "Bad Request",
@@ -285,23 +469,23 @@
}
}
},
- "description": "Übertragungsziel löschen",
+ "operationId": "get-application-data",
+ "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```",
"tags": [
- "Destination Management"
+ "Application Retrieval"
],
"security": [
{
- "API Key": [
+ "OAuth 2.0": [
"{subscriberId}:manage",
- "{subscriberId}:destination:manage",
- "{subscriberId}:destination:delete",
- "{subscriberId}:destination:{destinationId}:delete"
+ "{subscriberId}:application:receive",
+ "{subscriberId}:destination:{destinationId}:application:receive"
]
}
]
}
},
- "/{subscriberId}/destinations/{destinationId}/applications": {
+ "/{subscriberId}/destinations/{destinationId}/applications/{applicationId}/docs/{docId}": {
"parameters": [
{
"schema": {
@@ -315,162 +499,37 @@
"schema": {
"type": "string"
},
- "name": "destinationId",
- "in": "path",
- "required": true
- }
- ],
- "get": {
- "summary": "List Applications",
- "operationId": "list-applications",
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "application/json": {
- "schema": {
- "type": "array",
- "items": {
- "$ref": "../models/application/metadata.json"
- }
- },
- "examples": {
- "example-1": {
- "value": []
- },
- "example-2": {
- "value": [
- {
- "applicationId": "7236",
- "additionalReferenceInfo": {
- "subject": "Anmeldung eines Gewerbes in Musterstadt",
- "caseId": "DF/8923"
- },
- "contentStructure": {
- "data": {
- "size": 9438,
- "schema": {
- "mimeType": "json",
- "schemaSource": "none"
- }
- },
- "docs": [
- {
- "docId": "1",
- "purpose": "form",
- "size": 39273,
- "mimeType": "application/pdf",
- "filename": "antrag.pdf",
- "description": "Das Antragsformular",
- "lang": {
- "lang": "de",
- "region": "DE"
- },
- "hash": {
- "algorithm": "SHA-256",
- "digest": "03ba204e50d126e4674c005e04d82e84c21366780af1f43bd54a37816b6ab340"
- }
- },
- {
- "docId": "2",
- "purpose": "attachment",
- "size": 894834874,
- "mimeType": "image/jpeg",
- "filename": "scan.jpg",
- "description": "Scan der Bescheinigung",
- "hash": {
- "algorithm": "SHA-256",
- "digest": "e1762f14d9924e37b32f1c81dfd256410af462f5136415c96877efa8c80345d0"
- }
- }
- ]
- },
- "publicServiceType": {
- "name": "Gewerbeanmeldung",
- "description": "Eine Gewerbeanmeldung ist immer dann notwendig, wenn Sie einen stehenden Gewerbebetrieb beginnen.",
- "leikaId": "99050012104000",
- "otherIdentifiers": [
- {
- "id": "8664844",
- "schemeURI": "service.niedersachsen.de",
- "schemeName": "Serviceportal Niedersachsen"
- },
- {
- "id": "354824",
- "schemeURI": "buerger.thueringen.de",
- "schemeName": "Zuständigkeitsfinder Thüringen"
- }
- ]
- },
- "applicants": [
- {
- "identifier": [
- {
- "id": "918",
- "schemeName": "Antragsportal",
- "schemeId": "urn:com:example:antragsportal:user"
- }
- ],
- "contactInfo": {
- "physicalAddress": {
- "street": "Kurzer Weg",
- "houseNumber": 7,
- "postalCode": "12345",
- "city": "string",
- "addressSupplement": "string"
- },
- "telephone": [
- {
- "number": "+49 89 32168-42",
- "mobile": true,
- "description": "string"
- }
- ],
- "electronicAddresses": [
- {
- "channelType": "Service-Account-Mailbox",
- "address": "string"
- }
- ]
- },
- "identityInfo": {
- "gender": "m",
- "nationality": "string",
- "familyName": "string",
- "givenName": "string",
- "birthName": "string",
- "doctoralDegrees": "string",
- "artisticName": "string",
- "dateOfBirth": "2020-04-16",
- "placeOfBirth": "string",
- "placeOfResidence": {
- "street": "string",
- "houseNumber": null,
- "houseNumberSuffix": "st",
- "postalCode": "strin",
- "city": "string",
- "addressSupplement": "string"
- }
- },
- "authentificationInfo": {
- "timestamp": "2020-04-16T06:50:39Z",
- "authentificationToken": {},
- "authentificationMethod": "string",
- "assuranceLevel": "low"
- }
- }
- ],
- "payment-info": {
- "reference": "TP/93/GDP",
- "usage": "Gewerbeanmeldung",
- "amount": 17.3,
- "timestamp": "2020-03-03T12:38:23Z",
- "status": "success",
- "transaction": "1f77c5f9b759db9cdce59988b24974d465c7be5e462a6185485559ff6e2dea82"
- }
- }
- ]
- }
+ "name": "destinationId",
+ "in": "path",
+ "required": true
+ },
+ {
+ "schema": {
+ "type": "string"
+ },
+ "name": "applicationId",
+ "in": "path",
+ "required": true
+ },
+ {
+ "schema": {
+ "type": "string"
+ },
+ "name": "docId",
+ "in": "path",
+ "required": true
+ }
+ ],
+ "get": {
+ "summary": "Get Application Document",
+ "responses": {
+ "200": {
+ "description": "OK",
+ "content": {
+ "*/*": {
+ "schema": {
+ "type": "string",
+ "format": "binary"
}
}
}
@@ -516,13 +575,14 @@
}
}
},
- "description": "Ruft die Liste der wartenden Applications ab.",
+ "operationId": "get-application-document",
+ "description": "Ruf ein Dokument (Formular oder Anlage) der Application ab.",
"tags": [
"Application Retrieval"
],
"security": [
{
- "API Key": [
+ "OAuth 2.0": [
"{subscriberId}:manage",
"{subscriberId}:application:receive",
"{subscriberId}:destination:{destinationId}:application:receive"
@@ -571,14 +631,12 @@
"examples": {
"example-1": {
"value": {
- "applicationId": "7236",
"additionalReferenceInfo": {
"subject": "Anmeldung eines Gewerbes in Musterstadt",
"caseId": "DF/8923"
},
"contentStructure": {
"data": {
- "size": 9438,
"schema": {
"mimeType": "json",
"schemaSource": "none"
@@ -588,9 +646,9 @@
{
"docId": "1",
"purpose": "form",
- "size": 39273,
+ "size": 13046,
"mimeType": "application/pdf",
- "filename": "antrag.pdf",
+ "filename": "test.pdf",
"description": "Das Antragsformular",
"lang": {
"lang": "de",
@@ -598,19 +656,7 @@
},
"hash": {
"algorithm": "SHA-256",
- "digest": "03ba204e50d126e4674c005e04d82e84c21366780af1f43bd54a37816b6ab340"
- }
- },
- {
- "docId": "2",
- "purpose": "attachment",
- "size": 894834874,
- "mimeType": "image/jpeg",
- "filename": "scan.jpg",
- "description": "Scan der Bescheinigung",
- "hash": {
- "algorithm": "SHA-256",
- "digest": "e1762f14d9924e37b32f1c81dfd256410af462f5136415c96877efa8c80345d0"
+ "digest": "bf37d894fdf9aeade63975ed648d49c3e8a7a773923597d2418915f54cd7c3b9"
}
}
]
@@ -622,82 +668,69 @@
"otherIdentifiers": [
{
"id": "8664844",
- "schemeURI": "service.niedersachsen.de",
+ "schemeId": "service.niedersachsen.de",
"schemeName": "Serviceportal Niedersachsen"
},
{
"id": "354824",
- "schemeURI": "buerger.thueringen.de",
+ "schemeId": "buerger.thueringen.de",
"schemeName": "Zuständigkeitsfinder Thüringen"
}
]
},
"applicants": [
{
- "identifier": [
- {
- "id": "918",
- "schemeName": "Antragsportal",
- "schemeId": "urn:com:example:antragsportal:user"
+ "type": "person",
+ "authentificationInfo": {
+ "assuranceLevel": "high",
+ "authentificationMethod": "eID",
+ "timestamp": "2020-03-03T12:38:23Z"
+ },
+ "identityInfo": {
+ "dateOfBirth": "1970-09-13",
+ "gender": "m",
+ "givenName": "WERNER",
+ "familyName": "MUSTERMANN",
+ "placeOfResidence": {
+ "type": "national",
+ "street": "KURZER WEG 7",
+ "postalCode": "12345",
+ "city": "ANKH-MORPORK"
}
- ],
+ },
"contactInfo": {
+ "electronicAddresses": [
+ {
+ "channelType": "Service-Account-Mailbox",
+ "address": "3b0c9c8c-0801-45f0-a331-2abfc9db78d0"
+ }
+ ],
"physicalAddress": {
+ "type": "national",
"street": "Kurzer Weg",
- "houseNumber": 7,
+ "houseNumber": "7",
"postalCode": "12345",
- "city": "string",
- "addressSupplement": "string"
+ "city": "Ankh-Morpork"
},
"telephone": [
{
"number": "+49 89 32168-42",
"mobile": true,
- "description": "string"
- }
- ],
- "electronicAddresses": [
- {
- "channelType": "Service-Account-Mailbox",
- "address": "string"
+ "description": "work"
}
]
- },
- "identityInfo": {
- "gender": "m",
- "nationality": "string",
- "familyName": "string",
- "givenName": "string",
- "birthName": "string",
- "doctoralDegrees": "string",
- "artisticName": "string",
- "dateOfBirth": "2020-04-16",
- "placeOfBirth": "string",
- "placeOfResidence": {
- "street": "string",
- "houseNumber": null,
- "houseNumberSuffix": "st",
- "postalCode": "strin",
- "city": "string",
- "addressSupplement": "string"
- }
- },
- "authentificationInfo": {
- "timestamp": "2020-04-16T06:50:39Z",
- "authentificationToken": {},
- "authentificationMethod": "string",
- "assuranceLevel": "low"
}
}
],
- "payment-info": {
+ "paymentInfo": {
"reference": "TP/93/GDP",
"usage": "Gewerbeanmeldung",
"amount": 17.3,
"timestamp": "2020-03-03T12:38:23Z",
"status": "success",
"transaction": "1f77c5f9b759db9cdce59988b24974d465c7be5e462a6185485559ff6e2dea82"
- }
+ },
+ "applicationId": "0c508e3f-2353-4206-9a1e-34b2e864d5a8"
}
}
}
@@ -752,7 +785,7 @@
],
"security": [
{
- "API Key": [
+ "OAuth 2.0": [
"{subscriberId}:manage",
"{subscriberId}:application:receive",
"{subscriberId}:destination:{destinationId}:application:receive"
@@ -818,17 +851,33 @@
}
}
},
- "description": "Bestätigt die Abholung der Application. Über den Parameter `final-delivery` im Body wird gesteuert, wie der Folgestatus aussieht:\n\n| final-delivery | status |\n| -------------- | ----------- |\n| `false` | \"forwarded\" |\n| `true` | \"delivered\" |\n\nDer Parameter `final-delivery` zeigt an, ob der Antrag noch weitergesendet wird (`false`) oder das finale Ziel erreicht hat (`true`).\n\nSofern der Wert `false` übergeben wurde, muss zu einem späteren Zeitpunkt, wenn der Antrag final zugestellt wurde, ein weiterer Aufruf mit dem Wert `true` erfolgen.",
+ "description": "Bestätigt die Abholung der Application. Über den Parameter `finalDelivery` im Body wird gesteuert, wie der Folgestatus aussieht:\n\n| final-delivery | status |\n| -------------- | ----------- |\n| `false` | \"forwarded\" |\n| `true` | \"delivered\" |\n\nDer Parameter `finalDelivery` zeigt an, ob der Antrag noch weitergesendet wird (`false`) oder das finale Ziel erreicht hat (`true`).\n\nSofern der Wert `false` übergeben wurde, muss zu einem späteren Zeitpunkt, wenn der Antrag final zugestellt wurde, ein weiterer Aufruf mit dem Wert `true` erfolgen.",
"requestBody": {
"content": {
"application/json": {
"schema": {
"type": "object",
+ "additionalProperties": false,
"properties": {
- "final-delivery": {
+ "finalDelivery": {
"type": "boolean",
"description": "Zeigt an, ob die Zustellung zum nächsten Hop (`false`) oder bis zum Endpunkt (`true`) erfolgt ist."
}
+ },
+ "required": [
+ "finalDelivery"
+ ]
+ },
+ "examples": {
+ "example-1": {
+ "value": {
+ "finalDelivery": false
+ }
+ },
+ "example-2": {
+ "value": {
+ "finalDelivery": true
+ }
}
}
}
@@ -840,113 +889,7 @@
],
"security": [
{
- "API Key": [
- "{subscriberId}:manage",
- "{subscriberId}:application:receive",
- "{subscriberId}:destination:{destinationId}:application:receive"
- ]
- }
- ]
- }
- },
- "/{subscriberId}/destinations/{destinationId}/applications/{applicationId}/docs/{docId}": {
- "parameters": [
- {
- "schema": {
- "type": "string"
- },
- "name": "subscriberId",
- "in": "path",
- "required": true
- },
- {
- "schema": {
- "type": "string"
- },
- "name": "destinationId",
- "in": "path",
- "required": true
- },
- {
- "schema": {
- "type": "string"
- },
- "name": "applicationId",
- "in": "path",
- "required": true
- },
- {
- "schema": {
- "type": "string"
- },
- "name": "docId",
- "in": "path",
- "required": true
- }
- ],
- "get": {
- "summary": "Get Application Document",
- "responses": {
- "200": {
- "description": "OK",
- "content": {
- "*/*": {
- "schema": {
- "type": "string",
- "format": "binary"
- }
- }
- }
- },
- "400": {
- "description": "Bad Request",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "../models/error-body.json"
- }
- }
- }
- },
- "401": {
- "description": "Unauthorized",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "../models/error-body.json"
- }
- }
- }
- },
- "403": {
- "description": "Forbidden",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "../models/error-body.json"
- }
- }
- }
- },
- "404": {
- "description": "Not Found",
- "content": {
- "application/json": {
- "schema": {
- "$ref": "../models/error-body.json"
- }
- }
- }
- }
- },
- "operationId": "get-application-document",
- "description": "Ruf ein Dokument (Formular oder Anlage) der Application ab.",
- "tags": [
- "Application Retrieval"
- ],
- "security": [
- {
- "API Key": [
+ "OAuth 2.0": [
"{subscriberId}:manage",
"{subscriberId}:application:receive",
"{subscriberId}:destination:{destinationId}:application:receive"
@@ -955,7 +898,7 @@
]
}
},
- "/{subscriberId}/destinations/{destinationId}/applications/{applicationId}/data": {
+ "/{subscriberId}/destinations/{destinationId}/applications": {
"parameters": [
{
"schema": {
@@ -972,45 +915,133 @@
"name": "destinationId",
"in": "path",
"required": true
- },
- {
- "schema": {
- "type": "string"
- },
- "name": "applicationId",
- "in": "path",
- "required": true
}
],
"get": {
- "summary": "Get Application Data",
+ "summary": "List Applications",
+ "operationId": "list-applications",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
- "type": "object",
- "properties": {}
+ "type": "array",
+ "items": {
+ "$ref": "../models/application/metadata.json"
+ }
},
"examples": {
"example-1": {
- "value": {
- "F99000001": "Eins",
- "G99000001": {
- "F99000002": "Zwei",
- "F99000003": "Drei"
+ "value": []
+ },
+ "example-2": {
+ "value": [
+ {
+ "additionalReferenceInfo": {
+ "subject": "Anmeldung eines Gewerbes in Musterstadt",
+ "caseId": "DF/8923"
+ },
+ "contentStructure": {
+ "data": {
+ "schema": {
+ "mimeType": "json",
+ "schemaSource": "none"
+ }
+ },
+ "docs": [
+ {
+ "docId": "1",
+ "purpose": "form",
+ "size": 13046,
+ "mimeType": "application/pdf",
+ "filename": "test.pdf",
+ "description": "Das Antragsformular",
+ "lang": {
+ "lang": "de",
+ "region": "DE"
+ },
+ "hash": {
+ "algorithm": "SHA-256",
+ "digest": "bf37d894fdf9aeade63975ed648d49c3e8a7a773923597d2418915f54cd7c3b9"
+ }
+ }
+ ]
+ },
+ "publicServiceType": {
+ "name": "Gewerbeanmeldung",
+ "description": "Eine Gewerbeanmeldung ist immer dann notwendig, wenn Sie einen stehenden Gewerbebetrieb beginnen.",
+ "leikaId": "99050012104000",
+ "otherIdentifiers": [
+ {
+ "id": "8664844",
+ "schemeId": "service.niedersachsen.de",
+ "schemeName": "Serviceportal Niedersachsen"
+ },
+ {
+ "id": "354824",
+ "schemeId": "buerger.thueringen.de",
+ "schemeName": "Zuständigkeitsfinder Thüringen"
+ }
+ ]
+ },
+ "applicants": [
+ {
+ "type": "person",
+ "authentificationInfo": {
+ "assuranceLevel": "high",
+ "authentificationMethod": "eID",
+ "timestamp": "2020-03-03T12:38:23Z"
+ },
+ "identityInfo": {
+ "dateOfBirth": "1970-09-13",
+ "gender": "m",
+ "givenName": "WERNER",
+ "familyName": "MUSTERMANN",
+ "placeOfResidence": {
+ "type": "national",
+ "street": "KURZER WEG 7",
+ "postalCode": "12345",
+ "city": "ANKH-MORPORK"
+ }
+ },
+ "contactInfo": {
+ "electronicAddresses": [
+ {
+ "channelType": "Service-Account-Mailbox",
+ "address": "3b0c9c8c-0801-45f0-a331-2abfc9db78d0"
+ }
+ ],
+ "physicalAddress": {
+ "type": "national",
+ "street": "Kurzer Weg",
+ "houseNumber": "7",
+ "postalCode": "12345",
+ "city": "Ankh-Morpork"
+ },
+ "telephone": [
+ {
+ "number": "+49 89 32168-42",
+ "mobile": true,
+ "description": "work"
+ }
+ ]
+ }
+ }
+ ],
+ "paymentInfo": {
+ "reference": "TP/93/GDP",
+ "usage": "Gewerbeanmeldung",
+ "amount": 17.3,
+ "timestamp": "2020-03-03T12:38:23Z",
+ "status": "success",
+ "transaction": "1f77c5f9b759db9cdce59988b24974d465c7be5e462a6185485559ff6e2dea82"
+ },
+ "applicationId": "0c508e3f-2353-4206-9a1e-34b2e864d5a8"
}
- }
+ ]
}
}
- },
- "application/xml": {
- "schema": {
- "type": "object",
- "properties": {}
- },
- "examples": {}
}
}
},
@@ -1055,14 +1086,13 @@
}
}
},
- "operationId": "get-application-data",
- "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```",
+ "description": "Ruft die Liste der wartenden Applications ab.",
"tags": [
"Application Retrieval"
],
"security": [
{
- "API Key": [
+ "OAuth 2.0": [
"{subscriberId}:manage",
"{subscriberId}:application:receive",
"{subscriberId}:destination:{destinationId}:application:receive"
@@ -1071,8 +1101,16 @@
]
}
},
- "/{subscriberId}/destinations": {
+ "/{subscriberId}/destinations/{destinationId}": {
"parameters": [
+ {
+ "schema": {
+ "type": "string"
+ },
+ "name": "destinationId",
+ "in": "path",
+ "required": true
+ },
{
"schema": {
"type": "string"
@@ -1083,46 +1121,72 @@
}
],
"get": {
- "summary": "List Destinations",
+ "summary": "Get Destination",
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
- "type": "array",
- "items": {
- "$ref": "../models/destination.json"
- }
+ "$ref": "../models/destination.json"
},
"examples": {
"example-1": {
- "value": [
- {
- "destination-id": "83578",
- "public-organization": {
- "organizationName": "Gewerbeamt Musterhausen"
+ "value": {
+ "publicOrganization": {
+ "organizationName": "Gewerbeamt Musterstadt",
+ "address": {
+ "type": "national",
+ "street": "Kurzer Weg",
+ "houseNumber": "7",
+ "postalCode": "12345",
+ "city": "Ankh-Morpork"
},
- "technicalContact": [
- {
- "firstName": "Werner",
- "lastName": "Mustermann",
- "contact": {
- "telephone": [
- {
- "number": "+49 89 32168-42",
- "mobile": false,
- "description": "Dienstliches Festnetz"
- }
- ]
+ "contact": {
+ "telephone": [
+ {
+ "number": "+49 89 32168-0",
+ "mobile": false,
+ "description": "work"
}
+ ],
+ "email": "behoerde@example.com"
+ }
+ },
+ "technicalContact": [
+ {
+ "formOfAddress": "Herr",
+ "academicTitle": "Dr.",
+ "firstName": "Kunibert",
+ "lastName": "Vonundzu",
+ "contact": {
+ "telephone": [
+ {
+ "number": "+49 89 32168-42",
+ "mobile": false,
+ "description": "work"
+ },
+ {
+ "number": "+49 123 456789",
+ "mobile": true,
+ "description": "work"
+ }
+ ],
+ "email": "kunibert.vonundzu@example.com"
}
- ],
- "callback": {
- "callbackURI": "https://www.example.com/callback"
}
- }
- ]
+ ],
+ "schemas": [
+ {
+ "mimeType": "json",
+ "schemaSource": "none"
+ }
+ ],
+ "callback": {
+ "callbackURI": "http://127.0.0.1:4010/voluptas"
+ },
+ "destinationId": "7881dba9-4055-4854-8b6d-11ea5b7f3047"
+ }
}
}
}
@@ -1157,51 +1221,40 @@
}
}
}
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "../models/error-body.json"
+ }
+ }
+ }
}
},
- "operationId": "list-destinations",
- "description": "Ruft die Liste aller Destinations dieses Accounts auf.",
+ "operationId": "get-destination",
+ "description": "Ãœbertragungsziel abfragen",
"tags": [
"Destination Management"
],
"security": [
{
- "API Key": [
+ "OAuth 2.0": [
"{subscriberId}:destination:read",
+ "{subscriberId}:destination:manage",
"{subscriberId}:manage",
- "{subscriberId}:destination:manage"
+ "{subscriberId}:destination:{destinationId}:read"
]
}
]
},
- "post": {
- "summary": "Create Destination",
- "operationId": "create-destination",
+ "put": {
+ "summary": "Update Destination",
+ "operationId": "update-destination",
"responses": {
- "201": {
- "description": "Created",
- "content": {
- "application/json": {
- "schema": {
- "type": "object",
- "properties": {
- "destinationId": {
- "type": "string"
- }
- },
- "required": [
- "destinationId"
- ]
- },
- "examples": {
- "example-1": {
- "value": {
- "destinationId": "e15fc92e-c286-424b-9802-39c6b6bc441d"
- }
- }
- }
- }
- }
+ "200": {
+ "description": "OK"
},
"400": {
"description": "Bad Request",
@@ -1232,55 +1285,160 @@
}
}
}
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "../models/error-body.json"
+ }
+ }
+ }
}
},
- "description": "Legt eine neue Destination an.",
+ "description": "Ãœbertragungsziel aktualisieren",
"requestBody": {
"content": {
"application/json": {
"schema": {
- "$ref": "../models/destination-no-id.json"
+ "$ref": "../models/destination.json"
},
"examples": {
"example-1": {
"value": {
- "public-organization": {
- "organizationName": "Gewerbeamt Musterhausen"
+ "destinationId": "7881dba9-4055-4854-8b6d-11ea5b7f3047",
+ "publicOrganization": {
+ "organizationName": "Gewerbeamt Ankh-Morpork",
+ "address": {
+ "type": "national",
+ "street": "Kurzer Weg",
+ "houseNumber": "7",
+ "postalCode": "12345",
+ "city": "Ankh-Morpork"
+ },
+ "contact": {
+ "telephone": [
+ {
+ "number": "+49 89 32168-0",
+ "mobile": false,
+ "description": "work"
+ }
+ ],
+ "email": "behoerde@example.com"
+ }
},
"technicalContact": [
{
- "firstName": "Werner",
- "lastName": "Mustermann",
+ "formOfAddress": "Herr",
+ "academicTitle": "Dr.",
+ "firstName": "Kunibert",
+ "lastName": "Vonundzu",
"contact": {
"telephone": [
{
"number": "+49 89 32168-42",
"mobile": false,
- "description": "Dienstliches Festnetz"
+ "description": "work"
+ },
+ {
+ "number": "+49 123 456789",
+ "mobile": true,
+ "description": "work"
}
- ]
+ ],
+ "email": "kunibert.vonundzu@example.com"
}
}
],
+ "schemas": [
+ {
+ "mimeType": "json",
+ "schemaSource": "none"
+ }
+ ],
"callback": {
- "callbackURI": "https://www.example.com/callback"
+ "callbackURI": "http://127.0.0.1:4010/voluptas"
}
}
}
}
}
+ }
+ },
+ "tags": [
+ "Destination Management"
+ ],
+ "security": [
+ {
+ "OAuth 2.0": [
+ "{subscriberId}:manage",
+ "{subscriberId}:destination:update",
+ "{subscriberId}:destination:manage",
+ "{subscriberId}:destination:{destinationId}:update"
+ ]
+ }
+ ]
+ },
+ "delete": {
+ "summary": "Delete Destination",
+ "operationId": "delete-destination",
+ "responses": {
+ "200": {
+ "description": "OK"
+ },
+ "400": {
+ "description": "Bad Request",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "../models/error-body.json"
+ }
+ }
+ }
},
- "description": "Anzulegende Destination"
+ "401": {
+ "description": "Unauthorized",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "../models/error-body.json"
+ }
+ }
+ }
+ },
+ "403": {
+ "description": "Forbidden",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "../models/error-body.json"
+ }
+ }
+ }
+ },
+ "404": {
+ "description": "Not Found",
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "../models/error-body.json"
+ }
+ }
+ }
+ }
},
+ "description": "Übertragungsziel löschen",
"tags": [
"Destination Management"
],
"security": [
{
- "API Key": [
+ "OAuth 2.0": [
"{subscriberId}:manage",
"{subscriberId}:destination:manage",
- "{subscriberId}:destination:create"
+ "{subscriberId}:destination:delete",
+ "{subscriberId}:destination:{destinationId}:delete"
]
}
]
@@ -1297,24 +1455,24 @@
],
"components": {
"securitySchemes": {
- "API Key": {
+ "OAuth 2.0": {
"type": "oauth2",
"flows": {
"clientCredentials": {
- "tokenUrl": "",
- "refreshUrl": "",
+ "tokenUrl": "https://oauth.fiep-poc.de/invoke/pub.apigateway.oauth2/getAccessToken",
+ "refreshUrl": "https://oauth.fiep-poc.de/invoke/pub.oauth/refreshAccessToken",
"scopes": {
- "{subscriberId}:destination:delete": "Dieser Zugriffsbereich erlaubt die Löschung von Destinations eines Accounts.",
- "{subscriberId}:destination:{destinationId}:delete": "Dieser Zugriffsbereich erlaubt es, eine spezifische Destination zu löschen.",
- "{subscriberId}:destination:{destinationId}:application:receive": "Dieser Zugriffsbereich erlaubt es, Anträge einer spezifischen Destination abzuholen.",
- "{subscriberId}:manage": "Dieser Zugriffsbereich die vollständige Nutzung aller Endpunkte eines Subscribers.",
- "{subscriberId}:destination:{destinationId}:update": "Mit diesem Zugriffsbereich wird ein schreibende Zugriff auf eine spezifische Destination ermöglicht.",
- "{subscriberId}:application:receive": "Dieser Zugriffsbereich erlaubt es, Anträge für allen Destinations abzuholen.",
- "{subscriberId}:destination:{destinationId}:read": "Mit diesem Zugriffsbereich wird ein lesender Zugriff auf eine spezifische Destination ermöglicht.",
- "{subscriberId}:destination:read": "Dieser Zugriffsbereich erlaubt bei allen Destination-Informationen ein lesender Zugriff.",
- "{subscriberId}:destination:create": "Der Zugriffsbereich erlaubt Destinations neu anzulegen und zu verändern.",
+ "{subscriberId}:destination:manage": "Dieser Zugriffsbereich alle Destination Endpunkte eines Subscriber genutzt werden.",
"{subscriberId}:destination:update": "Dieser Zugriffsbereich erlaubt es, bestehende Destinations zu verändern.",
- "{subscriberId}:destination:manage": "Dieser Zugriffsbereich alle Destination Endpunkte eines Subscriber genutzt werden."
+ "{subscriberId}:destination:create": "Der Zugriffsbereich erlaubt Destinations neu anzulegen und zu verändern.",
+ "{subscriberId}:destination:read": "Dieser Zugriffsbereich erlaubt bei allen Destination-Informationen ein lesender Zugriff.",
+ "{subscriberId}:destination:{destinationId}:read": "Mit diesem Zugriffsbereich wird ein lesender Zugriff auf eine spezifische Destination ermöglicht.",
+ "{subscriberId}:application:receive": "Dieser Zugriffsbereich erlaubt es, Anträge für allen Destinations abzuholen.",
+ "{subscriberId}:destination:{destinationId}:update": "Mit diesem Zugriffsbereich wird ein schreibende Zugriff auf eine spezifische Destination ermöglicht.",
+ "{subscriberId}:manage": "Dieser Zugriffsbereich die vollständige Nutzung aller Endpunkte eines Subscribers.",
+ "{subscriberId}:destination:{destinationId}:application:receive": "Dieser Zugriffsbereich erlaubt es, Anträge einer spezifischen Destination abzuholen.",
+ "{subscriberId}:destination:{destinationId}:delete": "Dieser Zugriffsbereich erlaubt es, eine spezifische Destination zu löschen.",
+ "{subscriberId}:destination:delete": "Dieser Zugriffsbereich erlaubt die Löschung von Destinations eines Accounts."
}
}
},