Diese Dokumentation für die SOAP-Schnittstelle in der Version 3 richtet sich in erster Linie an IT-Dienstleister und Entwickler, die Daten aus dem BayernPortal in kommunale oder staatliche Webauftritte integrieren wollen.

Zur Authentifizierung müssen Sie in der Anfrage genau einen SOAP-Header mitschicken, nämlich einen UsernameToken-Header nach der WS-Security-Spezifikation:

Beispiel:

<soapenv:Header>
 <wsse:Security soapenv:mustUnderstand="1"
   xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" 
   xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd">
  
  <wsse:UsernameToken wsu:Id="UsernameToken-15703">
    <wsse:Username>
      username
    </wsse:Username>
    <wsse:Password 
     Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">
      password
    </wsse:Password>
   </wsse:UsernameToken>

 </wsse:Security>
</soapenv:Header>
                        

Weitere Security-Header sind im Gegensatz zu früheren Versionen der allgemeinen SOAP-Webservices nicht mehr erforderlich.

Die ausführliche Dokumentation für die Version 3 finden sie im Dokument Gesamtdokumentation (PDF).
Die SOAP Schnittstelle der Version 3 ermöglichen einen relativ unkomplizierten Umstieg von den Vorgänger-Versionen. Abweichungen und Erweiterungen der Version 3 gegenüber früheren Versionen beschreiben wir in den folgenden Abschnitten.

Die Berechtigung für die verschieden Endpunkte wird den Benutzern über die gleichen Rollen erteilt, die auch für die Versionen 1 und 2 gelten. Sie können also die Version 3 mit der gleichen Kennung und den gleichen Rechten nutzen, wie die Vorgängerversionen.

Webservice "Behörden, Gebäude und Ansprechpartner allgemein - Version 3 (WSDL - XML)"

Bei diesem Webservice gibt es folgende neuen Endpunkte:

• GetDienststellen - Liefert alle Dienststellen (inkl. Außenstellen), auf die der Benutzer Zugriff hat. Bei Angabe des optionalen Elements dienststellenschluessel werden nur Dienststellen geliefert, zu denen der 7-stellige Dienststellenschlüssel passt. Ersetzt den Endpunkt GetDienststelle der Webservice-Versionen 1 und 2.
  Das Ergebnis ist im Response in einen neuen zusätzlichen Container dienststellen > dienststelle eingepackt (Angleichung an das REST API).
• GetBehoerden - Liefert alle Behörden (Dienststellen, Außenstellen, Organisationseinheiten), auf die der Benutzer Zugriff hat
• GetAnsprechpartner - Liefert behördenübergreifend alle Ansprechpartner, auf die der Benutzer Zugriff hat. Bei Angabe des optionen Elements ansprechpartnerId werden nur Daten zu dem Ansprechpartner mit der angegebenen Id geliefert.
  Das Ergebnis ist im Response in einen neuen zusätzlichen Container ansprechparter > ap eingepackt (Angleichung an das REST API).

Für die Anfragen der drei neuen Endpunkte gibt es jeweils ein optionales Attribut (full). Wenn dieses gesetzt ist und den Wert true hat, dann werden vollständige Objekte (Dienststelle, Behörde, Ansprechpartner) geliefert, andernfalls nur Kurzformen.

Bei Angabe eines optionalen Attributs (page). Wenn dieses gesetzt ist und den Wert true hat, dann werden vollständige Objekte (Dienststelle, Behörde, Ansprechpartner) geliefert, andernfalls nur Kurzformen.

Für die Anfragen der drei neuen Endpunkte gibt es jeweils ein optionales Attribut (full). Wenn dieses gesetzt ist und den Wert true hat, dann werden vollständige Objekte (Dienststelle, Behörde, Ansprechpartner) geliefert, andernfalls nur Kurzformen.

Außerdem gibt es im Datenmodell einer Behörde das folgende zusätzliche Element:

Im Datenmodell einer Behörde / Dienststelle wurden folgenden Elemente zu optionalen Elementen ( minOccurs="0" ) erklärt, weil sie in der Kurzform nicht ausgeliefert werden:

Leistungen allgemein - Version 3 (WSDL - XML)

Der Endpunkt "GetLeistungsbeschreibungenVonDienststelle" mit seinen Anfrage-Optionen ermöglicht es, regionale Ergänzungen und zuständige Stellen "nach Dienststelle" gefiltert abzufragen. Der Endpunkt liefert "eigene" regionale Ergänzungen der Dienststelle und "eigene" Zuständigkeiten der Dienststelle. Diese Leistungsbeschreibungen müssen somit nicht einzeln über den Endpunkt "GetSingleLeistungsbeschreibung" abgerufen werden.

Statt vieler kurz laufender Anfragen kann nun eine etwas länger laufende Anfrage ("GetLeistungsbeschreibungenVonDienststelleRequest") gesendet werden. Jedoch ist die Antwortzeit der Anfrage länger und die übertragene Datenmenge deutlich größer. Das ist aber bei ausreichender Bandbreite in der Regel besser, als sehr viele Einzelanfragen.

Folgende neuen Elemente wurden hinzugefügt:

<schriftformErfordernis>
                    <id>1</id>
                    <beschreibung>
                        Dieses Formular muss unterschrieben (manuell oder elektronisch)
                        an die zuständige Stelle gesendet werden
                        (per Post, Fax oder geschützte E-Mail).
                    </beschreibung>
                </schriftformErfordernis>

Lebenslagen allgemein - Version 3 (WSDL - XML)

Hier gibt es folgende Neuerungen:

Neue Endpunkte:

• GetLebenslagenVonDienststelle - Erlaubt das Abfragen von Lebenslagen, die für eine Dienststelle passend sind. Es werden nur Lebenslagen zurückgeliefert, denen mindestens eine Leistung der Dienststelle zugeordnet ist. Als verpflichtendes Element ist bei der Anfrage ein 7-stelliger Dienststellenschlüssel anzugeben.
• GetLebenslage - Erlaubt das Abfragen einer bestimmten Lebenslage. Hierzu muss bei der Anfrage als verpflichtendes Element eine gültige id einer Lebenslage angegeben werden (z.B.: 10000100).

Weggefallenes Element:

Im Datenmodell der Antworten "GetAlleLebenslagenResponse" und "GetLebenslageResponse" ist bei den Elementen <lebenslage> das eingeschachtelte Element <metaTag> weggefallen.