Entwürfe Notifikationen, Dyn. Formulare und Schlüssellisten in den Developmentbranch aufgenommen

This commit is contained in:
2022-07-09 13:57:23 +02:00
parent 44a49df5eb
commit 474aac8fa7
3 changed files with 307 additions and 1 deletions

View File

@@ -3690,4 +3690,55 @@
</xsd:sequence>
</xsd:complexType>
<xsd:complexType name="ZusaetzlicheFondsdaten_Type" abstract="true"/>
<!-- Als Draft: Zwei Typen um dyn. Formulare zu integrieren -->
<xsd:complexType name="Formularfrage_Type">
<xsd:annotation>
<xsd:documentation>Eine Frage in einem Formular</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="Lfnr" type="xsd:unsignedByte"/>
<xsd:element name="Frage" type="Attribut_Type"/>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="Formular">
<xsd:annotation>
<xsd:documentation>Repräsentiert ein Formular</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:sequence>
<xsd:element name="FormType" type="xsd:string">
<xsd:annotation>
<xsd:documentation>Der Typ des Formulars</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Id" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Optional eine Id für das Formular</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Formularstatus">
<xsd:annotation>
<xsd:documentation>Ob das Formular in Bearbieitung oder abgeschlossen ist</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="inBearbeitung"/>
<xsd:enumeration value="abgeschlossen"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="Kontext" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>Optional Kontextinformationen, z.B. die Id des übergeordneten Geschäftsfalls, zu dem das Formular gehört.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Fragen" type="Formularfrage_Type" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>Die Liste der Fragen des Formulars, manche können beantwortet sein.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
</xsd:element>
<!-- Ende Typen Formulare -->
</xsd:schema>

View File

