diff --git a/models/application/applicant-contact-info.json b/models/application/applicant-contact-info.json index 15f55a4b99d0049d486739af9381c619a12110aa..7608c9f1353100267c21584bf9210ee03cb38b69 100644 --- a/models/application/applicant-contact-info.json +++ b/models/application/applicant-contact-info.json @@ -3,6 +3,29 @@ "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": [ diff --git a/models/application/applicant-person.json b/models/application/applicant-person.json index 8e51e383a16305209665981f0edab2a0487e91e0..a64e4d71c89bd90be66896cfcd905d20a11dc7d0 100644 --- a/models/application/applicant-person.json +++ b/models/application/applicant-person.json @@ -29,5 +29,48 @@ }, "required": [ "type" - ] + ], + "x-examples": { + "example-1": { + "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": { + "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" + } + ] + } + } + } } \ No newline at end of file diff --git a/models/application/document.json b/models/application/document.json index 22e8312c6c0bb14db98d27209aafb6d01991be1d..df5106a975faca8c6d8e6846ae11e2d1a4373094 100644 --- a/models/application/document.json +++ b/models/application/document.json @@ -72,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 3a787339c7ad20581199e3a1563b52323def9adf..7e646c1d25538952cb3c911d6e8799c5c549901f 100644 --- a/models/application/metadata-no-id.json +++ b/models/application/metadata-no-id.json @@ -63,5 +63,107 @@ }, "required": [ "contentStructure" - ] + ], + "x-examples": { + "example-1": { + "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": { + "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" + } + ] + } + } + ], + "paymentInfo": { + "reference": "TP/93/GDP", + "usage": "Gewerbeanmeldung", + "amount": 17.3, + "timestamp": "2020-03-03T12:38:23Z", + "status": "success", + "transaction": "1f77c5f9b759db9cdce59988b24974d465c7be5e462a6185485559ff6e2dea82" + } + } + } } \ No newline at end of file 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 df51e991ce028ef73deff7c43f7d28c705a77f0a..9e2a9c3ebbae39c9fd9ae4b9fd9ae988229890f4 100644 --- a/models/common/address-international.json +++ b/models/common/address-international.json @@ -5,6 +5,7 @@ "additionalProperties": false, "x-examples": { "example-1": { + "type": "international", "lines": [ "760 United Nations Plaza", "Manhattan, New York City, New York 10017" @@ -12,6 +13,7 @@ "country": "368" }, "example-2": { + "type": "international", "lines": [ "Threadneedle Street", "London EC2R 8AH"