Releasenotes Submission-API

Schnittstellenversion 4.2-beta (Release 4.114.0)

Mit dem Release 4.114.0 werden Änderungen am Datenmodell für Assistenten eingeführt.
Die Submission-API 4.2-beta bleibt abwärtskompatibel.

Änderungen mit Release 4-114-0

  • Bei Komponenten und Objektgruppen wird gekennzeichnet, ob sie während des Ausfüllens sichtbar waren.
    Key: needed: true/false

  • Bei Multipanels ist das Feld explanation kein komplexes JSON-Objekt mehr, sondern ein einfacher String.

  • Im Panel-Knoten wird position korrekt hochgezählt.

  • im Knoten category wurden ungenutzte Attribute entfernt: createdAt, changedAt

  • Die bestehenden i18n-Knoten (z. B. Bezeichnung öffentlich, Titel, ..) werden zusätzlich in sprechend benannten, einfachen Feldern ausgegeben.

Beispiel: neue Beschriftungs-Felder einer Komponente
..
"placeholderI18n": {..},
"placeholder": "",
..
"labelI18n": {..},
"publicLabel": "",
..
"ariaI18n": {..},
"accessibilityLabel": "",
..
"hintI18n": {..},
"hint": "",
..
"nameI18n": {..},
"internalLabel": ""
..

Schnittstellenversion 4.2-beta (Release 4.112.0)

Die Anwort auf Anfragen an die Submission-API wurde hier um Authentifizierungsdaten, die bisher als secureData schon im XML enthalten waren, erweitert.

Response mit BundID ab 4.2-beta

{
  "secureData": {
     "DateOfBirth": "01.01.1974",
     "Origin": "BUNDID",
     "Email": "max.mustermann@musterhausen.de",
     "BirthPlace": "Berlin",
     "FirstName": "Max",
     "ZipCode": "12345",
     "StorkQaaLevel": "STORK-QAA-Level-1",
     "City": "Musterhausen",
     "PostkorbId": "abcdefab-cdef-4abc-9def-abcdefabcdef",
     "AcademicTitle": "Dr.hc.",
     "Phone": "{plus}49 17012345678",
     "Titel": "Herr",
     "Street": "Musterstraße 1",
     "Country": "Deutschland",
     "LastName": "Mustermann",
     "BirthName": "Gabler"
    }
}

Response mit MUK ab 4.2-beta

{
"secureData": {
   "Origin": "MUK",
   "CompanyAddressLocality": "Musterhausen",
   "CompanyAddressPostCode": "123456",
   "OccupationText": "Beratung",
   "CompanyAddressCountry": "Deutschland",
   "CompanyAddressStreetNumber": "1",
   "StorkQaaLevel": "substanziell",
   "CompanyName": "Mustermann Beratung",
   "Occupation": "1",
   "RegisterNumber": "987654321",
   "RegisterCourt": "Amtsgericht Musterhausen",
   "CompanyAddressStreet": "Musterstraße",
   "TypeOfLegalPerson": "Natürliche Person",
   "RegisterType": "A"
  }
}

Schnittstellenversion 4.1 (Release 4.104.0)

In der Version 4.1 gibt es zusätzliche Felder:

Feld Inhalt

applicantFirstname

Vorname

applicantLastname

Nachname

applicantType

NATURAL_PERSON oder NOT_NATURAL_PERSON

applicationInfoText

Wird z.B. von Portalen benutzt, um durch Vorbefüllung ein Referenzzeichen zu übergeben.

Dynamische Befüllung dieses Werts im Assistenten durch eine Komponente mit der "Bezeichnung technisch": "INFOTEXT"

Die tabellarische Darstellung der Submission-API-Antwort enthält mit Version 4.1 mehr Informationen, die eine Zuordnung der Einreichungen erleichtern. Dies wird durch die Ergänzung dieser Felder auf der ersten Ebene des Schemas erreicht.

Response für eine natürliche Person in V4.0

{
 "applicantEMail": "max.mustermann@muster.de",
 "applicantName": "Max Mustermann ",
 "attachments": null,
 ...
}

Response für eine natürliche Person ab V4.1

{
 "applicantEMail": "max.mustermann@muster.de",
 "applicantName": "Max Mustermann",
 "applicantFirstname": "Max",
 "applicantLastname": "Mustermann",
 "applicantCompanyname": null,
 "applicantType": "NATURAL_PERSON",
 "applicationInfoText": "Standardwert InfoText",
 "attachments": null,
 ...
}

Response für eine nicht natürliche Person in V4.0

{
 "applicantEMail": "info@muster.de",
 "applicantName": "Muster GmbH Max Mustermann ",
 "attachments": null,
 ...
}

Response für eine nicht natürliche Person ab V4.1

{
 "applicantEMail": "info@muster.de",
 "applicantName": "Muster GmbH Max Mustermann",
 "applicantFirstname": "Max",
 "applicantLastname": "Mustermann",
 "applicantCompanyname": "Muster GmbH",
 "applicantType": "NOT_NATURAL_PERSON",
 "applicationInfoText": "Standardwert InfoText",
 "attachments": null,
 ...
}