diff --git a/models/common/address-national.json b/models/common/address-national.json
index 322a019f1751d796772fb2e42e8e30889dfa63a4..7f19e7af8fe1051ccdba9fd7b4f7ed0860b7372f 100644
--- a/models/common/address-national.json
+++ b/models/common/address-national.json
@@ -3,8 +3,9 @@
"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"
}
diff --git a/models/common/address-postbox.json b/models/common/address-postbox.json
index b7366a6c618bb973b0b5107dcec790ae744af52b..a2aee5ac854ac06428dc0433d1df4e8874a65113 100644
--- a/models/common/address-postbox.json
+++ b/models/common/address-postbox.json
@@ -3,8 +3,8 @@
"description": "Eine Adresse eines Postfachs.",
"x-examples": {
"example-1": {
- "street": "Kurzer Weg",
- "houseNumber": 7,
+ "type": "postbox",
+ "postOfficeBox": "987",
"postalCode": "12345",
"city": "Ankh-Morpork"
}
diff --git a/models/common/authentification-info.json b/models/common/authentification-info.json
index 440b551d4b0bf1a7261d44bfd77a397ed965ce49..c67b3c2862a8823afdc37577b3fb861b7213f23f 100644
--- a/models/common/authentification-info.json
+++ b/models/common/authentification-info.json
@@ -26,5 +26,12 @@
"assuranceLevel",
"authentificationMethod"
],
- "description": "Informationen über die Authentifikation der Person."
+ "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 34f942159f4a4d621725ce342a7cca77db1bf7be..db4db9d13b55193ad6c130ee72919a7946b27974 100644
--- a/models/common/eID-natural-person.json
+++ b/models/common/eID-natural-person.json
@@ -1,7 +1,21 @@
{
- "title": "Identity Information with Address",
- "description": "",
+ "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",
diff --git a/models/common/identifier.json b/models/common/identifier.json
index bf24327386c1e0d6462f475c9eac3c9e418c3d6d..977f430f30e3307738d319de041a57852102b98d 100644
--- a/models/common/identifier.json
+++ b/models/common/identifier.json
@@ -41,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 404bbe9d0bfa7c8daada6c35fdb700f2e3468f7b..cc3cba82820cf9652508bb268107310c5cadd14d 100644
--- a/models/common/individual.json
+++ b/models/common/individual.json
@@ -76,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 fe6f9d78c3fa4324248a7abc08066363ea368e7f..e26702b1d19670d89a5625d8c6981444e82fc81f 100644
--- a/models/destination-no-id.json
+++ b/models/destination-no-id.json
@@ -94,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 f284cfc4587439cc998a5e4f7246c7c77f542145..8c566ad31a7b358d024c6bffeebb8c6c037c2173 100644
--- a/models/error-body.json
+++ b/models/error-body.json
@@ -26,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/sender.json b/reference/sender.json
index 78a2c702eac7cf1b871690846fe591a92bd036a7..6c4f63e4e34826f9ab0f3e45db08dc86d829992b 100644
--- a/reference/sender.json
+++ b/reference/sender.json
@@ -57,6 +57,15 @@
"application/json": {
"schema": {
"$ref": "../models/status-overview.json"
+ },
+ "examples": {
+ "example-1": {
+ "value": {
+ "code": "queued",
+ "timestamp": "2020-05-20T08:31:01.135842+02:00",
+ "number": 2
+ }
+ }
}
}
}
@@ -180,7 +189,7 @@
"examples": {
"example-1": {
"value": {
- "applicationId": "45bb5b95-d853-4fc5-b45d-10aa9e15287a"
+ "applicationId": "0c508e3f-2353-4206-9a1e-34b2e864d5a8"
}
}
}
@@ -253,7 +262,6 @@
},
"contentStructure": {
"data": {
- "size": 9438,
"schema": {
"mimeType": "json",
"schemaSource": "none"
@@ -263,9 +271,9 @@
{
"docId": "1",
"purpose": "form",
- "size": 39273,
+ "size": 13046,
"mimeType": "application/pdf",
- "filename": "antrag.pdf",
+ "filename": "test.pdf",
"description": "Das Antragsformular",
"lang": {
"lang": "de",
@@ -273,19 +281,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"
}
}
]
@@ -297,75 +293,61 @@
"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,
@@ -403,6 +385,65 @@
"application/json": {
"schema": {
"$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"
+ }
+ }
}
}
}
@@ -785,6 +826,24 @@
}
}
}
+ },
+ "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
+ }
+ ]
+ }
+ }
}
}
}
@@ -934,6 +993,23 @@
}
}
}
+ },
+ "examples": {
+ "example-1": {
+ "value": {
+ "data": {
+ "status": "complete",
+ "length": 0
+ },
+ "docs": [
+ {
+ "status": "complete",
+ "docId": "1",
+ "length": 13046
+ }
+ ]
+ }
+ }
}
}
}
diff --git a/reference/subscriber.json b/reference/subscriber.json
index 52f9f394386f7c9ef696aee70ca6e0ff220e1d06..a6aca0b110b69fda6ec5225757fbc9bf33cedea9 100644
--- a/reference/subscriber.json
+++ b/reference/subscriber.json
@@ -48,28 +48,114 @@
"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"
+ },
+ "destinationId": "0ddf3ab5-dd89-4e04-9ecd-b2c50b0b4efd"
+ },
+ {
+ "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"
}
]
}
@@ -146,7 +232,7 @@
"examples": {
"example-1": {
"value": {
- "destinationId": "e15fc92e-c286-424b-9802-39c6b6bc441d"
+ "destinationId": "7881dba9-4055-4854-8b6d-11ea5b7f3047"
}
}
}
@@ -194,26 +280,57 @@
"examples": {
"example-1": {
"value": {
- "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"
}
}
}
@@ -277,11 +394,27 @@
"examples": {
"example-1": {
"value": {
- "F99000001": "Eins",
+ "F99000001": "string",
"G99000001": {
- "F99000002": "Zwei",
- "F99000003": "Drei"
- }
+ "F99000002": "string",
+ "F99000003": 42
+ },
+ "G99000002": [
+ {
+ "F99000004": true,
+ "G99000001": {
+ "F99000002": "string",
+ "F99000003": 17
+ }
+ },
+ {
+ "F99000004": true,
+ "G99000001": {
+ "F99000002": "string",
+ "F99000003": 24
+ }
+ }
+ ]
}
}
}
@@ -498,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"
@@ -515,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",
@@ -525,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"
}
}
]
@@ -549,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"
}
}
}
@@ -761,6 +867,18 @@
"required": [
"finalDelivery"
]
+ },
+ "examples": {
+ "example-1": {
+ "value": {
+ "finalDelivery": false
+ }
+ },
+ "example-2": {
+ "value": {
+ "finalDelivery": true
+ }
+ }
}
}
},
@@ -820,14 +938,12 @@
"example-2": {
"value": [
{
- "applicationId": "7236",
"additionalReferenceInfo": {
"subject": "Anmeldung eines Gewerbes in Musterstadt",
"caseId": "DF/8923"
},
"contentStructure": {
"data": {
- "size": 9438,
"schema": {
"mimeType": "json",
"schemaSource": "none"
@@ -837,9 +953,9 @@
{
"docId": "1",
"purpose": "form",
- "size": 39273,
+ "size": 13046,
"mimeType": "application/pdf",
- "filename": "antrag.pdf",
+ "filename": "test.pdf",
"description": "Das Antragsformular",
"lang": {
"lang": "de",
@@ -847,19 +963,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"
}
}
]
@@ -871,82 +975,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"
}
]
}
@@ -1042,28 +1133,59 @@
"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"
+ },
+ "destinationId": "7881dba9-4055-4854-8b6d-11ea5b7f3047"
}
}
}
@@ -1185,27 +1307,58 @@
"examples": {
"example-1": {
"value": {
- "destination-id": "83578",
- "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"
}
}
}