@@ -323,4 +323,259 @@
<xsd:element name="Zeitraum" type="cst:Zeitraum_Type"/>
</xsd:sequence>
</xsd:complexType>
<!-- Draft: Grundlagen Notifikationsservices -->
<xsd:element name="DeclareEndpointRequest" type="DeclareEndpointRequest_Type">
<xsd:annotation>
<xsd:documentation>Request um als Makler der VU einen Endpoint bekannt zu geben</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:complexType name="DeclareEndpointRequest_Type">
<xsd:annotation>
<xsd:documentation>Typ für den DeclareEndpointRequest</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="VUNr" type="omds:VUNr"/>
<xsd:element name="BasisUrlEndpoint">
<xsd:annotation>
<xsd:documentation>Die BasisURL unter welcher z.B. die VU die SOAP-Webservices des Vermittlers aufrufen kann. Die maximale Länge beträgt 1000 Zeichen</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="1000"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element ref="ArtAuthentifizierung"/>
<xsd:element name="Credentials" type="Credentials_Type">
<xsd:annotation>
<xsd:documentation>Ein abstrakter Credentials-Type, für den z.B. der UsernamePasswordCredentials_Type eingesetzt werden kann.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="AuthorizationFilter" type="cst:AuthorizationFilter" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Die Zuordnung des Endpoints zu bestimmten fachlichen Nutzern, z.B. Vermittlernummern.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="ArtAuthentifizierung">
<xsd:annotation>
<xsd:documentation>Gibt vor, wie die Authentifizierung beim einzelnen Serviceaufruf erfolgt. Derzeit werden die Typen Username-Token und Security-Context-Token unterstützt.</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:enumeration value="UsernameToken"/>
<xsd:enumeration value="Security-Context-Token"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:complexType name="Credentials_Type" abstract="true">
<xsd:annotation>
<xsd:documentation>Ein abstrakter Typ, dessen konkrete Implementierungen unterschiedliche Credentials aufnehmen können. </xsd:documentation>
</xsd:annotation>
</xsd:complexType>
<xsd:complexType name="UsernamePasswordCredentials_Type">
<xsd:annotation>
<xsd:documentation>Konkrete Implementierung von Credentials mit Username und Password</xsd:documentation>
</xsd:annotation>
<xsd:attribute name="Username" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>Der Username, wobei keine vorschriften bezüglich des Usernames gemacht werden.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
<xsd:attribute name="Password" type="xsd:string" use="required">
<xsd:annotation>
<xsd:documentation>Das Passwort, wobei keine Anforderungen an die Passwort-Stärke gemacht werden.</xsd:documentation>
</xsd:annotation>
</xsd:attribute>
</xsd:complexType>
<xsd:element name="DeclareEndpointResponse" type="DeclareEndpointResponse_Type">
<xsd:annotation>
<xsd:documentation>Response um als Makler der VU einen Endpoint bekannt zu geben</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:complexType name="DeclareEndpointResponse_Type">
<xsd:annotation>
<xsd:documentation>Response um als Makler der VU einen Endpoint bekannt zu geben</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="RegistrierteBasisUrlMaklerEndpoint" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Die von der VU zuletzt erfolgreich registrierte BasisUrl</xsd:documentation>
</xsd:annotation>
<xsd:simpleType>
<xsd:restriction base="xsd:string">
<xsd:maxLength value="1000"/>
</xsd:restriction>
</xsd:simpleType>
</xsd:element>
<xsd:element name="ServiceFault" type="cst:ServiceFault" minOccurs="0"/>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="SecurityContextTokenRequest" type="SecurityContextTokenRequest_Type">
<xsd:annotation>
<xsd:documentation>Request zum Bezug eines Security-Context-Token</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:complexType name="SecurityContextTokenRequest_Type">
<xsd:annotation>
<xsd:documentation>Request-Type zum Bezug eines Security-Context-Tokens</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="Credentials" type="Credentials_Type"/>
</xsd:sequence>
</xsd:complexType>
<xsd:element name="SecurityContextTokenResponse" type="SecurityContextTokenResponse_Type">
<xsd:annotation>
<xsd:documentation>Response des Bezug eines Security-Context-Tokens</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:complexType name="SecurityContextTokenResponse_Type">
<xsd:annotation>
<xsd:documentation>Response-Type zum Bezug eines Securtity-Context-Tokens</xsd:documentation>
</xsd:annotation>
<xsd:sequence>
<xsd:element name="Token" type="xsd:string">
<xsd:annotation>
<xsd:documentation>Der Token selbst als String</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="DauerhaftGueltig" type="xsd:boolean">
<xsd:annotation>
<xsd:documentation>Wahr, wenn der Token eine zeitlich unbeschränkte Gültigkeit aufweist, sonst falsch.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="GueltigBis" type="omds:Datum-Zeit" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Optional: Das Ablaufdatum des Tokens</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:complexType>
<!-- Ende Entwurf Notifikationen -->
<!-- Beginn Entwurf Schlüsselliste -->
<xsd:element name="GetElementListRequest">
<xsd:annotation>
<xsd:documentation>Request um eine Schlüsselliste abzufragen</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base="cst:CommonRequest_Type">
<xsd:sequence>
<xsd:element name="ListCd" type="xsd:string">
<xsd:annotation>
<xsd:documentation>Der Code der Schlüsselliste, zu welcher Informationen abgefragt werden sollen.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Context" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Optional eine Contextinformation zur Schlüsselliste</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
<xsd:element name="GetElementListResponse">
<xsd:annotation>
<xsd:documentation>Response mit einer Schlüsselliste</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base="cst:CommonResponse_Type">
<xsd:sequence>
<xsd:element name="Bezeichnung" type="xsd:string">
<xsd:annotation>
<xsd:documentation>Ein menschenverständlicher Text für die Liste, der z.B. in einer Oberfläche verwendet werden könnte. </xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="BeschreibungTxt" type="xsd:string" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Eine weiterführende Beschreibung der Liste.</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Values" type="cst:EintragSchluesselliste_Type" minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>Optional die Vorgabe einer Werteliste, aus der die ausgewählten Schlüssel stammen müssen</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="MinAnz" type="xsd:unsignedShort" minOccurs="0">
<xsd:annotation>
<xsd:documentation>Mindestanzahl zu selektierender Werte, z.B. 0 für optional oder 1 für obligatorisch oder auch mehrere, wenn Multiselect.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
<!-- Ende Entwurf Schlüsselliste -->
<!-- Beginn Entwurf dyn. Formulare -->
<xsd:element name="CreateFormRequest">
<xsd:annotation>
<xsd:documentation>Startet die Erstellung eines Formulars</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base="cst:CommonProcessRequest_Type">
<xsd:sequence>
<xsd:element name="FormType" type="xsd:string">
<xsd:annotation>
<xsd:documentation>Der Typ des Formulars</xsd:documentation>
</xsd:annotation>
</xsd:element>
<xsd:element name="Kontext" type="xsd:string" minOccurs="0" maxOccurs="unbounded">
<xsd:annotation>
<xsd:documentation>Optional Kontextinformationen, z.B. die Id des Geschäftsfalls, zu dem das Formular gehört.</xsd:documentation>
</xsd:annotation>
</xsd:element>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
<xsd:element name="CreateFormResponse">
<xsd:annotation>
<xsd:documentation>Gibt die Einstiegsfragen eines Formulars zurück.</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base="cst:CommonProcessResponse_Type">
<xsd:sequence>
<xsd:element ref="cst:Formular"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
<xsd:element name="SubmitFormRequest">
<xsd:annotation>
<xsd:documentation>Übergibt Antworten eines Formulars</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base="cst:CommonProcessRequest_Type">
<xsd:sequence>
<xsd:element ref="cst:Formular"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
<xsd:element name="SubmitFormResponse">
<xsd:annotation>
<xsd:documentation>Übergibt den aktuellen Zustand des Formulars und etwaige weitere Fragen falls notwendig</xsd:documentation>
</xsd:annotation>
<xsd:complexType>
<xsd:complexContent>
<xsd:extension base="cst:CommonProcessResponse_Type">
<xsd:sequence>
<xsd:element ref="cst:Formular"/>
</xsd:sequence>
</xsd:extension>
</xsd:complexContent>
</xsd:complexType>
</xsd:element>
<!-- Ende Entwurf dyn. Formulare -->
</xsd:schema>