187
Web-Service Dokumentation BayernPortal München | 2019

Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

Embed Size (px)

Citation preview

Page 1: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

Web-Service Dokumentation

BayernPortal

München | 2019

Page 2: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

Inhaltsverzeichnis1 Herausgeber ...................................................................................................................................... 4

2 Web-Services für den Datenexport aus dem BayernPortal ............................................................ 5

2.1 SOAP-Webservices ............................................................................................................................ 52.1.1 Erste Schritte mit SOAP-Webservices .............................................................................................................................. 5

2.1.2 Authentifizierung SOAP .................................................................................................................................................. 13

2.1.3 Version 1 .......................................................................................................................................................................... 14

2.1.4 Version 2 .......................................................................................................................................................................... 52

2.1.5 Version 3 SOAP ................................................................................................................................................................ 71

2.2 REST API ........................................................................................................................................ 1282.2.1 Authentifizierung REST-API .......................................................................................................................................... 128

2.2.2 Version 3 REST API ........................................................................................................................................................ 129

3 Web-Services für den Datenimport in das BayernPortal ............................................................ 130

3.1 Authentifizierung und Autorisierung ........................................................................................... 130

3.2 Integrationstests ........................................................................................................................... 130

3.3 Workflow........................................................................................................................................ 130

3.4 Fehlermeldungen im Rahmen der fachlichen Validierung ......................................................... 130

3.5 Authentifizierung Datenimport Web-Services............................................................................. 1313.5.1 Authentifizierung .......................................................................................................................................................... 131

3.6 Autorisierung Datenimport Web-Services ................................................................................... 1323.6.1 Einstiegspunkt............................................................................................................................................................... 132

3.6.2 Einhängepunkt.............................................................................................................................................................. 133

3.6.3 Einhängepunkt.............................................................................................................................................................. 134

3.6.4 Einstiegspunkt............................................................................................................................................................... 134

3.7 Beispiele für die Nutzung der Importschnittstelle ...................................................................... 1353.7.1 Beispiele für die Nutzung der Importschnittstelle ...................................................................................................... 135

3.7.2 Import einer Dienststelle ohne Organisationseinheiten ............................................................................................ 136

3.7.3 Import einer Dienststelle mit Organisationseinheiten ............................................................................................... 139

3.7.4 Import von Dienststellen und ihrer Außenstellen ....................................................................................................... 142

3.7.5 Import mit Leistungszuordnungen .............................................................................................................................. 145

3.7.6 Import von Mitarbeitern (Ansprechpartnern) ............................................................................................................. 154

3.7.7 Import mit Logos........................................................................................................................................................... 160

3.7.8 Import mit Leistungszuordnungen und regionalen Ergänzungen ............................................................................. 167

3.7.9 Import mit Angabe des Einhängepunkts ..................................................................................................................... 173

3.8 Validierungsfehler ......................................................................................................................... 1773.8.1 Validierungsfehler in der synchronen Phase ............................................................................................................... 177

3.8.2 Validierungsfehler in der asynchronen Phase............................................................................................................. 178

3.9 Workflow des Import-Web-Service .............................................................................................. 1833.9.1 Kurzbeschreibung ......................................................................................................................................................... 183

Page 3: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Seite  3 von 187

Die Daten des BayernPortals sollen, soweit rechtlich möglich, auch anderen staatlichen, kommunalen oder vergleichbaren Portalen zur Verfügung gestellt werden (Export). Umgekehrt möchte das BayernPortal auch Daten aus Content-Management-Systemen (CMS) integrieren (Import).

Als Austauschformat wird beim Export und Import XML (Extensible Markup Language) in der Version 1.0 verwendet. Die Kommunikation erfolgt einmal über das SOAP 1.1-Protokoll, zum anderen werden auch reine XML-Web-Servicesangeboten. Die Schnittstelle der SOAP-Web-Services wird in WSDL-Dateien veröffentlicht (Web Services Description Language in der Version 1.1).

Die meisten vom BayernPortal angebotenen Web Services erfordern eine Authentifizierung des Nutzers. Die Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification. Nähere Informationen hierzu finden Sie im jeweiligen Kapitel Authentifizierung.

Page 4: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Herausgeber Seite  4 von 187

1 HerausgeberDie Anwendungen des "BayernPortals" werden herausgegeben von:

Bayerisches Staatsministerium der Finanzen und für Heimat

Zentrale Redaktion des Redaktionssystems für Verwaltungsinformationen in Bayern

Hausanschrift:

Odeonsplatz 480539 München

Postanschrift:

Postfach 22 00 0380535 München

Telefon: +49 (0)89 2306-2267E-Mail: [email protected]

Page 5: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  5 von 187

2 Web-Services für den Datenexport aus dem BayernPortalPortale bzw. Content-Management-System-Provider (CMS-Provider) können folgende Web Services nutzen, um Daten aus dem Datenbestand des BayernPortal abzurufen. Diese Webservices liegen in unterschiedlichen Versionen vor.

2.1 SOAP-Webservices

2.1.1 Erste Schritte mit SOAP-Webservices

Soap-Client für SOAP-WebservicesUm die Webservices zum Abruf von Daten aus dem BayernPortal (Export-Webservices) und zur Übertragung von Daten in das BayernPortal (Import-Webservice) testweise kennenzulernen, benutzen Sie am besten einen „fertigen" Soap-Client.In der Entwicklung benutzen wir das kostenlose und sehr leistungsfähige Werkzeug SoapUI, das Sie unter http://sourceforge.net/projects/soapui/ kostenfrei herunterladen können.Installieren Sie diesen Soap-Client lokal auf Ihrem Rechner und legen Sie ein neues Projekt an.

Proxy-Einstellungen (optional)

Wenn Sie hinter einem Proxy arbeiten, dann geben Sie bitte zunächst den Proxy-Host und Proxy-Port unter File > Preferences > Proxy Settings ein:

Anlegen eines Projekts und Einbinden der ersten WSDL-Datei

Dann erzeugen Sie über „File > New soapUI Project" ein neues Projekt:

Page 6: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  6 von 187

Dabei geben Sie bei „Initial WSDL/WADL" gleich den URI einer ersten WSDL-Datei an. Für das Beispiel beginnen wir mit dem URI https://www.baybw-services.bayern.de/services/allgemein/allgemein-behoerden.v1.wsdl . Die referenzierte WSDL-Datei beschreibt den Soap-Webservice „Behörden, Gebäude und Ansprechpartner allgemein". Den Link dazu finden Sie auch auf unserer oben genannten Homepage. Nach Bestätigung Ihrer Eingaben im Dialog „New SoapUI Project" finden Sie im SoapUI-Navigator-Fenster folgende Einträge:

 

Das sind die 7 Endpunkte des Webservice „Behörden, Gebäude und Ansprechpartner allgemein". An jeden dieser Endpunkte können Sie per HTTP-POST einen ganz speziellen Soap-Request schicken.

Page 7: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  7 von 187

Einbinden der WSDL-Datei eines zweiten Webservice

Bitte binden Sie als nächstes die WSDL-Datei des Webservice „Leistungen allgemein" in Version 2 ein. Dazu markieren Sie das neue Projekt und wählen über das Kontext-Menü „Add WSDL". Der URI ist: https://www.baybw-services.bayern.de/services/allgemein/allgemein-leistungen.v2.wsdl Sie finden ihn auch auf unserer Homepage.

Nach Bestätigung Ihrer Eingaben sehen Sie im SoapUI-Navigator-Fenster folgende Einträge:

Page 8: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  8 von 187

 

Konfiguration der Authentifizierungs-Header

Sie könnten nun grundsätzlich an alle 12 Endpunkte dieser beiden Webservices einen Request schicken. SoapUI hat bereits beim Einbinden der WSDL-Dateien für jeden Endpunkt einen Beispiel-Request generiert. Sie müssen nur noch die konkreten Daten ergänzen. (SoapUI hat dafür Platzhalter ? Eingefügt.)Da beide Webservices jedoch eine Authentifizierung mit einem WS-Security-Header verlangen, müssen Sie noch weitere Vorbereitungen treffen. Für jeden der beiden Webservices geben Sie nun die Authentifizierungsinformationen ein.Doppelklicken Sie im Navigationsfenster auf den ersten Webservice (AllgemeinBehoerdenServicePortTypeSoap11) und geben Sie unter der Registerkarte „Service Endpoints" die folgenden Informationen ein:

• Username• Password• WSS-Type• WSS-TimeToLive

Alle vier Angaben sind erforderlich:  

Page 9: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  9 von 187

Klicken Sie danach die Schaltfläche „Assign", wählen Sie „-- All requests --" und bestätigen Sie. Nun sind alle 7 Beispiel-Request für ersten Webservice „ AllgemeinBehoerdenServicePortTypeSoap11" mit Authentifizierungsinformationen versehen. Überprüfen Sie das bitte, indem Sie auf den ersten Endpunkt „GetAlleAnsprechpartner" aufklappen und auf den generierten Request „Request 1" doppelklicken. Sie erhalten folgendes Bild:

Page 10: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  10 von 187

Beachten Sie das Fenster „Request Properties" in dem Sie sehen, dass für diesen Bespiel-Request die Authentifizierungsinformationen (Username, Password, WSS-Password Type und WSS TimeToLive) so gesetzt sind, wie Sie es gerade eingegeben haben. Gleiches gilt für alle 7 Beispiel-Requests, die SoapUI für den ausgewählten Webservice generiert hat.

Abschicken des Request

Jetzt sind Sie kurz davor, den Request abzusckicken zu können. Dort wo SoapUI im Bespiel-Request als Platzhalter das ? gesetzt hat, geben wir eine gültige Behörden-Id ein. Danach können Sie über den grünen Pfeil den Request abschicken und erhalten folgendes Ergebnis (Das funktioniert natürlich nur, wenn Ihre Kennung die notwendigen Zugriffsrechte für die Behörde mit der Id 4442 hat):

Page 11: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  11 von 187

Rechts neben dem Request-Fenster finden Sie im Response-Fenster das Ergebnis der Anfrage. Das Ergebnis ist wie die Anfrage ein vollständiges Soap-Dokument, jedoch mit leerem Soap-Header. Der wichtige Payload steht im Soap-Body.

Raw-Ansicht des Request

Für die Programmierung eines Soap-Requests ist die Raw-Ansicht im Request-Fenster sehr instruktiv. Klicken Sie im Request-Fenster auf den vertikalen Tab „Raw". Sie sehen folgendes (für die Darstellung nachformatiert):

Page 12: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  12 von 187

POST https://www.baybw-services.bayern.de:443/services/allgemein/behoerden/v1HTTP/1.1 Accept-Encoding: gzip,deflate Content-Type: text/xml;charset=UTF-8 SOAPAction: "" Authorization: Basic xxxxxxxxxxxxxxxxxxxxx Content-Length: 1204 Host: www.baybw-services.bayern.de:443 Connection: Keep-Alive User-Agent: Apache-HttpClient/4.1.1 (java 1.5) <soapenv:Envelope xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v1/behoerden" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Header> <wsse:Security soapenv:mustUnderstand="1" xmlns:wsse="...xsd" xmlns:wsu="...xsd"> <wsu:Timestamp wsu:Id="TS-2"> <wsu:Created>2013-07-17T14:16:22Z</wsu:Created> <wsu:Expires>2013-07-17T14:18:22Z</wsu:Expires> </wsu:Timestamp> <wsse:UsernameToken wsu:Id="UsernameToken-1"> <wsse:Username>0308106-003</wsse:Username> <wsse:Password Type="...-1.0#PasswordText">geheim-im-klartext</wsse:Password> <wsse:Nonce EncodingType="...-1.0#Base64Binary">GKn3ePKqkqHFI44ZCfuRyw==</wsse:Nonce> <wsu:Created>2013-07-17T14:16:22.537Z</wsu:Created> </wsse:UsernameToken> </wsse:Security> </soapenv:Header> <soapenv:Body> <beh:GetAlleAnsprechpartnerRequest> <behoerdeId>4442</behoerdeId> </beh:GetAlleAnsprechpartnerRequest> </soapenv:Body> </soapenv:Envelope>

Die Ansicht zeigt den kompletten POST auf HTTP-Protokoll-Ebene. Erst mit <soapenv:Envelope … >beginnt der eigentliche Soap-Request. Wenn man einen Soap-Client - wie SoapUI – zu Verfügung hat oder eine Soap-Bibliothek in einer bestimmten Programmiersprache benutzt, dann ist das Erzeugen der Soap-Header nicht kompliziert. Ohne derartige Hilfen ist jedoch zumindest das Generieren des WS-Security-Headers mit den Elementen „Timestamp" und „UsernameToken" eine kleine Herausforderung. Man muss sich dann schon mit dem WS-Security-Protokoll (https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=wss) selbst befassen. Wir empfehlen also, für die Programmierung eine Soap-Bibliothek zu benutzen. In Java ist mit JAX-WS ein Standard bereits integriert. Wir benutzen daneben aber auch Spring-WS (http://static.springsource.org/spring-ws/sites/2.0/).Für PHP-Nutzer können wir leider, mangels Erfahrung, keine Empfehlung nennen.

Zusammenfassung

• Zum Kennenlernen der Soap-Webservices des BayernPortals empfehlen wir die Benutzung eines fertigen Soap-Clients.

• SoapUI z.B. hilft Ihnen dabei, den Aufbau einer Soap-Anfrage / Soap-Antwort leichter zu verstehen, weil es aus der WSDL-Datei Beispiel-Requests generiert.

• Insbesondere die Soap-Header sind nicht einfach zu erzeugen. Man kann sich aber auch diese in der Raw-Ansicht zeigen lassen und lernt, wie sie aussehen müssen.

Page 13: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  13 von 187

• Es ist aber für Soap-Webservice-Client-Entwickler in jedem Fall sinnvoll, Soap-Requests und die notwendigen Header über eine Bibliothek erzeugen zu lassen.

• Für die im Beispiel dargestellten Webservices (Behörden, Gebäude und Ansprechpartner allgemein" und „Leistungen Allgemein") ist eine Authentifizierung erforderlich. Sie benötigen eine Benutzerkennung, die für die jeweilige Dienststelle die Rolle „Webservices Behörden" und die Rolle „Webservices Leistungen" hat.Sollte Ihre Authentifizierung fehlschlagen, nehmen Sie bitte mit der zentralen Redaktion Kontakt auf und lassen dies überprüfen.

• Die Kontaktdaten der zentralen Redaktion finden Sie unter https://www.bayvis-redaktionssystem.bayern.de.

2.1.2 Authentifizierung SOAP

Authentifizierung bei SOAP-Webservices - Versionen 1 und 2Soweit bei den Web Services eine Authentifizierung erforderlich ist, erfolgt diese nach der WS-Security-Spezifikation. Der Client authentifiziert sich über Benutzerkennung und Kennwort. Die beiden Angaben gehören zu einem speziellen Header der SOAP-Nachricht (UsernameToken). Außerdem kann als zusätzliches Sicherheitsmerkmal ein weiterer Header (Timestamp) angegeben werden. Dieser Header begrenzt die Gültigkeitszeit der Nachricht.

Für alle authentifizierungspflichtigen Webservices wird eine Kennung des Redaktionssystems für Verwaltungsinformationen benötigt. Diese Kennung können Sie hier beantragen:

HerausgeberDie Anwendungen des "BayernPortals" werden herausgegeben von:Bayerisches Staatsministerium der Finanzen und für HeimatZentrale Redaktion des Redaktionssystems für Verwaltungsinformationen in BayernHausanschrift:Odeonsplatz 480539 MünchenPostanschrift:Postfach 22 00 0380535 MünchenTelefon: +49 (0)89 2306-2267E-Mail: [email protected]

Page 14: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  14 von 187

Beispiel eines vollständigen WS-Security-SOAP-Header (mit Timestamp und UsernameToken)

<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"> <wsu:Timestamp wsu:Id="Timestamp-8382636" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <wsu:Created>2014-01-10T12:14:49.791Z</wsu:Created> <wsu:Expires>2014-01-10T12:15:49.791Z</wsu:Expires> </wsu:Timestamp> <wsse:UsernameToken wsu:Id="UsernameToken-11481251" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <wsse:Username>ws-user</wsse:Username> <wsse:Password Type="http://docs.oasis-open.org/ wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">secret</wsse:Password> <wsse:Nonce>sApImdTbRXGbhA/ugQM7Zw==</wsse:Nonce> <wsu:Created>2014-01-10T12:14:53.055Z</wsu:Created> </wsse:UsernameToken> </wsse:Security></soapenv:Header>

Authentifizierung bei SOAP-Webservices - Version 3Die Authentifizierung erfolgt über einen SOAP-Header (UsernameToken-Header) nach der WS-Security-Spezifikation. Weitere Header (z.B. Timestamp) sind im Gegensatz zu früheren Versionen der allgemeinen SOAP-Webservices nicht mehr erforderlich. Beim UsernameToken-Header sind die Elemente <Nonce> und <Created> zulässig, aber nicht erforderlich.

Beispiel:

Beispiel eines gültigen UsernameToken-Header (ohne Nonce und Created)

<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>nnnnnnn-nnn</wsse:Username>          <wsse:Password Type="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText">xxxxxxx</wsse:Password>      </wsse:UsernameToken>  </wsse:Security></soapenv:Header>

2.1.3 Version 1

Version wird eingestelltBitte beachten Sie, dass für diese Version bereits seit Ende 2013 kein Support mehr angeboten wird, und die Version voraussichtlich Ende 2016 vollständig vom Netz genommen wird. Es wird dringend geraten auf Webservices der Version 3 SOAP bzw. Version 3 REST-API umzusteigen.

Page 15: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  15 von 187

Behörden, Gebäude und Ansprechpartner (Version 1)Dieser Web Service erfordert eine Authentifizierung durch den Client (Portal oder CMS-Provider).

Die Schnittstellenbeschreibung finden Sie in folgender Web-Services-Description- Language-Datei (WSDL):

https://www.baybw-services.bayern.de/services/allgemein/allgemein-behoerden.v1.wsdl

Der Web Service bietet folgende Schnittstellen-Endpunkte an:

• Daten einer Dienststelle• Daten einer Behörde• Daten eines Behördengebäudes• Daten eines Behördenansprechpartners

Diese vier Schnittstellen sind darauf ausgelegt, dass man über den Endpunkt Daten einer Dienststelle bei der Dienststelle einsteigt und sich dann über rekursive Aufrufe von Daten einer Behörde "durch den Organisationsbaum der Dienststelle arbeitet".

Dabei erhält man in den Antworten die Referenz-Ids von Gebäuden und Ansprechpartnern, deren Daten über weitere Anfragen im Kontext der Behörde und des Gebäudes abgerufen werden können. Man erhält mit den Gebäuden auch Öffnungszeiten und mit den Ansprechpartnern auch Sprechzeiten.

• Liste der Ansprechpartner einer Behörde• Liste der Leistungen einer Behörde• Liste der Leistungen eines Ansprechpartners

Diese drei Schnittstellen liefern die erforderlichen Daten, um Ansprechpartner- und Leistungsübersichten zu erzeugen.

Alle Anfragen an die sieben hier genannten Endpunkte gewähren nur auf Daten von Behörden, Gebäuden und Ansprechpartnern Zugriff, für die Ihre Benutzerkennung berechtigt ist. Daher benötigen Sie für diesen Web Service eine Benutzerkennung, die vom zentralen Administrator beim Bayerischen Staatsministerium der Finanzen und für Heimat (StMFLH) speziell für den Datenexport Ihrer Dienststelle (z.B. Gemeinde) eingerichtet wird.

Der zentrale Administrator kann dieser Kennung bei Bedarf durchaus mehrere Profile zuordnen, so dass gleichzeitig auch der Zugriff auf die Daten weiterer Dienststellen (z.B. zusätzlich auf die Verwaltungsgemeinschaft, zu der eine Gemeinde gehört) ermöglicht wird.

Wenn Sie über einen der sieben genannten Endpunkte Daten anfordern, für die Ihre Kennung nicht berechtigt ist, wird folgender SOAP-Fehler geliefert:

BenutzerkennungSie benötigen eine Kennung, der ein Profil mit der Rolle "Webservices Behörden" zugeordnet ist. Der Einstiegsknoten des Profils wird bei Anfragen ausgewertet und sollte eine bestimmte Dienststelle oder sonstige Behörde sein. Der Webservice liefert nur Daten zu dieser Dienststelle oder sonstigen Behörde und ihrem organisatorischen Unterbau.Wenn Ihrer Kennung mehrere Profile mit dieser Rolle, aber mit unterschiedlichen Einstiegsknoten zugeordnet sind, können Sie mit der Kennung auch auf die Daten von mehr als einer Dienststelle oder sonstigen Behörde zugreifen.Unter der Web-Adresse https://www.bayvis-redaktionssystem.bayern.de finden Sie die Kontaktdaten zum Beantragen einer Kennung.

Page 16: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  16 von 187

Daten einer Dienststelle

Eine Anfrage über diesen Endpunkt sieht folgendermaßen aus (Soap-Header fehlt):

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://lfstad.bayern.de/baybw/allgemein/v1/behoerden"> <soapenv:Header/> <soapenv:Body> <v1:GetDienststelleRequest> <dienststellenschluessel>6721140</dienststellenschluessel> </v1:GetDienststelleRequest> </soapenv:Body></soapenv:Envelope>

Als Parameter müssen Sie den 7-stelligen Dienststellenschlüssel einer bayerischen Dienststelle angeben (Element dienststellenschluessel).

In der Antwort finden Sie dann die Daten zu dieser Dienststelle. Dazu gehören außerdem

• Verweise auf hierarchisch untergeordnete Organisationseinheiten (Element behoerdeZuordnungen) und

• Verweise auf die zugeordneten Gebäude (Element behoerdenGebaeudeZuordnungen)

Zum Abrufen der einzelnen zugeordneten Organisationseinheiten benutzen Sie den Endpunkt Daten einer Behörde, zum Abrufen der Gebäude den Endpunkt Daten eines Behördengebäudes.

Zugriffsberechtigung nicht vorhanden

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en"> Sie haben keine Berechtigung zum Abrufen der angeforderten Daten. </faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Page 17: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  17 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <ns3:GetDienststelleResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v1/behoerden"> <dienststelle id="2534"> <bezeichnung>Bad Kissingen</bezeichnung> <behoerdenart>Dienststelle</behoerdenart> <logo alt="Bad Kissingen Wappen" mimetype="image/jpeg" title="Bad Kissingen Wappen"> /9j/4AAQS ... //9k= </logo> <logoLangtext mimetype="image/gif" title="Bad Kissingen Wappen Geschichte"> R0lGODlhA ... AOw== </logoLangtext> <kurzbeschreibung> Die Große Kreisstadt Bad Kissingen ... </kurzbeschreibung> <langbeschreibung> Die Geschichte der Großen Kreisstadt Bad Kissingen reicht weit ins ... </langbeschreibung> <email>[email protected]</email> <deMail>[email protected]</deMail>  <website>http://www.badkissingen.de/</website> <behoerdengruppe>Ämter / Sachgebiete</behoerdengruppe> <sortierreihenfolge>0</sortierreihenfolge> <behoerdeZuordnungen> <behoerde id="52038"/> <behoerde id="53360"/> <behoerde id="52007"/> <behoerde id="58210"/> <behoerde id="58221"/> <behoerde id="52044"/> <behoerde id="58178"/> <behoerde id="52031"/> <behoerde id="58209"/> <behoerde id="52045"/> <behoerde id="52049"/> </behoerdeZuordnungen> <behoerdenGebaeudeZuordnungen> <gebaeude id="2534"/> </behoerdenGebaeudeZuordnungen> <bezeichnungZusatz>Große Kreisstadt</bezeichnungZusatz> <dienststellenschluessel>6721140</dienststellenschluessel> <dienststelleLfdNr>0</dienststelleLfdNr> <mitgliedVonVerwaltungsgemeinschaft></mitgliedVonVerwaltungsgemeinschaft/> </dienststelle> </ns3:GetDienststelleResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Die meisten Elemente der Antwort sind selbsterklärend. Hier einige zusätzliche Hinweise.

Das Element behoerdenart kann folgende Inhalte haben:

• Dienststelle• Organisationseinheit

Page 18: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  18 von 187

• Sonstige Behörde

Das Element behoerdengruppe kann folgende (relevante) Inhalte haben:

• Ämter / Sachgebiete• Einrichtungen• Geschäftsstellen• kommunale Beteiligungen / kommunale Unternehmen• Körperschaften, Anstalten und Stiftungen• Nachgeordnete Dienststellen• Sehenswürdigkeiten• Sonstiges• Versorgungsträger• Weitere Dienstsitze

Das Element sortierreihenfolge ist eine Ganzzahl, die die gewünschte Sortierreihenfolge von Geschwister-Organisationseinheiten bei der Anzeige festlegt.

Das Element dienststelleLfdNr ist 0, wenn es sich um eine Hauptdienststelle handelt. Bei Aussenstellen ist es > 0 (laufende Nummerierung).

Das Element mitgliedVonVerwaltungsgemeinschaft enthält die Bezeichnung einer Verwaltungsgemeinschaft, wenn einer Gemeinde Mitglied einer solchen ist.

Daten einer Behörde

Eine Anfrage über diesen Endpunkt sieht folgendermaßen aus (Soap-Header fehlt):

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://lfstad.bayern.de/baybw/allgemein/v1/behoerden"> <soapenv:Body> <v1:GetBehoerdeRequest> <behoerdeId>58221</behoerdeId> </v1:GetBehoerdeRequest> </soapenv:Body></soapenv:Envelope>

Als einzigen Parameter müssen Sie die Id einer Behörde angeben (Element behoerdeId). Diese Id erhalten sie zum Beispiel über einen vorherigen Aufruf des Endpunkts Daten einer Dienststelle. Aber auch die Antwort zu dieser Anfrage liefert gegebenenfalls Ids von untergeordneten Organisationseinheiten zurück (Element behoerdeZuordnungen).

In der Antwort finden Sie die Daten zur Behörde mit der angegebenen Id. Dazu gehören außerdem

Mögliche Fehler

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en"> Invalid parameter 'dienststellennummer'. Dienststelle mit der angegebenen Dienststellennummer nicht gefunden. </faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Page 19: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  19 von 187

• Verweise auf hierarchisch untergeordnete Organisationseinheiten (Element behoerdeZuordnungen) und

• Verweise auf die zugeordneten Gebäude (Element behoerdenGebaeudeZuordnungen)

Zum Abrufen der einzelnen zugeordneten Organisationseinheiten benutzen Sie den Endpunkt Daten einer Behörde, zum Abrufen der Gebäude den Endpunkt Daten eines Behördengebäudes.

Die Elemente entsprechen inhaltlich denen in der Antwort des Endpunkts Daten einer Dienststelle. Es fehlen jedoch die dienststellenspezifischen Elemente

• bezeichnungZusatz,• dienststellenschluessel,• dienststelleLfdNr und• mitgliedVonVerwaltungsgemeinschaft.

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetBehoerdeResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v1/behoerden"> <behoerde id="58221"> <bezeichnung>Kindergärten</bezeichnung> <behoerdenart>Organisationseinheit</behoerdenart> <logo alt="Bad Kissingen Wappen" mimetype="image/jpeg" title="Bad Kissingen Wappen"> /9j/4AAQS ... //9k= </logo> </kurzbeschreibung> <website>http://www.badkissingen.de/stadtleben/arbeit/schulen/index.html</website> <behoerdengruppe>Einrichtungen</behoerdengruppe> <sortierreihenfolge>10</sortierreihenfolge> <behoerdenGebaeudeZuordnungen> <gebaeude id="2534"/> </behoerdenGebaeudeZuordnungen> </behoerde> </ns3:GetBehoerdeResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Page 20: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  20 von 187

Daten eines Behördengebäudes

Eine Anfrage über diesen Endpunkt sieht folgendermaßen aus (Soap-Header fehlt):

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://lfstad.bayern.de/baybw/allgemein/v1/behoerden"> <soapenv:Body> <v1:GetBehoerdenGebaeudeRequest> <behoerdeId>2534</behoerdeId> <gebaeudeId>2534</gebaeudeId> </v1:GetBehoerdenGebaeudeRequest> </soapenv:Body></soapenv:Envelope>

Sie müssen zwei verpflichtende Parameter (Elemente behoerdeId und gebaeudeId) angeben. Es genügt nicht, nur die Id eines Gebäudes bereitzustellen, weil im BayernPortal ein Gebäude typischerweise mehreren Behörden zugeordnet ist. Sie fordern also mit diesem Endpunkt eigentlich ein Gebäude im Kontext seiner Behörden-Zuordnung an. In der Antwort sind die Elemente oeffnungszeiten und behoerdenAnsprechpartnerZuordnungen für dieses Gebäude nur bezüglich dieser Behördenzuordnung (Attribut behoerdeId) gültig. Für die Zuordnung des gleichen Gebäudes zu einer anderen Behörde kann es andere Ergebnisse geben.

Im BayernPortal gibt es die Möglichkeit, die Telefonnummer und Faxnummer eines Gebäudes für bestimmte Behördenzuordnungen zu überschreiben (Seite "Abweichende Telefonnummer"). Falls ein Redakteur eine der dort verfügbaren Optionen gewählt hat, gelten die Werte der Elemente

Mögliche Fehler

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en"> Invalid parameter. Behörde mit der angegebenen Id nicht gefunden. </faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en"> Invalid parameter. Behörde mit dieser Id ist keine Dienststelle oder Organisationseinheit oder sonstige Behörde. </faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Page 21: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  21 von 187

• telefonOrtsvorwahl• telefonAnlage• telefonDurchwahl• faxOrtsvorwahl• faxAnlage• faxDurchwahl

ebenfalls nur für die Zuordnung des Gebäudes zur angegebenen Behörde.

In der Antwort finden Sie neben den Gebäudedaten auch

• Verweise auf die zugeordneten Ansprechpartner (Element behoerdenAnsprechpartnerZuordnungen)• Öffnungszeiten des Gebäudes für die zugeordnete Behörde (Element oeffnungszeiten)

Die Öffnungszeiten können im BayernPortal als Zeitangabe für einzelne Wochentage (Element zeitangabe) und/oder als freies Textfeld (Element sonderzeiten) gespeichert werden. Ein zusätzliches Flag (Element nachVereinbarung) kann anzeigen, dass Termine auch nach Vereinbarung angeboten werden.

Page 22: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  22 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetBehoerdenGebaeudeResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v1/behoerden"> <BehoerdenGebaeude behoerdeId="2534" gebaeudeId="2534"> <bezeichnung>Rathaus Bad Kissingen</bezeichnung> <hausanschriftPLZ>97688</hausanschriftPLZ> <hausanschriftOrt>Bad Kissingen</hausanschriftOrt> <hausanschriftStrasse>Rathausplatz 1</hausanschriftStrasse> <postanschriftPLZ>97672</postanschriftPLZ> <postanschriftOrt>Bad Kissingen</postanschriftOrt> <postanschriftStrasse>Postfach 2260</postanschriftStrasse> <logo mimetype="image/jpeg" title="Rathaus"> /9j/4AAQS ... //9k= </logo> <sortierreihenfolge>100</sortierreihenfolge> <telefonLandvorwahl>49</telefonLandvorwahl> <telefonOrtsvorwahl>0971</telefonOrtsvorwahl> <telefonAnlage>807</telefonAnlage> <telefonDurchwahl>0</telefonDurchwahl> <faxLandvorwahl>49</faxLandvorwahl> <faxOrtsvorwahl>0971</faxOrtsvorwahl> <faxAnlage>807</faxAnlage> <faxDurchwahl>4444</faxDurchwahl> <oeffnungszeiten> <nachVereinbarung>true</nachVereinbarung> <sonderzeiten>Sie können mit uns auch am Samstag einen Termin vereinbaren.</sonderzeiten> <oeffnungszeit> <zeitangabe> <typ>MO</typ> <vonVormittags>08:00</vonVormittags> <bisVormittags>12:00</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>16:00</bisNachmittags> </zeitangabe> </oeffnungszeit> <oeffnungszeit> <zeitangabe> <typ>DI</typ> <vonVormittags>08:00</vonVormittags> <bisVormittags>12:00</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>16:00</bisNachmittags> </zeitangabe> </oeffnungszeit> <oeffnungszeit> <zeitangabe> <typ>MI</typ> <vonVormittags>08:00</vonVormittags> <bisVormittags>12:00</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>16:00</bisNachmittags> </zeitangabe>

Page 23: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  23 von 187

</oeffnungszeit> <oeffnungszeit> <zeitangabe> <typ>DO</typ> <vonVormittags>08:00</vonVormittags> <bisVormittags>12:00</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>16:00</bisNachmittags> </zeitangabe> </oeffnungszeit> <oeffnungszeit> <zeitangabe> <typ>FR</typ> <vonVormittags>08:00</vonVormittags> <bisVormittags>12:30</bisVormittags> </zeitangabe> </oeffnungszeit> </oeffnungszeiten> <behoerdenAnsprechpartnerZuordnungen> <ansprechpartner id="37535"/> </behoerdenAnsprechpartnerZuordnungen> </BehoerdenGebaeude> </ns3:GetBehoerdenGebaeudeResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Daten eines Behördenansprechpartners

Eine Anfrage über diesen Endpunkt sieht folgendermaßen aus (Soap-Header fehlt):

Mögliche Fehler

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en"> Invalid parameter. Gebäude mit der angegebenen Id nicht gefunden. </faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en"> Invalid parameter. Gebäude ist der Behörde mit der angegebenen Id nicht zugeordnet. </faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Page 24: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  24 von 187

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://lfstad.bayern.de/baybw/allgemein/v1/behoerden"> <soapenv:Header/> <soapenv:Body> <v1:GetBehoerdenAnsprechpartnerRequest> <behoerdeId>2534</behoerdeId> <gebaeudeId>2534</gebaeudeId> <ansprechpartnerId>37535</ansprechpartnerId> </v1:GetBehoerdenAnsprechpartnerRequest> </soapenv:Body></soapenv:Envelope>

Sie müssen drei verpflichtende Parameter (Elemente behoerdeId, gebaeudeId und ansprechpartnerId) angeben. Sie fordern demnach mit diesem Endpunkt die Daten eines Ansprechpartner im Kontext seiner Behörden- und Gebäudezuordnung an. Die persönlichen Daten eines Ansprechpartners sind natürlich bei jeder Gebäude- und Behördenzuordnung identisch. Das gilt aber nicht zwingend für die Sprechzeiten. Diese gelten nur im angegebenen Kontext.

Die Angabe zu Telefon und Fax werden bei Ansprechpartnern noch um das Elemente zum Mobiltelefon (mobilLandvorwahl, mobilLandvorwahl und mobilNummer) ergänzt.

Page 25: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  25 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetBehoerdenAnsprechpartnerResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v1/behoerden"> <ansprechpartner ansprechpartnerId="37535" behoerdeId="2534" gebaeudeId="2534"> <anrede/> <logo alt="Oberbürgermeister der Stadt Bad Kissingen seit 01.05.2008" mimetype="image/jpeg" title="Oberbürgermeister Hans Mustermann"> /9j/4AAQ ... //2Q== </logo> <vorname>Hans</vorname> <nachname>Mustermann</nachname> <funktion>Oberbürgermeister</funktion> <stellenbezeichnung></stellenbezeichnung> <email>[email protected]</email> <zimmer>14</zimmer> <sortierreihenfolge>97</sortierreihenfolge> <telefonLandvorwahl>49</telefonLandvorwahl> <telefonOrtsvorwahl>0971</telefonOrtsvorwahl> <telefonAnlage>807</telefonAnlage> <telefonDurchwahl>1000</telefonDurchwahl> <faxLandvorwahl>49</faxLandvorwahl> <faxOrtsvorwahl>0971</faxOrtsvorwahl> <faxAnlage>807</faxAnlage> <faxDurchwahl>2009</faxDurchwahl> <mobilLandvorwahl></mobilLandvorwahl> <mobilOrtsvorwahl></mobilOrtsvorwahl> <mobilNummer></mobilNummer> <sprechzeiten> <nachVereinbarung>true</nachVereinbarung> <sonderzeiten> Sie können mit mir auch telefonisch einen Termin vereinbaren. </sonderzeiten> <oeffnungszeit> <zeitangabe> <typ>DI</typ> <vonVormittags>08:00</vonVormittags> <bisVormittags>12:00</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>16:00</bisNachmittags> </zeitangabe> </oeffnungszeit> <oeffnungszeit> <zeitangabe> <typ>MI</typ> <vonVormittags>08:00</vonVormittags> <bisVormittags>12:00</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>16:00</bisNachmittags> </zeitangabe> </oeffnungszeit> <oeffnungszeit> <zeitangabe> <typ>DO</typ>

Page 26: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  26 von 187

<vonVormittags>08:00</vonVormittags> <bisVormittags>12:00</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>16:00</bisNachmittags> </zeitangabe> </oeffnungszeit> <oeffnungszeit> </sprechzeiten> </ansprechpartner> </ns3:GetBehoerdenAnsprechpartnerResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Liste der Ansprechpartner einer Behörde

Eine Anfrage über diesen Endpunkt sieht folgendermaßen aus (Soap-Header fehlt):

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://lfstad.bayern.de/baybw/allgemein/v1/behoerden"> <soapenv:Header/> <soapenv:Body> <v1:GetAlleAnsprechpartnerRequest> <behoerdeId>4442</behoerdeId> </v1:GetAlleAnsprechpartnerRequest> </soapenv:Body></soapenv:Envelope>

Mögliche Fehler

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en"> Invalid parameter. Ansprechpartner mit der angegebenen Id nicht gefunden. </faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en"> Invalid parameter. Ansprechpartner mit der angegebenen Id ist der Behörde oder dem Gebäude mit der angegebenen Id nicht zugeordnet. </faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Page 27: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  27 von 187

Als Parameter müssen Sie die Id einer Behörde (Dienststelle oder Organsationseinheit) angeben.

In der Antwort finden Sie eine Liste von ansprechpartner-Elementen. Es werden alle Ansprechpartner zurückgeliefert, die der Behörde oder ihren untergeordneten Organisationseinheiten zugeordnet sind. Für jeden Ansprechpartner werden die Ids der Behörde (behoerdeId) und des Gebäudes (gebaeudeId) mitgeliefert, so dass eine Verknüpfung mit der Behörde und dem Gebäude möglich ist.

Da jeder Ansprechpartner mehreren Behörden (Organisationseinheiten) und Gebäuden zugeordnet sein kann, ist es typisch, dass Ansprechpartner in der Antwort mehrfach geliefert werden.

Page 28: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  28 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetAlleAnsprechpartnerResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v1/behoerden"> <ansprechpartner ansprechpartnerId="64008"> <anrede>Frau</anrede> <vorname>Heidelore</vorname> <nachname>Adler</nachname> <stellenbezeichnung>Kasse</stellenbezeichnung> <email>[email protected]</email> <website>http://www.weiler-simmerberg.de</website> <zimmer>11</zimmer> <behoerdeId>4442</behoerdeId> <behoerdeBezeichnung>Markt Weiler-Simmerberg</behoerdeBezeichnung> <gebaeudeId>4442</gebaeudeId> <gebaeudeBezeichnung>Gemeindeverwaltung</gebaeudeBezeichnung> </ansprechpartner> <ansprechpartner ansprechpartnerId="64008"> <anrede>Frau</anrede> <vorname>Heidelore</vorname> <nachname>Adler</nachname> <stellenbezeichnung>Kasse</stellenbezeichnung> <email>[email protected]</email> <website>http://www.weiler-simmerberg.de</website> <zimmer>11</zimmer> <behoerdeId>66452</behoerdeId> <behoerdeBezeichnung>Finanzverwaltung</behoerdeBezeichnung> <gebaeudeId>4442</gebaeudeId> <gebaeudeBezeichnung>Gemeindeverwaltung</gebaeudeBezeichnung> </ansprechpartner> <ansprechpartner ansprechpartnerId="64009"> <anrede>Herr</anrede> <vorname>Christoph</vorname> <nachname>Berger</nachname> <stellenbezeichnung>Rentenamt</stellenbezeichnung> <email>[email protected]</email> <website>http://www.weiler-simmerberg.de</website> <zimmer>11</zimmer> <behoerdeId>66453</behoerdeId> <behoerdeBezeichnung>Kasse</behoerdeBezeichnung> <gebaeudeId>4442</gebaeudeId> <gebaeudeBezeichnung>Gemeindeverwaltung</gebaeudeBezeichnung> </ansprechpartner> <ansprechpartner ansprechpartnerId="64009"> <anrede>Herr</anrede> <vorname>Christoph</vorname> <nachname>Berger/nachname> <stellenbezeichnung>Rentenamt</stellenbezeichnung> <email>[email protected]</email> <website>http://www.weiler-simmerberg.de</website> <zimmer>11</zimmer> <behoerdeId>66452</behoerdeId> <behoerdeBezeichnung>Finanzverwaltung</behoerdeBezeichnung> <gebaeudeId>4442</gebaeudeId>

Page 29: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  29 von 187

<gebaeudeBezeichnung>Gemeindeverwaltung</gebaeudeBezeichnung> </ansprechpartner> </ns3:GetAlleAnsprechpartnerResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Die Elemente und Attribute haben folgende Bedeutung:

Element Attribut Beschreibung

ansprechpartner Container für die Daten eines Ansprechpartners

anrede Anrede des Ansprechpartners (Herr, Frau oder leer)

vorname Vorname des Ansprechpartners

nachname Nachname des Ansprechpartners

stellenbezeichnung Bezeichnung der Stelle des Ansprechpartners (z.B. Leitung Bauverwaltung, Öffentlichkeitsarbeit)

email E-Mail-Adresse des Ansprechpartners

website Web-Adresse des Ansprechpartners oder der Dienststelle

zimmer Zimmernummer des Ansprechpartners

behoerdeId Id der Behörde/Organisationseinheit des Ansprechpartners

behoerdeBezeichnung Bezeichnung der Behörde / Organisationseinheit des Ansprechpartners

gebaeudeId Id des Gebäudes des Ansprechpartners

gebaeudeBezeichnung Bezeichnung des Gebäudes des Ansprechpartners

Liste der Leistungen einer Behörde

Eine Anfrage über diesen Endpunkt sieht folgendermaßen aus (Soap-Header fehlt):

Page 30: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  30 von 187

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://lfstad.bayern.de/baybw/allgemein/v1/behoerden"> <soapenv:Header/> <soapenv:Body> <v1:GetBehoerdenLeistungenRequest> <behoerdeId>4442</behoerdeId> <nurDirekteLeistungszuordnungen>true</nurDirekteLeistungszuordnungen>  </v1:GetBehoerdenLeistungenRequest> </soapenv:Body></soapenv:Envelope>

Als Parameter müssen Sie die Id einer Behörde (Dienststelle oder Organsationseinheit) angeben. Darüberhinaus können Sie als zweiten Parameter das Element nurDirekteLeistungszuordnungen angeben. Hier wird ein boolscher Wert erwartet ( true oder false). Wenn Sie true angeben, werden nur Leistungen geliefert, die der Behörde (Dienststelle oder Organsationseinheit)  direkt zugeordnet sind. Bei false oder wenn Sie das Element weglassen, werden darüber hinaus auch Leistungen von nachgeordneten Organisationseinheiten berücksichtigt.

In der Antwort finden Sie eine Liste von leistung-Elementen.

Das Attribut id können Sie als Referenz-Id auf die Leistung verwenden. Geben Sie es als Parameter an, wenn Sie die Leistungsbeschreibung über den Endpunkt Abrufen einer kompletten Leistungsbeschreibung (mit regionalen Ergänzungen und Zuständigkeiten)abrufen möchten.

Für jede Leistung wird neben der Id das Element bezeichnung geliefert, das in einer Leistungsübersicht zur Behörde als Verlinkungstext benutzt werden kann.

Page 31: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  31 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetBehoerdenLeistungenResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v1/behoerden"> <leistung id="3581"> <bezeichnung>Abfallwirtschaft in Gemeinden</bezeichnung> </leistung> <leistung id="1845"> <bezeichnung>Abmarkung gemeindlicher Grundstücke</bezeichnung> </leistung> <leistung id="2861"> <bezeichnung>Absonderungsmaßnahmen bei übertragbaren Krankheiten</bezeichnung> </leistung> <leistung id="592"> <bezeichnung>Abwasserentsorgung</bezeichnung> </leistung> <leistung id="25417"> <bezeichnung>Abwasserentsorgung; Grundstücksanschluss Kanal</bezeichnung> </leistung> <leistung id="24737"> <bezeichnung>Abwassergebühren</bezeichnung> </leistung> <leistung id="25551"> <bezeichnung>Amtsblatt der Gemeinde</bezeichnung> </leistung> <leistung id="562"> <bezeichnung>Anmeldung der Eheschließung</bezeichnung> </leistung> <leistung id="25484"> ... </leistung> </ns3:GetBehoerdenLeistungenResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Liste der Leistungen eines Ansprechpartners

Für eine Anfrage über diesen Endpunkt gibt es folgende Varianten (Soap-Header fehlt):

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://lfstad.bayern.de/baybw/allgemein/v1/behoerden"> <soapenv:Header/> <soapenv:Body> <v1:GetAnsprechpartnerLeistungenRequest> <ansprechpartnerId>64008</ansprechpartnerId> </v1:GetAnsprechpartnerLeistungenRequest> </soapenv:Body></soapenv:Envelope>

Page 32: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  32 von 187

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:v1="http://lfstad.bayern.de/baybw/allgemein/v1/behoerden"> <soapenv:Header/> <soapenv:Body> <v1:GetAnsprechpartnerLeistungenRequest> <ansprechpartnerId>64008</ansprechpartnerId> <nurDirekteLeistungszuordnungen>true</nurDirekteLeistungszuordnungen> </v1:GetAnsprechpartnerLeistungenRequest> </soapenv:Body></soapenv:Envelope>

Als Parameter müssen Sie in beiden Varianten die Id des Ansprechpartners angeben. Wenn Sie keine weiteren Parameter angegeben, erhalten Sie alle Leistungen zurück, die dem Ansprechpartner direkt oder indirekt zugeordnet sind (Standardverhalten dieses Endpunkts).

Wenn Sie nur die Leistungen haben möchten, die dem Ansprechpartner direkt zugeordnet sind, dann geben Sie bitte das zusätzliche Element nurDirekteLeistungszuordnungen mit dem Inhalt true an. Wenn Sie dieses Element mit dem Inhalt false belegen, dann können Sie es auch weglassen.

In der Antwort finden Sie eine Liste von leistung-Elementen.

Das Attribut id können Sie als Referenz auf die Leistung verwenden. Geben Sie es als Parameter an, wenn Sie die Leistungsbeschreibung über den Endpunkt Abrufen einer kompletten Leistungsbeschreibung (mit regionalen Ergänzungen und Zuständigkeiten) abrufen möchten.

Für jede Leistung wird neben der Id das Element bezeichnung geliefert, das in einer Leistungsübersicht zum Ansprechpartner als Verlinkungstext benutzt werden kann.

Was sind direkte und indirekte Aufgabenzuordnungen/Leistungszuordnungen?Im Redaktionssystem für Verwaltungsinformationen können Sie die Geschäftsverteilung in einer Dienststelle dadurch abbilden, dass Sie

• Aufgaben (Leistungen) den verscheidenen Organisationseinheiten zuordnen• Aufgaben (Leistungen) zusätzlich einzelnen Ansprechpartnern zuordnen

Wenn Sie die Aufgaben (Leistungen) ausschließlich Organisationseinheiten zuordnen, dann "erben" die Anprechpartner dieser Organisationseinheiten diese Aufgabenzuordnungen. D.h. alle Ansprechpartner in einer Organisationseinheit sind für alle Aufgaben dieser Organisationseinheit zuständig. Diese Aufgabenzuordnung bezeichnen wir hier als indirekt. Sie können sich dadurch viel redaktionelle Arbeit ersparen, aber die Aufgabenzuordnung ist eventuell nicht ganz so präzise abgebildet wie bei der direkten Aufgabenzuordnung an Ansprechpartner. Sobald Sie Aufgaben (Leistungen) explizit einzelnen Ansprechpartnern zuordnen, ist diese Zuordnung vorrangig. Wir bezeichnen sie hier als direkt. Wenn es Ansprechpartner gibt, denen eine Aufgabe (Leistung) direkt zugeordnet ist, dann gelten die anderen Ansprechpartner nicht mehr als zuständig, es sei denn, auch ihnen ist die Aufgabe direkt zugeordnet.Im Ergebnis setzen sich also direkte Aufgabenzuordnungen gegen indirekte Aufgabenzuordnungen immer durch.

Page 33: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  33 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetAnsprechpartnerLeistungenResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v1/behoerden"> <leistung id="3554"> <bezeichnung>Kleineinleiterabgabe</bezeichnung> </leistung> <leistung id="27260"> <bezeichnung>Meldepflicht für Binnenschiffer und Seeleute</bezeichnung> </leistung> <leistung id="3522"> <bezeichnung>Messen</bezeichnung> </leistung> <leistung id="2827"> <bezeichnung>Miet- und Pachteinnahmen (Gemeinde)</bezeichnung> </leistung> <leistung id="3579"> <bezeichnung>öffentlicher Personennahverkehr; Tarifgestaltung, Haltestellenplanung</bezeichnung> </leistung> <leistung id="3578"> <bezeichnung>öffentlicher Personennahverkehr; Zuschüsse</bezeichnung> </leistung> <leistung id="1814"> <bezeichnung>Parkgebühren, Verordnung über</bezeichnung> </leistung> <leistung id="3566"> <bezeichnung>Schlachthof; Benutzungsbedingungen</bezeichnung> </leistung> <leistung id="3567"> <bezeichnung>Schlachthof; Benutzungsgebühren</bezeichnung> </leistung> <leistung id="3460"> <bezeichnung>Statistik (Gemeinde)</bezeichnung> </leistung> <leistung id="2842"> <bezeichnung>Zahlungsverkehr (Mahnung und Vollstreckung) - Gemeinde</bezeichnung> </leistung> </ns3:GetAnsprechpartnerLeistungenResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Lebenslagen (Version 1)Dieser Web Service erfordert eine Authentifizierung durch den Client (Portal oder CMS-Provider).

Die Schnittstellenbeschreibung finden Sie in folgender Web-Services-Description- Language-Datei (WSDL):

BenutzerkennungSie benötigen eine Kennung, der ein Profil mit der Rolle "Webservices Lebenslagen" zugeordnet ist. Der Einstiegsknoten des Profils wird bei Anfragen nicht ausgewertet, sollte aber im Hinblick auf zukünftige Differenzierungen sinnvoll gewählt werden.Unter der Web-Adresse https://www.bayvis-redaktionssystem.bayern.de finden Sie die Kontaktdaten zum Beantragen einer Kennung.

Page 34: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  34 von 187

https://www.baybw-services.bayern.de/services/allgemein/allgemein-lebenslagen.v1.wsdl

Der Web Service bietet folgenden Schnittstellen-Endpunkt an:

Abrufen aller Lebenslagen

Über diesen Schnittstellen-Endpunkt können alle Lebenslagen abgefragt werden. Die Lebenslagen werden unabhängig davon geliefert, ob die konkrete Lebenslage im BayernPortal als sichtbar gekennzeichnet ist oder nicht. Es spielt auch keine Rolle, ob der Lebenslage Leistungen zugeordnet sind. (Das BayernPortal selbst zeigt Lebenslagen nicht an, wenn sie als unsichtbar gekennzeichnet sind oder ihnen keine Leistungen zugeordnet sind.)Die Lebenslagen sind nach ihrer Id sortiert. Die Id ist ein 8-stelliger Schlüssel, der die Systematik des Lebenslagenkatalogs des Bundes widerspiegelt, den das BayernPortal übernommen hat.

Der Katalog unterscheidet drei Gruppen von Lebenslagen:

• Bürger• Unternehmer• Verwaltung

Die Lebenslagen sind in Oberkategorien und Unterkategorien untergliedert.

Id Oberkategorie Unterkategorie

10000100 Geburt

10000101 Allgemeines

10000102 Vor der Geburt

10000103 Nach der Geburt

10000104 Feststellung der Vaterschaft

10000105 ...

10000200 Kinderbetreuung

10000200 Allgemeines

... ...

Hier ist die Anfrage dargestellt:

Request

<soapenv:Envelope xmlns:leb="http://lfstad.bayern.de/baybw/allgemein/v1/lebenslagen" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"> <soapenv:Body> <leb:GetAlleLebenslagenRequest/> </soapenv:Body></soapenv:Envelope>

Die Antwort enthält im Element lebenslagen 0 bis n Elemente lebenslage.

Page 35: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  35 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:GetAlleLebenslagenResponse xmlns:ns2="http://lfstad.bayern.de/baybw/allgemein/v1/lebenslagen"> <lebenslagen> <lebenslage id="10000102"> <bezeichnung>Vor der Geburt</bezeichnung> <kurzbeschreibung>Alles Amtliche rund um die Geburt eines Kindes</kurzbeschreibung> <langbeschreibung>Oft wird leicht dahingesagt ...</langbeschreibung> <kategorie>buerger</kategorie> <vorgaengerId>10000100</vorgaengerId> <metaTag>ByLl_Geburt_VorGeburt</metaTag> <stand>2007-10-08T16:04:01+02:00</stand> <synonyme> <synonym>Geburtsvorbereitung</synonym> ... </synonyme> <leistungen> <leistung id="2988"> <bezeichnung>Mutterschutz</bezeichnung> </leistung> ... </lebenslage> ... </lebenslagen> </ns2:GetAlleLebenslagenResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Die Elemente und Attribute in der Antwort haben folgende Bedeutung:

Element Attribut Beschreibung

lebenslagen Container für die Lebenslagen

lebenslage Daten zu einer Lebenslage

lebenslage id Id der Lebenslage

bezeichnung Bezeichnung der Lebenslage

kurzbeschreibung Kurzbeschreibung der Lebenslage (sollte im Datenbestand keine vorhanden sein wird ein leeres Element geliefert)

langbeschreibung Optionale Langbeschreibung der Lebenslage

Page 36: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  36 von 187

Element Attribut Beschreibung

kategorie Kategorie der Lebenslage (buerger, unternehmer oder verwaltung)

vorgaengerId Id der übergeordneten Lebenslage

metaTag Codierung der Lebenslagenbezeichnung zur Benutzung in meta-Tags für die COGISUM-Suchmaschine

<meta name="ByLebenslagen" content="ByLl_Geburt_VorGeburt"/>

stand Datum bzw. Zeitpunkt, zu dem die Lebenslage zuletzt überarbeitet wurde

synonyme Container für die Synonyme zur Lebenslage

synonym Synonym zur Lebenslage

leistungen Container für die Leistungen, die der Lebenslage zugeordnet sind

leistung zugeordnete Leistung

leistung id Id der zugeordneten Leistung

bezeichnung Bezeichnung der zugeordneten Leistung

Sie benötigen eine Kennung, der ein Profil mit der Rolle "Webservices Behörden" zugeordnet ist. Der Einstiegsknoten des Profils wird bei Anfragen ausgewertet und sollte eine bestimmte Dienststelle oder sonstige Behörde sein. Der Webservice liefert nur Daten zu dieser Dienststelle oder sonstigen Behörde und ihrem organisatorischen Unterbau.

Wenn Ihrer Kennung mehrere Profile mit dieser Rolle, aber mit unterschiedlichen Einstiegsknoten zugeordnet sind, können Sie mit der Kennung auch auf die Daten von mehr als einer Dienststelle oder sonstigen Behörde zugreifen.Unter der Web-Adresse https://www.bayvis-redaktionssystem.bayern.de finden Sie die Kontaktdaten zum Beantragen einer Kennung.

Leistungen (Version 1)

Dieser Web Service erfordert eine Authentifizierung durch den Client (Portal oder CMS-Provider).

Die Schnittstellenbeschreibung finden Sie in folgender Web-Services-Description- Language-Datei (WSDL):

Neue Version verfügbarBitte beachten Sie, die Webservices zum Thema Leistungen liegen bereits in Version 2 vor.

BenutzerkennungSie benötigen eine Kennung, der ein Profil mit der Rolle "Webservices Leistungen" zugeordnet ist. Der Einstiegsknoten des Profils wird bei Anfragen nicht ausgewertet, sollte aber im Hinblick auf zukünftige Differenzierungen sinnvoll gewählt werden.Unter der Web-Adresse https://www.bayvis-redaktionssystem.bayern.de finden Sie die Kontaktdaten zum Beantragen einer Kennung.

Page 37: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  37 von 187

https://www.baybw-services.bayern.de/services/allgemein/allgemein-leistungen.v1.wsdl

Der Web Service bietet folgende Schnittstellen-Endpunkte an:

• Abrufen aller Leistungen• Abrufen der Leistungen, die einer Dienststelle zugeordnet sind• Abrufen aller Leistungsbeschreibungen• Abrufen der Leistungsbeschreibungen, die einer Dienststelle zugeordnet sind• Abrufen einer kompletten Leistungsbeschreibung (mit regionalen Ergänzungen und Zuständigkeiten)

Abrufen aller Leistungen

Über diesen Schnittstellen-Endpunkt können alle Leistungen abgefragt werden. Die Leistungen werden unabhängig davon geliefert, ob das Gültigkeitsdatum der dazugehörigen Leistungsbeschreibung bereits überschritten ist, bzw. ob die Leistungsbeschreibung gerade in Überarbeitung sind.

Wenn bei der Anfrage im Element gemeindekennziffer eine gültige 8-stellige (bayerische) Gemeindekennziffer angegeben wird, dann sind in der Antwort die URLs der Leistungen lokalisiert (also passend für die Gemeinde mit der angegebenen Gemeindekennziffer).

Die in der folgenden Anfrage angegebene Gemeindekennziffer 09162000 bewirkt, dass die URLs für die Landeshauptstadt München lokalisiert werden. In der Antwort erkennen Sie die Wirkung daran, dass die URLs für die Leistung drei HTTP-Parameter haben:

Eine lokalisierte URL sieht so aus:

lokalisierte URL

<url>http://www.behoerdenwegweiser.bayern.de/dokumente/aufgabenbeschreibung/26999461116?plz=80331&amp;behoerde=88887100385&amp;gemeinde=666856454699</url>

Eine nicht lokalisierte URL sieht so aus:

nicht lokalisierte URL

<url>http://www.behoerdenwegweiser.bayern.de/dokumente/aufgabenbeschreibung/26999461116</url>

Hier finden Sie das Beispiel für die Anfrage:

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:leis="http://lfstad.bayern.de/baybw/allgemein/v1/leistungen"> <soapenv:Header/> <soapenv:Body> <leis:GetAlleLeistungenRequest> <gemeindekennziffer>09162000</gemeindekennziffer> </leis:GetAlleLeistungenRequest> </soapenv:Body></soapenv:Envelope>

Die Antwort enthält im Element leistungen 0 bis n Elemente leistung.

Page 38: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  38 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetAlleLeistungenResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v1/leistungen"> <leistungen> <leistung id="3627" letzteAenderung="2010-12-15T13:57:04+01:00"> <bezeichnung leittext="bezeichnung" position="1" sichtbar="true">Abendgymnasium</bezeichnung> <url>http://www.behoerdenwegweiser.bayern.de/dokumente/aufgabenbeschreibung/47552656625 ?plz=80331&amp;behoerde=88887100385&amp;gemeinde=666856454699</url> <synonyme/> <lebenslagen> <lebenslage id="10000505"> <bezeichnung>Akademische Berufsausbildung</bezeichnung> <metaTag>ByLl_Berufsausbildung_AkademischeBerufsausbildung</metaTag> </lebenslage> ... </lebenslagen> </leistung> <leistung id="3694" letzteAenderung="2010-08-02T17:32:54+02:00"> <bezeichnung leittext="bezeichnung" position="1" sichtbar="true">Abfallberatung</bezeichnung> <url>http://www.behoerdenwegweiser.bayern.de/dokumente/aufgabenbeschreibung/71663715636 ?plz=80331&amp;behoerde=88887100385&amp;gemeinde=666856454699</url> <synonyme> <synonym>Müllabfuhr</synonym> ... </synonyme> <lebenslagen> <lebenslage id="10001102"> <bezeichnung>Neu in der Stadt</bezeichnung> <metaTag>ByLl_Wohnen_NeuStadt</metaTag> </lebenslage> <lebenslage id="20002105"> <bezeichnung>Umweltschutz</bezeichnung> <metaTag>ByGl_Gewerbeaufsicht_Umweltschutz</metaTag> </lebenslage> ... </lebenslagen> </leistung> ... </leistungen> </ns3:GetAlleLeistungenResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Die Elemente und Attribute in der Antwort haben folgende Bedeutung:

Element Attribut Beschreibung

leistungen Container für die Leistungen

Page 39: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  39 von 187

Element Attribut Beschreibung

leistung Daten zu einer Leistung

leistung id Id der Leistung

leistung letzteAenderung Zeitstempel der letzten Änderung bei dieser Leistung

bezeichnung Bezeichnung der Leistung

synonyme Container für die Synonyme zu einer Leistung

synonym Synonym einer Leistung

lebenslagen Container für die Lebenslagen, denen eine Leistung zugeordnet ist

lebenslage Lebenslage, der die Leistung zugeordnet ist

lebenslage id Id der Lebenslage, der die Leistung zugeordnet ist

bezeichnung Bezeichnung der Lebenslage

metaTag Codierung der Lebenslagenbezeichnung zur Benutzung in meta-Tags für die COGISUM-Suchmaschine

<meta name="ByLebenslagen" content="ByLl_Bauen_Bauplanung,ByGl_ImmobilienVerkehr_Bauplanung"/>

Abrufen der Leistungen, die einer Dienststelle zugeordnet sind

Über diesen Schnittstellen-Endpunkt können nur die Leistungen abgefragt werden, die einer bestimmten Dienststelle zugeordnet sind. Dafür muss in der Anfrage das Element dienststellenschluessel die 7-stellige Dienststellennummer der gewünschten Dienststelle enthalten.

Mögliche Fehler• Wenn die Gemeindekennziffer zu keiner Gemeinde passt, werden die URLs für die Leistungen

ohne Lokalisierungsparameter zurückgeliefert.• Wenn Sie die Gemeindekennziffer nicht numerisch und 8-stellig angeben, erhalten Sie folgenden

SOAP-Fault:

<SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en">Invalid parameter 'gemeindekennziffer'. Must be numeric with 8 digits. </faultstring></SOAP-ENV:Fault>

Page 40: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  40 von 187

Das Element gemeindekennziffer hat für die Anfrage die gleiche Bedeutung wie beim Schnittstellen-Endpunkt Abrufen aller Leistungen.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:leis="http://lfstad.bayern.de/baybw/allgemein/v1/leistungen"> <soapenv:Header/> <soapenv:Body> <leis:GetLeistungenVonDienststelleRequest> <dienststellenschluessel>6721140</dienststellenschluessel> <gemeindekennziffer>09672114</gemeindekennziffer> </leis:GetLeistungenVonDienststelleRequest> </soapenv:Body></soapenv:Envelope>

Die Anwort ist vom Datenmodell her mit der Antwort beim Schnittstellen-Endpunkt Abrufen aller Leistungen identisch. Sie enthält jedoch nicht alle Leistungen, sondern nur die der angegebenen Dienststelle.

Response

SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetLeistungenVonDienststelleResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v1/leistungen"> <leistungen> ... </leistungen> </ns3:GetLeistungenVonDienststelleResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Abrufen aller Leistungsbeschreibungen

Über diesen Schnittstellen-Endpunkt können alle Leistungsbeschreibungen (Leistungen einschließlich ihrer vollständigen Beschreibung) abgefragt werden. Das Inhaltsmodell der Antwort ergänzt nur das Inhaltsmodell des Schnittstellen-Endpunkts Abrufen aller Leistungen um weitere Elemente.

Eine Anfrage mit Lokalisierung auf die Landeshauptstadt München (Gemeindekennziffer 09162000) sieht folgendermaßen aus:

Mögliche Fehler• Wenn Sie keinen oder einen nicht existierenden Dienststellenschlüssel angeben, liefert der Web

Service die Antwort mit einem leeren Element leistungen zurück.• Wenn Sie den Dienststellenschlüssel nicht numerisch oder mit mehr als 7 Ziffern angeben,

erhalten Sie folgenden SOAP-Fault:

<SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en">Invalid parameter 'dienststellenschluessel'. Must be numeric containing a maximum of 7 digits. </faultstring></SOAP-ENV:Fault>

Page 41: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  41 von 187

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:leis="http://lfstad.bayern.de/baybw/allgemein/v1/leistungen"> <soapenv:Header/> <soapenv:Body> <leis:GetAlleLeistungsbeschreibungenRequest> <gemeindekennziffer>09162000</gemeindekennziffer> </leis:GetAlleLeistungsbeschreibungenRequest> </soapenv:Body></soapenv:Envelope>

Hier finden Sie die dazugehörige Antwort. Die Teile der Anwort, die bereits beim Schnittstellen-Endpunkt Abrufen aller Leistungen gezeigt wurden, werden hier nicht mehr dargestellt:

Page 42: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  42 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetAlleLeistungsbeschreibungenResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v1/leistungen"> <leistungsbeschreibungen> <leistungsbeschreibung id="3627" letzteAenderung="2010-07-12T11:42:48+02:00"> <bezeichnung leittext="bezeichnung" position="1" sichtbar="true"> Abendgymnasium </bezeichnung> <url>http://www.behoerdenwegweiser.bayern.de/dokumente/aufgabenbeschreibung/47552656625 ?plz=80331&amp;behoerde=88887100385&amp;gemeinde=666856454699</url> <!-- ... Inhalt wie beim Endpunkt GetAlleLeistungen ... --> <status leittext="Status" position="16" sichtbar="false">live</status> <gueltigBis leittext="Gültig bis" position="17" sichtbar="false"> 2010-12-31+01:00 </gueltigBis> <kurzbeschreibung leittext="Kurzbeschreibung" position="2" sichtbar="true"> ... </kurzbeschreibung> <langbeschreibung leittext="Beschreibung" position="3" sichtbar="true"> ... </langbeschreibung> <voraussetzungen leittext="Voraussetzungen" position="4" sichtbar="true"> ... </voraussetzungen> <fristen leittext="Fristen" position="5" sichtbar="true"> ... </fristen> <unterlagen leittext="Erforderliche Unterlagen" position="6" sichtbar="true"> <unterlage> <kurzbeschreibung>...</kurzbeschreibung> <langbeschreibung>...</langbeschreibung> <leistungId>...</leistungId> <leistungUrl>...</leistungUrl> </unterlage> ... </unterlagen> <kosten leittext="Kosten" position="7" sichtbar="true"> ... </kosten> <formulare leittext="Formulare" position="8" sichtbar="true"> <formular> <kurzbeschreibung>...</kurzbeschreibung> <langbeschreibung>...</langbeschreibung> <url>...</url> </formular> ... </formulare> <onlineVerfahren leittext="Online Verfahren" position="9" sichtbar="true"> <onlineVerfahren>

Page 43: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  43 von 187

<kurzbeschreibung>...</kurzbeschreibung> <langbeschreibung>...</langbeschreibung> <url>...</url> </onlineVerfahren> ... </onlineVerfahren>

Response - Fortsetzung

<rechtsvorschriften leittext="Rechtsgrundlagen" position="10" sichtbar="true"> <rechtsvorschrift> <kurzbeschreibung>...</kurzbeschreibung> <langbeschreibung>...</langbeschreibung> <url>...</url> </rechtsvorschrift> ... </rechtsvorschriften> <rechtsbehelf leittext="Rechtsbehelf" position="11" sichtbar="true"> <kurzbeschreibung>...</kurzbeschreibung> <leistungId>...</leistungId> <leistungBezeichnung>...</leistungBezeichnung> <leistungUrl>...</leistungUrl> </rechtsbehelf> <links leittext="Weiterführende Links" position="12" sichtbar="true"> <link> <kurzbeschreibung>...</kurzbeschreibung> <langbeschreibung>...</langbeschreibung> <url>...</url> </link> ... </links> <verwandteLeistungen leittext="Verwandte Themen" position="13" sichtbar="true"> <verwandteLeistung> <id>...</id> <bezeichnung>...</bezeichnung> <url>...</url> <direktVerwandt>...</direktVerwandt> </verwandteLeistung> ... </verwandteLeistungen> <stand leittext="Stand" position="14" sichtbar="true"> 2010-07-12T11:42:48+02:00 </stand> <verantwortlicheBehoerde leittext="Redaktionell verantwortlich" position="15" sichtbar="true"> ... </verantwortlicheBehoerde> </leistungsbeschreibung> ... </leistungsbeschreibungen> </ns3:GetAlleLeistungsbeschreibungenResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

In den folgenden Tabelle werden alle im Vergleich zum Endpunkt Abrufen aller Leistungen neuen Elemente einer Leistungsbeschreibung aufgeführt:

Page 44: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  44 von 187

Element Beschreibung

leistungsbeschreibungen Container für die Leistungsbeschreibungen

leistungsbeschreibung Daten zu einer Leistungsbeschreibung

bezeichnung Bezeichnung der Leistung im BayernPortal (als Titel verwendbar)

status live: die Leistungsbeschreibung ist online working: die Leistungsbeschreibung wird gerade überarbeitet

gueltigBis Datum, bis zu dem die Leistungsbeschreibung gültig ist

kurzbeschreibung Kurzbeschreibung (einführender Text); HTML-Markup zulässig

langbeschreibung Langbeschreibung mit dem Kerninhalt; HTML-Markup zulässig

voraussetzungen Erläuterung der Voraussetzungen; HTML-Markup zulässig

fristen Erläuterung der Fristen; HTML-Markup zulässig

unterlagen Container für die Unterlagen, die der Leistungsbeschreibung zugeordnet sind

kosten Erläuterung der Kosten; HTML-Markup zulässig

formulare Container für die Formulare, die der Leistungsbeschreibung zugeordnet sind

onlineVerfahren Container für die Online Verfahren, die der Leistungsbeschreibung zugeordnet sind

rechtsvorschriften Container für die Rechtsvorschriften, die der Leistungsbeschreibung zugeordnet sind

rechtsbehelf Ein Rechtsbehelf, der der Leistungsbeschreibung zugeordnet sein kann

links Container für die externen Links, die der Leistungsbeschreibung zugeordnet sind

verwandteLeistungen Container für die verwandten Leistungen im BayernPortal

stand Datum bzw. Zeitpunkt, zu dem die Leistungsbeschreibung zuletzt überarbeitet wurde (mit dem eher technischen Attribut "letzteAenderung" inhaltlich identisch)

Page 45: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  45 von 187

Element Beschreibung

verantwortlicheBehoerde Behörde, die für die Leistungsbeschreibung redaktionell verantwortlich ist (i.d.R. ein Ministerium)

unterlagen

Container für 0 bis n unterlage-Elemente zu einer Leistungsbeschreibung

Attribut Beschreibung

kurzbeschreibung Kurzbeschreibung der Unterlage (als Titel verwendbar)

langbeschreibung Langbeschreibung mit dem Kerninhalt; HTML-Markup zulässig (optional)

leistungId Id einer Leistung, mit der man die Unterlage (z.B. ein Dokument oder eine behördliche Bescheinigung) erlangt. Beispiele: Personalausweis / vorläufiger Personalausweis oder Freizügigkeitsbescheinigung (optional)

leistungUrl URL dieser Leistung. Die URL wird mit Lokalisierungsparametern geliefert, soweit bei der Anfrage das Element gemeindekennziffer angegeben wurde und gültig ist. (optional)

formulare, onlineVerfahren, rechtsvorschriften, links

Container für 0 bis n formular-, onlineVerfahren-, rechtsvorschrift- und link-Elementen zu einer Leistungsbeschreibung

Attribut Beschreibung

kurzbeschreibung Kurzbeschreibung des Elements (als Titel verwendbar)

langbeschreibung Langbeschreibung mit dem Kerninhalt; HTML-Markup zulässig

url Url zum jeweiligen Element

rechtsbehelf

Ein optionales rechtsbehelf-Element zu einer Leistungsbeschreibung. Der Rechtsbehelf kann entweder nur eine Kurzbeschreibung, nur eine Referenz auf eine Leistung im BayernPortal oder beides enthalten.

Attribut Beschreibung

kurzbeschreibung Kurzbeschreibung des Rechtsbehelfs; HTML-Markup zulässig; nicht als Titel verwendbar)

leistungId Id einer Leistung, die den Rechtsbehelf beschreibt (z.B. Widerspruchsverfahren)

leistungBezeichnung Bezeichnung dieser Leistung (als Titel verwendbar)

Page 46: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  46 von 187

Attribut Beschreibung

leistungUrl URL dieser Leistung. Die URL wird mit Lokalisierungsparametern geliefert, soweit bei der Anfrage das Element gemeindekennzifferangegeben wurde und gültig ist.)

verwandteLeistungen

Container für 0 bis n verwandteLeistung-Elemente zu einer Leistungsbeschreibung

Attribut Beschreibung

id Id der Leistung im BayernPortal

bezeichnung Bezeichnung der Leistung im BayernPortal (als Titel verwendbar)

url URL der Leistung im BayernPortal, die mit dieser Leistungsbeschreibung verwandt ist. Die URL wird mit Lokalisierungsparametern geliefert, soweit bei der Anfrage das Element gemeindekennziffer angegeben wurde und gültig ist.)

direktVerwandt true: Leistung ist direkt verwandt und wird auch im BayernPortal als verwandte Leistung angezeigt. false: Leistung ist entfernt verwandt, und wird eventuell lediglich in der Langbeschreibung verlinkt.

Mit Hilfe dieser Elemente können Links zu verwandten Leistungen erzeugt werden. Entweder in die eigene Webseite vom Element id ausgehend oder in den BayernPortal (Element url).Es müssen nur solche verwandten Leistungen als Links angezeigt werden, für die das Attribut direktVerwandt den Wert true hat. Die anderen werden zu einem weiteren Zweck mitgeliefert.Der Container verwandteLeistungen kann nämlich dazu verwendet werden, um eingebettete Links im Element langbeschreibung aufzufinden und durch Links in die eigene Webseite zu ersetzen. Jeder eingebettete Link wird auch als Element verwandteLeistung geliefert, wobei das Attribut direktVerwandt den Wert true oder false haben kann. Über das href-Attribut des eingebettenen Links besteht eine Beziehung zum Element url der verwandten Leistung. Das Element id der verwandten Leistung kann daher auch bei eingebetteten Links zum Ersetzen dieser Links durch solche in die eigene Webseite verwendet werden.

Alle soeben beschriebenen Elemente bilden die vollständige Leistungsbeschreibung.Sie haben die folgenden Attribute gemeinsam, die als Meta-Daten für den korrekten Zusammenbau der Leistungsbeschreibung zu einer Web-Seite dienen. Clienten dieses Web Service müssen diese Meta-Daten bei der Aufbereitung der Leistungsbeschreibung auswerten und nach folgenden Angaben interpretieren:

Attribut Beschreibung

leittext Leittext oder Überschrift, die verwendet werden muss, wenn das Element dargestellt wird

position Positive Zahl, die angibt, an welcher Position das Element bei der Darstellung im Bezug auf die anderen Elemente der Leistungsbeschreibung stehen muss

Page 47: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  47 von 187

Attribut Beschreibung

sichtbar true: das Element muss angezeigt werden false: das Element darf nicht angezeigt werden, es ist nur für die Auswertung vorgesehen

Abrufen der Leistungsbeschreibungen, die einer Dienststelle zugeordnet sind

Über diesen Schnittstellen-Endpunkt können nur die Leistungsbeschreibungen abgefragt werden, die einer bestimmten Dienststelle zugeordnet sind. Dafür muss in der Anfrage das Element dienststellenschluessel die 7-stellige Dienststellenummer der gewünschten Dienststelle enthalten.

Das Element gemeindekennziffer hat für die Anfrage die gleiche Bedeutung wie beim Schnittstellen-Endpunkt Abrufen aller Leistungen.

Zusammenfassende Hinweise• Eine Leistungsbeschreibung muss immer vollständig angezeigt werden. Alle oben genannten

Elemente, bei denen das Attribut sichtbar den Wert true hat, müssen in der Reihenfolge angezeigt werden, die durch das Attribut position vorgegeben wird.

• Der für das Element angegebene Leittext muss verwendet werden (z.B. als Überschrift).• Jedem sichtbaren Element der Leistungsbeschreibung darf eine regionale Ergänzung

hinzugefügt werden.Jedoch nur, wenn die regionale Ergänzung optisch abgegrenzt ist (z.B. durch die Zwischenüberschrift"Regionale Ergänzung"), und wenn angezeigt wird, wer für die regionale Ergänzung verantwortlich ist.

• Wenn das Datum gueltigBis abgelaufen ist, dürfen die Inhalte der Leistungsbeschreibung nicht mehroder nur mit einem entsprechenden Hinweis angezeigt werden.

• Wenn das Element status den Wert working hat, dürfen die Inhalte der Leistungsbeschreibungnicht mehr oder nur mit einem entsprechenden Hinweis angezeigt werden.

• Mögliche Fehler bei der Anfrage sind bereits beim Schnittstellen-Endpunkt Abrufen aller Leistungen beschrieben.

Wo HTML-Markup zugelassen ist, können folgende HTML-Tags bzw. Klassenstile vorkommen

HTML-Tag / Klassenstil Semantische Bedeutung

p, br, ul, ol, li, dl, dt, dd, dir, blockquote, i, cite, em, b, strong, sup, sub, hr, a

übliche Bedeutung

class="fundstelle" Kommt in Sozialfibel-Leistungsbeschreibungen als Attribut von Absätzen (p) und Textteilen (span) vor und kennzeichnet, dass eine Fundstelle beschrieben wird

class="zustaendig" Kommt in Sozialfibel-Leistungsbeschreibungen als Attribut von Absätzen (p) und Textteilen (span) vor und kennzeichnet, eine Aufzählung der zuständigen Behörden

class="ueberschrift3" Kommt in Sozialfibel-Leistungsbeschreibungen als Attribut von Textteilen (span) vor und kennzeichnet Zwischenüberschriften im Langtext der Leistungsbeschreibung

Page 48: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  48 von 187

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:leis="http://lfstad.bayern.de/baybw/allgemein/v1/leistungen"> <soapenv:Header/> <soapenv:Body> <leis:GetLeistungsbeschreibungenVonDienststelleRequest> <dienststellenschluessel>6721140</dienststellenschluessel> <gemeindekennziffer>09672114</gemeindekennziffer> </leis:GetLeistungsbeschreibungenVonDienststelleRequest> </soapenv:Body></soapenv:Envelope>

Die Anwort ist vom Datenmodell her mit der Antwort beim Schnittstellen-Endpunkt Abrufen aller Leistungsbeschreibungen identisch. Sie enthält jedoch nicht alle Leistungsbeschreibungen, sondern nur die der angeforderten Dienststelle.

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetLeistungsbeschreibungenVonDienststelleResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v1/leistungen"> <leistungsbeschreibungen> ... </leistungsbeschreibungen> </ns3:GetLeistungsbeschreibungenVonDienststelleResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Abrufen einer kompletten Leistungsbeschreibung (mit regionalen Ergänzungen und Zuständigkeiten)

Über diesen Schnittstellen-Endpunkt kann eine einzelne Leistungsbeschreibung oder eine regionale Ergänzung per Id abgefragt werden. Gültige Ids von Leistungen erhält der Client durch vorheriges Abrufen eines der anderen Endpunkte (z.B. Abrufen aller Leistungen).Gültige Ids von regionalen Ergänzungen kann der Client erhalten, wenn er vorher den hier beschriebenen Endpunkt für eine zentrale Leistungsbeschreibung aufruft, soweit diese für die angegebene gemeindekennziffer regionale Ergänzungen hat.

Das Element gemeindekennziffer hat für die Anfrage die gleiche Bedeutung wie beim Schnittstellen-Endpunkt Abrufen aller Leistungen.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:leis="http://lfstad.bayern.de/baybw/allgemein/v1/leistungen"> <soapenv:Header/> <soapenv:Body> <leis:GetSingleLeistungsbeschreibungRequest> <id>164</id> <gemeindekennziffer>09776129</gemeindekennziffer> </leis:GetSingleLeistungsbeschreibungRequest> </soapenv:Body></soapenv:Envelope>

Die Anwort liefert die angeforderte Leistungsbeschreibung oder regionale Ergänzung. Der Inhalt des Elements leistungsbeschreibung ist vom Datenmodell her grundsätzlich identisch mit dem gleichnahmigen Element beim Schnittstellen-Endpunkt Abrufen aller Leistungsbeschreibungen.Jedoch wird hier optional zusätzlich ein Element regionaleErgaenzungen zurückgeliefert. Darin enthalten sind 1 bis n

Page 49: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  49 von 187

Elemente regionaleErgaenzung, die nur das Attribut id besitzen. Über die Id können diese regionalen Ergänzungen im nächsten Schritt selbst abgerufen werden, wobei wieder der hier beschriebene Endpunkt benutzt wird.Außerdem ist optional ein Element zustaendigkeiten vorhanden, das 1 bis n Elemente zustaendigkeit einschließt.Das Element zustaendigkeit schließlich enthält folgende Elemente:

Element Beschreibung

bezeichnung Bezeichnung der zuständigen Behörde

anschriften Enthält alle 0 bis n Gebäude zu dieser Behörde

gebaeude Jedes Gebäude hat genau eine Hausanschrift und eventuell eine Postanschrift, Telefon- und Faxnummer

email Email-Adresse der zuständigen Behörde (falls vorhanden)

website Homepage der zuständigen Behörde (falls vorhanden)

Entwicklung noch nicht abgeschlossen!Anpassungen bei der Auslieferung der Zuständigkeiten möglich. Muss mit den Partnern eventuell noch detaillierter abgestimmt werden.

Page 50: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  50 von 187

Response als zentrale Leistungsbeschreibung

SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetSingleLeistungsbeschreibungResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v1/leistungen"> <leistungsbeschreibung id="27397" letzteAenderung="2010-12-01T10:18:30+01:00"> ... <regionaleErgaenzungen> <regionaleErgaenzung id="27411"/> </regionaleErgaenzungen> <zustaendigkeiten> <zustaendig> <bezeichnung>Landratsamt Lindau (Bodensee)</bezeichnung> <anschriften> <gebaeude> <hausanschrift> <strasse>Stiftsplatz 4</strasse> <plz>88131</plz> <ort>Lindau (Bodensee)</ort> </hausanschrift> <postanschrift> <strasse>Postfach 3322</strasse> <plz>88105</plz> <ort>Lindau (Bodensee)</ort> </postanschrift> <telefon>+49 (0)8382 270-0</telefon> <fax>+49 (0)8382 270-115</fax> </gebaeude> </anschriften> <email>[email protected]</email> <website>http://www.landkreis-lindau.de</website> </zustaendig> </zustaendigkeiten> </leistungsbeschreibung> </ns3:GetSingleLeistungsbeschreibungResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Eine regionale Ergänzung ist eine spezielle Leistungsbeschreibung, die mit den gleichen Elementen ausgestattet ist, wie die (zentrale) Leistungsbeschreibung zu der sie gehört. Meist sind bei der regionalen Ergänzung jedoch weniger Elemente mit Inhalt belegt.

Im folgenden Beispiel wird eine regionale Ergänzung zu folgenden Elementen geliefert:

• kosten• onlineVerfahren

Page 51: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  51 von 187

Response als regionale Ergänzung

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetSingleLeistungsbeschreibungResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v1/leistungen"> <leistungsbeschreibung id="27411" letzteAenderung="2010-07-12T11:42:48+02:00"> <bezeichnung leittext="bezeichnung" position="1" sichtbar="true"> Handwerksrecht, Anzeige eines zulassungsfreien Handwerks oder eines handwerksähnlichen Gewerbes - HwK Unterfranken </bezeichnung> <url/> <synonyme/> <lebenslagen/> <status leittext="Status" position="16" sichtbar="false">live</status> <gueltigBis leittext="Gültig bis" position="17" sichtbar="false"> 2010-12-31+01:00 </gueltigBis> <kurzbeschreibung leittext="Kurzbeschreibung" position="2" sichtbar="true"/> <langbeschreibung leittext="Beschreibung" position="3" sichtbar="true"/> <voraussetzungen leittext="Voraussetzungen" position="4" sichtbar="true"/> <fristen leittext="Fristen" position="5" sichtbar="true"/> <unterlagen leittext="Erforderlich Unterlagen" position="6" sichtbar="true"/> <kosten leittext="Kosten" position="7" sichtbar="true"> <![CDATA[ <p>Ersteintragung in die Handwerksrolle bzw. in das Verzeichnis der zulassungsfreien Handwerke und handwerksähnlichen Gewerbe </p> <p>für Einzelunternehmen 76 €, </p> <p>für andere Rechtsformen 128 €;</p> <p>Änderungen der Eintragung 50 €</p> ]]> </kosten> <formulare leittext="Formulare" position="8" sichtbar="true"/> <onlineVerfahren leittext="Online Verfahren" position="9" sichtbar="true"> <onlineVerfahren> <kurzbeschreibung> Handwerksrolle online - Handwerkskammer für Unterfranken </kurzbeschreibung> <langbeschreibung> Ein neuer Service für Existenzgründer und Mitgliedsbe... </langbeschreibung> <url> http://www.hwk-unterfranken.odav.de/view?onr=78&amp;pnr=hto_hrolle_start </url> </onlineVerfahren> </onlineVerfahren> <rechtsvorschriften leittext="Rechtsgrundlagen" position="10" sichtbar="true"/> <rechtsbehelf leittext="Rechtsbehelf" position="11" sichtbar="true"/> <links leittext="Weiterführende Links" position="12" sichtbar="true"/> <stand leittext="Stand" position="14" sichtbar="true"> 2010-07-12T11:42:48+02:00 </stand> <verantwortlicheBehoerde leittext="Redaktionell verantwortlich" position="15" sichtbar="true"> Handwerkskammer für Unterfranken

Page 52: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  52 von 187

</verantwortlicheBehoerde> </leistungsbeschreibung> </ns3:GetSingleLeistungsbeschreibungResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Die regionale Ergänzung hat ihre eigene zeitliche Gültigkeitsbegrenzung (Element gueltigBis), die beachtet werden muss. Sie darf nur angezeigt werden, wenn sie zeitlich noch gültig ist.Natürlich hat die regionale Ergänzung auch eine eigene redaktionell verantwortliche Behörde (Element verantwortlicheBehoerde), die mit jeder regionalen Ergänzung angezeigt werden muss. Denn für die Inhalte der regionalen Ergänzung ist die regionale Dienststelle verantwortlich, nicht die Behörde, die die zentrale Leistungsbeschreibung pflegt.

2.1.4 Version 2

Leistungen (Version 2)Dieser Web Service erfordert eine Authentifizierung durch den Client (Portal oder CMS-Provider).

Die Schnittstellenbeschreibung finden Sie in folgender Web-Services-Description- Language-Datei (WSDL):

https://www.baybw-services.bayern.de/services/allgemein/allgemein-leistungen.v2.wsdl

Der Web Service bietet folgende Schnittstellen-Endpunkte an:

• Abrufen aller Leistungen• Abrufen der Leistungen, die einer Dienststelle zugeordnet sind• Abrufen aller Leistungsbeschreibungen• Abrufen der Leistungsbeschreibungen, die einer Dienststelle zugeordnet sind• Abrufen einer kompletten Leistungsbeschreibung (mit regionalen Ergänzungen und Zuständigkeiten)

Abrufen aller Leistungen

Über diesen Schnittstellen-Endpunkt können alle Leistungen abgefragt werden. Die Leistungen werden unabhängig davon geliefert, ob das Gültigkeitsdatum der dazugehörigen Leistungsbeschreibung bereits überschritten ist, bzw. ob die Leistungsbeschreibung gerade in Überarbeitung sind.

Mögliche Fehler• Wenn die Id der Leistung oder regionalen Ergänzung nicht gültig ist, erhalten sie folgende SOAP-

Fault:

<SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en">Invalid parameter 'id'. Service or regional extension not found by Id. </faultstring></SOAP-ENV:Fault>

Version wird eingestelltBitte beachten Sie, dass für diese Version ab Ende 2016 kein Support mehr angeboten wird, und die Version voraussichtlich Ende 2018 vollständig vom Netz genommen wird. Es wird dringend gebeten auf Webservices der Version 3 SOAP bzw. Version 3 REST-API umzusteigen.

BenutzerkennungSie benötigen eine Kennung, der ein Profil mit der Rolle "Webservices Leistungen" zugeordnet ist. Der Einstiegsknoten des Profils wird bei Anfragen nicht ausgewertet, sollte aber im Hinblick auf zukünftige Differenzierungen sinnvoll gewählt werden.Unter der Web-Adresse https://www.bayvis-redaktionssystem.bayern.de finden Sie die Kontaktdaten zum Beantragen einer Kennung.

Page 53: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  53 von 187

Wenn bei der Anfrage im Element gemeindekennziffer eine gültige 8-stellige (bayerische) Gemeindekennziffer angegeben wird, dann sind in der Antwort die URLs der Leistungen lokalisiert (also passend für die Gemeinde mit der angegebenen Gemeindekennziffer).

Die in der folgenden Anfrage angegebene Gemeindekennziffer 09162000 bewirkt, dass die URLs für die Landeshauptstadt München lokalisiert werden. In der Antwort erkennen Sie die Wirkung daran, dass die URLs für die Leistung drei HTTP-Parameter haben:

Eine lokalisierte URL sieht so aus:

lokalisierte URL

<url>http://www.behoerdenwegweiser.bayern.de/dokumente/aufgabenbeschreibung/26999461116?plz=80331&amp;behoerde=88887100385&amp;gemeinde=666856454699</url>

Eine nicht lokalisierte URL sieht so aus:

nicht lokalisierte URL

<url>http://www.behoerdenwegweiser.bayern.de/dokumente/aufgabenbeschreibung/26999461116</url>

Hier finden Sie das Beispiel für die Anfrage:

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:leis="http://lfstad.bayern.de/baybw/allgemein/v2/leistungen"> <soapenv:Header/> <soapenv:Body> <leis:GetAlleLeistungenRequest> <gemeindekennziffer>09162000</gemeindekennziffer> </leis:GetAlleLeistungenRequest> </soapenv:Body></soapenv:Envelope>

Die Antwort enthält im Element leistungen 0 bis n Elemente leistung.

Page 54: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  54 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetAlleLeistungenResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v2/leistungen"> <leistungen> <leistung id="3627" letzteAenderung="2010-12-15T13:57:04+01:00"> <bezeichnung leittext="bezeichnung" position="1" sichtbar="true">Abendgymnasium</bezeichnung> <url>http://www.behoerdenwegweiser.bayern.de/dokumente/aufgabenbeschreibung/47552656625 ?plz=80331&amp;behoerde=88887100385&amp;gemeinde=666856454699</url> <synonyme/> <lebenslagen> <lebenslage id="10000505"> <bezeichnung>Akademische Berufsausbildung</bezeichnung> <metaTag>ByLl_Berufsausbildung_AkademischeBerufsausbildung</metaTag> </lebenslage> ... </lebenslagen> </leistung> <leistung id="3694" letzteAenderung="2010-08-02T17:32:54+02:00"> <bezeichnung leittext="bezeichnung" position="1" sichtbar="true">Abfallberatung</bezeichnung> <url>http://www.behoerdenwegweiser.bayern.de/dokumente/aufgabenbeschreibung/71663715636 ?plz=80331&amp;behoerde=88887100385&amp;gemeinde=666856454699</url> <synonyme> <synonym>Müllabfuhr</synonym> ... </synonyme> <lebenslagen> <lebenslage id="10001102"> <bezeichnung>Neu in der Stadt</bezeichnung> <metaTag>ByLl_Wohnen_NeuStadt</metaTag> </lebenslage> <lebenslage id="20002105"> <bezeichnung>Umweltschutz</bezeichnung> <metaTag>ByGl_Gewerbeaufsicht_Umweltschutz</metaTag> </lebenslage> ... </lebenslagen> </leistung> ... </leistungen> </ns3:GetAlleLeistungenResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Die Elemente und Attribute in der Antwort haben folgende Bedeutung:

Element Attribut Beschreibung

leistungen Container für die Leistungen

Page 55: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  55 von 187

Element Attribut Beschreibung

leistung Daten zu einer Leistung

leistung id Id der Leistung

leistung letzteAenderung Zeitstempel der letzten Änderung bei dieser Leistung

bezeichnung Bezeichnung der Leistung

synonyme Container für die Synonyme zu einer Leistung

synonym Synonym einer Leistung

lebenslagen Container für die Lebenslagen, denen eine Leistung zugeordnet ist

lebenslage Lebenslage, der die Leistung zugeordnet ist

lebenslage id Id der Lebenslage, der die Leistung zugeordnet ist

bezeichnung Bezeichnung der Lebenslage

metaTag Codierung der Lebenslagenbezeichnung zur Benutzung in meta-Tags für die COGISUM-Suchmaschine

<meta name="ByLebenslagen" content="ByLl_Bauen_Bauplanung,ByGl_ImmobilienVerkehr_Bauplanung"/>

Abrufen der Leistungen, die einer Dienststelle zugeordnet sind

Über diesen Schnittstellen-Endpunkt können nur die Leistungen abgefragt werden, die einer bestimmten Dienststelle zugeordnet sind. Dafür muss in der Anfrage das Element dienststellenschluessel die 7-stellige Dienststellennummer der gewünschten Dienststelle enthalten.

Mögliche Fehler• Wenn die Gemeindekennziffer zu keiner Gemeinde passt, werden die URLs für die Leistungen

ohne Lokalisierungsparameter zurückgeliefert.• Wenn Sie die Gemeindekennziffer nicht numerisch und 8-stellig angeben, erhalten Sie folgenden

SOAP-Fault:

<SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en">Invalid parameter 'gemeindekennziffer'. Must be numeric with 8 digits. </faultstring></SOAP-ENV:Fault>

Page 56: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  56 von 187

Das Element gemeindekennziffer hat für die Anfrage die gleiche Bedeutung wie beim Schnittstellen-Endpunkt Abrufen aller Leistungen.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:leis="http://lfstad.bayern.de/baybw/allgemein/v2/leistungen"> <soapenv:Header/> <soapenv:Body> <leis:GetLeistungenVonDienststelleRequest> <dienststellenschluessel>6721140</dienststellenschluessel> <gemeindekennziffer>09672114</gemeindekennziffer> </leis:GetLeistungenVonDienststelleRequest> </soapenv:Body></soapenv:Envelope>

Die Anwort ist vom Datenmodell her mit der Antwort beim Schnittstellen-Endpunkt Abrufen aller Leistungen identisch. Sie enthält jedoch nicht alle Leistungen, sondern nur die der angegebenen Dienststelle.

Response

SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetLeistungenVonDienststelleResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v2/leistungen"> <leistungen> ... </leistungen> </ns3:GetLeistungenVonDienststelleResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Abrufen aller Leistungsbeschreibungen

Über diesen Schnittstellen-Endpunkt können alle Leistungsbeschreibungen (Leistungen einschließlich ihrer vollständigen Beschreibung) abgefragt werden. Das Inhaltsmodell der Antwort ergänzt nur das Inhaltsmodell des Schnittstellen-Endpunkts Abrufen aller Leistungen um weitere Elemente.

Eine Anfrage mit Lokalisierung auf die Landeshauptstadt München (Gemeindekennziffer 09162000) sieht folgendermaßen aus:

Mögliche Fehler• Wenn Sie keinen oder einen nicht existierenden Dienststellenschlüssel angeben, liefert der Web

Service die Antwort mit einem leeren Element leistungen zurück.• Wenn Sie den Dienststellenschlüssel nicht numerisch oder mit mehr als 7 Ziffern angeben,

erhalten Sie folgenden SOAP-Fault:

<SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en">Invalid parameter 'dienststellenschluessel'. Must be numeric containing a maximum of 7 digits. </faultstring></SOAP-ENV:Fault>

Page 57: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  57 von 187

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:leis="http://lfstad.bayern.de/baybw/allgemein/v2/leistungen"> <soapenv:Header/> <soapenv:Body> <leis:GetAlleLeistungsbeschreibungenRequest> <gemeindekennziffer>09162000</gemeindekennziffer> </leis:GetAlleLeistungsbeschreibungenRequest> </soapenv:Body></soapenv:Envelope>

Hier finden Sie die dazugehörige Antwort. Die Teile der Anwort, die bereits beim Schnittstellen-Endpunkt Abrufen aller Leistungen gezeigt wurden, werden hier nicht mehr dargestellt:

Page 58: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  58 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetAlleLeistungsbeschreibungenResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v2/leistungen"> <leistungsbeschreibungen> <leistungsbeschreibung id="3627" letzteAenderung="2011-11-24T15:37:54+01:00"> <bezeichnung leittext="bezeichnung" position="1" sichtbar="true"> Abendgymnasium </bezeichnung> <url>http://www.behoerdenwegweiser.bayern.de/dokumente/aufgabenbeschreibung/47552656625 ?plz=80331&amp;behoerde=88887100385&amp;gemeinde=666856454699</url> <!-- ... Inhalt wie beim Endpunkt GetAlleLeistungen ... --> <status leittext="Status" position="16" sichtbar="false">live</status> <kurzbeschreibung leittext="Kurzbeschreibung" position="2" sichtbar="true"> ... </kurzbeschreibung> <langbeschreibung leittext="Beschreibung" position="3" sichtbar="true"> ... </langbeschreibung> <voraussetzungen leittext="Voraussetzungen" position="4" sichtbar="true"> ... </voraussetzungen> <verfahrensablauf leittext="Verfahrensablauf" position="5" sichtbar="true"> ... </verfahrensablauf> <hinweise leittext="Hinweise" position="6" sichtbar="true"> ... </hinweise>  <fristen leittext="Fristen" position="5" sichtbar="true"> ... </fristen> <bearbeitungsdauer leittext="Hinweise" position="8" sichtbar="true"> ... </bearbeitungsdauer>  <unterlagen leittext="Erforderliche Unterlagen" position="9" sichtbar="true"> <unterlage> <kurzbeschreibung>...</kurzbeschreibung> <langbeschreibung>...</langbeschreibung> <leistungId>...</leistungId> <leistungUrl>...</leistungUrl> </unterlage> ... </unterlagen> <kosten leittext="Kosten" position="12" sichtbar="true"> ... </kosten> <formulare leittext="Formulare" position="10" sichtbar="true"> <formular> <kurzbeschreibung>...</kurzbeschreibung> <langbeschreibung>...</langbeschreibung>

Page 59: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  59 von 187

<url>...</url> </formular> ... </formulare> <onlineVerfahren leittext="Online Verfahren" position="11" sichtbar="true"> <onlineVerfahren> <kurzbeschreibung>...</kurzbeschreibung> <langbeschreibung>...</langbeschreibung> <url>...</url> </onlineVerfahren> ... </onlineVerfahren>

Page 60: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  60 von 187

Response - Fortsetzung

<rechtsvorschriften leittext="Rechtsgrundlagen" position="10" sichtbar="true"> <rechtsvorschrift> <kurzbeschreibung>...</kurzbeschreibung> <langbeschreibung>...</langbeschreibung> <url>...</url> </rechtsvorschrift> ... </rechtsvorschriften> <rechtsbehelf leittext="Rechtsbehelf" position="13" sichtbar="true"> <kurzbeschreibung>...</kurzbeschreibung> <leistungId>...</leistungId> <leistungBezeichnung>...</leistungBezeichnung> <leistungUrl>...</leistungUrl> </rechtsbehelf> <links leittext="Weiterführende Links" position="15" sichtbar="true"> <link> <kurzbeschreibung>...</kurzbeschreibung> <langbeschreibung>...</langbeschreibung> <url>...</url> </link> ... </links> <verwandteLeistungen leittext="Verwandte Themen" position="16" sichtbar="true"> <verwandteLeistung> <id>...</id> <bezeichnung>...</bezeichnung> <url>...</url> <direktVerwandt>...</direktVerwandt> </verwandteLeistung> ... </verwandteLeistungen> <stand leittext="Stand" position="17" sichtbar="true"> 2011-11-24T15:37:54+01:00 </stand> <verantwortlicheBehoerde leittext="Redaktionell verantwortlich" position="18" sichtbar="true"> Bayerisches Staatsministerium für ... (zur Verfügung gestellt durch das  &lt;a href="...">BayernPortal&lt;/a>) </verantwortlicheBehoerde> </leistungsbeschreibung> ... </leistungsbeschreibungen> </ns3:GetAlleLeistungsbeschreibungenResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

In den folgenden Tabelle werden alle im Vergleich zum Endpunkt Abrufen aller Leistungen neuen Elemente einer Leistungsbeschreibung aufgeführt:

Element Beschreibung

leistungsbeschreibungen Container für die Leistungsbeschreibungen

leistungsbeschreibung Daten zu einer Leistungsbeschreibung

Page 61: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  61 von 187

Element Beschreibung

bezeichnung Bezeichnung der Leistung im BayernPortal (als Titel verwendbar)

status live: die Leistungsbeschreibung ist online working: die Leistungsbeschreibung wird gerade überarbeitet

kurzbeschreibung Kurzbeschreibung (einführender Text); HTML-Markup zulässig

langbeschreibung Langbeschreibung mit dem Kerninhalt; HTML-Markup zulässig

voraussetzungen Erläuterung der Voraussetzungen; HTML-Markup zulässig

verfahrensablauf Skizze zum Ablauf des Verwaltungsverfahrens (Prozess; HTML-Markup zulässig

hinweise Hinweise, die im Zusammenhang mit der Leistung beachtet werden sollten; HTML-Markup zulässig

fristen Erläuterung der Fristen; HTML-Markup zulässig

bearbeitungsdauer Angaben zur durchschnittlichen Bearbeitungsdauer; HTML-Markup zulässig

unterlagen Container für die Unterlagen, die der Leistungsbeschreibung zugeordnet sind

kosten Erläuterung der Kosten; HTML-Markup zulässig

formulare Container für die Formulare, die der Leistungsbeschreibung zugeordnet sind

onlineVerfahren Container für die Online Verfahren, die der Leistungsbeschreibung zugeordnet sind

rechtsvorschriften Container für die Rechtsvorschriften, die der Leistungsbeschreibung zugeordnet sind

rechtsbehelf Ein Rechtsbehelf, der der Leistungsbeschreibung zugeordnet sein kann

links Container für die externen Links, die der Leistungsbeschreibung zugeordnet sind

verwandteLeistungen Container für die verwandten Leistungen im BayernPortal

stand Datum bzw. Zeitpunkt, zu dem die Leistungsbeschreibung zuletzt überarbeitet wurde (mit dem eher technischen Attribut "letzteAenderung" inhaltlich identisch)

Page 62: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  62 von 187

Element Beschreibung

verantwortlicheBehoerde Behörde, die für die Leistungsbeschreibung redaktionell verantwortlich ist (i.d.R. ein Ministerium). Darüber hinaus wird ein Hinweistext auf die Herkunft der Daten mit einer Verlinkung auf die (eventuell lokalisierte) Leistungsbeschreibung im BayernPortal geliefert.

unterlagen

Container für 0 bis n unterlage-Elemente zu einer Leistungsbeschreibung

Attribut Beschreibung

kurzbeschreibung Kurzbeschreibung der Unterlage (als Titel verwendbar)

langbeschreibung Langbeschreibung mit dem Kerninhalt; HTML-Markup zulässig (optional)

leistungId Id einer Leistung, mit der man die Unterlage (z.B. ein Dokument oder eine behördliche Bescheinigung) erlangt. Beispiele: Personalausweis / vorläufiger Personalausweis oder Freizügigkeitsbescheinigung (optional)

leistungUrl URL dieser Leistung. Die URL wird mit Lokalisierungsparametern geliefert, soweit bei der Anfrage das Element gemeindekennziffer angegeben wurde und gültig ist. (optional)

formulare, onlineVerfahren, rechtsvorschriften, links

Container für 0 bis n formular-, onlineVerfahren-, rechtsvorschrift- und link-Elementen zu einer Leistungsbeschreibung

Attribut Beschreibung

kurzbeschreibung Kurzbeschreibung des Elements (als Titel verwendbar)

langbeschreibung Langbeschreibung mit dem Kerninhalt; HTML-Markup zulässig

url Url zum jeweiligen Element

rechtsbehelf

Ein optionales rechtsbehelf-Element zu einer Leistungsbeschreibung. Der Rechtsbehelf kann entweder nur eine Kurzbeschreibung, nur eine Referenz auf eine Leistung im BayernPortal oder beides enthalten.

Attribut Beschreibung

kurzbeschreibung Kurzbeschreibung des Rechtsbehelfs; HTML-Markup zulässig; nicht als Titel verwendbar)

leistungId Id einer Leistung, die den Rechtsbehelf beschreibt (z.B. Widerspruchsverfahren)

Page 63: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  63 von 187

Attribut Beschreibung

leistungBezeichnung Bezeichnung dieser Leistung (als Titel verwendbar)

leistungUrl URL dieser Leistung. Die URL wird mit Lokalisierungsparametern geliefert, soweit bei der Anfrage das Element gemeindekennzifferangegeben wurde und gültig ist.)

verwandteLeistungen

Container für 0 bis n verwandteLeistung-Elemente zu einer Leistungsbeschreibung

Attribut Beschreibung

id Id der Leistung im BayernPortal

bezeichnung Bezeichnung der Leistung im BayernPortal (als Titel verwendbar)

url URL der Leistung im BayernPortal, die mit dieser Leistungsbeschreibung verwandt ist. Die URL wird mit Lokalisierungsparametern geliefert, soweit bei der Anfrage das Element gemeindekennziffer angegeben wurde und gültig ist.)

direktVerwandt true: Leistung ist direkt verwandt und wird auch im BayernPortal als verwandte Leistung angezeigt. false: Leistung ist entfernt verwandt, und wird eventuell lediglich in der Langbeschreibung verlinkt.

Mit Hilfe dieser Elemente können Links zu verwandten Leistungen erzeugt werden. Entweder in die eigene Webseite vom Element id ausgehend oder in das BayernPortal (Element url).Es müssen nur solche verwandten Leistungen als Links angezeigt werden, für die das Attribut direktVerwandt den Wert true hat. Die anderen werden zu einem weiteren Zweck mitgeliefert.Der Container verwandteLeistungen kann nämlich dazu verwendet werden, um eingebettete Links im Element langbeschreibung aufzufinden und durch Links in die eigene Webseite zu ersetzen. Jeder eingebettete Link wird auch als Element verwandteLeistung geliefert, wobei das Attribut direktVerwandt den Wert true oder false haben kann. Über das href-Attribut des eingebettenen Links besteht eine Beziehung zum Element url der verwandten Leistung. Das Element id der verwandten Leistung kann daher auch bei eingebetteten Links zum Ersetzen dieser Links durch solche in die eigene Webseite verwendet werden.

Alle soeben beschriebenen Elemente bilden die vollständige Leistungsbeschreibung.Sie haben die folgenden Attribute gemeinsam, die als Meta-Daten für den korrekten Zusammenbau der Leistungsbeschreibung zu einer Web-Seite dienen. Clienten dieses Web Service müssen diese Meta-Daten bei der Aufbereitung der Leistungsbeschreibung auswerten und nach folgenden Angaben interpretieren:

Attribut Beschreibung

leittext Leittext oder Überschrift, die verwendet werden muss, wenn das Element dargestellt wird

Page 64: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  64 von 187

Attribut Beschreibung

position Positive Zahl, die angibt, an welcher Position das Element bei der Darstellung im Bezug auf die anderen Elemente der Leistungsbeschreibung stehen muss

sichtbar true: das Element muss angezeigt werden false: das Element darf nicht angezeigt werden, es ist nur für die Auswertung vorgesehen

Zusammenfassende Hinweise• Eine Leistungsbeschreibung muss immer vollständig angezeigt werden. Alle oben genannten

Elemente, bei denen das Attribut sichtbar den Wert true hat, müssen in der Reihenfolge angezeigt werden, die durch das Attribut position vorgegeben wird.

• Der für das Element angegebene Leittext muss verwendet werden (z.B. als Überschrift).• Jedem sichtbaren Element der Leistungsbeschreibung darf eine regionale Ergänzung

hinzugefügt werden.Jedoch nur, wenn die regionale Ergänzung optisch abgegrenzt ist (z.B. durch die Zwischenüberschrift"Regionale Ergänzung"), und wenn angezeigt wird, wer für die regionale Ergänzung verantwortlich ist.

• Wenn die Gültigkeitszeit abgelaufen ist oder das Element status den Wert working hat, dürfen die Inhalte der Leistungsbeschreibung nicht mehr oder nur mit einem entsprechenden Hinweis angezeigt werden. In diesem Fall steht im Element kurzbeschreibung der Text "Diese Leistungsbeschreibung wird aktuell überarbeitet.". Die Elemente lebenslagen, langbeschreibung, voraussetzungen, fristen, unterlagen, kosten, formulare, onlineVerfahren, rechtsvorschriften, rechtsbehelf, links und verwandteLeistungenwerden in diesem Fall nicht geliefert.

• Mögliche Fehler bei der Anfrage sind bereits beim Schnittstellen-Endpunkt Abrufen aller Leistungen beschrieben.

Wo HTML-Markup zugelassen ist, können folgende HTML-Tags bzw. Klassenstile vorkommen

HTML-Tag / Klassenstil Semantische Bedeutung

p, br, ul, ol, li, dl, dt, dd, dir, blockquote, i, cite, em, b, strong, sup, sub, hr, a

übliche Bedeutung

class="fundstelle" Kommt in Sozialfibel-Leistungsbeschreibungen als Attribut von Absätzen (p) und Textteilen (span) vor und kennzeichnet, dass eine Fundstelle beschrieben wird

class="zustaendig" Kommt in Sozialfibel-Leistungsbeschreibungen als Attribut von Absätzen (p) und Textteilen (span) vor und kennzeichnet, eine Aufzählung der zuständigen Behörden

class="ueberschrift3" Kommt in Sozialfibel-Leistungsbeschreibungen als Attribut von Textteilen (span) vor und kennzeichnet Zwischenüberschriften im Langtext der Leistungsbeschreibung

Page 65: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  65 von 187

Abrufen der Leistungsbeschreibungen, die einer Dienststelle zugeordnet sind

Über diesen Schnittstellen-Endpunkt können nur die Leistungsbeschreibungen abgefragt werden, die einer bestimmten Dienststelle zugeordnet sind. Dafür muss in der Anfrage das Element dienststellenschluessel die 7-stellige Dienststellenummer der gewünschten Dienststelle enthalten.

Das Element gemeindekennziffer hat für die Anfrage die gleiche Bedeutung wie beim Schnittstellen-Endpunkt Abrufen aller Leistungen.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:leis="http://lfstad.bayern.de/baybw/allgemein/v2/leistungen"> <soapenv:Header/> <soapenv:Body> <leis:GetLeistungsbeschreibungenVonDienststelleRequest> <dienststellenschluessel>6721140</dienststellenschluessel> <gemeindekennziffer>09672114</gemeindekennziffer> </leis:GetLeistungsbeschreibungenVonDienststelleRequest> </soapenv:Body></soapenv:Envelope>

Die Anwort ist vom Datenmodell her mit der Antwort beim Schnittstellen-Endpunkt Abrufen aller Leistungsbeschreibungen identisch. Sie enthält jedoch nicht alle Leistungsbeschreibungen, sondern nur die der angeforderten Dienststelle.

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetLeistungsbeschreibungenVonDienststelleResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v2/leistungen"> <leistungsbeschreibungen> ... </leistungsbeschreibungen> </ns3:GetLeistungsbeschreibungenVonDienststelleResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Abrufen einer kompletten Leistungsbeschreibung (mit regionalen Ergänzungen und Zuständigkeiten)

Über diesen Schnittstellen-Endpunkt kann eine einzelne Leistungsbeschreibung oder eine regionale Ergänzung per Id abgefragt werden. Gültige Ids von Leistungen erhält der Client durch vorheriges Abrufen eines der anderen Endpunkte (z.B. Abrufen aller Leistungen).Gültige Ids von regionalen Ergänzungen kann der Client erhalten, wenn er vorher den hier beschriebenen Endpunkt für eine zentrale Leistungsbeschreibung aufruft, soweit diese für die angegebene gemeindekennziffer regionale Ergänzungen hat.

Das Element gemeindekennziffer hat für die Anfrage die gleiche Bedeutung wie beim Schnittstellen-Endpunkt Abrufen aller Leistungen.

Page 66: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  66 von 187

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:leis="http://lfstad.bayern.de/baybw/allgemein/v2/leistungen"> <soapenv:Header/> <soapenv:Body> <leis:GetSingleLeistungsbeschreibungRequest> <id>161</id> <gemeindekennziffer>09463000</gemeindekennziffer> </leis:GetSingleLeistungsbeschreibungRequest> </soapenv:Body></soapenv:Envelope>

Die Anwort liefert die angeforderte Leistungsbeschreibung oder regionale Ergänzung. Der Inhalt des Elements leistungsbeschreibung ist vom Datenmodell her grundsätzlich identisch mit dem gleichnahmigen Element beim Schnittstellen-Endpunkt Abrufen aller Leistungsbeschreibungen.Jedoch wird hier optional zusätzlich ein Element regionaleErgaenzungen zurückgeliefert. Darin enthalten sind 1 bis n Elemente regionaleErgaenzung, die nur das Attribut id besitzen. Über die Id können diese regionalen Ergänzungen im nächsten Schritt selbst abgerufen werden, wobei wieder der hier beschriebene Endpunkt benutzt wird.Außerdem ist optional ein Element zustaendigkeiten vorhanden, das 1 bis n Elemente zustaendigkeit einschließt.Das Element zustaendigkeit schließlich enthält folgende Elemente:

Element Attribute Beschreibung

behoerdeId   Id der zuständigen Behörde (nur gefüllt, wenn der Benutzer das Recht hat, die Detaildaten zur Behörde anzufordern)

bezeichnung   Bezeichnung der zuständigen Behörde

anschriften   Enthält alle 0 bis n Gebäude zu dieser Behörde

gebaeude   Jedes Gebäude hat genau eine Hausanschrift und eventuell eine Postanschrift, Telefon- und Faxnummer

gebaeudeId   Id des Gebäudes, das der zuständigen Behörde zugeordnet ist (nur gefüllt, wenn der Benutzer das Recht hat, die Detaildaten zur Behörde anzufordern)

email   Email-Adresse der zuständigen Behörde (falls vorhanden)

website   Homepage der zuständigen Behörde (falls vorhanden)

behoerdenAnsprechpartnerZuordnungen

  Container mit 0 bis n Ansprechpartner-Ids (nur gefüllt, wenn der Benutzer das Recht hat, die Detaildaten zur Behörde anzufordern)

ansprechpartner id Id eines zuständigen Ansprechpartners

Die Elemente behoerdeId, gebaeudeId, behoerdenAnsprechpartnerZuordnungen/ansprechpartner[id] werden nur geliefert, wenn die Benutzerkennung, mit der der Webservice aufgerufen wird, Zugriff auf die Daten der zuständigen Behörde hat. Die Benutzerkennung braucht dazu ein Benutzerprofil mit der Rolle "Webservices Behörden" für die jeweilige

Page 67: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  67 von 187

Dienststelle.Inhaltlich handelt es sich um Referenz-Ids der zuständigen Behörde, ihrer Gebäude und der zuständigen Ansprechpartner. Die Referenz-Ids können genutzt werden, um über den Webservice       Behörden, Gebäude und Ansprechpartner die Detaildaten abzurufen.

Page 68: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  68 von 187

Response als zentrale Leistungsbeschreibung

SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetSingleLeistungsbeschreibungResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v2/leistungen"> <leistungsbeschreibung id="161" letzteAenderung="2011-12-01T10:18:30+01:00"> ... <regionaleErgaenzungen> <regionaleErgaenzung id="27411"/> </regionaleErgaenzungen>  <zustaendigkeiten> <zustaendig> <bezeichnung>Industrie- und Handelskammer zu Coburg</bezeichnung> <anschriften> <gebaeude> <hausanschrift> <strasse>Schloßplatz 5</strasse> <plz>96450</plz> <ort>Coburg</ort> </hausanschrift> <postanschrift> <strasse>Postfach 2043</strasse> <plz>96409</plz> <ort>Coburg</ort> </postanschrift> <telefon>+49 (0)9561 7426-0</telefon> <fax>+49 (0)9561 7426-50</fax> </gebaeude> </anschriften> <email>[email protected]</email> <website>http://www.coburg.ihk.de</website> <bwwlink>http://www.behoerdenwegweiser.bayern.de/dokumente/behoerde/659077564723</bwwlink> </zustaendig> <zustaendig> <behoerdId>51017</behoerdId>  <bezeichnung>32-1 - Gewerberecht</bezeichnung> <anschriften> <gebaeude> <gebaeudeId>40365</gebaeudeId> <hausanschrift> <strasse>Rosengasse 1</strasse> <plz>96450</plz> <ort>Coburg</ort> </hausanschrift> <postanschrift> <strasse>Postfach 30 42</strasse> <plz>96419</plz> <ort>Coburg</ort> </postanschrift> <telefon>+49 (0)9561 89-0</telefon> <fax>+49 (0)9561 89-2111</fax> <behoerdenAnsprechpartnerZuordnungen>  <ansprechpartner id="48442"/>

Page 69: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  69 von 187

 </behoerdenAnsprechpartnerZuordnungen> </gebaeude> </anschriften> <email>[email protected]</email> <website>http://www.coburg.de</website> <bwwlink>http://www.behoerdenwegweiser.bayern.de/dokumente/behoerde/646404686857</bwwlink> </zustaendig> </zustaendigkeiten>  </leistungsbeschreibung> </ns3:GetSingleLeistungsbeschreibungResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Eine regionale Ergänzung ist eine spezielle Leistungsbeschreibung, die mit den gleichen Elementen ausgestattet ist, wie die (zentrale) Leistungsbeschreibung zu der sie gehört. Meist sind bei der regionalen Ergänzung jedoch weniger Elemente mit Inhalt belegt. Im folgenden Beispiel wird eine regionale Ergänzung zu folgenden Elementen geliefert:

• kosten• onlineVerfahren

Page 70: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  70 von 187

Response als regionale Ergänzung

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetSingleLeistungsbeschreibungResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v2/leistungen"> <leistungsbeschreibung id="27411" letzteAenderung="2011-07-12T11:42:48+02:00"> <bezeichnung leittext="bezeichnung" position="1" sichtbar="true"> Handwerksrecht, Anzeige eines zulassungsfreien Handwerks oder eines handwerksähnlichen Gewerbes - HwK Unterfranken </bezeichnung> <url/> <synonyme/> <lebenslagen/> <status leittext="Status" position="16" sichtbar="false">live</status> <kurzbeschreibung leittext="Kurzbeschreibung" position="2" sichtbar="true"/> <langbeschreibung leittext="Beschreibung" position="3" sichtbar="true"/> <voraussetzungen leittext="Voraussetzungen" position="4" sichtbar="true"/> <fristen leittext="Fristen" position="5" sichtbar="true"/> <unterlagen leittext="Erforderlich Unterlagen" position="6" sichtbar="true"/> <kosten leittext="Kosten" position="7" sichtbar="true"> <![CDATA[ <p>Ersteintragung in die Handwerksrolle bzw. in das Verzeichnis der zulassungsfreien Handwerke und handwerksähnlichen Gewerbe </p> <p>für Einzelunternehmen 76 €, </p> <p>für andere Rechtsformen 128 €;</p> <p>Änderungen der Eintragung 50 €</p> ]]> </kosten> <formulare leittext="Formulare" position="8" sichtbar="true"/> <onlineVerfahren leittext="Online Verfahren" position="9" sichtbar="true"> <onlineVerfahren> <kurzbeschreibung> Handwerksrolle online - Handwerkskammer für Unterfranken </kurzbeschreibung> <langbeschreibung> Ein neuer Service für Existenzgründer und Mitgliedsbe... </langbeschreibung> <url> http://www.hwk-unterfranken.odav.de/view?onr=78&amp;pnr=hto_hrolle_start </url> </onlineVerfahren> </onlineVerfahren> <rechtsvorschriften leittext="Rechtsgrundlagen" position="10" sichtbar="true"/> <rechtsbehelf leittext="Rechtsbehelf" position="11" sichtbar="true"/> <links leittext="Weiterführende Links" position="12" sichtbar="true"/> <stand leittext="Stand" position="14" sichtbar="true"> 2010-07-12T11:42:48+02:00 </stand> <verantwortlicheBehoerde leittext="Redaktionell verantwortlich" position="15" sichtbar="true"> Handwerkskammer für Unterfranken </verantwortlicheBehoerde> </leistungsbeschreibung> </ns3:GetSingleLeistungsbeschreibungResponse>

Page 71: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  71 von 187

</SOAP-ENV:Body></SOAP-ENV:Envelope>

Die regionale Ergänzung hat ihre eigene zeitliche Gültigkeitsbegrenzung. Wenn die Gültigkeitszeit abgelaufen ist oder das Element status den Wert working hat, dürfen die Inhalte der regionalen Ergänzung nicht mehr oder nur mit einem entsprechenden Hinweis angezeigt werden. In diesem Fall steht im Element kurzbeschreibung der Text "Die Leistungsbeschreibung wird aktuell überarbeitet.". Die Elemente langbeschreibung, voraussetzungen, fristen, unterlagen, kosten, formulare, onlineVerfahren, rechtsvorschriften, rechtsbehelf und links werden in diesem Fall nicht geliefert.

Natürlich hat die regionale Ergänzung auch eine eigene redaktionell verantwortliche Behörde (Element verantwortlicheBehoerde), die mit jeder regionalen Ergänzung angezeigt werden muss. Denn für die Inhalte der regionalen Ergänzung ist die regionale Dienststelle verantwortlich, nicht die Behörde, die die zentrale Leistungsbeschreibung pflegt.

2.1.5 Version 3 SOAP• Behörden, Gebäude und Ansprechpartner (Version 3)• Lebenslagen (Version 3)• Leistungen (Version 3)• Formulare (Version 3)

Behörden, Gebäude und Ansprechpartner (Version 3)Dieser Web Service erfordert eine Authentifizierung durch den Client.

Ab Version 3 bietet das BayernPortal die Export-Webservices auf zwei unterschiedlichen Zugriffswegen an, nämlich als

• REST API und• SOAP Schnittstelle

In beiden Fällen ist eine HTTP-Basic-Authentication erforderlich. Die in früheren Versionen der SOAP Schnittstelle (Versionen 1 und 2) verwendete Authentifizierungsmethode nach der  WS-Security -Spezifikation (d.h. als Teil der SOAP-Nachricht) wird aufgegeben.

Für die SOAP Schnittstelle finden Sie eine Schnittstellenbeschreibung in folgender Web-Services-Description- Language-Datei (WSDL):

Mögliche Fehler• Wenn die Id der Leistung oder regionalen Ergänzung nicht gültig ist, erhalten sie folgende SOAP-

Fault:

<SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en">Invalid parameter 'id'. Service or regional extension not found by Id. </faultstring></SOAP-ENV:Fault>

BenutzerkennungSie benötigen eine Kennung, der ein Profil mit der Rolle "Webservices Behörden" zugeordnet ist. Der Einstiegsknoten des Profils wird bei Anfragen ausgewertet und sollte eine bestimmte Dienststelle oder sonstige Behörde sein. Der Webservice liefert nur Daten zu dieser Dienststelle oder sonstigen Behörde und ihrem organisatorischen Unterbau.Wenn Ihrer Kennung mehrere Profile mit dieser Rolle, aber mit unterschiedlichen Einstiegsknoten zugeordnet sind, können Sie mit der Kennung auch auf die Daten von mehr als einer Dienststelle oder sonstigen Behörde zugreifen.Unter der Web-Adresse https://www.bayvis-redaktionssystem.bayern.de finden Sie die Kontaktdaten zum Beantragen einer Kennung.

Page 72: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  72 von 187

https://www.baybw-services.bayern.de/services/allgemein/allgemein-behoerden.v3.wsdl

Der Web Service bietet folgende Schnittstellen-Endpunkte wie in der Vorgänger-Version an:

• Daten einer Dienststelle• Daten einer Behörde• Daten eines Behördengebäudes• Daten eines Behördenansprechpartners• Liste der Ansprechpartner einer Behörde• Liste der Leistungen einer Behörde• Liste der Leistungen eines Ansprechpartners

Um Konsistenz mit dem neuen REST API herzustellen, wurden folgende zusätzlichen Endpunkte implementiert:

• Dienststellen• Behörden• Ansprechpartner

Alle Anfragen an die genannten Endpunkte gewähren nur auf Daten von Behörden, Gebäuden und Ansprechpartnern Zugriff, für die Ihre Benutzerkennung berechtigt ist.Daher benötigen Sie für diesen Web Service eine Benutzerkennung, die vom zentralen Administrator beim Bayerischen Staatsministerium der Finanzen und für Heimat (StMFLH) speziell für den Datenexport Ihrer Dienststelle (z.B. Gemeinde) eingerichtet wird. Der zentrale Administrator kann dieser Kennung bei Bedarf durchaus mehrere Profile zuordnen, so dass gleichzeitig auch der Zugriff auf die Daten weiterer Dienststellen (z.B. zusätzlich auf die Verwaltungsgemeinschaft, zu der eine Gemeinde gehört) ermöglicht wird.

Wenn Sie über einen der sieben genannten Endpunkte Daten anfordern, für die Ihre Kennung nicht berechtigt ist, wird folgender SOAP-Fehler geliefert:

Daten einer Dienststelle

Liefert die Daten der Dienststelle mit der angegebenen Dienststellennummer. Das Ergebnis enthält nur die Hauptdienststelle, nicht die Außenstellen.

Zugriffsberechtigung nicht vorhanden

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en"> Sie haben keine Berechtigung zum Abrufen der angeforderten Daten. </faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Page 73: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  73 von 187

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <soapenv:Header/> <soapenv:Body> <beh:GetDienststelleRequest> <dienststellenschluessel>6721140</dienststellenschluessel> </beh:GetDienststelleRequest> </soapenv:Body></soapenv:Envelope>

Als Parameter müssen Sie den 7-stelligen Dienststellenschlüssel einer bayerischen Dienststelle angeben (Element dienststellenschluessel).

In der Antwort finden Sie dann die Daten zu dieser Dienststelle. Dazu gehören außerdem

• Verweise auf hierarchisch untergeordnete Organisationseinheiten (Element behoerdeZuordnungen) und

• Verweise auf die zugeordneten Gebäude (Element behoerdenGebaeudeZuordnungen)

Zum Abrufen der einzelnen zugeordneten Organisationseinheiten benutzen Sie den Endpunkt Daten einer Behörde, zum Abrufen der Gebäude den Endpunkt Daten eines Behördengebäudes.

Page 74: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  74 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Body> <beh:GetDienststelleResponse xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <dienststelle id="2534"> <bezeichnung>Bad Kissingen</bezeichnung> <behoerdenart>Dienststelle</behoerdenart> <logo alt="Bad Kissingen Wappen" mimetype="image/jpeg" title="Bad Kissingen Wappen"> /9j/4AAQS ... //9k= </logo> <logoLangtext mimetype="image/gif" title="Bad Kissingen Wappen Geschichte"> R0lGODlhA ... AOw== </logoLangtext> <kurzbeschreibung> Die Große Kreisstadt Bad Kissingen ... </kurzbeschreibung> <langbeschreibung> Die Geschichte der Großen Kreisstadt Bad Kissingen reicht weit ins ... </langbeschreibung> <email>[email protected]</email> <deMail>[email protected]</deMail>  <website>http://www.badkissingen.de/</website> <behoerdengruppe>Ämter / Sachgebiete</behoerdengruppe> <sortierreihenfolge>0</sortierreihenfolge> <behoerdeZuordnungen> <behoerde id="52038"/> <behoerde id="53360"/> <behoerde id="52007"/> <behoerde id="58210"/> <behoerde id="58221"/> <behoerde id="52044"/> <behoerde id="58178"/> <behoerde id="52031"/> <behoerde id="58209"/> <behoerde id="52045"/> <behoerde id="52049"/> </behoerdeZuordnungen> <behoerdenGebaeudeZuordnungen> <gebaeude id="2534"/> </behoerdenGebaeudeZuordnungen> <bezeichnungZusatz>Große Kreisstadt</bezeichnungZusatz> <dienststellenschluessel>6721140</dienststellenschluessel> <dienststelleLfdNr>0</dienststelleLfdNr> <mitgliedVonVerwaltungsgemeinschaft></mitgliedVonVerwaltungsgemeinschaft/> </dienststelle> </beh:GetDienststelleResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Die meisten Elemente der Antwort sind selbsterklärend. Hier einige zusätzliche Hinweise.

Das Element behoerdenart kann folgende Inhalte haben:

• Dienststelle• Organisationseinheit• Sonstige Behörde

Page 75: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  75 von 187

Das Element behoerdengruppe kann folgende (relevante) Inhalte haben:

• Ämter / Sachgebiete• Einrichtungen• Geschäftsstellen• kommunale Beteiligungen / kommunale Unternehmen• Körperschaften, Anstalten und Stiftungen• Nachgeordnete Dienststellen• Sehenswürdigkeiten• Sonstiges• Versorgungsträger• Weitere Dienstsitze

Das Element sortierreihenfolge ist eine Ganzzahl, die die gewünschte Sortierreihenfolge von Geschwister-Organisationseinheiten bei der Anzeige festlegt.

Das Element dienststelleLfdNr ist 0, wenn es sich um eine Hauptdienststelle handelt. Bei Außenstellen ist es > 0 (laufende Nummerierung).

Das Element mitgliedVonVerwaltungsgemeinschaft enthält die Bezeichnung einer Verwaltungsgemeinschaft, wenn einer Gemeinde Mitglied einer solchen ist.

Daten einer Behörde

Eine Anfrage über diesen Endpunkt sieht folgendermaßen aus:

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <soapenv:Body> <beh:GetBehoerdeRequest> <behoerdeId>58221</behoerdeId> </beh:GetBehoerdeRequest> </soapenv:Body></soapenv:Envelope>

Als einzigen Parameter müssen Sie die Id einer Behörde angeben (Element behoerdeId). Diese Id erhalten sie zum Beispiel über einen vorherigen Aufruf des Endpunkts Daten einer Dienststelle. Aber auch die Antwort zu dieser Anfrage liefert gegebenenfalls Ids von untergeordneten Organisationseinheiten zurück (Element behoerdeZuordnungen).

In der Antwort finden Sie die Daten zur Behörde mit der angegebenen Id. Dazu gehören außerdem

Mögliche Fehler

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en"> Invalid parameter 'dienststellennummer'. Dienststelle mit der angegebenen Dienststellennummer nicht gefunden. </faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Page 76: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  76 von 187

• Verweise auf hierarchisch untergeordnete Organisationseinheiten (Element behoerdeZuordnungen) und

• Verweise auf die zugeordneten Gebäude (Element behoerdenGebaeudeZuordnungen)

Zum Abrufen der einzelnen zugeordneten Organisationseinheiten benutzen Sie den Endpunkt Daten einer Behörde, zum Abrufen der Gebäude den Endpunkt Daten eines Behördengebäudes.

Die Elemente entsprechen inhaltlich denen in der Antwort des Endpunkts Daten einer Dienststelle. Es fehlen jedoch die dienststellenspezifischen Elemente

• bezeichnungZusatz,• dienststellenschluessel,• dienststelleLfdNr und• mitgliedVonVerwaltungsgemeinschaft.

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <beh:GetBehoerdeResponse xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <behoerde id="58221"> <bezeichnung>Kindergärten</bezeichnung> <behoerdenart>Organisationseinheit</behoerdenart> <logo alt="Bad Kissingen Wappen" mimetype="image/jpeg" title="Bad Kissingen Wappen"> /9j/4AAQS ... //9k= </logo> </kurzbeschreibung> <website>http://www.badkissingen.de/stadtleben/arbeit/schulen/index.html</website> <behoerdengruppe>Einrichtungen</behoerdengruppe> <sortierreihenfolge>10</sortierreihenfolge> <behoerdenGebaeudeZuordnungen> <gebaeude id="2534"/> </behoerdenGebaeudeZuordnungen> </behoerde> </beh:GetBehoerdeResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Page 77: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  77 von 187

Daten eines Behördengebäudes

Eine Anfrage über diesen Endpunkt sieht folgendermaßen aus:

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <soapenv:Body> <beh:GetBehoerdenGebaeudeRequest> <behoerdeId>2534</behoerdeId> <gebaeudeId>2534</gebaeudeId> </beh:GetBehoerdenGebaeudeRequest> </soapenv:Body></soapenv:Envelope>

Sie müssen zwei verpflichtende Parameter (Elemente behoerdeId und gebaeudeId) angeben. Es genügt nicht, nur die Id eines Gebäudes bereitzustellen, weil im BayernPortal ein Gebäude typischerweise mehreren Behörden zugeordnet ist. Sie fordern also mit diesem Endpunkt eigentlich ein Gebäude im Kontext seiner Behörden-Zuordnung an.In der Antwort sind die Elemente oeffnungszeiten und behoerdenAnsprechpartnerZuordnungen für dieses Gebäude nur bezüglich dieser Behördenzuordnung (Attribut behoerdeId) gültig. Für die Zuordnung des gleichen Gebäudes zu einer anderen Behörde kann es andere Ergebnisse geben.

Im BayernPortal gibt es die Möglichkeit, die Telefonnummer und Faxnummer eines Gebäudes für bestimmte Behördenzuordnungen zu überschreiben (Seite "Abweichende Telefonnummer"). Falls ein Redakteur eine der dort verfügbaren Optionen gewählt hat, gelten die Werte der Elemente

Mögliche Fehler

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en"> Invalid parameter. Behörde mit der angegebenen Id nicht gefunden. </faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en"> Invalid parameter. Behörde mit dieser Id ist keine Dienststelle oder Organisationseinheit oder sonstige Behörde. </faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Page 78: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  78 von 187

• telefonOrtsvorwahl• telefonAnlage• telefonDurchwahl• faxOrtsvorwahl• faxAnlage• faxDurchwahl

ebenfalls nur für die Zuordnung des Gebäudes zur angegebenen Behörde.

In der Antwort finden Sie neben den Gebäudedaten auch

• Verweise auf die zugeordneten Ansprechpartner (Element behoerdenAnsprechpartnerZuordnungen)• Öffnungszeiten des Gebäudes für die zugeordnete Behörde (Element oeffnungszeiten)

Die Öffnungszeiten können im BayernPortal als Zeitangabe für einzelne Wochentage (Element zeitangabe) und/oder als freies Textfeld (Element sonderzeiten) gespeichert werden. Ein zusätzliches Flag (Element nachVereinbarung) kann anzeigen, dass Termine auch nach Vereinbarung angeboten werden.

Page 79: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  79 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <beh:GetBehoerdenGebaeudeResponse xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <BehoerdenGebaeude behoerdeId="2534" gebaeudeId="2534"> <bezeichnung>Rathaus Bad Kissingen</bezeichnung> <hausanschriftPLZ>97688</hausanschriftPLZ> <hausanschriftOrt>Bad Kissingen</hausanschriftOrt> <hausanschriftStrasse>Rathausplatz 1</hausanschriftStrasse> <postanschriftPLZ>97672</postanschriftPLZ> <postanschriftOrt>Bad Kissingen</postanschriftOrt> <postanschriftStrasse>Postfach 2260</postanschriftStrasse> <logo mimetype="image/jpeg" title="Rathaus"> /9j/4AAQS ... //9k= </logo> <sortierreihenfolge>100</sortierreihenfolge> <telefonLandvorwahl>49</telefonLandvorwahl> <telefonOrtsvorwahl>0971</telefonOrtsvorwahl> <telefonAnlage>807</telefonAnlage> <telefonDurchwahl>0</telefonDurchwahl> <faxLandvorwahl>49</faxLandvorwahl> <faxOrtsvorwahl>0971</faxOrtsvorwahl> <faxAnlage>807</faxAnlage> <faxDurchwahl>4444</faxDurchwahl> <oeffnungszeiten> <nachVereinbarung>true</nachVereinbarung> <sonderzeiten>Sie können mit uns auch am Samstag einen Termin vereinbaren.</sonderzeiten> <oeffnungszeit> <zeitangabe> <typ>MO</typ> <vonVormittags>08:00</vonVormittags> <bisVormittags>12:00</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>16:00</bisNachmittags> </zeitangabe> </oeffnungszeit> <oeffnungszeit> <zeitangabe> <typ>DI</typ> <vonVormittags>08:00</vonVormittags> <bisVormittags>12:00</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>16:00</bisNachmittags> </zeitangabe> </oeffnungszeit> <oeffnungszeit> <zeitangabe> <typ>MI</typ> <vonVormittags>08:00</vonVormittags> <bisVormittags>12:00</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>16:00</bisNachmittags> </zeitangabe>

Page 80: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  80 von 187

</oeffnungszeit> <oeffnungszeit> <zeitangabe> <typ>DO</typ> <vonVormittags>08:00</vonVormittags> <bisVormittags>12:00</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>16:00</bisNachmittags> </zeitangabe> </oeffnungszeit> <oeffnungszeit> <zeitangabe> <typ>FR</typ> <vonVormittags>08:00</vonVormittags> <bisVormittags>12:30</bisVormittags> </zeitangabe> </oeffnungszeit> </oeffnungszeiten> <behoerdenAnsprechpartnerZuordnungen> <ansprechpartner id="37535"/> </behoerdenAnsprechpartnerZuordnungen> </BehoerdenGebaeude> </beh:GetBehoerdenGebaeudeResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Daten eines Behördenansprechpartners

Eine Anfrage über diesen Endpunkt sieht folgendermaßen aus:

Mögliche Fehler

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en"> Invalid parameter. Gebäude mit der angegebenen Id nicht gefunden. </faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en"> Invalid parameter. Gebäude ist der Behörde mit der angegebenen Id nicht zugeordnet. </faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Page 81: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  81 von 187

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <soapenv:Header/> <soapenv:Body> <beh:GetBehoerdenAnsprechpartnerRequest> <behoerdeId>2534</behoerdeId> <gebaeudeId>2534</gebaeudeId> <ansprechpartnerId>37535</ansprechpartnerId> </beh:GetBehoerdenAnsprechpartnerRequest> </soapenv:Body></soapenv:Envelope>

Sie müssen drei verpflichtende Parameter (Elemente behoerdeId, gebaeudeId und ansprechpartnerId) angeben. Sie fordern demnach mit diesem Endpunkt die Daten eines Ansprechpartner im Kontext seiner Behörden- und Gebäudezuordnung an.Die persönlichen Daten eines Ansprechpartners sind natürlich bei jeder Gebäude- und Behördenzuordnung identisch. Das gilt aber nicht zwingend für die Sprechzeiten. Diese gelten nur im angegebenen Kontext.

Die Angabe zu Telefon und Fax werden bei Ansprechpartnern noch um das Elemente zum Mobiltelefon (mobilLandvorwahl, mobilLandvorwahl und mobilNummer) ergänzt.

Page 82: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  82 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <beh:GetBehoerdenAnsprechpartnerResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <ansprechpartner ansprechpartnerId="37535" behoerdeId="2534" gebaeudeId="2534"> <anrede/> <logo alt="Oberbürgermeister der Stadt Bad Kissingen seit 01.05.2008" mimetype="image/jpeg" title="Oberbürgermeister Hans Mustermann"> /9j/4AAQ ... //2Q== </logo> <vorname>Hans</vorname> <nachname>Mustermann</nachname> <funktion>Oberbürgermeister</funktion> <stellenbezeichnung></stellenbezeichnung> <email>[email protected]</email> <zimmer>14</zimmer> <sortierreihenfolge>97</sortierreihenfolge> <telefonLandvorwahl>49</telefonLandvorwahl> <telefonOrtsvorwahl>0971</telefonOrtsvorwahl> <telefonAnlage>807</telefonAnlage> <telefonDurchwahl>1000</telefonDurchwahl> <faxLandvorwahl>49</faxLandvorwahl> <faxOrtsvorwahl>0971</faxOrtsvorwahl> <faxAnlage>807</faxAnlage> <faxDurchwahl>2009</faxDurchwahl> <mobilLandvorwahl></mobilLandvorwahl> <mobilOrtsvorwahl></mobilOrtsvorwahl> <mobilNummer></mobilNummer> <sprechzeiten> <nachVereinbarung>true</nachVereinbarung> <sonderzeiten> Sie können mit mir auch telefonisch einen Termin vereinbaren. </sonderzeiten> <oeffnungszeit> <zeitangabe> <typ>DI</typ> <vonVormittags>08:00</vonVormittags> <bisVormittags>12:00</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>16:00</bisNachmittags> </zeitangabe> </oeffnungszeit> <oeffnungszeit> <zeitangabe> <typ>MI</typ> <vonVormittags>08:00</vonVormittags> <bisVormittags>12:00</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>16:00</bisNachmittags> </zeitangabe> </oeffnungszeit> <oeffnungszeit> <zeitangabe> <typ>DO</typ>

Page 83: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  83 von 187

<vonVormittags>08:00</vonVormittags> <bisVormittags>12:00</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>16:00</bisNachmittags> </zeitangabe> </oeffnungszeit> <oeffnungszeit> </sprechzeiten> </ansprechpartner> </beh:GetBehoerdenAnsprechpartnerResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Liste der Ansprechpartner einer Behörde

Eine Anfrage über diesen Endpunkt sieht folgendermaßen aus:

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <soapenv:Header/> <soapenv:Body> <beh:GetAlleAnsprechpartnerRequest> <behoerdeId>4442</behoerdeId> </beh:GetAlleAnsprechpartnerRequest> </soapenv:Body></soapenv:Envelope>

Mögliche Fehler

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en"> Invalid parameter. Ansprechpartner mit der angegebenen Id nicht gefunden. </faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en"> Invalid parameter. Ansprechpartner mit der angegebenen Id ist der Behörde oder dem Gebäude mit der angegebenen Id nicht zugeordnet. </faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Page 84: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  84 von 187

Als Parameter müssen Sie die Id einer Behörde (Dienststelle oder Organsationseinheit) angeben.

In der Antwort finden Sie eine Liste von ansprechpartner-Elementen. Es werden alle Ansprechpartner zurückgeliefert, die der Behörde oder ihren untergeordneten Organisationseinheiten zugeordnet sind. Für jeden Ansprechpartner werden die Ids der Behörde (behoerdeId) und des Gebäudes (gebaeudeId) mitgeliefert, so dass eine Verknüpfung mit der Behörde und dem Gebäude möglich ist.

Da jeder Ansprechpartner mehreren Behörden (Organisationseinheiten) und Gebäuden zugeordnet sein kann, ist es typisch, dass Ansprechpartner in der Antwort mehrfach geliefert werden.

Page 85: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  85 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <beh:GetAlleAnsprechpartnerResponse xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <ansprechpartner ansprechpartnerId="64008"> <anrede>Frau</anrede> <vorname>Heidelore</vorname> <nachname>Adler</nachname> <stellenbezeichnung>Kasse</stellenbezeichnung> <email>[email protected]</email> <website>http://www.weiler-simmerberg.de</website> <zimmer>11</zimmer> <behoerdeId>4442</behoerdeId> <behoerdeBezeichnung>Markt Weiler-Simmerberg</behoerdeBezeichnung> <gebaeudeId>4442</gebaeudeId> <gebaeudeBezeichnung>Gemeindeverwaltung</gebaeudeBezeichnung> </ansprechpartner> <ansprechpartner ansprechpartnerId="64008"> <anrede>Frau</anrede> <vorname>Heidelore</vorname> <nachname>Adler</nachname> <stellenbezeichnung>Kasse</stellenbezeichnung> <email>[email protected]</email> <website>http://www.weiler-simmerberg.de</website> <zimmer>11</zimmer> <behoerdeId>66452</behoerdeId> <behoerdeBezeichnung>Finanzverwaltung</behoerdeBezeichnung> <gebaeudeId>4442</gebaeudeId> <gebaeudeBezeichnung>Gemeindeverwaltung</gebaeudeBezeichnung> </ansprechpartner> <ansprechpartner ansprechpartnerId="64009"> <anrede>Herr</anrede> <vorname>Christoph</vorname> <nachname>Berger</nachname> <stellenbezeichnung>Rentenamt</stellenbezeichnung> <email>[email protected]</email> <website>http://www.weiler-simmerberg.de</website> <zimmer>11</zimmer> <behoerdeId>66453</behoerdeId> <behoerdeBezeichnung>Kasse</behoerdeBezeichnung> <gebaeudeId>4442</gebaeudeId> <gebaeudeBezeichnung>Gemeindeverwaltung</gebaeudeBezeichnung> </ansprechpartner> <ansprechpartner ansprechpartnerId="64009"> <anrede>Herr</anrede> <vorname>Christoph</vorname> <nachname>Berger/nachname> <stellenbezeichnung>Rentenamt</stellenbezeichnung> <email>[email protected]</email> <website>http://www.weiler-simmerberg.de</website> <zimmer>11</zimmer> <behoerdeId>66452</behoerdeId> <behoerdeBezeichnung>Finanzverwaltung</behoerdeBezeichnung> <gebaeudeId>4442</gebaeudeId>

Page 86: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  86 von 187

<gebaeudeBezeichnung>Gemeindeverwaltung</gebaeudeBezeichnung> </ansprechpartner> </beh:GetAlleAnsprechpartnerResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Die Elemente und Attribute haben folgende Bedeutung:

Element Attribut Beschreibung

ansprechpartner Container für die Daten eines Ansprechpartners

anrede Anrede des Ansprechpartners (Herr, Frau oder leer)

vorname Vorname des Ansprechpartners

nachname Nachname des Ansprechpartners

stellenbezeichnung Bezeichnung der Stelle des Ansprechpartners (z.B. Leitung Bauverwaltung, Öffentlichkeitsarbeit)

email E-Mail-Adresse des Ansprechpartners

website Web-Adresse des Ansprechpartners oder der Dienststelle

zimmer Zimmernummer des Ansprechpartners

behoerdeId Id der Behörde/Organisationseinheit des Ansprechpartners

behoerdeBezeichnung Bezeichnung der Behörde / Organisationseinheit des Ansprechpartners

gebaeudeId Id des Gebäudes des Ansprechpartners

gebaeudeBezeichnung Bezeichnung des Gebäudes des Ansprechpartners

Liste der Leistungen einer Behörde

Eine Anfrage über diesen Endpunkt sieht folgendermaßen aus:

Page 87: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  87 von 187

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <soapenv:Header/> <soapenv:Body> <beh:GetBehoerdenLeistungenRequest> <behoerdeId>4442</behoerdeId> <nurDirekteLeistungszuordnungen>true</nurDirekteLeistungszuordnungen>  </beh:GetBehoerdenLeistungenRequest> </soapenv:Body></soapenv:Envelope>

Als Parameter müssen Sie die Id einer Behörde (Dienststelle oder Organsationseinheit) angeben. Darüberhinaus können Sie als zweiten Parameter das Element nurDirekteLeistungszuordnungen angeben. Hier wird ein boolscher Wert erwartet ( true oder false). Wenn Sie true angeben, werden nur Leistungen geliefert, die der Behörde (Dienststelle oder Organsationseinheit)  direkt zugeordnet sind. Bei false oder wenn Sie das Element weglassen, werden darüber hinaus auch Leistungen von nachgeordneten Organisationseinheiten berücksichtigt.

In der Antwort finden Sie eine Liste von leistung-Elementen.

Das Attribut id können Sie als Referenz-Id auf die Leistung verwenden. Geben Sie es als Parameter an, wenn Sie die Leistungsbeschreibung über den Endpunkt Abrufen einer kompletten Leistungsbeschreibung (mit regionalen Ergänzungen und Zuständigkeiten) abrufen möchten.

Für jede Leistung wird neben der Id das Element bezeichnung geliefert, das in einer Leistungsübersicht zur Behörde als Verlinkungstext benutzt werden kann.

Page 88: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  88 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <beh:GetBehoerdenLeistungenResponse xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <leistung id="3581"> <bezeichnung>Abfallwirtschaft in Gemeinden</bezeichnung> </leistung> <leistung id="1845"> <bezeichnung>Abmarkung gemeindlicher Grundstücke</bezeichnung> </leistung> <leistung id="2861"> <bezeichnung>Absonderungsmaßnahmen bei übertragbaren Krankheiten</bezeichnung> </leistung> <leistung id="592"> <bezeichnung>Abwasserentsorgung</bezeichnung> </leistung> <leistung id="25417"> <bezeichnung>Abwasserentsorgung; Grundstücksanschluss Kanal</bezeichnung> </leistung> <leistung id="24737"> <bezeichnung>Abwassergebühren</bezeichnung> </leistung> <leistung id="25551"> <bezeichnung>Amtsblatt der Gemeinde</bezeichnung> </leistung> <leistung id="562"> <bezeichnung>Anmeldung der Eheschließung</bezeichnung> </leistung> <leistung id="25484"> ... </leistung> </beh:GetBehoerdenLeistungenResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Liste der Leistungen eines Ansprechpartners

Für eine Anfrage über diesen Endpunkt gibt es folgende Varianten:

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <soapenv:Header/> <soapenv:Body> <beh:GetAnsprechpartnerLeistungenRequest> <ansprechpartnerId>64008</ansprechpartnerId> </beh:GetAnsprechpartnerLeistungenRequest> </soapenv:Body></soapenv:Envelope>

Page 89: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  89 von 187

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <soapenv:Header/> <soapenv:Body> <beh:GetAnsprechpartnerLeistungenRequest> <ansprechpartnerId>64008</ansprechpartnerId> <nurDirekteLeistungszuordnungen>true</nurDirekteLeistungszuordnungen> </beh:GetAnsprechpartnerLeistungenRequest> </soapenv:Body></soapenv:Envelope>

Als Parameter müssen Sie in beiden Varianten die Id des Ansprechpartners angeben. Wenn Sie keine weiteren Parameter angegeben, erhalten Sie alle Leistungen zurück, die dem Ansprechpartner direkt oder indirekt zugeordnet sind (Standardverhalten dieses Endpunkts).

Wenn Sie nur die Leistungen haben möchten, die dem Ansprechpartner direkt zugeordnet sind, dann geben Sie bitte das zusätzliche Element nurDirekteLeistungszuordnungen mit dem Inhalt true an. Wenn Sie dieses Element mit dem Inhalt false belegen, dann können Sie es auch weglassen.

In der Antwort finden Sie eine Liste von leistung-Elementen.

Das Attribut id können Sie als Referenz auf die Leistung verwenden. Geben Sie es als Parameter an, wenn Sie die Leistungsbeschreibung über den Endpunkt Abrufen einer kompletten Leistungsbeschreibung (mit regionalen Ergänzungen und Zuständigkeiten) abrufen möchten.

Für jede Leistung wird neben der Id das Element bezeichnung geliefert, das in einer Leistungsübersicht zum Ansprechpartner als Verlinkungstext benutzt werden kann.

Was sind direkte und indirekte Aufgabenzuordnungen/Leistungszuordnungen?Im Redaktionssystem für Verwaltungsinformationen können Sie die Geschäftsverteilung in einer Dienststelle dadurch abbilden, dass Sie

• Aufgaben (Leistungen) den verscheidenen Organisationseinheiten zuordnen• Aufgaben (Leistungen) zusätzlich einzelnen Ansprechpartnern zuordnen

Wenn Sie die Aufgaben (Leistungen) ausschließlich Organisationseinheiten zuordnen, dann "erben" die Anprechpartner dieser Organisationseinheiten diese Aufgabenzuordnungen. D.h. alle Ansprechpartner in einer Organisationseinheit sind für alle Aufgaben dieser Organisationseinheit zuständig. Diese Aufgabenzuordnung bezeichnen wir hier als indirekt. Sie können sich dadurch viel redaktionelle Arbeit ersparen, aber die Aufgabenzuordnung ist eventuell nicht ganz so präzise abgebildet wie bei der direkten Aufgabenzuordnung an Ansprechpartner. Sobald Sie Aufgaben (Leistungen) explizit einzelnen Ansprechpartnern zuordnen, ist diese Zuordnung vorrangig. Wir bezeichnen sie hier als direkt. Wenn es Ansprechpartner gibt, denen eine Aufgabe (Leistung) direkt zugeordnet ist, dann gelten die anderen Ansprechpartner nicht mehr als zuständig, es sei denn, auch ihnen ist die Aufgabe direkt zugeordnet. Im Ergebnis setzen sich also direkte Aufgabenzuordnungen gegen indirekte Aufgabenzuordnungen immer durch.

Page 90: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  90 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <beh:GetAnsprechpartnerLeistungenResponse xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <leistung id="3554"> <bezeichnung>Kleineinleiterabgabe</bezeichnung> </leistung> <leistung id="27260"> <bezeichnung>Meldepflicht für Binnenschiffer und Seeleute</bezeichnung> </leistung> <leistung id="3522"> <bezeichnung>Messen</bezeichnung> </leistung> <leistung id="2827"> <bezeichnung>Miet- und Pachteinnahmen (Gemeinde)</bezeichnung> </leistung> <leistung id="3579"> <bezeichnung>öffentlicher Personennahverkehr; Tarifgestaltung, Haltestellenplanung</bezeichnung> </leistung> <leistung id="3578"> <bezeichnung>öffentlicher Personennahverkehr; Zuschüsse</bezeichnung> </leistung> <leistung id="1814"> <bezeichnung>Parkgebühren, Verordnung über</bezeichnung> </leistung> <leistung id="3566"> <bezeichnung>Schlachthof; Benutzungsbedingungen</bezeichnung> </leistung> <leistung id="3567"> <bezeichnung>Schlachthof; Benutzungsgebühren</bezeichnung> </leistung> <leistung id="3460"> <bezeichnung>Statistik (Gemeinde)</bezeichnung> </leistung> <leistung id="2842"> <bezeichnung>Zahlungsverkehr (Mahnung und Vollstreckung) - Gemeinde</bezeichnung> </leistung> </beh:GetAnsprechpartnerLeistungenResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Dienststellen

Liefert alle Dienststellen und ihre Außenstellen, auf die der Benutzer Zugriff hat.

Page 91: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  91 von 187

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <soapenv:Header/> <soapenv:Body> <beh:GetDienststellenRequest beh:full="false"> <dienststellenschluessel>0358143</dienststellenschluessel> </beh:GetDienststellenRequest> </soapenv:Body></soapenv:Envelope>

Das Attribut full ist optional. Wenn Sie es nicht angeben oder auf den Wert false setzen (Default), dann werden die Dienstellendaten in Kurzform geliefert.

Das Element dienststellenschluessel ist ebenfalls optional. Wenn Sie einen gültigen 7-stelligen numerischen Dienststellenschlüssel angeben, dann wird die Dienststelle mit diesem Dienststellenschlüssel und alle ihre Außenstellen geliefert. Wenn Sie dieses Element weglassen, werden alle Dienststellen und Außenstellen geliefert, auf die der Benutzer Zugriff hat.

Die Antwort (Kurzform) sieht folgendermaßen aus:

Page 92: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  92 von 187

Response (Kurzform)

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <beh:GetDienststellenResponse xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <beh:dienststellen> <dienststelle id="61583"> <bezeichnung>Landratsamt Neustadt a.d.Aisch-Bad Windsheim Dienststelle Bad Windsheim</bezeichnung> <behoerdenart>Dienststelle</behoerdenart> <email>[email protected]</email> <website>http://www.kreis-nea.de</website> <behoerdengruppe>Weitere Dienstorte</behoerdengruppe> <sortierreihenfolge>0</sortierreihenfolge> <dienststellenschluessel>358143</dienststellenschluessel> <dienststelleLfdNr>3</dienststelleLfdNr> </dienststelle> <dienststelle id="61581"> <bezeichnung>Landratsamt Neustadt a.d.Aisch-Bad Windsheim Dienststelle Neustadt a.d.Aisch Konrad-Adenauer-Str. 2</bezeichnung> <behoerdenart>Dienststelle</behoerdenart> <email>[email protected]</email> <website>http://www.kreis-nea.de</website> <behoerdengruppe>Weitere Dienstorte</behoerdengruppe> <sortierreihenfolge>0</sortierreihenfolge> <dienststellenschluessel>358143</dienststellenschluessel> <dienststelleLfdNr>1</dienststelleLfdNr> </dienststelle> <dienststelle id="61584"> <bezeichnung>Landratsamt Neustadt a.d.Aisch-Bad Windsheim Dienststelle Scheinfeld</bezeichnung> <behoerdenart>Dienststelle</behoerdenart> <email>[email protected]</email> <website>http://www.steigerwald-info.de</website> <behoerdengruppe>Weitere Dienstorte</behoerdengruppe> <sortierreihenfolge>0</sortierreihenfolge> <dienststellenschluessel>358143</dienststellenschluessel> <dienststelleLfdNr>4</dienststelleLfdNr> </dienststelle> <dienststelle id="61585"> <bezeichnung>Landratsamt Neustadt a.d.Aisch-Bad Windsheim Dienststelle Uffenheim</bezeichnung> <behoerdenart>Dienststelle</behoerdenart> <email>[email protected]</email> <website>http://www.kreis-nea.de</website> <behoerdengruppe>Weitere Dienstorte</behoerdengruppe> <sortierreihenfolge>0</sortierreihenfolge> <dienststellenschluessel>358143</dienststellenschluessel> <dienststelleLfdNr>5</dienststelleLfdNr> </dienststelle> <dienststelle id="2400"> <bezeichnung>Landratsamt Neustadt a.d.Aisch-Bad Windsheim</bezeichnung> <behoerdenart>Dienststelle</behoerdenart> <email>[email protected]</email> <deMail>[email protected]</deMail> <website>http://www.kreis-nea.de</website>

Page 93: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  93 von 187

<behoerdengruppe>Ämter / Sachgebiete</behoerdengruppe> <sortierreihenfolge>0</sortierreihenfolge> <dienststellenschluessel>358143</dienststellenschluessel> <dienststelleLfdNr>0</dienststelleLfdNr> </dienststelle> </bhe:dienststellen> </beh:GetDienststellenResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Behörden

Liefert alle Behörden, auf die der Benutzer Zugriff hat.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <soapenv:Header/> <soapenv:Body> <beh:GetBehoerdenRequest beh:full="false" /> </soapenv:Body></soapenv:Envelope>

Das Attribut full ist optional. Wenn Sie es nicht angeben oder auf den Wert false setzen (Default), dann werden die Behördendaten in Kurzform geliefert.

Die Antwort (Kurzform) sieht folgendermaßen aus:

Page 94: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  94 von 187

Response (Kurzform)

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <beh:GetBehoerdenResponse xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <beh:behoerden> <behoerde id="11289"> <bezeichnung>Abfallwirtschaft</bezeichnung> <behoerdenart>Organisationseinheit</behoerdenart> <behoerdengruppe>Ämter / Sachgebiete</behoerdengruppe> <sortierreihenfolge>34</sortierreihenfolge> </behoerde> <behoerde id="67937"> <bezeichnung>Abteilung 1 - Zentrale Angelegenheiten</bezeichnung> <behoerdenart>Organisationseinheit</behoerdenart> <behoerdengruppe>Ämter / Sachgebiete</behoerdengruppe> <sortierreihenfolge>10</sortierreihenfolge> </behoerde> <behoerde id="67938"> <bezeichnung>Abteilung 2 - Kommunale und soziale Angelegenheiten</bezeichnung> <behoerdenart>Organisationseinheit</behoerdenart> <behoerdengruppe>Ämter / Sachgebiete</behoerdengruppe> <sortierreihenfolge>20</sortierreihenfolge> </behoerde> <behoerde id="67939"> <bezeichnung>Abteilung 3 - Öffentliche Sicherheit und Ordnung</bezeichnung> <behoerdenart>Organisationseinheit</behoerdenart> <behoerdengruppe>Ämter / Sachgebiete</behoerdengruppe> <sortierreihenfolge>30</sortierreihenfolge> </behoerde> <behoerde id="67940"> <bezeichnung>Abteilung 4 - Bau, Umwelt- und Naturschutz</bezeichnung> <behoerdenart>Organisationseinheit</behoerdenart> <behoerdengruppe>Ämter / Sachgebiete</behoerdengruppe> <sortierreihenfolge>40</sortierreihenfolge> </behoerde>   <behoerde id="2401"> <bezeichnung>Abteilung 5 - Gesundheitsamt</bezeichnung> <behoerdenart>Organisationseinheit</behoerdenart> <behoerdengruppe>Ämter / Sachgebiete</behoerdengruppe> <sortierreihenfolge>50</sortierreihenfolge> </behoerde> <behoerde id="11837"> <bezeichnung>Abteilung 6 - Veterinäramt</bezeichnung> <behoerdenart>Organisationseinheit</behoerdenart> <behoerdengruppe>Ämter / Sachgebiete</behoerdengruppe> <sortierreihenfolge>60</sortierreihenfolge> </behoerde> <behoerde id="2400"> <bezeichnung>Landratsamt Neustadt a.d.Aisch-Bad Windsheim</bezeichnung> <behoerdenart>Dienststelle</behoerdenart> <email>[email protected]</email> <deMail>[email protected]</deMail> <website>http://www.kreis-nea.de</website> <behoerdengruppe>Ämter / Sachgebiete</behoerdengruppe>

Page 95: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  95 von 187

<sortierreihenfolge>0</sortierreihenfolge> </behoerde> <behoerde id="61583"> <bezeichnung>Landratsamt Neustadt a.d.Aisch-Bad Windsheim Dienststelle Bad Windsheim</bezeichnung> <behoerdenart>Dienststelle</behoerdenart> <email>[email protected]</email> <website>http://www.kreis-nea.de</website> <behoerdengruppe>Weitere Dienstorte</behoerdengruppe> <sortierreihenfolge>0</sortierreihenfolge> </behoerde> <behoerde id="61581"> <bezeichnung>Landratsamt Neustadt a.d.Aisch-Bad Windsheim Dienststelle Neustadt a.d.Aisch Konrad-Adenauer-Str. 2</bezeichnung> <behoerdenart>Dienststelle</behoerdenart> <email>[email protected]</email> <website>http://www.kreis-nea.de</website> <behoerdengruppe>Weitere Dienstorte</behoerdengruppe> <sortierreihenfolge>0</sortierreihenfolge> </behoerde> <behoerde id="61584"> <bezeichnung>Landratsamt Neustadt a.d.Aisch-Bad Windsheim Dienststelle Scheinfeld</bezeichnung> <behoerdenart>Dienststelle</behoerdenart> <email>[email protected]</email> <website>http://www.steigerwald-info.de</website> <behoerdengruppe>Weitere Dienstorte</behoerdengruppe> <sortierreihenfolge>0</sortierreihenfolge> </behoerde> </beh:behoerden> </beh:GetBehoerdenResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Ansprechpartner

Beispielanfrage mit Ergebnis in Kurzform (Attribut full="false")

Liefert alle Ansprechpartner, auf die der Benutzer Zugriff hat. Per Voreinstellung (Attribut full= "false") wird eine Kurzform der Ansprechpartnerdaten geliefert (ohne Logo, Kommunikationsdaten, Sprechzeiten und Leistungen).

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <soapenv:Header/> <soapenv:Body> <beh:GetAnsprechpartnerRequest beh:full="false" /> </soapenv:Body></soapenv:Envelope>

Eine Antwort in Kurzform sieht folgendermaßen aus:

Page 96: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  96 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <beh:GetAnsprechpartnerResponse xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <beh:ansprechpartner> <ap ansprechpartnerId="109732"> <anrede/> <akademischerGrad>Dr.</akademischerGrad> <vorname>Anton</vorname> <nachname>Achrainer</nachname> <funktion>Sachgebietsleiter</funktion> <stellenbezeichnung/> <email/> <website/> <zimmer>A 102</zimmer> <sortierreihenfolge>0</sortierreihenfolge> <behoerdeId>11168</behoerdeId> <behoerdeBezeichnung>Naturschutz / Gartenbau und Landschaftspflege</behoerdeBezeichnung> <gebaeudeId>2400</gebaeudeId> <gebaeudeBezeichnung>Landratsamt Neustadt a.d.Aisch-Bad Windsheim</gebaeudeBezeichnung> </ap> <ap ansprechpartnerId="39853"> <anrede/> <akademischerGrad>Dr.</akademischerGrad> <vorname>Anton</vorname> <nachname>Achrainer</nachname> <funktion>Abteilungsleiter</funktion> <stellenbezeichnung/> <email/> <website/> <zimmer>A 103</zimmer> <sortierreihenfolge>0</sortierreihenfolge> <behoerdeId>67940</behoerdeId> <behoerdeBezeichnung>Abteilung 4 - Bau, Umwelt- und Naturschutz</behoerdeBezeichnung> <gebaeudeId>2400</gebaeudeId> <gebaeudeBezeichnung>Landratsamt Neustadt a.d.Aisch-Bad Windsheim</gebaeudeBezeichnung> </ap> <ap ansprechpartnerId="6317"> <anrede/> <vorname>Anneliese</vorname> <nachname>Ziglitz</nachname> <funktion>- Keine Angabe -</funktion> <stellenbezeichnung/> <email/> <website/> <zimmer>A 022</zimmer> <sortierreihenfolge>0</sortierreihenfolge> <behoerdeId>11192</behoerdeId> <behoerdeBezeichnung>Kreiskasse</behoerdeBezeichnung> <gebaeudeId>2400</gebaeudeId>

Page 97: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  97 von 187

<gebaeudeBezeichnung>Landratsamt Neustadt a.d.Aisch-Bad Windsheim</gebaeudeBezeichnung> </ap> <ap ansprechpartnerId="50190"> <anrede/> <vorname>Michael</vorname> <nachname>Zinser</nachname> <funktion>- Keine Angabe -</funktion> <stellenbezeichnung/> <email/> <website/> <zimmer>B 048</zimmer> <sortierreihenfolge>0</sortierreihenfolge> <behoerdeId>11287</behoerdeId> <behoerdeBezeichnung>Allgemeiner Sozialdienst - ASD</behoerdeBezeichnung> <gebaeudeId>2400</gebaeudeId> <gebaeudeBezeichnung>Landratsamt Neustadt a.d.Aisch-Bad Windsheim</gebaeudeBezeichnung> </ap> </beh:ansprechpartner> </beh:GetAnsprechpartnerResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Beispielanfrage für einen bestimmten Ansprechpartner in Langform (Attribut full="true")

Liefert die vollständigen Daten (auch Logo, Kommunikationsdaten, Sprechzeiten und Leistungen) zum Ansprechpartner mit der angegebenen ID.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <soapenv:Header/> <soapenv:Body> <beh:GetAnsprechpartnerRequest beh:full="true"> <ansprechpartnerId>64000</ansprechpartnerId> </beh:GetAnsprechpartnerRequest> </soapenv:Body></soapenv:Envelope>

Das Element ansprechpartnerId ist optional. Wenn Sie die numerische Id eines Ansprechpartners angeben, dann werden nur die Daten zu diesem Ansprechpartner geliefert. Voraussetzung ist in jedem Fall, dass Ihre Benutzerkennung auf die Daten des Ansprechpartners Zugriff hat.

Hinweis:Beachten Sie, dass der Ansprechpartner deshalb mehrfach vorkommt, weil er mehreren Organisationseinheiten (Markt Weiler-Simmerberg, Gemeindeverwaltung, Finanzverwaltung) der Dienststelle mit unterschiedlichen Sprechzeiten zugeordnet ist.

Die Antwort in Langform (mit Logo, Kommunikationsdaten, Sprechzeiten und Leistungen) sieht folgendermaßen aus:

Page 98: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  98 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <beh:GetAnsprechpartnerResponse xmlns:beh="http://lfstad.bayern.de/baybw/allgemein/v3/behoerden"> <beh:ansprechpartner> <ap ansprechpartnerId="64008"> <anrede>Frau</anrede> <vorname>Anna</vorname> <nachname>Birger</nachname> <funktion>- Keine Angabe -</funktion> <stellenbezeichnung>Kasse</stellenbezeichnung> <email>[email protected]</email> <website>http://www.weiler-simmerberg.de</website> <zimmer>11</zimmer> <sortierreihenfolge>0</sortierreihenfolge> <behoerdeId>66453</behoerdeId> <behoerdeBezeichnung>Kasse</behoerdeBezeichnung> <gebaeudeId>4442</gebaeudeId> <gebaeudeBezeichnung>Gemeindeverwaltung</gebaeudeBezeichnung> <logo alt="..." mimetype="image/jpeg" quelle="..." title="...">/9j/4AAQSkZJRgABAQEDjgOOAAD...SpQP//Z</logo> <telefonLandvorwahl>49</telefonLandvorwahl> <telefonOrtsvorwahl>08387</telefonOrtsvorwahl> <telefonAnlage>391</telefonAnlage> <telefonDurchwahl>32</telefonDurchwahl> <faxLandvorwahl>49</faxLandvorwahl> <faxOrtsvorwahl>08387</faxOrtsvorwahl> <faxAnlage>391</faxAnlage> <faxDurchwahl>7532</faxDurchwahl> <sprechzeiten> <nachVereinbarung>false</nachVereinbarung> <sonderzeiten></sonderzeiten> </sprechzeiten> <leistungen> <lg id="2842"> <bezeichnung>Mahnung und Vollstreckung; Kommunal</bezeichnung> </lg> <lg id="2827"> <bezeichnung>Miet- und Pachteinnahmen; Gemeinde</bezeichnung> </lg> <lg id="3460"> <bezeichnung>Statistiken; Durchführung durch die Gemeinde</bezeichnung> </lg> </leistungen> </ap> <ap ansprechpartnerId="64008"> <anrede>Frau</anrede> <vorname>Anna</vorname> <nachname>Birger</nachname> <funktion>- Keine Angabe -</funktion> <stellenbezeichnung>Kasse</stellenbezeichnung> <email>[email protected]</email> <website>http://www.weiler-simmerberg.de</website> <zimmer>11</zimmer>

Page 99: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  99 von 187

<behoerdeId>4442</behoerdeId> <behoerdeBezeichnung>Markt Weiler-Simmerberg</behoerdeBezeichnung> <gebaeudeId>4442</gebaeudeId> <gebaeudeBezeichnung>Gemeindeverwaltung</gebaeudeBezeichnung> <logo alt="..." mimetype="image/jpeg" quelle="..." title="...">/9j/4AAQSkZJRgABAQEDjgOOAAD...SpQP//Z</logo> <telefonLandvorwahl>49</telefonLandvorwahl> <telefonOrtsvorwahl>08387</telefonOrtsvorwahl> <telefonAnlage>391</telefonAnlage> <telefonDurchwahl>32</telefonDurchwahl> <faxLandvorwahl>49</faxLandvorwahl> <faxOrtsvorwahl>08387</faxOrtsvorwahl> <faxAnlage>391</faxAnlage> <faxDurchwahl>7532</faxDurchwahl> <sprechzeiten> <nachVereinbarung>true</nachVereinbarung> <sonderzeiten/> <oeffnungszeit> <zeitangabe> <typ>MO</typ> <vonVormittags>8:00</vonVormittags> <bisVormittags>12:15</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>16:00</bisNachmittags> </zeitangabe> </oeffnungszeit> <oeffnungszeit> <zeitangabe> <typ>DI</typ> <vonVormittags>8:00</vonVormittags> <bisVormittags>12:15</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>16:00</bisNachmittags> </zeitangabe> </oeffnungszeit> <oeffnungszeit> <zeitangabe> <typ>MI</typ> <vonVormittags>8:00</vonVormittags> <bisVormittags>12:15</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>18:00</bisNachmittags> </zeitangabe> </oeffnungszeit> <oeffnungszeit> <zeitangabe> <typ>DO</typ> <vonVormittags>8:00</vonVormittags> <bisVormittags>12:15</bisVormittags> <vonNachmittags>14:00</vonNachmittags> <bisNachmittags>16:00</bisNachmittags> </zeitangabe> </oeffnungszeit> <oeffnungszeit> <zeitangabe> <typ>FR</typ> <vonVormittags>8:00</vonVormittags> <bisVormittags>12:15</bisVormittags> <vonNachmittags/>

Page 100: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  100 von 187

<bisNachmittags/> </zeitangabe> </oeffnungszeit> </sprechzeiten> <leistungen> <lg id="2842"> <bezeichnung>Mahnung und Vollstreckung; Kommunal</bezeichnung> </lg> <lg id="2827"> <bezeichnung>Miet- und Pachteinnahmen; Gemeinde</bezeichnung> </lg> <lg id="3460"> <bezeichnung>Statistiken; Durchführung durch die Gemeinde</bezeichnung> </lg> </leistungen> </ap> <ap ansprechpartnerId="64008"> <anrede>Frau</anrede> <vorname>Anna</vorname> <nachname>Birger</nachname> <funktion>- Keine Angabe -</funktion> <stellenbezeichnung>Kasse</stellenbezeichnung> <email>[email protected]</email> <website>http://www.weiler-simmerberg.de</website> <zimmer>11</zimmer> <sortierreihenfolge>0</sortierreihenfolge> <behoerdeId>66452</behoerdeId> <behoerdeBezeichnung>Finanzverwaltung</behoerdeBezeichnung> <gebaeudeId>4442</gebaeudeId> <gebaeudeBezeichnung>Gemeindeverwaltung</gebaeudeBezeichnung> <logo alt="..." mimetype="image/jpeg" quelle="..." title="...">/9j/4AAQSkZJRgABAQEDjgOOAAD...SpQP//Z</logo>  <telefonLandvorwahl>49</telefonLandvorwahl> <telefonOrtsvorwahl>08387</telefonOrtsvorwahl> <telefonAnlage>391</telefonAnlage> <telefonDurchwahl>32</telefonDurchwahl> <faxLandvorwahl>49</faxLandvorwahl> <faxOrtsvorwahl>08387</faxOrtsvorwahl> <faxAnlage>391</faxAnlage> <faxDurchwahl>7532</faxDurchwahl> <sprechzeiten> <nachVereinbarung>false</nachVereinbarung> <sonderzeiten></sonderzeiten> </sprechzeiten> <leistungen> <lg id="2842"> <bezeichnung>Mahnung und Vollstreckung; Kommunal</bezeichnung> </lg> <lg id="2827"> <bezeichnung>Miet- und Pachteinnahmen; Gemeinde</bezeichnung> </lg> <lg id="3460"> <bezeichnung>Statistiken; Durchführung durch die Gemeinde</bezeichnung> </lg> </leistungen> </ap>  </beh:ansprechpartner>

Page 101: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  101 von 187

</beh:GetAnsprechpartnerResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Lebenslagen (Version 3)Dieser Web Service erfordert eine Authentifizierung durch den Client.

Die Schnittstellenbeschreibung finden Sie in folgender Web-Services-Description-Language-Datei (WSDL):

https://www.baybw-services.bayern.de/services/allgemein/allgemein-lebenslagen.v3.wsdl

Der Web Service bietet folgende Schnittstellen-Endpunkte an:

Abrufen aller Lebenslagen

Über diesen Schnittstellen-Endpunkt können alle Lebenslagen abgefragt werden, die es im Lebenslagenkatalog des BayernPortal gibt.

Der Katalog unterscheidet drei Gruppen von Lebenslagen:

• Bürger• Unternehmer• Verwaltung

Sie können an der ersten Ziffer in der Id der Lebenslage erkennen, zu welcher Gruppe sie gehört ( 1=Bürger, 2=Unternehmer, 3=Verwaltung). Lebenslagen werden nur ausgeliefert, wenn sie im Redaktionssystem als sichtbargekennzeichnet sind (anzeigeFlag) und das Endedatum der Gültigkeit (gueltigBis) nicht in der Vergangenheit liegt.

Die Lebenslagen sind in Oberkategorien und Unterkategorien untergliedert.

Id Oberkategorie Unterkategorie

10000100 Geburt

10000101 Allgemeines

10000102 Vor der Geburt

10000103 Nach der Geburt

10000104 Feststellung der Vaterschaft

10000105 ...

10000200 Kinderbetreuung

10000200 Allgemeines

BenutzerkennungSie benötigen eine Kennung, der ein Profil mit der Rolle "Webservices Lebenslagen" zugeordnet ist. Der Einstiegsknoten des Profils spielt zur Zeit beim Zugriffsschutz keine Rolle, sollte aber im Hinblick auf zukünftige Differenzierungen sinnvoll gewählt werden.Unter der Web-Adresse https://www.bayvis-redaktionssystem.bayern.de finden Sie die Kontaktdaten zum Beantragen einer Kennung.

Page 102: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  102 von 187

Id Oberkategorie Unterkategorie

... ...

Sie können im Request das folgende optionale Element angeben:

Elementbezeichnung

Kardinalität Typ Werte

leistungenZugeordnet

optional boolean false (oder Element nicht angegeben)

Lebenslage wird ausgeliefert, auch wenn ihr keine Leistungen zugeordnet sind (default).

true:

Lebenslage wird nur ausgeliefert, wenn ihr mindestens eine Leistung zugeordnet ist. In diesem Fall wird auch die dazugehörige Oberkategorie ausgeliefert.

Hier ist die Anfrage dargestellt:

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:leb="http://lfstad.bayern.de/baybw/allgemein/v3/lebenslagen"> <soapenv:Body> <leb:GetAlleLebenslagenRequest> <!-- optional --> <leistungenZugeordnet>true</leistungenZugeordnet> </leb:GetAlleLebenslagenRequest> </soapenv:Body></soapenv:Envelope>

Die Antwort enthält im Element lebenslagen 0 bis n Elemente lebenslage.

Page 103: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  103 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:GetAlleLebenslagenResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v3/lebenslage"> <lebenslagen> <lebenslage id="10000102"> <bezeichnung>Vor der Geburt</bezeichnung> <kurzbeschreibung>Alles Amtliche rund um die Geburt eines Kindes</kurzbeschreibung> <langbeschreibung>&lt;p>Bereits während der Schwangerschaft können Sie ... &lt;/p></langbeschreibung> <kategorie>buerger</kategorie> <vorgaengerId>10000100</vorgaengerId> <stand>2013-08-28T12:11:20+02:00</stand> <synonyme> <synonym>Geburtsvorbereitung</synonym> ... </synonyme> <leistungen> <leistung id="2988"> <bezeichnung>Mutterschutz</bezeichnung> </leistung> ... </lebenslage> ... </lebenslagen> </ns2:GetAlleLebenslagenResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Die Elemente und Attribute in der Antwort haben folgende Bedeutung:

Element Attribut Beschreibung

lebenslagen Container für die Lebenslagen

lebenslage Daten zu einer Lebenslage

lebenslage id Id der Lebenslage

bezeichnung Bezeichnung der Lebenslage

kurzbeschreibung Kurzbeschreibung der Lebenslage (sollte im Datenbestand keine vorhanden sein wird ein leeres Element geliefert)

langbeschreibung Optionale Langbeschreibung der Lebenslage

kategorie Kategorie der Lebenslage (buerger, unternehmer oder verwaltung)

Page 104: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  104 von 187

Element Attribut Beschreibung

vorgaengerId Id der übergeordneten Lebenslage

stand Zeitpunkt, zu dem die Lebenslage zuletzt überarbeitet wurde

synonyme Container für die Synonyme zur Lebenslage

synonym Synonym zur Lebenslage

leistungen Container für die Leistungen, die der Lebenslage zugeordnet sind

leistung zugeordnete Leistung

leistung id Id der zugeordneten Leistung

bezeichnung Bezeichnung der zugeordneten Leistung

Abrufen der Lebenslagen für eine Dienststelle

Über diesen Schnittstellen-Endpunkt können die Lebenslagen abgefragt werden, die zu einer Dienststelle passen. Es werden also nur Lebenslagen ausgeliefert, denen mindestens eine Leistung der Dienststelle zugeordnet ist. Im Ergebnis werden natürlich auch die zugeordneten Leistungen mitgeliefert, für andere Dienststellen zuständig sind. Wie beim Endpunkt Abrufen aller Lebenslagen Lebenslagen nur ausgeliefert, wenn Sie als sichtbar gekennzeichnet sind (anzeigeFlag) und das Endedatum der Gültigkeit (gueltigBis) nicht in der Vergangenheit liegt.

Sie müssen im Request das folgende Element angegeben:

Elementbezeichnung Kardinalität Typ Werte

dienststellenschluessel verpflichtend 7-stellig numerisch Beispiele:

4610000: Stadt Bamberg

0348110 - Landratsamt Bamberg

1001007 - Sozialministerium

0318006 - Regierung von Oberbayern

6741299 - Verwaltungsgemeinschaft Ebelsbach

Beispielanfrage für die Stadt Bamberg:

Page 105: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  105 von 187

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:leb="http://lfstad.bayern.de/baybw/allgemein/v3/lebenslagen"> <soapenv:Body> <leb:GetLebenslagenVonDienststelleRequest> <!-- Lebenslagen für die Dienststelle Stadt Bamberg --> <dienststellenschluessel>4610000</dienststellenschluessel> </leb:GetLebenslagenVonDienststelleRequest> </soapenv:Body></soapenv:Envelope>

Die Antwort ist inhaltlich genauso strukturiert wie beim Endpunkt Abrufen aller Lebenslagen.

Fehlernachrichten werden als Soap-Fault zurückgegeben.

Ursache Soap-Fault mit folgendem <detail>

Element 'dienststellenschluessel' nicht angegeben      <SOAP-ENV:Fault>         <faultcode>SOAP-ENV:Client</faultcode>         <faultstring xml:lang="en">Validation error</faultstring>         <detail>            <spring-ws:ValidationError xmlns:spring-ws="http://springframework.org/spring-ws">              cvc-complex-type.2.4.b: The content of element 'leb:GetLebenslagenVonDienststelleRequest' is not complete.              One of '{dienststellenschluessel}' is expected.            </spring-ws:ValidationError>         </detail>      </SOAP-ENV:Fault>

Falscher Dienststellenschlüssel      <SOAP-ENV:Fault>         <faultcode>SOAP-ENV:Client</faultcode>         <faultstring xml:lang="en">Keine Dienststelle mit dem Dienststellenschlüssel '1111111' gefunden.</faultstring>      </SOAP-ENV:Fault>

Dienststellen existiert, aber hat keine Leistungszuordnungen

      <SOAP-ENV:Fault>         <faultcode>SOAP-ENV:Client</faultcode>         <faultstring xml:lang="en">Der Dienststelle mit dem Dienststellenschlüssel '6741603' sind keine Leistungen zugewiesen.                                                 Daher werden keine Lebenslagen zurückgegeben.         </faultstring>      </SOAP-ENV:Fault>

Leistungen (Version 3)Dieser Web Service erfordert eine Authentifizierung durch den Client (Portal oder CMS-Provider).

BenutzerkennungSie benötigen eine Kennung, der ein Profil mit der Rolle "Webservices Leistungen" zugeordnet ist. Der Einstiegsknoten des Profils wird bei Anfragen nicht ausgewertet, sollte aber im Hinblick auf zukünftige Differenzierungen sinnvoll gewählt werden.Unter der Web-Adresse https://www.bayvis-redaktionssystem.bayern.de finden Sie die Kontaktdaten zum Beantragen einer Kennung.

Page 106: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  106 von 187

Die Schnittstellenbeschreibung finden Sie in folgender Web-Services-Description- Language-Datei (WSDL):

https://www.baybw-services.bayern.de/services/allgemein/allgemein-leistungen.v3.wsdl

Der Web Service bietet folgende Schnittstellen-Endpunkte an:

• Abrufen aller Leistungen• Abrufen der Leistungen, die einer Dienststelle zugeordnet sind• Abrufen aller Leistungsbeschreibungen• Abrufen der Leistungsbeschreibungen, die einer Dienststelle zugeordnet sind• Abrufen einer kompletten Leistungsbeschreibung (mit regionalen Ergänzungen und Zuständigkeiten)

Abrufen aller Leistungen

Über diesen Schnittstellen-Endpunkt können alle Leistungen abgefragt werden. Die Leistungen werden unabhängig davon geliefert, ob das Gültigkeitsdatum der dazugehörigen Leistungsbeschreibung bereits überschritten ist, bzw. ob die Leistungsbeschreibung gerade in Überarbeitung sind.

Wenn bei der Anfrage im Element gemeindekennziffer eine gültige 8-stellige (bayerische) Gemeindekennziffer angegeben wird, dann sind in der Antwort die URLs der Leistungen lokalisiert (also passend für die Gemeinde mit der angegebenen Gemeindekennziffer).

Die in der folgenden Anfrage angegebene Gemeindekennziffer 09162000 bewirkt, dass die URLs für die Landeshauptstadt München lokalisiert werden. In der Antwort erkennen Sie die Wirkung daran, dass die URLs für die Leistung drei HTTP-Parameter (plz, behoerde, gemeinde) haben. Die genaue Bedeutung der drei Parameter muss der Client nicht wirklich kennen, denn er muss die URL nur benutzen, aber nicht selber konstruieren oder manipulieren:

Eine lokalisierte URL sieht so aus:

lokalisierte URL

<url> http://www.freistaat.bayern/dokumente/leistung/26999461116?plz=80331&amp;behoerde=88887100385&amp;gemeinde=666856454699</url>

Eine nicht lokalisierte URL sieht so aus:

nicht lokalisierte URL

<url> http://www.freistaat.bayern/dokumente/leistung/26999461116</url>

Hier finden Sie das Beispiel für die Anfrage, deren Ergebnisse auf den Markt Großostheim lokalisiert werden sollen:

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:leis="http://lfstad.bayern.de/baybw/allgemein/v3/leistungen"> <soapenv:Body> <leis:GetAlleLeistungenRequest> <!--Optional: Allgemeiner Gemeindeschlüssel (AGS) des Marktes Großostheim -->  <gemeindekennziffer>09671122</gemeindekennziffer> </leis:GetAlleLeistungenRequest> </soapenv:Body></soapenv:Envelope>

Die Antwort enthält im Element leistungen 0 bis n Elemente leistung.

Page 107: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  107 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetAlleLeistungenResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v3/leistungen"> <ns3:leistungen> <leistung id="27981" letzteAenderung="2013-08-26T14:57:00+02:00"> <bezeichnung leittext="Bezeichnung" position="1" sichtbar="true">Abfallbeförderungserlaubnis oder Abfalltransporterlaubnis; Erteilung</bezeichnung> <url>http://www.freistaat.bayern/dokumente/leistung/153533714471?plz=63762&amp;behoerde=81330664575&amp;gemeinde=540858036665</url> <synonyme> <synonym>abfallrechtliche Beförderungsgenehmigung</synonym> <synonym>abfallrechtliche Transporterlaubnis</synonym> <synonym>abfallrechtliche Transportgenehmigung</synonym> </synonyme> <lebenslagen> <lebenslage id="20000107"> <bezeichnung>Erlaubnispflichtige und überwachungspflichtige Unternehmen</bezeichnung> </lebenslage> <lebenslage id="20002105"> <bezeichnung>Umweltschutz</bezeichnung> </lebenslage> </lebenslagen> </leistung> <leistung id="3694" letzteAenderung="2013-08-20T17:09:02+02:00"> <bezeichnung leittext="Bezeichnung" position="1" sichtbar="true">Abfallberatung; kommunal</bezeichnung> <url>http://www.freistaat.bayern/dokumente/leistung/71663715636?plz=63762&amp;behoerde=81330664575&amp;gemeinde=540858036665</url> <synonyme> <synonym>Müllabfuhr</synonym> </synonyme> <lebenslagen> <lebenslage id="10001105"> <bezeichnung>Ver- und Entsorgung</bezeichnung> </lebenslage> </lebenslagen> </leistung>  ... </leistungen> </ns3:GetAlleLeistungenResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Die Elemente und Attribute in der Antwort haben folgende Bedeutung:

Element Attribut Beschreibung

leistungen Container für die Leistungen

leistung Daten zu einer Leistung

Page 108: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  108 von 187

Element Attribut Beschreibung

leistung id Id der Leistung

leistung letzteAenderung Zeitstempel der letzten Änderung bei dieser Leistung

bezeichnung Bezeichnung der Leistung

synonyme Container für die Synonyme zu einer Leistung

synonym Synonym einer Leistung

lebenslagen Container für die Lebenslagen, denen eine Leistung zugeordnet ist

lebenslage Lebenslage, der die Leistung zugeordnet ist

lebenslage id Id der Lebenslage, der die Leistung zugeordnet ist

bezeichnung Bezeichnung der Lebenslage

Abrufen der Leistungen, die einer Dienststelle zugeordnet sind

Über diesen Schnittstellen-Endpunkt können nur die Leistungen abgefragt werden, die einer bestimmten Dienststelle zugeordnet sind. Dafür muss in der Anfrage das Element dienststellenschluessel den 7-stelligen Dienststellenschlüssel der gewünschten Dienststelle enthalten. Im Beispiel ist es der Dienststellenschlüssel des Marktes Großostheim (67112220).

Das Element gemeindekennziffer hat für die Anfrage die gleiche Bedeutung wie beim Schnittstellen-Endpunkt Abrufen aller Leistungen. Es drückt nämlich aus, für welche Gemeinde das Ergebnis lokalisiert werden soll.

Mögliche Fehler• Wenn die Gemeindekennziffer zu keiner Gemeinde passt, werden die URLs für die Leistungen

ohne Lokalisierungsparameter zurückgeliefert.• Wenn Sie die Gemeindekennziffer nicht numerisch und 8-stellig angeben, erhalten Sie folgenden

SOAP-Fault:

<SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en">Invalid parameter 'gemeindekennziffer'. Must be numeric with 8 digits. </faultstring></SOAP-ENV:Fault>

Page 109: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  109 von 187

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:leis="http://lfstad.bayern.de/baybw/allgemein/v3/leistungen"> <soapenv:Body> <leis:GetLeistungenVonDienststelleRequest> <dienststellenschluessel>6711220</dienststellenschluessel> <gemeindekennziffer>09671122</gemeindekennziffer> </leis:GetLeistungenVonDienststelleRequest> </soapenv:Body></soapenv:Envelope>

Die Antwort ist vom Datenmodell her mit der Antwort beim Schnittstellen-Endpunkt Abrufen aller Leistungen identisch. Sie enthält jedoch nicht alle Leistungen, sondern nur die der angegebenen Dienststelle.

Response

SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetLeistungenVonDienststelleResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v3/leistungen"> <leistungen> ... </leistungen> </ns3:GetLeistungenVonDienststelleResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Abrufen aller Leistungsbeschreibungen

Über diesen Schnittstellen-Endpunkt können alle Leistungsbeschreibungen (Leistungen einschließlich ihrer vollständigen Beschreibung) abgefragt werden. Das Inhaltsmodell der Antwort ergänzt nur das Inhaltsmodell des Schnittstellen-Endpunkts Abrufen aller Leistungen um weitere Elemente.

Eine Anfrage mit Lokalisierung auf die Landeshauptstadt München (Gemeindekennziffer 09162000) sieht folgendermaßen aus:

Mögliche Fehler• Wenn Sie keinen oder einen nicht existierenden Dienststellenschlüssel angeben, liefert der Web

Service die Antwort mit einem leeren Element leistungen zurück.• Wenn Sie den Dienststellenschlüssel nicht numerisch oder mit mehr als 7 Ziffern angeben,

erhalten Sie folgenden SOAP-Fault:

<SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en">Invalid parameter 'dienststellenschluessel'. Must be numeric containing a maximum of 7 digits. </faultstring></SOAP-ENV:Fault>

Page 110: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  110 von 187

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:leis="http://lfstad.bayern.de/baybw/allgemein/v3/leistungen"> <soapenv:Body> <leis:GetAlleLeistungsbeschreibungenRequest> <gemeindekennziffer>09162000</gemeindekennziffer> <!--Optional:--> <mitRegionalenErgaenzungen>true</mitRegionalenErgaenzungen> </leis:GetAlleLeistungsbeschreibungenRequest> </soapenv:Body></soapenv:Envelope>

Die optionalen Elemente in der Anfrage haben folgende Bedeutung:

Element Beschreibung

mitRegionalenErgaenzungen false (oder nicht vorhanden): Regionale Ergänzungen werden nicht mitgeliefert (default).

true: Regionale Ergänzungen zu den Leistungsbeschreibungen werden mitgeliefert (wie beim Endpunkt Abrufen einer kompletten Leistungsbeschreibung !)

Hier finden Sie die dazugehörige Antwort. Die Teile der Antwort, die bereits beim Schnittstellen-Endpunkt Abrufen aller Leistungen gezeigt wurden, werden hier nicht mehr dargestellt:

Page 111: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  111 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetAlleLeistungsbeschreibungenResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v3/leistungen"> <leistungsbeschreibungen> <leistungsbeschreibung id="3627" letzteAenderung="2013-11-24T15:37:54+01:00"> <bezeichnung leittext="bezeichnung" position="1" sichtbar="true"> Abendgymnasium </bezeichnung> <url>http://www.freistaat.bayern/dokumente/leistung/47552656625 ?plz=80331&amp;behoerde=88887100385&amp;gemeinde=666856454699</url> <!-- ... Inhalt wie beim Endpunkt GetAlleLeistungen ... --> <status leittext="Status" position="16" sichtbar="false">live</status> <kurzbeschreibung leittext="Kurzbeschreibung" position="2" sichtbar="true"> ... </kurzbeschreibung> <langbeschreibung leittext="Beschreibung" position="3" sichtbar="true"> ... </langbeschreibung> <voraussetzungen leittext="Voraussetzungen" position="4" sichtbar="true"> ... </voraussetzungen> <verfahrensablauf leittext="Verfahrensablauf" position="5" sichtbar="true"> ... </verfahrensablauf> <hinweise leittext="Hinweise" position="6" sichtbar="true"> ... </hinweise>  <fristen leittext="Fristen" position="5" sichtbar="true"> ... </fristen> <bearbeitungsdauer leittext="Hinweise" position="8" sichtbar="true"> ... </bearbeitungsdauer>  <unterlagen leittext="Erforderliche Unterlagen" position="9" sichtbar="true"> <unterlage> <kurzbeschreibung>...</kurzbeschreibung> <langbeschreibung>...</langbeschreibung> <leistungId>...</leistungId> <leistungUrl>...</leistungUrl> </unterlage> ... </unterlagen> <kosten leittext="Kosten" position="12" sichtbar="true"> ... </kosten> <formulare leittext="Formulare" position="10" sichtbar="true"> <formular vorausfuellbar="true"> <kurzbeschreibung>...</kurzbeschreibung> <langbeschreibung>...</langbeschreibung> <url>...</url>

Page 112: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  112 von 187

<schriftformerfordernis> <id>...</id> <beschreibung>...</beschreibung> </schriftformerfordernis>  </formular> ... </formulare> <onlineVerfahren leittext="Online Verfahren" position="11" sichtbar="true"> <onlineVerfahren> <kurzbeschreibung>...</kurzbeschreibung> <langbeschreibung>...</langbeschreibung> <url>...</url> </onlineVerfahren> ... </onlineVerfahren> <rechtsvorschriften leittext="Rechtsgrundlagen" position="10" sichtbar="true"> <rechtsvorschrift> <kurzbeschreibung>...</kurzbeschreibung> <langbeschreibung>...</langbeschreibung> <url>...</url> </rechtsvorschrift> ... </rechtsvorschriften> <rechtsbehelf leittext="Rechtsbehelf" position="13" sichtbar="true"> <kurzbeschreibung>...</kurzbeschreibung> <leistungId>...</leistungId> <leistungBezeichnung>...</leistungBezeichnung> <leistungUrl>...</leistungUrl> </rechtsbehelf> <links leittext="Weiterführende Links" position="15" sichtbar="true"> <link> <kurzbeschreibung>...</kurzbeschreibung> <langbeschreibung>...</langbeschreibung> <url>...</url> </link> ... </links> <verwandteLeistungen leittext="Verwandte Themen" position="16" sichtbar="true"> <verwandteLeistung> <id>...</id> <bezeichnung>...</bezeichnung> <url>...</url> <direktVerwandt>...</direktVerwandt> </verwandteLeistung> ... </verwandteLeistungen> <stand leittext="Stand" position="17" sichtbar="true"> 2013-11-24T15:37:54+01:00 </stand> <verantwortlicheBehoerde leittext="Redaktionell verantwortlich" position="18" sichtbar="true"> Bayerisches Staatsministerium für ... (zur Verfügung gestellt durch den &lt;a href="...">BayernPortal&lt;/a>) </verantwortlicheBehoerde> </leistungsbeschreibung> ... </leistungsbeschreibungen> </ns3:GetAlleLeistungsbeschreibungenResponse> </SOAP-ENV:Body>

Page 113: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  113 von 187

</SOAP-ENV:Envelope> 

In den folgenden Tabelle werden alle im Vergleich zum Endpunkt Abrufen aller Leistungen neuen Elemente einer Leistungsbeschreibung aufgeführt:

Element Beschreibung

leistungsbeschreibungen Container für die Leistungsbeschreibungen

leistungsbeschreibung Daten zu einer Leistungsbeschreibung

bezeichnung Bezeichnung der Leistung im BayernPortal (als Titel verwendbar)

status live: die Leistungsbeschreibung ist online working: die Leistungsbeschreibung wird gerade überarbeitet

kurzbeschreibung Kurzbeschreibung (einführender Text); HTML-Markup zulässig

langbeschreibung Langbeschreibung mit dem Kerninhalt; HTML-Markup zulässig

voraussetzungen Erläuterung der Voraussetzungen; HTML-Markup zulässig

verfahrensablauf Skizze zum Ablauf des Verwaltungsverfahrens (Prozess; HTML-Markup zulässig

hinweise Hinweise, die im Zusammenhang mit der Leistung beachtet werden sollten; HTML-Markup zulässig

fristen Erläuterung der Fristen; HTML-Markup zulässig

bearbeitungsdauer Angaben zur durchschnittlichen Bearbeitungsdauer; HTML-Markup zulässig

unterlagen Container für die Unterlagen, die der Leistungsbeschreibung zugeordnet sind

kosten Erläuterung der Kosten; HTML-Markup zulässig

formulare Container für die Formulare, die der Leistungsbeschreibung zugeordnet sind

onlineVerfahren Container für die Online Verfahren, die der Leistungsbeschreibung zugeordnet sind

rechtsvorschriften Container für die Rechtsvorschriften, die der Leistungsbeschreibung zugeordnet sind

rechtsbehelf Ein Rechtsbehelf, der der Leistungsbeschreibung zugeordnet sein kann

Page 114: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  114 von 187

Element Beschreibung

links Container für die externen Links, die der Leistungsbeschreibung zugeordnet sind

verwandteLeistungen Container für die verwandten Leistungen im BayernPortal

stand Datum bzw. Zeitpunkt, zu dem die Leistungsbeschreibung zuletzt überarbeitet wurde (mit dem eher technischen Attribut "letzteAenderung" inhaltlich identisch)

verantwortlicheBehoerde Behörde, die für die Leistungsbeschreibung redaktionell verantwortlich ist (i.d.R. ein Ministerium). Darüber hinaus wird ein Hinweistext auf die Herkunft der Daten mit einer Verlinkung auf die (eventuell lokalisierte) Leistungsbeschreibung im BayernPortal geliefert.

unterlagen

Container für 0 bis n unterlage-Elemente zu einer Leistungsbeschreibung

Attribut Beschreibung

kurzbeschreibung Kurzbeschreibung der Unterlage (als Titel verwendbar)

langbeschreibung Langbeschreibung mit dem Kerninhalt; HTML-Markup zulässig (optional)

leistungId Id einer Leistung, mit der man die Unterlage (z.B. ein Dokument oder eine behördliche Bescheinigung) erlangt. Beispiele: Personalausweis / vorläufiger Personalausweis oder Freizügigkeitsbescheinigung (optional)

leistungUrl URL dieser Leistung. Die URL wird mit Lokalisierungsparametern geliefert, soweit bei der Anfrage das Element gemeindekennziffer angegeben wurde und gültig ist. (optional)

formulare

Container für 0 bis n formular-Elementen zu einer Leistungsbeschreibung

Attribut Beschreibung

vorausfuellbar true: Das Formular kann mit den Empfängerdaten der zuständigen Behörde vorbelegt sein. (Nur wenn genau eine zuständige Behörde zu dieser Leistungsbeschreibung vorhanden ist.)false: Das Formular kann nicht vorbelegt werden.

Nähere Informationen zur Vorausfüllbarkeit erhalten Sie beim, für das Webservice-Angebot, fachlich Verantwortlichen .

kurzbeschreibung Kurzbeschreibung des Elements (als Titel verwendbar)

langbeschreibung Langbeschreibung mit dem Kerninhalt; HTML-Markup zulässig

Page 115: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  115 von 187

Attribut Beschreibung

url Url zum jeweiligen Element

schriftformerfordernis Dieses Element gibt Auskunft über die zulässige Art des Einreichens eines Formulars.Mögliche Ausprägungen hierbei sind:

• ja - Unterschrift rechtlich vorgeschrieben• ja - Unterschrift und persönliches Erscheinen rechtlich

vorgeschrieben• nein - keine Unterschrift rechtlich vorgeschrieben

Attribut Beschreibung

id Id des Schriftformerfordernisses

beschreibung Beschreibung des Schriftformerfordernisses (Dieses Element eignet sich für eine Anzeige in Ihrer Webseite.)

onlineVerfahren, rechtsvorschriften, links

Container für 0 bis n onlineVerfahren-, rechtsvorschrift- und link-Elementen zu einer Leistungsbeschreibung

Attribut Beschreibung

kurzbeschreibung Kurzbeschreibung des Elements (als Titel verwendbar)

langbeschreibung Langbeschreibung mit dem Kerninhalt; HTML-Markup zulässig

url Url zum jeweiligen Element

rechtsbehelf

Ein optionales rechtsbehelf-Element zu einer Leistungsbeschreibung. Der Rechtsbehelf kann entweder nur eine Kurzbeschreibung, nur eine Referenz auf eine Leistung im BayernPortal oder beides enthalten.

Attribut Beschreibung

kurzbeschreibung Kurzbeschreibung des Rechtsbehelfs; HTML-Markup zulässig; nicht als Titel verwendbar)

leistungId Id einer Leistung, die den Rechtsbehelf beschreibt (z.B. Widerspruchsverfahren)

leistungBezeichnung Bezeichnung dieser Leistung (als Titel verwendbar)

leistungUrl URL dieser Leistung. Die URL wird mit Lokalisierungsparametern geliefert, soweit bei der Anfrage das Element gemeindekennzifferangegeben wurde und gültig ist.)

Page 116: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  116 von 187

verwandteLeistungen

Container für 0 bis n verwandteLeistung-Elemente zu einer Leistungsbeschreibung

Attribut Beschreibung

id Id der Leistung im BayernPortal

bezeichnung Bezeichnung der Leistung im BayernPortal (als Titel verwendbar)

url URL der Leistung im BayernPortal, die mit dieser Leistungsbeschreibung verwandt ist. Die URL wird mit Lokalisierungsparametern geliefert, soweit bei der Anfrage das Element gemeindekennziffer angegeben wurde und gültig ist.)

direktVerwandt true: Leistung ist direkt verwandt und wird auch im BayernPortal als verwandte Leistung angezeigt. false: Leistung ist entfernt verwandt, und wird eventuell lediglich in der Langbeschreibung verlinkt.

Mit Hilfe dieser Elemente können Links zu verwandten Leistungen erzeugt werden. Entweder in die eigene Webseite vom Element id ausgehend oder in den BayernPortal (Element url).Es müssen nur solche verwandten Leistungen als Links angezeigt werden, für die das Attribut direktVerwandt den Wert true hat. Die anderen werden zu einem weiteren Zweck mitgeliefert.Der Container verwandteLeistungen kann nämlich dazu verwendet werden, um eingebettete Links im Element langbeschreibung aufzufinden und durch Links in die eigene Webseite zu ersetzen. Jeder eingebettete Link wird auch als Element verwandteLeistung geliefert, wobei das Attribut direktVerwandt den Wert true oder false haben kann. Über das href-Attribut des eingebettenen Links besteht eine Beziehung zum Element url der verwandten Leistung. Das Element id der verwandten Leistung kann daher auch bei eingebetteten Links zum Ersetzen dieser Links durch solche in die eigene Webseite verwendet werden.

Alle soeben beschriebenen Elemente bilden die vollständige Leistungsbeschreibung.Sie haben die folgenden Attribute gemeinsam, die als Meta-Daten für den korrekten Zusammenbau der Leistungsbeschreibung zu einer Web-Seite dienen. Clienten dieses Web Service müssen diese Meta-Daten bei der Aufbereitung der Leistungsbeschreibung auswerten und nach folgenden Angaben interpretieren:

Attribut Beschreibung

leittext Leittext oder Überschrift, die verwendet werden muss, wenn das Element dargestellt wird

position Positive Zahl, die angibt, an welcher Position das Element bei der Darstellung im Bezug auf die anderen Elemente der Leistungsbeschreibung stehen muss

sichtbar true: das Element muss angezeigt werden false: das Element darf nicht angezeigt werden, es ist nur für die Auswertung vorgesehen

Page 117: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  117 von 187

Abrufen der Leistungsbeschreibungen, die einer Dienststelle zugeordnet sind

Über diesen Schnittstellen-Endpunkt können nur die Leistungsbeschreibungen abgefragt werden, die einer bestimmten Dienststelle zugeordnet sind. Dafür muss in der Anfrage das Element dienststellenschluessel die 7-stellige Dienststellenummer der gewünschten Dienststelle enthalten.

Das Element gemeindekennziffer ist bei dieser Anfrage optional, denn die Ermittlung der passenden "eigenen" regionalen Ergänzungen und "eigenen" zuständigen Stellen ist nur vom angegebenen dienststellenschluesselabhängig. Wenn das Element gemeindekennziffer angegeben wird, dann können jedoch in der Antwort die URLs für die Leistung auf die passende Gemeinde lokalisiert werden.

Zusammenfassende Hinweise• Eine Leistungsbeschreibung muss immer vollständig angezeigt werden. Alle oben genannten

Elemente, bei denen das Attribut sichtbar den Wert true hat, müssen in der Reihenfolge angezeigt werden, die durch das Attribut position vorgegeben wird.

• Der für das Element angegebene Leittext muss verwendet werden (z.B. als Überschrift).• Jedem sichtbaren Element der Leistungsbeschreibung darf eine regionale Ergänzung

hinzugefügt werden. Jedoch nur, wenn die regionale Ergänzung optisch abgegrenzt ist (z.B. durch die Zwischenüberschrift "Regionale Ergänzung"), und wenn angezeigt wird, wer für die regionale Ergänzung verantwortlich ist.

• Wenn die Gültigkeitszeit abgelaufen ist oder das Element status den Wert working hat, dürfen die Inhalte der Leistungsbeschreibung nicht mehr oder nur mit einem entsprechenden Hinweis angezeigt werden. In diesem Fall steht im Element kurzbeschreibung der Text "Diese Leistungsbeschreibung wird aktuell überarbeitet.". Die Elemente lebenslagen, langbeschreibung, voraussetzungen, fristen, unterlagen, kosten, formulare, onlineVerfahren, rechtsvorschriften, rechtsbehelf, links und verwandteLeistungenwerden in diesem Fall nicht geliefert.

• Mögliche Fehler bei der Anfrage sind bereits beim Schnittstellen-Endpunkt Abrufen aller Leistungen beschrieben.

Wo HTML-Markup zugelassen ist, können folgende HTML-Tags bzw. Klassenstile vorkommen

HTML-Tag / Klassenstil Semantische Bedeutung

p, br, ul, ol, li, dl, dt, dd, dir, blockquote, i, cite, em, b, strong, sup, sub, hr, a

übliche Bedeutung

class="fundstelle" Kommt in Sozialfibel-Leistungsbeschreibungen als Attribut von Absätzen (p) und Textteilen (span) vor und kennzeichnet, dass eine Fundstelle beschrieben wird

class="zustaendig" Kommt in Sozialfibel-Leistungsbeschreibungen als Attribut von Absätzen (p) und Textteilen (span) vor und kennzeichnet, eine Aufzählung der zuständigen Behörden

class="ueberschrift3" Kommt in Sozialfibel-Leistungsbeschreibungen als Attribut von Textteilen (span) vor und kennzeichnet Zwischenüberschriften im Langtext der Leistungsbeschreibung

Page 118: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  118 von 187

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:leis="http://lfstad.bayern.de/baybw/allgemein/v3/leistungen"> <soapenv:Header/> <soapenv:Body> <leis:GetLeistungsbeschreibungenVonDienststelleRequest> <dienststellenschluessel>6711220</dienststellenschluessel> <!--Optional:--> <gemeindekennziffer>09671122</gemeindekennziffer> <!--Optional:--> <mitRegionalenErgaenzungen>true</mitRegionalenErgaenzungen> <!--Optional:--> <mitZustaendigkeiten>true</mitZustaendigkeiten> </leis:GetLeistungsbeschreibungenVonDienststelleRequest> </soapenv:Body></soapenv:Envelope>

Die optionalen Elemente in der Anfrage haben folgende Bedeutung:

Element Beschreibung

mitRegionalenErgaenzungen false (oder nicht vorhanden): Regionale Ergänzungen zu den Leistungsbeschreibungen werden nicht mitgeliefert (default).

true: Regionale Ergänzungen zu den Leistungsbeschreibungen werden mitgeliefert. Jedoch nur solche, für die die Dienststelle mit dem angegebenen Dienststellenschlüssel redaktionell zuständig ist (also "eigene" regionale Ergänzungen).

Das Element gemeindekennziffer spielt bei dieser Anfrage für die Auswahl der passenden regionalen Ergänzungen keine Rolle.

mitZustaendigkeiten false (oder nicht vorhanden): Zuständige Stellen werden nicht mitgeliefert (default).

true: Zuständige Stellen werden mitgeliefert. Es werden aber nur Stellen / Organisationseinheiten berücksichtigt, die zur Dienststelle mit dem angegebenen "dienststellenschluessel" gehören. Dazu gehören die Dienststelle selbst, ihre Aussenstellen und alle Organisationseinheiten dieser Dienststelle oder ihrer Aussenstellen.

Das Element gemeindekennziffer spielt demnach bei dieser Anfrage für die Auswahl der passenden zuständigen Stellen keine Rolle.

Die Antwort ist vom Datenmodell her mit der Antwort beim Schnittstellen-Endpunkt Abrufen aller Leistungsbeschreibungen identisch. Sie enthält jedoch nicht alle Leistungsbeschreibungen, sondern nur die der angeforderten Dienststelle.

Page 119: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  119 von 187

Response

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetLeistungsbeschreibungenVonDienststelleResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v3/leistungen"> <leistungsbeschreibungen> ... </leistungsbeschreibungen> </ns3:GetLeistungsbeschreibungenVonDienststelleResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Abrufen einer kompletten Leistungsbeschreibung (mit regionalen Ergänzungen und Zuständigkeiten)

Über diesen Schnittstellen-Endpunkt kann eine einzelne Leistungsbeschreibung oder eine regionale Ergänzung per Id abgefragt werden. Gültige Ids von Leistungen erhält der Client durch vorheriges Abrufen eines der anderen Endpunkte (z.B. Abrufen aller Leistungen).Gültige Ids von regionalen Ergänzungen kann der Client erhalten, wenn er vorher den hier beschriebenen Endpunkt für eine zentrale Leistungsbeschreibung aufruft, soweit diese für die angegebene gemeindekennziffer regionale Ergänzungen hat.

Das Element gemeindekennziffer hat für die Anfrage die gleiche Bedeutung wie beim Schnittstellen-Endpunkt Abrufen aller Leistungen.

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:leis="http://lfstad.bayern.de/baybw/allgemein/v3/leistungen"> <soapenv:Body> <leis:GetSingleLeistungsbeschreibungRequest> <id>25349</id> <!--Optional:--> <gemeindekennziffer>09671122</gemeindekennziffer> <!--Optional:--> <mitRegionalenErgaenzungen>false</mitRegionalenErgaenzungen> </leis:GetSingleLeistungsbeschreibungRequest> </soapenv:Body></soapenv:Envelope>

Im Ergebnis wird die angeforderte Leistungsbeschreibung oder die angeforderte regionale Ergänzung geliefert. Beide haben das gleiche Inhaltsmodell. Der Inhalt des Elements leistungsbeschreibung wurde bereits beim Schnittstellen-Endpunkt Abrufen aller Leistungsbeschreibungen beschrieben.

Falls die angeforderte Leistungsbeschreibung zur Gemeindekennziffer passende regionale Ergänzungen hat (und das Element mitRegionalenErgaenzungen in der Anfrage nicht explizit auf false gesetzt wurde), wird zusätzlich ein Element regionaleErgaenzungen zurückgeliefert. Darin enthalten sind 1 bis n Elemente regionaleErgaenzung, die nur das Attribut id besitzen. Über die Id können diese regionalen Ergänzungen im nächsten Schritt selbst abgerufen werden. Benutzen Sie dafür bitte wieder den hier beschriebenen Endpunkt (gleiches Inhaltsmodell).

Außerdem wird ein Element zustaendigkeiten geliefert, das 1 bis n Elemente zustaendigkeit einschließt. Es handelt sich um die Daten der für die Leistung zuständigen Stellen.

Das Element zustaendigkeit enthält folgende Elemente:

Page 120: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  120 von 187

Element Attribute Beschreibung

behoerdeId Id der zuständigen Behörde (nur gefüllt, wenn der Benutzer das Recht hat, die Detaildaten zur Behörde anzufordern)

bezeichnung Bezeichnung der zuständigen Behörde

anschriften Enthält alle 0 bis n Gebäude zu dieser Behörde

gebaeude Jedes Gebäude hat genau eine Hausanschrift und eventuell eine Postanschrift, Telefon- und Faxnummer

gebaeudeId Id des Gebäudes, das der zuständigen Behörde zugeordnet ist (nur gefüllt, wenn der Benutzer das Recht hat, die Detaildaten zur Behörde anzufordern)

email Email-Adresse der zuständigen Behörde (falls vorhanden)

website Homepage der zuständigen Behörde (falls vorhanden)

behoerdenAnsprechpartnerZuordnungen

Container mit 0 bis n Ansprechpartner-Ids (nur gefüllt, wenn der Benutzer das Recht hat, die Detaildaten zur Behörde anzufordern)

ansprechpartner id Id eines zuständigen Ansprechpartners

Die Elemente behoerdeId, gebaeudeId, behoerdenAnsprechpartnerZuordnungen/ansprechpartner[id] werden nur geliefert, wenn die Benutzerkennung, mit der der Webservice aufgerufen wird, Zugriff auf die Daten der zuständigen Behörde hat.

Die Benutzerkennung braucht dazu ein Benutzerprofil mit der Rolle "Webservices Behörden" für die jeweilige Dienststelle. Inhaltlich handelt es sich um Referenz-Ids der zuständigen Behörde, ihrer Gebäude und der zuständigen Ansprechpartner. Die Referenz-Ids können genutzt werden, um über den Webservice     Behörden, Gebäude und Ansprechpartner die Detaildaten abzurufen.

Page 121: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  121 von 187

Response als zentrale Leistungsbeschreibung

SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetSingleLeistungsbeschreibungResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v3/leistungen"> <leistungsbeschreibung id="161" letzteAenderung="2011-12-01T10:18:30+01:00"> ... <regionaleErgaenzungen> <regionaleErgaenzung id="27411"/> </regionaleErgaenzungen>  <zustaendigkeiten> <zustaendig> <bezeichnung>Industrie- und Handelskammer zu Coburg</bezeichnung> <anschriften> <gebaeude> <hausanschrift> <strasse>Schloßplatz 5</strasse> <plz>96450</plz> <ort>Coburg</ort> </hausanschrift> <postanschrift> <strasse>Postfach 2043</strasse> <plz>96409</plz> <ort>Coburg</ort> </postanschrift> <telefon>+49 (0)9561 7426-0</telefon> <fax>+49 (0)9561 7426-50</fax> </gebaeude> </anschriften> <email>[email protected]</email> <website>http://www.coburg.ihk.de</website> <bwwlink>http://www.behoerdenwegweiser.bayern.de/dokumente/behoerde/659077564723</bwwlink> </zustaendig> <zustaendig> <behoerdId>51017</behoerdId>  <bezeichnung>32-1 - Gewerberecht</bezeichnung> <anschriften> <gebaeude> <gebaeudeId>40365</gebaeudeId> <hausanschrift> <strasse>Rosengasse 1</strasse> <plz>96450</plz> <ort>Coburg</ort> </hausanschrift> <postanschrift> <strasse>Postfach 30 42</strasse> <plz>96419</plz> <ort>Coburg</ort> </postanschrift> <telefon>+49 (0)9561 89-0</telefon> <fax>+49 (0)9561 89-2111</fax> <behoerdenAnsprechpartnerZuordnungen>  <ansprechpartner id="48442"/>

Page 122: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  122 von 187

 </behoerdenAnsprechpartnerZuordnungen> </gebaeude> </anschriften> <email>[email protected]</email> <website>http://www.coburg.de</website> <bwwlink>http://www.behoerdenwegweiser.bayern.de/dokumente/behoerde/646404686857</bwwlink> </zustaendig> </zustaendigkeiten>  </leistungsbeschreibung> </ns3:GetSingleLeistungsbeschreibungResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Eine regionale Ergänzung ist eine spezielle Leistungsbeschreibung, die mit den gleichen Elementen ausgestattet ist, wie die (zentrale) Leistungsbeschreibung zu der sie gehört. Meist sind bei der regionalen Ergänzung jedoch weniger Elemente mit Inhalt belegt. Im folgenden Beispiel wird eine regionale Ergänzung zu folgenden Elementen geliefert:

• kosten• onlineVerfahren

Page 123: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  123 von 187

Response als regionale Ergänzung

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetSingleLeistungsbeschreibungResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v3/leistungen"> <leistungsbeschreibung id="27411" letzteAenderung="2013-07-12T11:42:48+02:00"> <bezeichnung leittext="bezeichnung" position="1" sichtbar="true"> Handwerksrecht, Anzeige eines zulassungsfreien Handwerks oder eines handwerksähnlichen Gewerbes - HwK Unterfranken </bezeichnung> <url/> <synonyme/> <lebenslagen/> <status leittext="Status" position="16" sichtbar="false">live</status> <kurzbeschreibung leittext="Kurzbeschreibung" position="2" sichtbar="true"/> <langbeschreibung leittext="Beschreibung" position="3" sichtbar="true"/> <voraussetzungen leittext="Voraussetzungen" position="4" sichtbar="true"/> <fristen leittext="Fristen" position="5" sichtbar="true"/> <unterlagen leittext="Erforderlich Unterlagen" position="6" sichtbar="true"/> <kosten leittext="Kosten" position="7" sichtbar="true"> <![CDATA[ <p>Ersteintragung in die Handwerksrolle bzw. in das Verzeichnis der zulassungsfreien Handwerke und handwerksähnlichen Gewerbe </p> <p>für Einzelunternehmen 76 €, </p> <p>für andere Rechtsformen 128 €;</p> <p>Änderungen der Eintragung 50 €</p> ]]> </kosten> <formulare leittext="Formulare" position="8" sichtbar="true"/> <onlineVerfahren leittext="Online Verfahren" position="9" sichtbar="true"> <onlineVerfahren> <kurzbeschreibung> Handwerksrolle online - Handwerkskammer für Unterfranken </kurzbeschreibung> <langbeschreibung> Ein neuer Service für Existenzgründer und Mitgliedsbe... </langbeschreibung> <url> http://www.hwk-unterfranken.odav.de/view?onr=78&amp;pnr=hto_hrolle_start </url> </onlineVerfahren> </onlineVerfahren> <rechtsvorschriften leittext="Rechtsgrundlagen" position="10" sichtbar="true"/> <rechtsbehelf leittext="Rechtsbehelf" position="11" sichtbar="true"/> <links leittext="Weiterführende Links" position="12" sichtbar="true"/> <stand leittext="Stand" position="14" sichtbar="true"> 2013-07-12T11:42:48+02:00 </stand> <verantwortlicheBehoerde leittext="Redaktionell verantwortlich" position="15" sichtbar="true"> Handwerkskammer für Unterfranken </verantwortlicheBehoerde> </leistungsbeschreibung> </ns3:GetSingleLeistungsbeschreibungResponse>

Page 124: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  124 von 187

</SOAP-ENV:Body></SOAP-ENV:Envelope>

Die regionale Ergänzung hat ihre eigene zeitliche Gültigkeitsbegrenzung. Wenn die Gültigkeitszeit abgelaufen ist oder das Element status den Wert working hat, dürfen die Inhalte der regionalen Ergänzung nicht mehr oder nur mit einem entsprechenden Hinweis angezeigt werden. In diesem Fall steht im Element kurzbeschreibung der Text "Die Leistungsbeschreibung wird aktuell überarbeitet.". Die Elemente langbeschreibung, voraussetzungen, fristen, unterlagen, kosten, formulare, onlineVerfahren, rechtsvorschriften, rechtsbehelf und links werden in diesem Fall nicht geliefert.

Natürlich hat die regionale Ergänzung auch eine eigene redaktionell verantwortliche Behörde (Element verantwortlicheBehoerde), die mit jeder regionalen Ergänzung angezeigt werden muss. Denn für die Inhalte der regionalen Ergänzung ist die regionale Dienststelle verantwortlich, nicht die Behörde, die die zentrale Leistungsbeschreibung pflegt.

Formulare (Version 3)Dieser Web Service erfordert eine Authentifizierung durch den Client (Portal oder CMS-Provider).

Die Schnittstellenbeschreibung finden Sie in folgender Web-Services-Description- Language-Datei (WSDL):

https://www.baybw-services.bayern.de/services/allgemein/allgemein-formulare.v3.wsdl

Der Web Service bietet den folgenden Schnittstellen-Endpunkte an:

Abrufen der Formulare, die den Leistungen einer Dienststelle zugeordnet sind

Über diesen Schnittstellen-Endpunkt können nur die Formulare abgefragt werden, die den Leistungen einer bestimmten Dienststelle zugeordnet sind. Dafür muss in der Anfrage das Element dienststellenschluessel den 7-stelligen Dienststellenschlüssel der gewünschten Dienststelle enthalten. Im Beispiel ist es der Dienststellenschlüssel der Regierung von Oberbayern (0318006).

Das optionale Element gemeindekennziffer hat für die Anfrage zwei Auswirkungen:

• zum ersten hat er die gleiche Bedeutung wie beim Schnittstellen-Endpunkt Abrufen aller Leistungen im Leistungen (Version 3)-Webservice. Es drückt nämlich aus, für welche Gemeinde das Ergebnis lokalisiert werden soll.

• zum zweiten liefert der Webservice dann auch alle Formulare der "Regionalen Ergänzungen" dieses Gebiets.

Das optionale boolesche Element gruppiertNachLeistungen hat nur im Hinblick auf die Schachtelung der Ergebnisse Auswirkungen auf die Antwort:

Mögliche Fehler• Wenn die Id der Leistung oder regionalen Ergänzung nicht gültig ist, erhalten sie folgende SOAP-

Fault:

<SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en">Invalid parameter 'id'. Service or regional extension not found by Id. </faultstring></SOAP-ENV:Fault>

BenutzerkennungSie benötigen eine Kennung, der ein Profil mit der Rolle "Webservices Behörden" zugeordnet ist. Der Einstiegsknoten des Profils wird bei Anfragen nicht ausgewertet, sollte aber im Hinblick auf zukünftige Differenzierungen sinnvoll gewählt werden.Unter der Web-Adresse https://www.bayvis-redaktionssystem.bayern.de finden Sie die Kontaktdaten zum Beantragen einer Kennung.

Page 125: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  125 von 187

• true (Default): Es werden Leistungen zurückgeliefert, die die zugeordneten Formulare beinhalten, somit können sie gegliedert angezeigt werden. kurz: Formulare gegliedert nach Leistungen

• false: Es werden Formulare zurückgeliefert, die eine Liste von Leistungen (denen sie zugeordnet sind) mitführen. kurz: Formulare mit ihren zugehörigen Leistungen

Request

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:for="http://lfstad.bayern.de/baybw/allgemein/v3/formulare"> <soapenv:Body> <for:GetFormulareVonDienststelleRequest> <dienststellenschluessel>0318006</dienststellenschluessel> <gemeindekennziffer>09183148</gemeindekennziffer> <gruppiertNachLeistung>true</gruppiertNachLeistung> </for:GetFormulareVonDienststelleRequest> </soapenv:Body></soapenv:Envelope>

Response (gruppiertNachLeistungen=true)

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetFormulareVonDienststelleResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v3/formulare"> <ns3:formulare dienststellenschluessel="0318006"> <leistungMitFormularen> <leistungId>12112</leistungId> <leistungBezeichnung>Psychologische Psychotherapeutinnen und [...]</leistungBezeichnung> <leistungUrl>http://freistaat.bayern/dokumente/leistung/906990501204?plz=63762&amp;behoerde=81330664575&amp;gemeinde=540858036665</leistungUrl> <formulare> <formular vorausfuellbar="false"> <id>9529</id> <kurzbeschreibung>Approbationsantrag Psychotherapeut (Regierung von Unterfranken)</kurzbeschreibung> <url>http://www.regierung.unterfranken.bayern.de/aufgaben/7/3/00663/index.html</url> <schriftformErfordernis> <id>1</id> <bezeichnung>ja - Unterschrift rechtlich vorgeschrieben</bezeichnung> <beschreibung>Dieses Formular muss unterschrieben an die zuständige Behörde [...]</beschreibung> </schriftformErfordernis> </formular> ... </formulare> </leistungMitFormularen> ... </ns3:GetFormulareVonDienststelleResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Page 126: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  126 von 187

Response (gruppiertNachLeistungen=false)

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns3:GetFormulareVonDienststelleResponse xmlns:ns3="http://lfstad.bayern.de/baybw/allgemein/v3/formulare"> <ns3:formulare dienststellenschluessel="0318006"> <formular vorausfuellbar="false"> <id>10946</id> <kurzbeschreibung>Ablaufschema zur Prüfung des Artenschutzes in der Straßenplanung</kurzbeschreibung> <url>http://formulare.bayern.de/OBB/sap_schema.pdf</url> <langbeschreibung>Fassung mit Stand 01/2013</langbeschreibung> <schriftformErfordernis> <id>3</id> <bezeichnung>nein - keine Unterschrift rechtlich vorgeschrieben</bezeichnung> <beschreibung>Dieses Formular muss nicht unterschrieben werden.</beschreibung> </schriftformErfordernis> <leistungen> <leistung> <leistungId>29785</leistungId> <leistungBezeichnung>Artenschutz in der Straßenplanung; Hinweise zur Aufstellung der naturschutzfachlichen Angaben</leistungBezeichnung> <leistungUrl>http://freistaat.bayern/dokumente/leistung/420643422501</leistungUrl> </leistung> ... </leistungen> </formular> ... </ns3:formulare> </ns3:GetFormulareVonDienststelleResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Die Elemente und Attribute haben in beiden Fällen der Antwort die folgende Bedeutung:

Element Attribut Beschreibung

leistungMitFormularen Container für die Leistungen mit Formularen

leistungId Id der Leistung

leistungBezeichnung Bezeichnung der Leistung

leistungUrl Link auf die Leistung im BayernPortal (wenn im Request eine Gemeindekennziffer mitgeschickt wurde, sogar auf diese lokalisiert)

formulare dienststellenschluessel Liste von Formular-Elementen dieser Leistung (zur Kontrolle nochmal der in der Anfrage eingetragene Dienststellenschlüssel)

Page 127: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  127 von 187

Element Attribut Beschreibung

formular Container für ein Formular

formular vorausfuellbar false:  "Normales" Formular

true: Zentral abgelegtes Formular, das mit den Empfängerdaten der zuständigen Behörde vorbelegt ist

Für nähere Informationen zu diesem Thema wenden Sie sich bitte an den Herausgeber

id Id des Formulars

kurzbeschreibung Kurzbeschreibung / Bezeichnung des Formulars

langbeschreibung Ausführliche Beschreibung des Formulars (z.B. zusätzlich notwendige Unterlagen...)

url Link des Formulars

schriftformErfordernis Container für die Schriftformerfordernis.Gibt Auskunft darüber wie ein Formular einzureichen ist, mögliche Werte sind:

1. Die Unterschrift rechtlich vorgeschrieben2. Das Formular muss unterschrieben und

persönlich in der Behörde abgegeben werden

3. Das Formular muss nicht unterschrieben werden

schriftformErfordernis id Id des Schriftformerfordernisses

schriftformErfordernis bezeichnung Kurztext

schriftformErfordernis beschreibung Ausführlichere Beschreibung

Page 128: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  128 von 187

2.2 REST API

2.2.1 Authentifizierung REST-API

Mögliche Fehler• Wenn der Dienststellenschlüßel zu keiner Dienststelle passt, erhalten Sie ein leeres Antwort-

Dokument.• Wenn Sie den Dienststellenschlüßel nicht numerisch und 7-stellig angeben, erhalten Sie

folgenden SOAP-Fault:

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en">Invalid parameter 'dienststellenschluessel'. Must be numeric containing a maximum of 7 digits.</faultstring> </SOAP-ENV:Fault> </SOAP-ENV:Body></SOAP-ENV:Envelope>

• Wenn die Gemeindekennziffer zu keiner Gemeinde passt, werden die URLs für die Leistungen ohne Lokalisierungsparameter zurückgeliefert.

• Wenn Sie die Gemeindekennziffer nicht numerisch und 8-stellig angeben, erhalten Sie folgenden SOAP-Fault:

<SOAP-ENV:Fault> <faultcode>SOAP-ENV:Client</faultcode> <faultstring xml:lang="en">Invalid parameter 'gemeindekennziffer'. Must be numeric with 8 digits. </faultstring></SOAP-ENV:Fault>

Für alle Webservices bei denen eine Authentifizierung erforderlich ist, erfolgt diese gemäß HTTP Basic Authentication nach RFC 2617.Es wird eine Kennung des Redaktionssystems für Verwaltungsinformationen benötigt. Diese Kennung können Sie hier beantragen:

HerausgeberDie Anwendungen des "BayernPortals" werden herausgegeben von:Bayerisches Staatsministerium der Finanzen und für HeimatZentrale Redaktion des Redaktionssystems für Verwaltungsinformationen in BayernHausanschrift:Odeonsplatz 480539 MünchenPostanschrift:Postfach 22 00 0380535 MünchenTelefon: +49 (0)89 2306-2267E-Mail: [email protected]

Page 129: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenexport aus dem BayernPortal Seite  129 von 187

2.2.2 Version 3 REST APIDie aktuelle Dokumentation zum REST API finden Sie direkt auf unserer Homepage unter der Adresse https://www.baybw-services.bayern.de/restapi.htm

Page 130: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  130 von 187

3 Web-Services für den Datenimport in das BayernPortalDieser Import-Webservice bietet Portalen und Content-Management-System(CMS)-Provider (staatlich, kommunal oder sonstiger Institutionen in Bayern) eine Web Service-Schnittstelle für den Daten-Upload in den Datenbestand des BayernPortals an.

Diese Schnittstelle bietet die Möglichkeit folgende Daten bezüglich einer bestimmten Dienststelle zu importieren:

• Daten zur Dienststelle selbst (Kurzbeschreibung, Langbeschreibung), die selbst schon im BayernPortal vorhanden sein muss

• Organigramm der Dienststelle, also alle Organisationseinheiten und Einrichtungen, die der Dienststelle organisatorisch nachgeordnet sind

• Adressen der Organisationseinheiten und Einrichtungen• Kommunikationsverbindungen und Öffnungszeiten der Organisationseinheiten und Einrichtungen• Mitarbeiter (Ansprechpartner) mit Kommunikationsverbindungen und Sprechzeiten• Aufgabenzuordnungen zu den Organisationseinheiten und Einrichtungen und• Regionale Ergänzungen zu den zentralen Aufgabenbeschreibungen.

3.1 Authentifizierung und AutorisierungDie angebotenen Webservices erwarten verpflichtend eine Authentifizierung und eine Autorisierung.

3.2 IntegrationstestsWenn Sie ihr System an das BayernPortal anbinden, dann werden Sie vermutlich mit kleinen Uploads beginnen und brauchen eine geeignete Testumgebung. Für diese Integrationstest stellen wir eine Testumgebung unter der folgenden URL bereit:

https://pre.bayvis-services.bayern.de/

Die Services in der Testumgebung sind mit der Produktionsumgebung identisch und immer auf dem gleichen Stand. Die Webservices in der Testumgebung sind allerdings mit einer Testdatenbank verbunden, so dass bei ihren Integrationstest keine Gefahr besteht, produktive Daten zu beschädigen. Um die Ergebnisse ihrer Importe zu kontrollieren, wird unter der URL

https://pre.bayvis-redaktionssystem.bayern.de/

auch das Redaktionssystem für Integrationstests bereitgestellt. Bei den Beispielen, die wir als Tutorial unter Beispiele für die Nutzung der Importschnittstelle anbieten, wird immer wieder Bezug auf das Redaktionssystem genommen, weil ein Benutzer die Ergebnisse seines Imports dort am besten überprüfen kann. Es ist uns natürlich bewusst, dass man dabei auf das Know-How eines regionalen Redakteurs angewiesen ist.

3.3 WorkflowDer generelle Workflow beim Import-Webservice wird im Abschnitt Workflow des Import-Web-Service erläutert.

3.4 Fehlermeldungen im Rahmen der fachlichen ValidierungDie Fehlermeldungen bei der fachlichen Validierung werden im Abschnitt Validierungsfehler erläutert.

Page 131: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  131 von 187

3.5 Authentifizierung Datenimport Web-Services

3.5.1 AuthentifizierungDie Authentifizierungsinformationen geben sie über den Header der Soap-Nachricht (WS-Security-Spezifikation mit UsernameToken) mit. Der Client authentifiziert sich über Benutzerkennung und Kennwort. Die beiden Angaben gehören zu einem speziellen Header der SOAP-Nachricht (UsernameToken). Außerdem kann als zusätzliches Sicherheitsmerkmal ein weiterer Header (Timestamp) angegeben werden. Dieser Header begrenzt die Gültigkeitszeit der Nachricht.

Der Import-Web Service erfordert eine Authentifizierung durch den Client (Portal oder CMS-Provider). Sie benötigen dafür eine Kennung mit folgendem Profil:

• Rolle: Regionaler Administrator• Zugeordnete Behörde: Dienststelle, für die der Daten-Upload erfolgen soll

Diese Kennung können Sie hier beantragen:

HerausgeberDie Anwendungen des "BayernPortals" werden herausgegeben von:Bayerisches Staatsministerium der Finanzen und für HeimatZentrale Redaktion des Redaktionssystems für Verwaltungsinformationen in BayernHausanschrift:Odeonsplatz 480539 MünchenPostanschrift:Postfach 22 00 0380535 MünchenTelefon: +49 (0)89 2306-2267E-Mail: [email protected]

Page 132: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  132 von 187

Beispiel eines vollständigen WS-Security-SOAP-Header (mit Timestamp und UsernameToken)

<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"> <wsu:Timestamp wsu:Id="Timestamp-8382636" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <wsu:Created>2014-01-10T12:14:49.791Z</wsu:Created> <wsu:Expires>2014-01-10T12:15:49.791Z</wsu:Expires> </wsu:Timestamp> <wsse:UsernameToken wsu:Id="UsernameToken-11481251" xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-utility-1.0.xsd"> <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:Nonce>sApImdTbRXGbhA/ugQM7Zw==</wsse:Nonce> <wsu:Created>2014-01-10T12:14:53.055Z</wsu:Created> </wsse:UsernameToken> </wsse:Security></soapenv:Header>

3.6 Autorisierung Datenimport Web-ServicesFür die Autorisierung ist die Angabe des richtigen Einstiegspunkts im Payload des Request (Element CmsIntegrationRequest / WSRequestContex / dienststellenSchluessel) entscheidend. Eine Erläuterung dazu finden sie unter dem Absatz Einstiegspunkt.

Die Schnittstellenbeschreibung finden Sie in folgender Web-Services-Description- Language-Datei (WSDL):

https://www.baybw-services.bayern.de/services/cmsIntegration.wsdl

Die Beschreibung der Request und Response-Dokumente finden Sie in den folgenden XML-Schema-Dateien.

• XML-Schema der Nachrichten• XML-Schema der Datentypen

Darüber hinaus stellen wir zur Verdeutlichung folgende Beispiele für die Nutzung der Importschnittstelle zur Verfügung, die nach Bedarf weiterhin ergänzt werden.

Bei allen Requests wird zwischen Einstiegs- und Einhängepunkt unterschieden. Hier finden Sie eine Begriffsabgrenzung:

3.6.1 EinstiegspunktDer Einstiegspunkt eines Request ist stets mit einer bestimmten Dienststelle identisch. Denn der Zweck des Import-Webservice ist ja, Daten zu genau einer Dienststelle zu importieren. Da jedoch im BayernPortal einige tausend Dienststellen gespeichert sind, muss bei jedem Request ein Einstiegspunkt, eben diese Dienststelle, mitgegeben werden. Dafür müssen Sie im Payload das Element CmsIntegrationRequest / WSRequestContex / dienststellenSchluessel verwenden. Hier geben Sie also eine gültige 7-stellige Dienststellennummer einer bayerischen Dienststelle an, für die Sie Daten importieren wollen.

Page 133: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  133 von 187

Wir gehen davon aus, dass jede Dienststelle ihre eigene Dienststellennummer kennt. Wie bereits oben erklärt, wird ein Request nur akzeptiert, wenn Sie sich mit einer bestimmten Benutzerkennung authentifiziert haben. Darüber hinaus wird aber nach der erfolgreichen Authentifizierung noch geprüft, ob diese Kennung berechtigt ist, für die angegebene Dienststellennummer Daten hochzuladen (Autorisierung). Falls nicht, erhalten Sie folgenden Response als Soap-Nachricht:

Response bei fehlgeschlagener Autorisierung

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:CmsIntegrationResponse xmlns:ns2="http://lfstad.bayern.de/baybw/schemas/cmsintegration/messages"> <ns2:outcome>ERROR</ns2:outcome> <ns2:message> Benutzer "6741604-002" hat nicht die Rolle "Regionaler Administrator" für die Dienststelle mit dem Dienststellenschlüssel "2711270". </ns2:message> </ns2:CmsIntegrationResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

3.6.2 EinhängepunktDer Einhängepunkt eines Requests ist identisch mit der Dienststelle (also dem Einstiegspunkt) oder alternativ eine Organisationseinheit unterhalb der Dienststelle. Im Normalfall brauchen Sie sich um den Einhängepunkt nicht zu kümmern, weil er dann identisch mit der Dienststelle ist.

Wenn sie den Einhängepunkt für den Request explizit festzulegen möchten, müssen Sie das Element CmsIntegrationRequest / WSRequestContex / organisationsBezeichnung angeben. Tragen sie dort die genaue Bezeichnung derjenigen Organisationseinheit ein, unter der die gelieferten Daten relativ eingehängt werden sollen.Die Daten, die sie liefern, müssen natürlich dazu passen, d.h. das Element CmsIntegrationRequest / organisationenthält die Daten des Einhängepunkts und im Element CmsIntegrationRequest / organisation / organisationensind die Nachfahren im Organigramm eingepackt.

Falls der von Ihnen angegebene Einhängpunkt im BayernPortal nicht gefunden wird, erhalten sie folgenden Response als Soap-Nachricht:

Response bei fehlgeschlagener Autorisierung

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:CmsIntegrationResponse xmlns:ns2="http://lfstad.bayern.de/baybw/schemas/cmsintegration/messages"> <ns2:outcome>ERROR</ns2:outcome> <ns2:message>Die Organisationsbezeichnung "Rechtsamt" ist im Teilbaum der Dienststelle nicht vorhanden.</ns2:message> </ns2:CmsIntegrationResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Page 134: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  134 von 187

3.6.3 EinhängepunktDer Einhängepunkt eines Requests ist identisch mit der Dienststelle (also dem Einstiegspunkt) oder alternativ eine Organisationseinheit unterhalb der Dienststelle. Im Normalfall brauchen Sie sich um den Einhängepunkt nicht zu kümmern, weil er dann identisch mit der Dienststelle ist.

Wenn sie den Einhängepunkt für den Request explizit festzulegen möchten, müssen Sie das Element CmsIntegrationRequest / WSRequestContex / organisationsBezeichnung angeben. Tragen sie dort die genaue Bezeichnung derjenigen Organisationseinheit ein, unter der die gelieferten Daten relativ eingehängt werden sollen.Die Daten, die sie liefern, müssen natürlich dazu passen, d.h. das Element CmsIntegrationRequest / organisationenthält die Daten des Einhängepunkts und im Element CmsIntegrationRequest / organisation / organisationensind die Nachfahren im Organigramm eingepackt.

Falls der von Ihnen angegebene Einhängpunkt im BayernPortal nicht gefunden wird, erhalten sie folgenden Response als Soap-Nachricht:

Response bei fehlgeschlagener Autorisierung

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:CmsIntegrationResponse xmlns:ns2="http://lfstad.bayern.de/baybw/schemas/cmsintegration/messages"> <ns2:outcome>ERROR</ns2:outcome> <ns2:message>Die Organisationsbezeichnung "Rechtsamt" ist im Teilbaum der Dienststelle nicht vorhanden.</ns2:message> </ns2:CmsIntegrationResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

3.6.4 EinstiegspunktDer Einstiegspunkt eines Request ist stets mit einer bestimmten Dienststelle identisch. Denn der Zweck des Import-Webservice ist ja, Daten zu genau einer Dienststelle zu importieren. Da jedoch im BayernPortal einige tausend Dienststellen gespeichert sind, muss bei jedem Request ein Einstiegspunkt, eben diese Dienststelle, mitgegeben werden. Dafür müssen Sie im Payload das Element CmsIntegrationRequest / WSRequestContex / dienststellenSchluessel verwenden. Hier geben Sie also eine gültige 7-stellige Dienststellennummer einer bayerischen Dienststelle an, für die Sie Daten importieren wollen.

Wir gehen davon aus, dass jede Dienststelle ihre eigene Dienststellennummer kennt. Wie bereits oben erklärt, wird ein Request nur akzeptiert, wenn Sie sich mit einer bestimmten Benutzerkennung authentifiziert haben. Darüber hinaus wird aber nach der erfolgreichen Authentifizierung noch geprüft, ob diese Kennung berechtigt ist, für die angegebene Dienststellennummer Daten hochzuladen (Autorisierung). Falls nicht, erhalten Sie folgenden Response als Soap-Nachricht:

Page 135: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  135 von 187

Response bei fehlgeschlagener Autorisierung

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:CmsIntegrationResponse xmlns:ns2="http://lfstad.bayern.de/baybw/schemas/cmsintegration/messages"> <ns2:outcome>ERROR</ns2:outcome> <ns2:message> Benutzer "6741604-002" hat nicht die Rolle "Regionaler Administrator" für die Dienststelle mit dem Dienststellenschlüssel "2711270". </ns2:message> </ns2:CmsIntegrationResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

3.7 Beispiele für die Nutzung der Importschnittstelle

3.7.1 Beispiele für die Nutzung der ImportschnittstelleDie folgenden Beispiele beschreiben die Nutzung der Importschnittstelle, wobei mit jedem Beispiel die Komplexität steigt. Es ist empfehlenswert, wenn Sie die Beispiele in der angegebenen Reihenfolge ansehen.

• Import einer Dienststelle ohne OrganisationseinheitenZeigt den kleinstmöglichen Request. Dabei werden einige grundsätzliche Begriffe erklärt. "Klein" ist dieser Request jedoch nur in Bezug auf die gesendete Soap-Nachricht, nicht jedoch in Bezug auf seine Auswirkungen. Denn wenn Sie diesen Request für eine Dienststelle mit einem tiefen Organigramm senden, wird der komplette organisatorische Unterbau der Dienststelle gelöscht. Nur die Dienststelle als Einstiegspunkt bleibt erhalten.

• Import einer Dienststelle mit OrganisationseinheitenZeigt, wie man unterhalb der Dienststelle zwei Organisationseinheiten ("Hauptamt" und "Einwohnermeldeamt") mit Adresse und Kommunikationsdaten importiert. Es werden jedoch keine Bilder (Logos), keine Aufgabenzuordnungen, keine Mitarbeiter (Ansprechpartner) und keine regionalen Ergänzungen importiert.

• Import mit LeistungszuordnungenZeigt zusätzlich, wie man Aufgabenzuordnungen für die beiden Organisationseinheiten ("Hauptamt" und "Einwohnermeldeamt") importiert.

• Import von Mitarbeitern (Ansprechpartnern)Zeigt zusätzlich, wie man Mitarbeiter (Ansprechpartner) für die beiden Organisationseinheiten ("Hauptamt" und "Einwohnermeldeamt") importiert.

• Import mit LogosZeigt zusätzlich, wie Bilder (Logos) für eine Organisationseinheit bzw. einen Mitarbeiter (Ansprechpartner) importiert.

• Import mit Leistungszuordnungen und regionalen ErgänzungenZeigt, wie man für die beiden Organisationseinheiten neben den Aufgabenzuordnungen zwei regionale Ergänzungen importiert.

• Import mit Angabe des EinhängepunktsZeigt, wie man Daten nur unterhalb eines bestimmten Einhängepunkts importiert bzw. aktualisiert.

Page 136: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  136 von 187

3.7.2 Import einer Dienststelle ohne Organisationseinheiten

Import einer Dienststelle ohne OrganisationseinheitenDas folgende Beispiel zeigt Ihnen, wie ein minimaler Request aussehen kann. Im Soap-Body ist das Dokument-Wurzelelement CmsIntegrationRequest eingebettet, darin wiederum die verpflichtenden Elemente organisationund wsRequestContext. Das mögliche Element logos fehlt, weil bei diesem Request keine Bilder mitgeliefert werden sollen.

organisation

Innerhalb des Elements organisation sind nur Daten zur Dienststelle "Gemeinde Kirchlauter" zu finden (z.B. bezeichnung, providerid usw.). Im Container adressen ist nur ein Element adresse enthalten, was wohl der Normalfall ist. Es wäre jedoch auch möglich, mehrere Adressen anzugeben. Eine Adresse ist jedoch verpflichtend.

Auch andere optionale Elemente innerhalb von organisation und adresse fehlen, nämlich bei organisation die möglichen Elemente logo und aufgaben, bei adresse die möglichen Elemente logo und email.

providerId

Die Elemente organisation und adresse haben ein Kindelement providerId, das Sie unbedingt nutzen sollten. Geben Sie hier bitte eine eindeutige Id für das Elternelement (z.B. die Adresse) mit. Das kann ohne weiteres eine interne, vielleicht sogar generierte Id sein. Wichtig ist nur, dass das Elternelement (z.B. die Adresse) immer die gleiche Id hat, wann immer sie im Request vorkommt. Typisch wäre z.B. der Fall, dass der Organisationsbaum aus der Dienststelle und mehreren Organisationseinheiten besteht, dass aber alle Organisationseinheiten die gleiche Adresse haben. Dann muss auch die providerId aller Elemente  adresse identisch sein.

Bei dem hier dargestellten Request ist die providerId noch ohne Bedeutung, da nur genau eine Organisationseinheit bzw. Adresse importiert wird. Wenn Sie aber die komplette Organisationshierarchie der Dienststelle importieren, dann erkennt der Webservice an der providerId, ob das zu importierende Objekt (z.B. die Adresse) bereits an anderen Stellen im XML-Payload vorkommt und referenziert es nur noch, statt das Objekt mehrfach zu importieren.

Das Element providerId kann eine beliebige Zeichenkette oder Zahl enthalten. Es ist nur für die Verarbeitung des aktuellen Request von Bedeutung und wird nicht im BayernPortal gespeichert.

wsRequestContext

Innerhalb des Elements wsRequestContext geben Sie wichtige Steuerungsdaten für den Request an.

dienststellenSchluessel

Das element dienststellenSchluessel legt den Einstiegspunkt fest. Der Einstiegspunkt identifiziert eine Dienststelle, deren Daten bereits im BayernPortal gespeichert sind. (Wir gehen davon aus, dass in der Verwaltung jeder Dienststelle die eigene 7-stellige Dienststellennummer bekannt ist.)  Der Request bezieht sich also auf die hier referenzierte Dienststelle und kann nur Daten dieser Dienststelle oder einer Organisationseinheit im Organigramm dieser Dienststelle verändern. Selbstverständlich sollten Sie hier nur die Dienststellennummer einer Dienststelle angeben, für die ihre Kennung eine Importberechtigung hat. Andernfalls wird der Request zurückgewiesen.

organisationsBezeichnung

Das element organisationsBezeichnung ist bei diesem Beispiel leer. Sie könnten hier die Bezeichnung einer im BayernPortal bereits bestehenden Organisationseinheit im Organigramm der Dienststelle angeben. Diese Organisationseinheit könnte z.B. durch einen früheren Import erzeugt worden sein. Falls die Organisationseinheit aufgrund der angegebenen Bezeichnung gefunden werden kann, würde sie als Einhängepunkt verwendet. Dazu erfahren Sie in einem späteren Beispiel mehr.

Page 137: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  137 von 187

responseViaWebService / responseEndpoint und responseViaEMail / responseEMailAddress

Mit diesen Elementpaaren können Sie angeben, auf welchen Kanälen Sie über den Erfolg oder Misserfolg des Imports informiert werden wollen. Wenn Sie das Element responseViaWebService auf den Wert true setzen, müssen sie ein weiteres Element responseEndpoint mit einer Webservice-Rückruf-URL angegeben. Davon machen wir hier keinen Gebrauch und erläutern in einem späteren Beispiel mehr.

Stattdessen ist das Element responseViaEMail mit true belegt, womit festgelegt ist, dass Sie per E-Mail benachrichtigt werden wollen. Natürlich müssen Sie dafür eine gültige E-Mail-Adresse angeben (Element responseEMailAddress). Sie können sich selbstverständlich auch auf beiden Kanälen benachrichtigen lassen.

<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:mes="http://lfstad.bayern.de/baybw/schemas/cmsintegration/messages" xmlns:typ="http://lfstad.bayern.de/baybw/schemas/cmsintegration/types"> <soapenv:Header/> <soapenv:Body> <mes:CmsIntegrationRequest> <mes:organisation> <typ:adressen> <typ:adresse> <typ:bezeichnung>Kirchlauter</typ:bezeichnung> <typ:hausAnschriftStrasse>Karl-Glockner-Str. 2</typ:hausAnschriftStrasse> <typ:hausAnschriftOrt>Kirchlauter</typ:hausAnschriftOrt> <typ:hausAnschriftPlz>96166</typ:hausAnschriftPlz> <typ:postAnschriftStrasse>Georg-Schäfer-Str. 56</typ:postAnschriftStrasse> <typ:postAnschriftOrt>Ebelsbach</typ:postAnschriftOrt> <typ:postAnschriftPlz>97500</typ:postAnschriftPlz> <typ:telefon>09536/921049</typ:telefon> <typ:fax>09536/1512</typ:fax> <typ:oeffnungsZeiten></typ:oeffnungsZeiten> <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId> </typ:adresse> </typ:adressen> <typ:bezeichnung>Kirchlauter</typ:bezeichnung> <typ:bezeichnungZusatz>Gemeinde</typ:bezeichnungZusatz> <typ:kurzBeschreibung>Kurzbeschreibung für Gemeinde Kirchlauter</typ:kurzBeschreibung> <typ:langBeschreibung>Langbeschreibung für Gemeinde Kirchlauter</typ:langBeschreibung> <typ:homePage>http://www.kirchlauter.de</typ:homePage> <typ:gruppe>Aemter / Sachgebiete</typ:gruppe> <typ:providerId>ORGANISATION_PROVIDER_ID_0</typ:providerId> </mes:organisation> <mes:wsRequestContext> <typ:dienststellenSchluessel>6741603</typ:dienststellenSchluessel> <typ:organisationsBezeichnung></typ:organisationsBezeichnung> <typ:responseViaWebService>false</typ:responseViaWebService> <typ:responseViaEMail>true</typ:responseViaEMail> <typ:responseEMailAddresses> <typ:responseEMailAddress>[email protected]</typ:responseEMailAddress> </typ:responseEMailAddresses> <typ:requestTransactionId>TRANSACTION_1</typ:requestTransactionId> </mes:wsRequestContext> </mes:CmsIntegrationRequest> </soapenv:Body></soapenv:Envelope>

Page 138: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  138 von 187

Sie können den Beispiel-Request auch zur Bearbeitung in einem Editor ihrer Wahl herunterladen.

Welche Daten werden durch diesen Request im BayernPortal geändert?Man könnte bei diesem Beispiel meinen, dass der Request nur die Daten der Dienststelle selbst bzw. ihre Adresse aktualisiert. Das ist aber nicht der Fall. Vielmehr ist dieser Webservice darauf angelegt, mit jedem Request einen kompletten organisatorischen Teilbaum einer Dienststelle zu importieren und zwar mit allen Konsequenzen. Der zu importierende Teilbaum beginnt im dargestellten Beispiel bei der Dienststelle selbst ( Einstiegspunkt ).

D.h. mit diesem Request - so klein er auch ist - liefern Sie alle Daten zur Dienststelle. Das hat zur Folge, dass nach dem erfolgreichen Import folgende Daten im BayernPortal gespeichert sind:

• die Daten der Dienststelle und ihre Adresse• keinerlei sonstige Organisationseinheiten von einem früheren Import (Das Organigramm besteht nur

noch aus der Dienststelle.)• alle vorher vorhandenen Leistungszuordnungen (Dazu später mehr.)• möglicherweise noch regionale Ergänzungen zu den Leistungen von einem früheren Import (Dazu später

mehr.)• möglicherweise noch Mitarbeiter (=Ansprechpartner) von einem früheren Import, jedoch nur solche, die

(auch) der Dienststelle direkt zugewiesen waren (Genaueres dazu erfahren Sie später.)• möglicherweise Logos, die vorher schon vorhanden waren (Genaueres dazu erfahren Sie später.)

Dieser Import räumt also das ganze Organigramm der Dienststelle gründlich auf. Die Dienststelle, also der Einstiegspunktkann durch einen Import nicht gelöscht werden.

Sonst wäre plötzlich eine bayerische Dienststelle mit allen ihren Leistungszuordnungen aus dem BayernPortal verschwunden.

Aber auch so ist die Wirkung dieses Imports schon beachtlich. Alle vielleicht vorher vorhandenen Organisationseinheiten sind gelöscht. Alle Mitarbeiter (=Ansprechpartner), die die diesen Organisationseinheiten zugeordnet waren, sind gelöscht. Nur Mitarbeiter, die ausschließlich oder zumindest auch der Dienststelle selbst zugewiesen waren, sind noch vorhanden.

Alle Leistungszuordnungen zu (ehemals vorhandenen) Organisationseinheiten sind gelöscht. Sie sind aber nicht verloren, denn Sie wurden durch den Import an die Dienststelle geknüpft. Daher sind nun alle Leistungen der Dienststelle selbst zugeordnet. (Es ist ja keine Organisationseinheit sonst mehr vorhanden.)

Falls vor dem Import Logos gespeichert waren, die mit einer Organisationseinheit, deren Adresse oder einem Mitarbeiter verknüpft waren, welche es nun nicht mehr gibt, sind auch diese gelöscht.

Damit ist hoffentlich die Grundidee des Import-Webservices ausreichend beschrieben. Sie können nicht

• einzelne Organisationseinheiten neuanlegen, ändern oder löschen• einzelne Adressen (im Redaktionssystem "Gebäude" genannt) neuanlegen, ändern, zuordnen oder

löschen• einzelne Mitarbeiter (im Redaktionssystem "Ansprechpartner" genannt) neuanlegen, ändern, zuordnen

oder löschen• einzelne Logos neuanlegen, ändern, zuordnen oder löschen• einzelne Leistungszuordnungen anlegen oder löschen• einzelne Regionale Ergänzungen anlegen oder löschen

sondern nur eine komplette Organisationsstruktur inklusive der Leistungszuordnungen und regionalen Ergänzungen importieren.

Es ist jedoch möglich einen anderen Einhängepunkt anzugeben, also eine Organisationseinheit aus dem BayernPortal, die es im Organigramm dieser Dienststelle vor dem Import bereits gibt. Dann bleiben im Organigramm alle ihre "Geschwister" und "Vorgänger" von dem Import völlig unberührt. Der Einhängepunkt (Element organisationsBezeichnung) bestimmt also, welcher Teilbaum im Organigramm vom Import überhaupt betroffen ist.Falls Sie keinen Einhängepunkt angeben, wie in unserem Beispiel, dann gilt der Einstiegspunkt, also die Dienststelle, als Einhängepunkt.

Page 139: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  139 von 187

3.7.3 Import einer Dienststelle mit Organisationseinheiten

Import einer Dienststelle mit OrgansationseinheitenDas folgende Beispiel zeigt einen Request, der nicht nur Daten zur Dienststelle selbst, sondern auch zu zwei Organisationseinheiten liefert. Diese haben die Bezeichnung "Hauptamt" und "Einwohnermeldeamt" und sind im Organigramm direkt der Dienststelle "Gemeinde Kirchlauter" untergeordnet. Wir gehen davon aus, dass es nur ein Dienstgebäude für die Gemeinde Kirchlauter gibt. Die beiden Organisationseinheiten haben also die gleiche Adresse wie die Dienststelle.Wie auch im Beispiel Import einer Dienststelle ohne Organisationseinheiten, verzichten wir immer noch darauf, Bilder mitzuliefern.

Im Soap-Body ist das Dokument-Wurzelelement CmsIntegrationRequest eingebettet, darin wiederum die verpflichtenden Elemente organisation und wsRequestContext. Das mögliche Element logos fehlt, weil bei diesem Request keine Bilder mitgeliefert werden sollen.

organisation

Innerhalb des Elements organisation sind die Detaildaten zur Dienststelle "Gemeinde Kirchlauter" zu finden (z.B. bezeichnung, providerId usw.). Im Container adressen ist die adresse der Dienststelle angegeben.

organisationen

Die wesentliche Erweiterung zum Beispiel Import einer Dienststelle ohne Organisationseinheiten ist das Element organisationen, ein Container mit 0 bis n Kindelementen organisation. In diesem Container liefert der Request alle Organisationseinheiten, die im Organigramm der Dienststelle "Gemeinde Kirchlauter" direkt untergeordnet sind. Das sind die beiden Organisationseinheiten "Hauptamt" und "Einwohnermeldeamt".

Jede der beiden Organisationseinheiten hat als Kindelement einen adressen-Container mit einer adresse. Wenn Sie die drei Adressen der Dienststelle und der beiden Organisationseinheiten vergleichen, dann sind diese inhaltlich völlig identisch. Sie haben die gleiche providerId, woran der Webservice erkennt, dass das Objekt (nämlich die Adresse) im BayernPortal nur einmal angelegt werden muss. Alle Organisationseinheiten werden also mit der gleichen Adresse verknüpft.

Dagegen ist die providerId der drei organisation-Elemente unterschiedlich. Der Webservice legt daher die beiden Organisationseinheiten unterhalb der Dienststelle neu an. Die Dienststelle ist ja als Einstiegspunkt ohnehin schon vorhanden und wird nur aktualisiert.

wsRequestContext

Der Inhalt dieses verpflichtenden Elements wurde unverändert aus dem Beispiel Import einer Dienststelle ohne Organisationseinheiten übernommen, wo Sie weitere Erläuterungen zur Bedeutung der Kindelmente finden.

Page 140: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  140 von 187

<soapenv:Envelope xmlns:mes="http://lfstad.bayern.de/baybw/schemas/cmsintegration/messages" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://lfstad.bayern.de/baybw/schemas/cmsintegration/types"> <soapenv:Body> <mes:CmsIntegrationRequest> <mes:organisation> <typ:adressen> <typ:adresse> ... <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId> </typ:adresse> </typ:adressen> ... <typ:providerId>ORGANISATION_PROVIDER_ID_0</typ:providerId>  <typ:organisationen> <typ:organisation> <typ:adressen> <typ:adresse> <typ:bezeichnung>Kirchlauter</typ:bezeichnung> <typ:hausAnschriftStrasse>Karl-Glockner-Str. 2</typ:hausAnschriftStrasse> <typ:hausAnschriftOrt>Kirchlauter</typ:hausAnschriftOrt> <typ:hausAnschriftPlz>96166</typ:hausAnschriftPlz> <typ:postAnschriftStrasse>Georg-Schäfer-Str. 56</typ:postAnschriftStrasse> <typ:postAnschriftOrt>Ebelsbach</typ:postAnschriftOrt> <typ:postAnschriftPlz>97500</typ:postAnschriftPlz> <typ:telefon>09536/921049</typ:telefon> <typ:fax>09536/1512</typ:fax> <typ:oeffnungsZeiten/> <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId> </typ:adresse> </typ:adressen> <typ:bezeichnung>Hauptamt</typ:bezeichnung> <typ:bezeichnungZusatz></typ:bezeichnungZusatz> <typ:kurzBeschreibung></typ:kurzBeschreibung> <typ:langBeschreibung></typ:langBeschreibung> <typ:homePage></typ:homePage> <typ:gruppe>Aemter / Sachgebiete</typ:gruppe> <typ:providerId>ORGANISATION_PROVIDER_ID_10</typ:providerId> </typ:organisation>  <typ:organisation> <typ:adressen> <typ:adresse> <typ:bezeichnung>Kirchlauter</typ:bezeichnung> <typ:hausAnschriftStrasse>Karl-Glockner-Str. 2</typ:hausAnschriftStrasse> <typ:hausAnschriftOrt>Kirchlauter</typ:hausAnschriftOrt> <typ:hausAnschriftPlz>96166</typ:hausAnschriftPlz> <typ:postAnschriftStrasse>Georg-Schäfer-Str. 56</typ:postAnschriftStrasse> <typ:postAnschriftOrt>Ebelsbach</typ:postAnschriftOrt> <typ:postAnschriftPlz>97500</typ:postAnschriftPlz> <typ:telefon>09536/921049</typ:telefon> <typ:fax>09536/1512</typ:fax> <typ:oeffnungsZeiten/> <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId> </typ:adresse>

Page 141: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  141 von 187

</typ:adressen> <typ:bezeichnung>Einwohnermeldeamt</typ:bezeichnung> <typ:bezeichnungZusatz></typ:bezeichnungZusatz> <typ:kurzBeschreibung></typ:kurzBeschreibung> <typ:langBeschreibung></typ:langBeschreibung> <typ:homePage></typ:homePage> <typ:gruppe>Aemter / Sachgebiete</typ:gruppe> <typ:providerId>ORGANISATION_PROVIDER_ID_11</typ:providerId> </typ:organisation> </typ:organisationen>  </mes:organisation> <mes:wsRequestContext> ... </mes:wsRequestContext></mes:CmsIntegrationRequest>  </soapenv:Body></soapenv:Envelope>

Sie können den vollständigen Beispiel-Request auch zur Bearbeitung in einem Editor ihrer Wahl herunterladen.

Welche Daten werden durch diesen Request im BayernPortal geändert?Alles was unter Import einer Dienststelle ohne Organisationseinheiten erläutert wurde, gilt auch für diesen Request. Dort sind einige grundsätzliche Erläuterungen zu finden, während hier nur noch beschrieben wird, was bei diesem Request zusätzlich gilt.

Im Organigramm unterhalb der Dienststelle wurden zwei Organisationseinheiten angelegt. Sie sind mit genau einem Gebäude / einer Adresse verknüpft. Im Redaktionssystem sieht ein Benutzer etwa folgendes Bild:

Abbildung: Dienststelle und Organisationseinheiten nach Import im Redaktionssystem

Da im Request keinerlei Leistungszuordnungen (weder für die Dienststelle noch für die beiden Organisationseinheiten) geliefert wurden, sind alle Leistungen, die der Dienststelle von der zentralen Redaktion (Bayerisches Staatsministerium des Innern) zugewiesen wurden, allein der Dienststelle zugeordnet. Neue regionale Ergänzungen wurden durch diesen Request auch nicht geliefert.

Page 142: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  142 von 187

3.7.4 Import von Dienststellen und ihrer Außenstellen

ProblembeschreibungBeim Importieren des Organisationsbaums von Landratsämtern aus deren Content-Management-Systemen (CMS) in das BayernPortal tritt regelmäßig folgende Fragestellung auf:

Außenstellen sind im Datenmodell des BayernPortals vom Typ her „Dienststellen“ und daher aufgrund zentraler Datenpflege immer schon vorhanden. Sie haben eine Dienststellennummer, die sich aus der Dienststellennummer der Hauptdienststelle und einer zusätzlichen laufenden Nummer zusammensetzt. Die folgende Tabelle zeigt am Beispiel des Landratsamts Wunsiedel die erste und zweite Ebene des Organigramms:

Organisatorische Bezeichnung Typ

Wunsiedel i.Fichtelgebirge (Landratsamt) / WUN Dienststelle

(Nr.: 348193)

Landratsamt Wunsiedel i.Fichtelgebirge Abteilung Gesundheitswesen Außenstelle Selb

Dienststelle / Außenstelle

(Nr.: 348193 - 1)

Landratsamt Wunsiedel i.Fichtelgebirge Kfz-Zulassungsstelle Außenstelle Marktredwitz

Dienststelle / Außenstelle

(Nr.: 348193 - 2)

Landratsamt Wunsiedel i.Fichtelgebirge Kfz-Zulassungsstelle Außenstelle Selb

Dienststelle / Außenstelle

(Nr.: 348193 - 3

Amtsvorstand - Landrat Dr. Karl Döhler Organisationseinheit

Verkehrsgemeinschaft Fichtelgebirge (Geschäftsstelle) Organisationseinheit

Gleichstellungsstelle Organisationseinheit

Kreisrechnungsprüfungsamt Organisationseinheit

Abt. 1 - Zentrale Dienste Organisationseinheit

Abt. 2 - Kommunale und soziale Angelegenheiten Organisationseinheit

Abt. 3 - Öffentliche Sicherheit und Ordnung Organisationseinheit

Abt. 4 - Bauabteilung, Umweltschutz Organisationseinheit

Abt. 6 - Gesundheitswesen Organisationseinheit

Wie soll mit den Außenstellen und ihrer organisatorischen Untergliederung umgegangen werden?

Page 143: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  143 von 187

Organisatorische Bezeichnung Typ

Abt. 7 - Veterinärwesen, Ernährung und Verbraucherschutz

Organisationseinheit

Tabelle 1: Landratsamt Wunsiedel – Organigramm (erste und zweite Ebene)

Wenn beim Import als Einstiegspunkt der oberste Knoten (also das Landratsamt als Dienststelle mit der Nr. 348193) gewählt wird, und alle untergeordneten Organisationseinheiten importiert werden sollen, ergibt die Validierung der Importdaten folgende Fehler:

• Organisationsbezeichnung "Landratsamt Wunsiedel i.Fichtelgebirge Abteilung Gesundheitswesen Außenstelle Selb" ist bereits im BayernPortal vorhanden. Ein Einfügen dieser Organisationseinheit würde daher ein Duplikat erzeugen.

• Organisationsbezeichnung "Landratsamt Wunsiedel i.Fichtelgebirge Kfz-Zulassungsstelle Außenstelle Marktredwitz" ist bereits im BayernPortal vorhanden. Ein Einfügen dieser Organisationseinheit würde daher ein Duplikat erzeugen.

• Organisationsbezeichnung "Landratsamt Wunsiedel i.Fichtelgebirge Kfz-Zulassungsstelle Außenstelle Selb" ist bereits im BayernPortal vorhanden. Ein Einfügen dieser Organisationseinheit würde daher ein Duplikat erzeugen.

Der Import kann nicht ausgeführt werden, weil die Außenstellen als Dienststellen bereits im BayernPortal vorhanden sind. Im Gegensatz zu Organisationseinheiten gehören die Dienststellen und ihre Außenstellen zum zentral gepflegten Stammdaten-Bestand des BayernPortals.

Sie können bei einem Importvorgang nicht einfach gelöscht und wieder neu angelegt werden, wie dies mit Organisationseinheiten (und deren Verknüpfungen) geschieht. Denn die Dienststellen (als zentral gepflegte Stammdaten) sind im Datenmodell des BayernPortals mit zusätzlichen Merkmalen verknüpft, die der Import nicht liefern (also nach dem Löschen nicht wiederherstellen) kann.

Lösungsvariante 1Als Einstiegsknoten wird der oberste Knoten (also das Landratsamt selbst) verwendet. (Das ist eigentlich der Normalfall.) Der Webservice-Client sorgt aber beim Erstellen der Import-Datei (also des Webservice-Request) dafür, dass die Außenstellen nicht exakt die gleiche organisatorische Bezeichnung haben wie im BayernPortal.

Vorteile

Die Außenstellen können dann wie normale Organisationseinheiten importiert werden. (Theoretisch könnten sie sogar an beliebiger Stelle im Organigramm der Dienststelle eingegliedert sein, also nicht nur direkt unterhalb der Hauptdienststelle.)Falls die Außenstelle durch Organisationseinheiten weiter untergliedert ist, werden auch diese Organisationseinheiten importiert. Das gilt ebenso für alle Aufgabenzuordnungen, regionalen Ergänzungen und Ansprechpartner, die der Außenstelle und ihren Organisationseinheiten zugeordnet sind.

Nachteil

Die Außenstellen sind nach dem Import unter zwei verschiedenen Bezeichnungen und Organisationstypen im BayernPortal vorhanden. Einmal als Typ „Dienststelle“ und einmal als Typ „Organisationseinheit“.Die „wirklichen“ Außenstellen werden vom Import ignoriert und bleiben „verwaist“ zurück. Zu ihnen werden keine untergeordneten Organisationseinheiten, keine Aufgabenzuordnungen und Ansprechpartner  importiert.

Empfehlung

Diese Lösungsvariante interpretiert die Außenstellen als Organisationseinheiten (Abteilung  Gesundheit, Kfz-Zulassungsstelle) und gliedert sie unter einer entsprechenden Bezeichnung in den Organisationsbaum der Hauptdienststelle ein. Wenn dies organisatorisch der Realität entspricht, ist dies Lösungsvariante relativ unkompliziert anzuwenden.

Page 144: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  144 von 187

Lösungsvariante 2Daten zur Hauptdienststelle und zu den Außenstellen werden in getrennten Imports (Webservice-Requests) hochgeladen. Im Fall des Landratsamts Wunsiedel sind dazu insgesamt 4 Imports notwendig, um für die Hauptdienststelle und alle ihre Außenstellen die komplette organisatorische Untergliederung (inkl. Aufgaben, Ansprechpartner etc.) zu liefern:

1. Import:

Einstiegspunkt ist der oberste Knoten (also die Dienststelle). Es werden alle Organisationseinheiten unterhalb der Dienststelle mit ihren Zuordnungen von Aufgaben, Ansprechpartnern etc. geliefert. Daten zu den drei Außenstellen sind nicht enthalten.

2. bis 4. Import:

Einstiegspunkt ist je eine der drei Außenstellen. Neben der Außenstelle (als Einstiegspunkt) werden alle Organisationseinheiten unterhalb der Außenstelle mit ihren Zuordnungen von Aufgaben, Ansprechpartnern etc. geliefert.

Exemplarischer Inhalt 1. Import

<CmsIntegrationRequest> <organisation> … Elemente mit Daten der Hauptdienststelle selbst <organisationen> … Elemente mit untergeordnete Organisationseinheiten der Hauptdienststelle und deren Zuordnungen, aber ohne die Außenstellen </organisationen> </organisation> <wsRequestContext> <dienststellenSchluessel>348193</dienststellenSchluessel> <organisationsBezeichnung /> … weitere Elemente </wsRequestContext></CmsIntegrationRequest>

Exemplarischer Inhalt 2. bis 4. Import

<CmsIntegrationRequest> <organisation> … Elemente mit Daten der Außenstelle selbst <organisationen> … Elemente mit untergeordneten Organisationseinheiten der Außenstelle mit ihren Zuordnungen </organisationen> </organisation> <wsRequestContext> <dienststellenSchluessel>348193</dienststellenSchluessel> <organisationsBezeichnung>Landratsamt Wunsiedel i.Fichtelgebirge Abteilung Gesundheitswesen Außenstelle Selb</organisationsBezeichnung> … weitere Elemente </wsRequestContext></CmsIntegrationRequest>

Beachten Sie bitte:

Page 145: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  145 von 187

• Bei allen 4 Imports ist der Inhalt des Elements <wsRequestContext> / <dienststellenSchluessel> identisch, nämlich 348193, auch bei den Außenstellen.

• Bei allen Imports enthält das äußerste <organisation>-Element die Daten zum Einstiegspunkt. Beim ersten Import ist es die Hauptdienststelle, bei den anderen eine der Außenstellen.

• Beim 1. Import ist das Element <wsRequestContext> / <organisationsBezeichnung> ein leeres Element (Einhängepunkt= Einstiegspunkt).

• Beim 2. bis 4. Import steht im Element <wsRequestContext> / <organisationsBezeichnung> die Bezeichnung der Außenstelle (genauso geschrieben, wie ihre offizielle Bezeichnung im BayernPortal ist). Dieses Element ist nämlich beim Import wichtig, um die richtige Außenstelle als Einhängepunkt zu finden.

Vorteile:

Die Daten der Hauptdienststelle und ihrer Außenstellen können inklusive des jeweiligen organisatorischen Unterbaus und aller Zuordnungen (Aufgaben, regionale Ergänzungen und Ansprechpartner) korrekt importiert werden.

Nachteil:

Es müssen mehrere Import-Aufrufe ausgeführt werden.

Voraussetzungen:

Im CMS des Landratsamts müssen die Daten der Hauptdienststelle und der Außenstellen klar voneinander abzugrenzen sein. Die Außenstelle darf also nicht nur ein abweichendes Adressefeld sein. Die Bezeichnungen der Außenstellen müssen im CMS des Landratsamts mit denen im BayernPortal übereinstimmen.

3.7.5 Import mit Leistungszuordnungen

Import mit LeistungszuordnungenDer hier beschriebene Request baut auf dem Beispiel Import einer Dienststelle mit Organisationseinheiten auf. Er zeigt darüber hinaus, wie man die Zuordnung von Leistungen der Dienststelle zu ihren Organisationseinheiten importieren kann.

1. Schritt: Abrufen der Leistungen

Wenn Sie Leistungszuordnungen importieren wollen, dann brauchen Sie die BayernPortal-Ids dieser Leistungen. Um diese zu erhalten, rufen Sie per Webservice die Leistungen ab, die Ihrer Dienststelle insgesamt zugeordnet sind. Es ist sicher sinnvoll, diese Liste in Ihrem System zu hinterlegen. Zwar ändert sich der "Leistungsbestand" der Dienststelle nicht täglich, dennoch sollten Sie regelmäßig überprüfen, was sich geändert hat. Sie können dafür den Webservice nutzen, der unter Abrufen der Leistungen, die einer Dienststelle zugeordnet sind beschrieben wird.

Vermutlich haben in Ihrem System Leistungen eine andere Repräsentation als im BayernPortal. Dann müssen sie die eigenen Repräsentationen irgendwie mit denen des BayernPortals verknüpfen (z.B. durch ein Id-Mapping). Sie könnten natürlich auch über den Webservice Abrufen der Leistungsbeschreibungen, die einer Dienststelle zugeordnet sind die vollständigen Leistungsbeschreibungen für Ihre Dienststelle aus dem BayernPortal abrufen und diese als Repräsentation der Leistungen in Ihrem System verwenden.

Falls Sie bei einem Import Ids von Leistungen angeben, die nicht zum derzeitigen "Leistungsbestand" der Dienststelle gehören, werden die Zuordnungen nicht berücksichtigt. Sie erhalten dann in der Antwort (per E-Mail oder per Webservice-Rückruf) die Fehlermeldung: "Leistung mit der Id ... ist der Dienststelle ... nicht zugeordnet und kann daher auch nicht von einer untergeordneten Organisationseinheit ... wahrgenommen werden ...". Weitere Details dazu finden Sie im Kapitel Validierungsfehler.

2. Schritt: Import der Leistungszuordnungen

Nehmen wir nun an, dass der Dienststelle "Gemeinde Kirchlauter" vor dem Import 258 Leistungen zugewiesen sind. Diese Leistungen wurden von der zentralen Redaktion (Herausgeber) an die Dienststelle "ausgerollt". Das ist also der derzeitige "Leistungsbestand" der Dienststelle.

Page 146: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  146 von 187

Wenn es

• für die Dienststelle noch keine Organisationseinheiten gibt oder wenn• sich bisher niemand darum gekümmert hat, die Leistungen eventuell bereits vorhandenen

Organisationseinheiten zuzuordnen,

dann sind alle 258 Leistungen immer noch der Dienststelle (= dem Einstiegspunkt) zugeordnet. Das wollen wir mit diesem Import bespielhaft für das "Hauptamt" und das "Einwohnermeldeamt" ändern.

Hier ist zunächst ein tabellarischer Auszug der Leistungen der Gemeinde Kirchlauter:

ID der Leistung Leistung zugewiesen an

1845 Abmarkung gemeindlicher Grundstücke Gemeinde Kirchlauter

298 Ausstellung von Personenstandsurkunden Gemeinde Kirchlauter

3596 Auszug aus dem Gewerbezentralregister Gemeinde Kirchlauter

1839 Bauanträge - Prüfung, Einvernehmen Gemeinde Kirchlauter

3776 Bauleitplanverfahren Gemeinde Kirchlauter

3770 Bebauungsplan Gemeinde Kirchlauter

3462 Beglaubigungen (Gemeinde) Gemeinde Kirchlauter

3455 Behördennetz (Gemeinde) Gemeinde Kirchlauter

3530 Bildungseinrichtungen; Benutzungsgebühren Gemeinde Kirchlauter

3531 Bildungseinrichtungen; Benutzungsordnung Gemeinde Kirchlauter

1847 Bodenrichtwerte Gemeinde Kirchlauter

2911 Bürgerbegehren und Bürgerentscheide (Gemeinde) Gemeinde Kirchlauter

3463 Bürgermeister- und Gemeinderatsangelegenheiten Gemeinde Kirchlauter

3471 Datenschutzbeauftragter (Gemeinde) Gemeinde Kirchlauter

Die Leistungszuordnung soll nun durch den Import geändert werden. 5 der angezeigten Leistungen sollen dem Hauptamt und 4 dem Einwohnermeldamt zugewiesen werden, so dass sich nach dem Import folgendes Bild ergeben wird:

ID der Leistung Leistung zugewiesen an

1845 Abmarkung gemeindlicher Grundstücke Gemeinde Kirchlauter

298 Ausstellung von Personenstandsurkunden Einwohnermeldeamt

Page 147: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  147 von 187

ID der Leistung Leistung zugewiesen an

3596 Auszug aus dem Gewerbezentralregister Einwohnermeldeamt

1839 Bauanträge - Prüfung, Einvernehmen Gemeinde Kirchlauter

3776 Bauleitplanverfahren Gemeinde Kirchlauter

3770 Bebauungsplan Gemeinde Kirchlauter

3462 Beglaubigungen (Gemeinde) Hauptamt

3455 Behördennetz (Gemeinde) Hauptamt

3530 Bildungseinrichtungen; Benutzungsgebühren Hauptamt

3531 Bildungseinrichtungen; Benutzungsordnung Hauptamt

1847 Bodenrichtwerte Gemeinde Kirchlauter

2911 Bürgerbegehren und Bürgerentscheide (Gemeinde) Einwohnermeldeamt

3463 Bürgermeister- und Gemeinderatsangelegenheiten Einwohnermeldeamt

3471 Datenschutzbeauftragter (Gemeinde) Hauptamt

Im Soap-Body ist das Dokument-Wurzelelement CmsIntegrationRequest eingebettet, darin wiederum die verpflichtenden Elemente organisation und wsRequestContext. Das mögliche Element logos fehlt, weil bei diesem Request keine Bilder mitgeliefert werden sollen.

organisation

Innerhalb des Elements organisation sind die Detaildaten zur Dienststelle "Gemeinde Kirchlauter" zu finden (z.B. bezeichnung, providerId). Im Container adressen ist die adresse der Dienststelle angegeben. Das optionale Kindelement aufgaben fehlt bei der Dienststelle, denn Sie können mit dem Import der Dienststelle nicht direkt Leistungen zuordnen.

organisationen/organisation/aufgaben/aufgabe

Die wesentliche Erweiterung im Bezug auf das Beispiel Import einer Dienststelle mit Organisationseinheiten ist das Element aufgaben, ein Container mit 0 bis n Kindelementen aufgabe. In diesem Container liefert der Request die Ids der Leistungen, die den Organisationseinheiten "Hauptamt" bzw. "Einwohnermeldeamt" zugewiesen werden sollen. Die Ids derjenigen Leistungen, die für eine Dienststelle in Frage kommen, erhalten Sie über den Webservices Abrufen der Leistungen, die einer Dienststelle zugeordnet sind.

5 Leistungen sind für das Hauptamt vorgesehen und 4 Leistungen für das Einwohnermeldeamt. Die sonstigen Inhalte der Elemente organisationen, organisation, adressen und adresse haben wir unverändert aus dem Beispiel Import einer Dienststelle mit Organisationseinheiten übernommen.

Page 148: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  148 von 187

wsRequestContext

Der Inhalt dieses verpflichtenden Elements wurde unverändert aus dem Beispiel Import einer Dienststelle ohne Organisationseinheiten übernommen, wo Sie weitere Erläuterungen zur Bedeutung der Kindelmente finden.

Page 149: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  149 von 187

<soapenv:Envelope xmlns:mes="http://lfstad.bayern.de/baybw/schemas/cmsintegration/messages" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://lfstad.bayern.de/baybw/schemas/cmsintegration/types"> <soapenv:Body> <mes:CmsIntegrationRequest> <mes:organisation> <typ:adressen> <typ:adresse> ... <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId> </typ:adresse> </typ:adressen> <typ:bezeichnung>Kirchlauter</typ:bezeichnung> <typ:bezeichnungZusatz>Gemeinde</typ:bezeichnungZusatz> ... <typ:providerId>ORGANISATION_PROVIDER_ID_0</typ:providerId>  <typ:organisationen> <typ:organisation> <typ:adressen> <typ:adresse> ... <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId> </typ:adresse> </typ:adressen> <typ:bezeichnung>Hauptamt</typ:bezeichnung> ... <typ:providerId>ORGANISATION_PROVIDER_ID_10</typ:providerId>  <typ:aufgaben> <typ:aufgabe> <typ:id>3462</typ:id> </typ:aufgabe> <typ:aufgabe> <typ:id>3455</typ:id> </typ:aufgabe> <typ:aufgabe> <typ:id>3530</typ:id> </typ:aufgabe> <typ:aufgabe> <typ:id>3531</typ:id> </typ:aufgabe> <typ:aufgabe> <typ:id>3471</typ:id> </typ:aufgabe> </typ:aufgaben>  </typ:organisation>  <typ:organisation> <typ:adressen> <typ:adresse> ... <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId> </typ:adresse> </typ:adressen>

Page 150: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  150 von 187

<typ:bezeichnung>Einwohnermeldeamt</typ:bezeichnung> ... <typ:providerId>ORGANISATION_PROVIDER_ID_11</typ:providerId>  <typ:aufgaben> <typ:aufgabe> <typ:id>298</typ:id> </typ:aufgabe> <typ:aufgabe> <typ:id>3596</typ:id> </typ:aufgabe> <typ:aufgabe> <typ:id>2911</typ:id> </typ:aufgabe> <typ:aufgabe> <typ:id>3463</typ:id> </typ:aufgabe> </typ:aufgaben>  </typ:organisation> </typ:organisationen>  </mes:organisation> <mes:wsRequestContext> ... </mes:wsRequestContext></mes:CmsIntegrationRequest>  </soapenv:Body></soapenv:Envelope>

Sie können den vollständigen Beispiel-Request auch zur Bearbeitung in einem Editor ihrer Wahl herunterladen.

Welche Daten werden durch diesen Request im BayernPortal geändert?Wie beim Beispiel Import einer Dienststelle mit Organisationseinheiten werden im Organigramm unterhalb der Dienststelle die beiden Organisationseinheiten "Hauptamt" und "Einwohnermeldeamt" neu angelegt. Sie sind mit genau einem Gebäude / einer Adresse verknüpft, die auch neu angelegt wird. Die Daten der Dienststelle selbst werden "nur" aktualisiert, also weder gelöscht noch neu angelegt.

Neu sind die Leistungszuordnungen, die wir für die beiden Organisationseinheiten importiert haben. Wenn ein Benutzer sich diese im Redaktionssystem https://www.bayvis-redaktionssystem.bayern.de ansieht (Menü "Leistungen" > "Leistungszuordnung"), erhält er folgendes Bild:

Page 151: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  151 von 187

Page 152: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  152 von 187

Abbildung: Leistungszuordnungen für das Hauptamt - Ansicht im Redaktionssystem nach dem Import

Abbildung: Leistungszuordnungen für das Einwohnermeldeamt - Ansicht im Redaktionssystem nach dem Import

Für die Leistungszuordnungen wurde automatisch der Standard-Zuständigkeitsbereich der Gemeinde Kirchlauter festgelegt. Auch dies kann ein Benutzer im Redaktionssystem sehen:

Page 153: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  153 von 187

Abbildung: Zuständigkeitsbereich für die Leistungen - Ansicht im Redaktionssystem nach dem Import

Neue regionale Ergänzungen wurden durch diesen Request - wie bei den bisherigen Bespielen - nicht angelegt.

Wie kann man der Dienststelle selbst Leistungen zuordnen?Sie können die Leistungszuordnungen der Dienststelle durch den Import nur indirekt beeinflussen. Es muss nach jedem Import sichergestellt sein, dass jede Leistung, die der Dienststelle von der zentralen Redaktion durch "Ausrollen" einmal zugewiesen war, im Organigramm der Dienststelle "irgendwo" zugewiesen bleibt. Um dies sicherzustellen, werden beim Import zunächst alle Leistungen den Organisationseinheiten zugeordnet, wie es oben beschrieben ist.Wenn nach der Verteilung noch Leistungen übrig bleiben, die zum Grund-Leistungsbestand der Dienststelle (Ausrollen!) gehören, aber im Import nirgendwo aufgeführt sind, dann werden (oder bleiben) diese Leistungen der Dienststelle zugeordnet.

Kann man Leistungen mehreren Organisationseinheiten gleichzeitig zuordnen?Ja. Sie müssen die Ids dieser Leistungen einfach im aufgaben-Container des jeweiligen organisation-Elements aufführen.

Kann man Leistungen gleichzeitig der Dienststelle und einer/mehreren Organisationseinheit(en) zuordnen?Im Prinzip ist das im BayernPortal erlaubt. Über das Redaktionssystem https://www.bayvis-redaktionssystem.bayern.dekönnen sie solche Zuordnungen manuell anlegen. Der Webservice-Import unterstützt dies jedoch nicht.

Kann man Leistungszuordnungen importieren, ohne gleichzeitig das Organigramm und die Adressdaten zu importieren?Nein. Der Import legt immer einen neuen Organisationsbaum an und ordnet die Leistungen dann erst zu.

Wie löscht man Leistungszuordnungen bei einer Organisationseinheit?Die empfohlene Vorgehensweise ist, beim Import die Leistungs-Id nicht (mehr) im aufgaben-Container der jeweiligen organisation aufzuführen.

Page 154: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  154 von 187

Die Leistungszuordnung wird natürlich auch gelöscht, wenn die Organisationseinheit durch den Import gelöscht wird. Dies geschieht, wenn die Organisationseinheit im Request nicht mehr als organisation-Element vorkommt.

Kann man den regionalen Zuständigkeitsbereich der Leistungszuordnung durch den Import beeinflussen?Nein. Über das Redaktionssystem https://www.bayvis-redaktionssystem.bayern.de ist dies ohne weiteres möglich. Denkbar wäre zum Beispiel, dass in einem Landkreis zwei Sachgebiete für die Bauaufsicht zuständig sind, das eine Sachgebiet für den nördlichen Bereich, das andere für den südlichen Bereich. Dann wären die betroffenen Leistungszuordnungen beim regionalen Zuständigkeitsbereich anzupassen. Der Import-Webservice unterstützt solche Spezialfälle leider nicht.

Daher gilt, dass jede Leistungszuordnung mit dem Standard-Zuständigkeitsbereich der Dienststelle erfolgt.

3.7.6 Import von Mitarbeitern (Ansprechpartnern)

Import von Mitarbeitern (Ansprechpartnern)Das folgende Beispiel zeigt einen Request, der auf dem Beispiel Import einer Dienststelle mit Organisationseinheitenaufbaut. Es werden also wieder die beiden Organisationseinheiten "Hauptamt" und "Einwohnermeldeamt" importiert. Darüber hinaus zeigt das Beispiel aber auch, wie man Mitarbeiter (Ansprechpartner) dieser beiden Organisationseinheiten importieren kann.

Wir verzichten weiterhin darauf, Bilder mitzuliefern.

Im Soap-Body ist das Dokument-Wurzelelement CmsIntegrationRequest eingebettet, darin wiederum die verpflichtenden Elemente organisation und wsRequestContext. Das mögliche Element logos fehlt, weil bei diesem Request keine Bilder mitgeliefert werden sollen.

organisation

Innerhalb des Elements organisation sind die Detaildaten zur Dienststelle "Gemeinde Kirchlauter" zu finden (z.B. bezeichnung, providerid). Im Container adressen ist die adresse der Dienststelle angegeben.

organisationen/organisation/adressen/adresse/mitarbeiter/mitarbeiter

Die wesentliche Erweiterung zum Beispiel Import einer Dienststelle mit Organisationseinheiten ist der Container mitarbeiter, in dem 0 bis n mitarbeiter-Elemente enthalten sein können.

Vielleicht fragen Sie sich, warum der Mitarbeiter-Container so tief "eingeschachtelt" ist. Er könnte prinzipiell auch ein Kindelement von organisation sein, womit lediglich ausgedrückt würde, dass ein Mitarbeiter (Ansprechpartner) zu einer bestimmten Organisationseinheit gehört.Unser tatsächlich etwas komplizierteres Datenmodell erlaubt es aber, Mitarbeiter (Ansprechpartner) auch dann genau zuzuordnen, wenn eine Organisationseinheit über mehrere Zweigstellen "verstreut" ist, also mehrere Adressen hat.Bei den 4 mitarbeiter-Elementen haben wir alle verpflichtenden Kindelemente angegeben. Soweit wir keinen konkreten Wert haben, haben wir die Elemente dennoch im Request aufgeführt, um eine erfolgreiche Schema-Validierung zu erreichen (z.B. bei <titel>, <mobilTelefon> und <sprechZeiten>).

providerId

Beachten Sie bitte, dass die mitarbeiter-Elemente ein Kindelement providerId haben. Es hat die gleiche Bedeutung wie bei Organisationseinheiten und Adressen. Wenn also ein Mitarbeiter im Request mehrfach vokommt, wie Frau "Annette Adam", die sowohl beim "Hauptamt" als auch beim "Einwohnermeldeamt" tätig ist, dann erkennt der Import-Webservice an der identischen ProviderId (hier: "MITARBEITER_PROVIDER_ID_1"), dass es sich um den gleichen Mitarbeiter handelt. Statt diesen im BayernPortal mehrfach anzulegen, wird er nur einmal gespeichert und beiden Organisationseinheiten zugeordnet.

Page 155: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  155 von 187

titel, stellenBezeichnung, geschlecht

Die Kindelemente von mitarbeiter sind weitgehend selbsterklärend. Das Element titel ist für Titel vorgesehen, die in der Anrede verwendet werden (z.B. Dr. oder Prof. Dr.). Das Element stellenBezeichnung ist für Amts-, Dienst- oder Tätigkeitsbezeichnungen (z.B. Verwaltungsangestellte, Regierungsrat, Geschäftsführer etc.) vorgesehen.Erwähnenswert ist das Element geschlecht, bei dem die drei Werte 0 = unbekannt, 1 = weiblich, 2 = männlich zulässig sind.

Die optionale Element logo haben wir stets, das optionale Element email bei einem Mitarbeiter (Ansprechpartner) weggelassen.

sprechZeiten

In diesem Kindelement konnen Sie die Sprechzeiten als Zeichenkette liefern. Sprechzeiten für Mitarbeiter (Ansprechpartner) sollten nur angegeben werden, wenn Sie von den Öffnungszeiten der Organisationseinheit abweichen, bei der der Mitarbeiter (Ansprechpartner) beschäftigt ist. Wir demonstrieren, am Beispiel von Herrn Christian Chef, dass in den Sprechzeiten auch einfache HTML-Tags zur Formatierung vorkommen dürfen (hier ein <br />).Es sind nur die HTML-Tags erlaubt, die auch im Redaktionssystem (https://www.bayvis-redaktionssystem.bayern.de) eingeben werden dürfen.

wsRequestContext

Der Inhalt dieses verpflichtenden Elements wurde unverändert aus dem Beispiel Import einer Dienststelle ohne Organisationseinheiten übernommen, wo Sie weitere Erläuterungen zur Bedeutung der Kindelmente finden.

Page 156: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  156 von 187

<soapenv:Envelope xmlns:mes="http://lfstad.bayern.de/baybw/schemas/cmsintegration/messages" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://lfstad.bayern.de/baybw/schemas/cmsintegration/types"> <soapenv:Body> <mes:CmsIntegrationRequest> <mes:organisation> <typ:adressen> <typ:adresse> ... <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId> </typ:adresse> </typ:adressen> <typ:bezeichnung>Kirchlauter</typ:bezeichnung> <typ:bezeichnungZusatz>Gemeinde</typ:bezeichnungZusatz> ... <typ:providerId>ORGANISATION_PROVIDER_ID_0</typ:providerId> <typ:organisationen> <typ:organisation> <typ:adressen> <typ:adresse> ... <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId>  <typ:mitarbeiter> <typ:mitarbeiter> <typ:vorname>Christian</typ:vorname> <typ:nachname>Chef</typ:nachname> <typ:titel>MA</typ:titel> <typ:stellenBezeichnung>Geschäftsleiter</typ:stellenBezeichnung> <typ:telefon>09536/277</typ:telefon> <typ:fax>09536/1277</typ:fax> <typ:email>[email protected]</typ:email> <typ:url>http://www.kirchlauter.de/hauptamt</typ:url> <typ:zimmer>23</typ:zimmer> <typ:mobilTelefon>0173/1234567</typ:mobilTelefon> <typ:geschlecht>2</typ:geschlecht> <typ:sprechZeiten> Mo 08:00 bis 12:00 13:00 bis 17:00&lt;br /&gt; Di 08:00 bis 12:00 13:00 bis 17:00&lt;br /&gt; Mi 08:00 bis 12:00 13:00 bis 19:00&lt;br /&gt; Do 08:00 bis 12:00 &lt;br /&gt; Fr 08:00 bis 12:00 13:00 bis 16:00&lt;br /&gt; </typ:sprechZeiten> <typ:providerId>MITARBEITER_PROVIDER_ID_0</typ:providerId> </typ:mitarbeiter> <typ:mitarbeiter> <typ:vorname>Annette</typ:vorname> <typ:nachname>Adam</typ:nachname> <typ:titel></typ:titel> <typ:stellenBezeichnung>Verwaltungsangestellte</typ:stellenBezeichnung> <typ:telefon>09536/688</typ:telefon> <typ:fax>09536/1688</typ:fax> <typ:email>[email protected]</typ:email> <typ:url>http://www.kirchlauter.de/einwohnermeldeamt</typ:url>

Page 157: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  157 von 187

<typ:zimmer>26</typ:zimmer> <typ:mobilTelefon></typ:mobilTelefon> <typ:geschlecht>1</typ:geschlecht> <typ:sprechZeiten></typ:sprechZeiten> <typ:providerId>MITARBEITER_PROVIDER_ID_1</typ:providerId> </typ:mitarbeiter> </typ:mitarbeiter>  </typ:adresse> </typ:adressen> <typ:bezeichnung>Hauptamt</typ:bezeichnung> ... <typ:providerId>ORGANISATION_PROVIDER_ID_10</typ:providerId> </typ:organisation>  <typ:organisation> <typ:adressen> <typ:adresse> ... <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId> <typ:mitarbeiter> <typ:mitarbeiter> <typ:vorname>Franz</typ:vorname> <typ:nachname>Fritz</typ:nachname> <typ:titel></typ:titel> <typ:stellenBezeichnung>Standesbeamter</typ:stellenBezeichnung> <typ:telefon>09536/477</typ:telefon> <typ:fax>09536/1477</typ:fax> <typ:url>http://www.kirchlauter.de/einwohnermeldeamt</typ:url> <typ:zimmer>25</typ:zimmer> <typ:mobilTelefon>0175/5544667</typ:mobilTelefon> <typ:geschlecht>2</typ:geschlecht> <typ:sprechZeiten></typ:sprechZeiten> <typ:providerId>MITARBEITER_PROVIDER_ID_2</typ:providerId> </typ:mitarbeiter> <typ:mitarbeiter> <typ:vorname>Annette</typ:vorname> <typ:nachname>Adam</typ:nachname> <typ:titel></typ:titel> <typ:stellenBezeichnung>Verwaltungsangestellte</typ:stellenBezeichnung> <typ:telefon>09536/688</typ:telefon> <typ:fax>09536/1688</typ:fax> <typ:email>[email protected]</typ:email> <typ:url>http://www.kirchlauter.de/einwohnermeldeamt</typ:url> <typ:zimmer>26</typ:zimmer> <typ:mobilTelefon></typ:mobilTelefon> <typ:geschlecht>1</typ:geschlecht> <typ:sprechZeiten></typ:sprechZeiten> <typ:providerId>MITARBEITER_PROVIDER_ID_1</typ:providerId> </typ:mitarbeiter> </typ:mitarbeiter>  </typ:adresse> </typ:adressen> <typ:bezeichnung>Einwohnermeldeamt</typ:bezeichnung> ... <typ:providerId>ORGANISATION_PROVIDER_ID_11</typ:providerId>

Page 158: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  158 von 187

</typ:organisation> </typ:organisationen> </mes:organisation> <mes:wsRequestContext> ... </mes:wsRequestContext></mes:CmsIntegrationRequest>  </soapenv:Body></soapenv:Envelope>

Sie können den vollständigen Beispiel-Request auch zur Bearbeitung in einem Editor ihrer Wahl herunterladen.

Welche Daten werden durch diesen Request im BayernPortal geändert?Alles was unter Import einer Dienststelle mit Organisationseinheiten erläutert wurde, gilt auch für diesen Request. Im Organigramm unterhalb der Dienststelle wurden also zwei Organisationseinheiten angelegt. Sie sind mit genau einem Gebäude / einer Adresse verknüpft.

Darüber hinaus gibt es jetzt 3 neue Mitarbeiter, die den Organisationseinheiten "Hauptamt" und "Einwohnermeldeamt" zugewiesen sind. Das sieht im Redaktionssystem folgendermaßen aus:

Abbildung: Ansprechpartnerübersicht nach Import im Redaktionssystem

Wenn wir die Ansprechpartnerin "Annette Adam" herausgreifen, sieht man im Redaktionssystem folgende Daten:

Page 159: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  159 von 187

Abbildung: Eine Ansprechpartnerin nach Import im Redaktionssystem

Wenn wir die Sprechzeiten von "Christian Chef" herausgreifen, sieht man im Redaktionssystem folgende Daten:

Page 160: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  160 von 187

Abbildung: Sprechzeiten eines Ansprechpartners nach Import im Redaktionssystem

Da im Request keinerlei Leistungszuordnungen (weder für die Dienststelle noch für die beiden Organisationseinheiten) geliefert wurden, sind alle Leistungen, die der Dienststelle von der zentralen Redaktion (Herausgeber) zugewiesen wurden, allein der Dienststelle zugeordnet. Neue regionale Ergänzungen wurden durch diesen Request nicht geliefert.

3.7.7 Import mit Logos

Import mit LogosDas folgende Beispiel zeigt einen Request, der auf dem Beispiel Import von Mitarbeitern (Ansprechpartnern) aufbaut. Zusätzlich werden hier für die Organisationseinheit "Hauptamt" und den Mitarbeiter (Ansprechpartner) "Christian Chef" zwei Logos importiert.

Im Soap-Body ist das Dokument-Wurzelelement CmsIntegrationRequest eingebettet, darin wiederum die verpflichtenden Elemente organisation und wsRequestContext. Darüber hinaus ist jetzt der Container logosvorhanden, in dem die beiden logo-Elemente eingebettet sind, die wir importieren wollen.

logos/logo

Ein Logo besteht aus einigen beschreibenden Kindelementen (titel, alternativText, beschreibung, breite, hoeheund dateiName), deren Bedeutung nicht schwer zu erraten ist. breite und hoehe müssen als Ganzzahlen (in Pixel) angegeben werden. dateiName hat eigentlich nur eine dokumentierende Funktion; die importierende Dienststelle kann vielleicht so später nachvollziehen, wie die Orginaldatei des importierten Bildes hieß. Für das BayernPortal ist der dateiName ohne weitere Bedeutung.

Außerdem sind natürlich die Binärdaten im Element bild enthalten. Sie sind base64-codiert.

Page 161: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  161 von 187

Schließlich gibt es noch das Kindelement id, mit dem das jeweilige Logo eindeutig identifiziert wird und innerhalb des Request referenziert werden kan. Jedes logo im Container logos muss selbstverständlich eine eindeutige Id haben, die aber keine weitere Bedeutung über den Import hinaus hat und nicht im BayernPortal gespeichert wird.

organistion/logo bzw. mitarbeiter/logo

In diesem Beispiel wird jedes der beiden Logos genau an einer Stelle über seine Id referenziert, und zwar bei der Organisationseinheit "Hauptamt" und beim Mitarbeiter (Ansprechpartner) "Christian Chef".

organisationen/organisation/adressen/adresse/mitarbeiter/mitarbeiter

Wenn Sie Erläuterungen zu den sonstigen Inhalten der hier genannten Elemente brauchen, lesen Sie bitte im Beispiel Import von Mitarbeitern (Ansprechpartnern) nach.

wsRequestContext

Der Inhalt dieses verpflichtenden Elements wurde unverändert aus dem Beispiel Import einer Dienststelle ohne Organisationseinheiten übernommen, wo Sie weitere Erläuterungen zur Bedeutung der Kindelmente finden.

Page 162: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  162 von 187

<soapenv:Envelope xmlns:mes="http://lfstad.bayern.de/baybw/schemas/cmsintegration/messages" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://lfstad.bayern.de/baybw/schemas/cmsintegration/types"> <soapenv:Body> <mes:CmsIntegrationRequest> <mes:organisation> <typ:adressen> <typ:adresse> ... <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId> </typ:adresse> </typ:adressen> ... <typ:providerId>ORGANISATION_PROVIDER_ID_0</typ:providerId>  <typ:organisationen> <typ:organisation> <typ:adressen> <typ:adresse> ... <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId>  <typ:mitarbeiter> <typ:mitarbeiter> ... <typ:logo>LOGO_ID_1</typ:logo> <typ:providerId>MITARBEITER_PROVIDER_ID_0</typ:providerId> </typ:mitarbeiter> <typ:mitarbeiter> ... <typ:providerId>MITARBEITER_PROVIDER_ID_1</typ:providerId> </typ:mitarbeiter> </typ:mitarbeiter>  </typ:adresse> </typ:adressen> ... <typ:providerId>ORGANISATION_PROVIDER_ID_10</typ:providerId> <typ:logo>LOGO_ID_0</typ:logo> </typ:organisation>  <typ:organisation> <typ:adressen> <typ:adresse> ... <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId>  <typ:mitarbeiter> <typ:mitarbeiter> ... <typ:providerId>MITARBEITER_PROVIDER_ID_2</typ:providerId> </typ:mitarbeiter> <typ:mitarbeiter> ... <typ:providerId>MITARBEITER_PROVIDER_ID_1</typ:providerId> </typ:mitarbeiter>

Page 163: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  163 von 187

</typ:mitarbeiter>  </typ:adresse> </typ:adressen> ... <typ:providerId>ORGANISATION_PROVIDER_ID_11</typ:providerId> </typ:organisation> </typ:organisationen>  </mes:organisation>  <mes:logos> <typ:logo> <typ:id>LOGO_ID_0</typ:id> <typ:titel>Bild Hauptamt</typ:titel> <typ:alternativText>Bild der Gemeinde Kirchlauter - Hauptamt</typ:alternativText> <typ:beschreibung></typ:beschreibung> <typ:bild>/9j/4AAQSkZJRgABAQEAYABgAAD ... /9k=</typ:bild> <typ:breite>122</typ:breite> <typ:hoehe>122</typ:hoehe> <typ:dateiName>kirchlauter-hauptamt.png</typ:dateiName> </typ:logo> <typ:logo> <typ:id>LOGO_ID_1</typ:id> <typ:titel>Bild des Geschäftsführers</typ:titel> <typ:alternativText>Bild des Geschäftsführers</typ:alternativText> <typ:beschreibung></typ:beschreibung> <typ:bild>/9j/4AAQSkZJRgABAQAAAQABAAD ... +R//9k=</typ:bild> <typ:breite>48</typ:breite> <typ:hoehe>48</typ:hoehe> <typ:dateiName>geschaeftsfuehrer.png</typ:dateiName> </typ:logo> </mes:logos>  <mes:wsRequestContext> ... </mes:wsRequestContext></mes:CmsIntegrationRequest>  </soapenv:Body></soapenv:Envelope>

Sie können den vollständigen Beispiel-Request auch zur Bearbeitung in einem Editor ihrer Wahl herunterladen.

Welche Daten werden durch diesen Request im BayernPortal geändert?Alles was unter Import von Mitarbeitern (Ansprechpartnern) erläutert wurde, gilt auch für diesen Request. Darüber hinaus werden die beiden neuen Logos importiert. Das Ergebnis des Imports sieht im Redaktionssystem folgendermaßen aus:

Page 164: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  164 von 187

Abbildung: Logoübersicht nach Import im Redaktionssystem

Insgesamt finden wir drei Logos, deren Eigentümer die Dienststelle ist. Eines war schon vor dem Import vorhanden (Wappen der Gemeinde Kirchlauter). Dieses Logo ist der Dienststelle "Gemeinde Kirchlauter" selbst, also dem Einstiegspunkt zugeordnet. Der Import-Webservice läßt es unberührt, weil er nicht dafür vorgesehen ist, Logos für den Einstiegspunkt zu importieren, zu ändern oder zu löschen.

Die Logodaten des Logos für Herrn "Christian Chef" sehen nach dem Import im Redaktionssystem so aus:

Page 165: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  165 von 187

Abbildung: Logo-Einzeldaten nach Import im Redaktionssystem

Die beiden neuen Logos sind nach dem Import jeweils der Organisationseinheit "Hauptamt" und dem Ansprechpartner "Christian Chef" zugeordnet. Das sieht im Redaktionssystem folgendermaßen aus:

Page 166: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  166 von 187

Abbildung: Hauptamt mit Logo nach Import im Redaktionssystem

Page 167: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  167 von 187

Abbildung: Ansprechpartner Christian Chef mit Logo nach Import im Redaktionssystem

3.7.8 Import mit Leistungszuordnungen und regionalen Ergänzungen

Import mit Leistungszuordnungen und regionalen ErgänzungenDer hier beschriebene Request baut auf dem Beispiel Import mit Leistungszuordnungen auf. Er zeigt darüber hinaus, wie man regionale Ergänzungen zu Leistungen importieren kann. Im dem Request, auf dem wir hier aufbauen, werden zunächst 5 Leistungen an das "Hauptamt" und 4 Leistungen an das "Einwohnermeldeamt" zugewiesen.

Für die beiden Leistungen, die in der folgenden Tabelle genannt sind - eine für das Einwohnermeldeamt und eine für das Hauptamt - wollen wir diesmal jedoch zusätzlich je eine regionale Ergänzung importieren.

ID der Leistung Leistung zugewiesen an

298 Ausstellung von Personenstandsurkunden Einwohnermeldeamt

3530 Bildungseinrichtungen; Benutzungsgebühren Hauptamt

Im Soap-Body ist das Dokument-Wurzelelement CmsIntegrationRequest eingebettet, darin wiederum die verpflichtenden Elemente organisation und wsRequestContext. Das mögliche Element logos fehlt, weil bei diesem Request keine Bilder mitgeliefert werden sollen.

organisation

Innerhalb des Elements organisation sind die Detaildaten zur Dienststelle "Gemeinde Kirchlauter" zu finden (z.B. bezeichnung, providerId usw.). Im Container adressen ist die adresse der Dienststelle angegeben. Das optionale Kindelement aufgaben fehlt bei der Dienststelle, denn Sie können mit dem Import der Dienststelle nicht direkt Leistungen zuordnen.

organisationen/organisation/aufgaben/aufgabe/regionaleErgaenzung

Die wesentliche Erweiterung im Bezug auf das Beispiel Import mit Leistungszuordnungen ist das Element regionaleErgaenzung. Man kann jeder Leistung nur genau eine regionale Ergänzung zuordnen. Daher ist das Element regionaleErgaenzung ein Kindelement von aufgabe.

Die beiden regionalen Ergänzungen, die wir importieren wollen, finden sich im Request bei den aufgabe-Elementen mit der Id 3530 und 298.

Wenn Sie im BayernPortal Leistungsbeschreibungen ansehen (z.b. https://www.freistaat.bayern/dokumente/leistung/4333023669), dann erkennen Sie, dass diese sich in definierte Abschnitte untergliedern (z.B. Bezeichnung, Kurzbeschreibung, Beschreibung, Voraussetzungen, Fristen, Kosten, Rechtsgrundlagen, Verwandte Themen). Mit regionalen Ergänzungen können Sie einige dieser Abschnitte "mit lokalen Informationen anreichern". Die lokalen Informationen werden im BayernPortal nur angezeigt, wenn von den Benutzern eine PLZ oder ein Ort (Lokalisierung) ausgewählt wurde, in dessen Bereich die regionale Ergänzung "fällt".

Die folgende Tabelle zeigt, welche Abschnitte einer Leistungsbeschreibung durch eine regionale Ergänzung überhaupt "ergänzt" werden können:

Abschnitt Überschrift im BayernPortal

kurzBeschreibung keine Überschrift (fett gedruckt unter der Bezeichnung)

langBeschreibung Beschreibung

Page 168: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  168 von 187

Abschnitt Überschrift im BayernPortal

voraussetzungen Voraussetzungen

fristen Fristen

kosten Kosten

unterlagen Erforderliche Unterlagen

formulare/formular Formulare

rechtsvorschriften/rechtsvorschrift Rechtsvorschriften

links/link Weiterführende Links

onlineVerfahren/onlineService Online Verfahren

In unserem Beispiel ergänzen wir bei der Leistung "3530 - Bildungseinrichtungen; Benutzungsgebühren" die folgenden Abschnitte:

Ergänzter Abschnitt Überschrift im BayernPortal

langBeschreibung Beschreibung

kosten Kosten

links/link Weiterführende Links

Bei der Leistung "298 - Ausstellung von Personenstandsurkunden" ergänzen wir nur den Abschnitt:

Ergänzter Abschnitt Überschrift im BayernPortal

formulare/formular Formulare

wsRequestContext

Der Inhalt dieses verpflichtenden Elements wurde unverändert aus dem Beispiel Import einer Dienststelle ohne Organisationseinheiten übernommen, wo Sie weitere Erläuterungen zur Bedeutung der Kindelmente finden.

Page 169: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  169 von 187

<soapenv:Envelope xmlns:mes="http://lfstad.bayern.de/baybw/schemas/cmsintegration/messages" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://lfstad.bayern.de/baybw/schemas/cmsintegration/types"> <soapenv:Body> <mes:CmsIntegrationRequest> <mes:organisation> <typ:adressen> <typ:adresse> ... <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId> </typ:adresse> </typ:adressen> ... <typ:providerId>ORGANISATION_PROVIDER_ID_0</typ:providerId> <typ:organisationen> <typ:organisation> <typ:adressen> <typ:adresse> ... <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId> </typ:adresse> </typ:adressen> ... <typ:providerId>ORGANISATION_PROVIDER_ID_10</typ:providerId>  <typ:aufgaben> ... <typ:aufgabe> <typ:id>3530</typ:id> <typ:regionaleErgaenzung> <typ:bezeichnung>Bildungseinrichtungen; Benutzungsgebühren (regional)</typ:bezeichnung> <typ:langBeschreibung> &lt;div&gt;Als kommunales Bildungs- und Kulturzentrum hat die Volkshochschule (VHS) ihr Büro “Grips &amp; Co.” in der Müllerstraße 14 (2. Stock), zentral direkt neben dem Rathaus gelegen. Mit ihrem umfassenden Angebot an Kursen aus den Bereichen Beruf und Karriere, Gesellschaft und Leben, Sprachen, Gesundheit und Ernährung sowie Vorträgen, Führungen, Exkursionen und Studienreisen leistet sie Beiträge zu wichtigen Fragen der Zukunft und Gegenwart, fördert Leistungsfähigkeit, berufliche Qualifikation und bietet Lebenshilfe und Orientierung. &lt;br /&gt; &lt;br /&gt; &lt;br /&gt; &lt;b&gt; Bürozeiten während des Semesters&lt;/b&gt; &lt;br /&gt; &lt;br /&gt; Montag 15 bis 16 Uhr&lt;br /&gt; Dienstag 11 bis 12 Uhr&lt;br /&gt; Mittwoch 9 bis 11 Uhr&lt;br /&gt; Donnerstag 9 bis 11 Uhr&lt;br /&gt; Freitag 9 bis 11 Uhr&lt;/p&gt;&lt;/div&gt; </typ:langBeschreibung> <typ:kosten>

Page 170: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  170 von 187

Die Gebühren für Kurse der VHS entnehmen Sie bitte dem halbjährlich veröffentlichten Kursprogramm. </typ:kosten> <typ:links> <typ:link> <typ:kurz>Homepage der Volkshochschule Kirchlauter</typ:kurz> <typ:lang></typ:lang> <typ:url>http://www.kirchlauter.de/vhs</typ:url> </typ:link> </typ:links> </typ:regionaleErgaenzung> </typ:aufgabe> <typ:aufgabe> ... </typ:aufgaben>  </typ:organisation>  <typ:organisation> <typ:adressen> <typ:adresse> ... <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId> </typ:adresse> </typ:adressen> ... <typ:providerId>ORGANISATION_PROVIDER_ID_11</typ:providerId> <typ:aufgaben> <typ:aufgabe> <typ:id>298</typ:id> <typ:regionaleErgaenzung> <typ:bezeichnung>Ausstellung von Personenstandsurkunden (regional)</typ:bezeichnung> <typ:formulare> <typ:formular> <typ:kurz> Antrag auf Ausstellung einer Eheurkunde </typ:kurz> <typ:lang> Formgerechter Antrag auf Ausstellung einer Eheurkunde über die Gemeinde Kirchlauter </typ:lang> <typ:url>http://www.kirchlauter.de/formulare/antrag-eheurkunde.pdf</typ:url> </typ:formular> <typ:formular> <typ:kurz>Antrag auf Ausstellung einer Lebenspartnerschaftsurkunde</typ:kurz> <typ:lang> Formgerechter Antrag auf Ausstellung einer Lebenspartnerschaftsurkunde über die Gemeinde Kirchlauter </typ:lang> <typ:url> http://www.kirchlauter.de/formulare/antrag-lebenspartnerschaftsurkunde.pdf </typ:url> </typ:formular> </typ:formulare>

Page 171: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  171 von 187

</typ:regionaleErgaenzung> </typ:aufgabe> ... </typ:aufgaben> </typ:organisation> </typ:organisationen> </mes:organisation> <mes:wsRequestContext> ... </mes:wsRequestContext></mes:CmsIntegrationRequest>  </soapenv:Body></soapenv:Envelope>

Sie können den vollständigen Beispiel-Request auch zur Bearbeitung in einem Editor ihrer Wahl herunterladen.

Welche Daten werden durch diesen Request im BayernPortal geändert?Wie beim Beispiel Import mit Leistungszuordnungen werden im Organigramm unterhalb der Dienststelle die beiden Organisationseinheiten "Hauptamt" und "Einwohnermeldeamt" neu angelegt. Sie sind mit genau einem Gebäude / einer Adresse verknüpft, das/die auch neu angelegt wird. Die Daten der Dienststelle selbst werden "nur" aktualisiert, also weder gelöscht noch neu angelegt.

Es werden 5 Leistungszuordnungen für die Organisationseinheit "Hauptamt" und 4 für die Organisationseinheit "Einwohnermeldeamt" importiert.

Neu bei diesem Beispiel ist, dass zwei regionale Ergänzungen im BayernPortal angelegt werden. Sie gehören zu den Leistungen mit der Id 3530 und 298. Ein Benutzer, der sich die regionalen Ergänzungen im Reaktionssystem ansieht, erhält folgendes Bild:

Page 172: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  172 von 187

Abbildung: Zwei regionale Ergänzungen - Ansicht im Redaktionssystem nach dem Import

Abbildung: Detaildaten zu einer regionalen Ergänzung - Ansicht im Redaktionssystem nach dem Import

Den importierten regionalen Ergänzungen wurde automatisch der Standard-Zuständigkeitsbereich der Gemeinde Kirchlauter zugeordnet. Sie werden also nur dann im BayernPortal angezeigt, wenn ein Benutzer bei der Lokalisierung die passende PLZ bzw. den passenden Ort auswählt. Den Zuständigkeitsbreich für die regionalen Ergänzungen kann ein Benutzer im Redaktionssystem folgendermaßen sehen:

Page 173: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  173 von 187

Abbildung: Zuständigkeitsbereich für eine regionale Ergängzung - Ansicht im Redaktionssystem nach dem Import

Bei welcher Leistungszuordnung muss die regionale Ergänzung eingebettet werden, wenn eine Leistung mehrfach zugeordnet ist?Wenn etwa die Leistung mit der Id 3530 drei Organisationseinheiten zugeordnet werden soll, dann müssen Sie die gleiche regionale Ergänzung (Element regionaleErgaenzung) bei jedem dieser aufgabe-Elemente als Kindelement angeben. Sie wird beim Import jedoch nur einmal gespeichert.

Kann man regionale Ergänzungen unabhängig von Leistungszuordnungen importieren?Nein. Das ist im Datenmodell des BayernPortals nicht sinnvoll, da regionale Ergänzungen nur im Zusammenhang mit Leistungszuordnungen sichtbar sind.

Wie kann man eine regionale Ergänzung löschen?Eine regionale Ergänzung wird gelöscht, wenn sie bei einem Import nicht mehr der Leistung zugeordnet ist, zu der sie ehemals gehörte.

Kann man den Zuständigkeitsbereich, innerhalb dessen die regionale Ergänzung gilt, durch den Import beeinflussen?Nein. Über das Redaktionssystem https://www.bayvis-redaktionssystem.bayern.de ist dies ohne weiteres möglich. Der Import-Webservice legt aber für regionale Ergänzungen immer automatisch den Standard-Zuständigkeitsbereich der Dienststelle fest.

3.7.9 Import mit Angabe des Einhängepunkts

Import mit Angabe des EinhängepunktsDas folgende Beispiel zeigt einen Request, bei dem die Organisationseinheit "Hauptamt" als Einhängepunkt gewählt wird. Wir setzen dabei auf dem Datenbestand auf, den wir im BayernPortal nach Ausführung des Beispiels Import mit Leistungszuordnungen haben. D.h. unterhalb der Dienststelle sind im Organigramm die beiden Organisationseinheiten "Hauptamt" und Einwohnermeldeamt zu finden. Dem Hauptamt sind die folgenden 5 Leistungen zugeordnet:

Page 174: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  174 von 187

ID der Aufgabe Aufgabe zugewiesen an

3462 Beglaubigungen (Gemeinde) Hauptamt

3455 Behördennetz (Gemeinde) Hauptamt

3530 Bildungseinrichtungen; Benutzungsgebühren Hauptamt

3531 Bildungseinrichtungen; Benutzungsordnung Hauptamt

3471 Datenschutzbeauftragter (Gemeinde) Hauptamt

Dem Einwohnermeldeamt sind ebenfalls 4 Leistungen zugeordnet. Mitarbeiter/Ansprechpartner, Logos und regionale Ergänzungen sind nicht vorhanden. Alle anderen Leistungen sind der Dienststelle "Gemeinde Kirchlauter" zugeordnet.

Im Soap-Body ist das Dokument-Wurzelelement CmsIntegrationRequest eingebettet, darin wiederum die verpflichtenden Elemente organisation und wsRequestContext. Das mögliche Element logos fehlt, weil bei diesem Request keine Bilder mitgeliefert werden sollen.

wsRequestContext

Den gewünschten Einhängepunkt "Hauptamt" geben wir im Element CmsIntegrationRequest/wsRequestContext/organisationsBezeichnung an. Wir drücken damit aus, dass wir bei diesem Import nur Daten liefern, die Organisationseinheiten unterhalb des Einhängepunkts "Hauptamt" betreffen.Weitere Erläuterungen zum verpflichtenden Element wsRequestContext finden Sie im Beispiel Import einer Dienststelle ohne Organisationseinheiten.

organisation

Innerhalb des Elements organisation sind nun die Detaildaten zur Organisationseinheit "Hauptamt" zu finden (z.B. bezeichnung, providerId). Im Container adressen ist die adresse der Organisationseinheit "Hauptamt" angegeben, die aber mit der Adresse aller anderen Organisationseinheiten identisch ist.

organisationen

Dieser Container enthält die 3 Organsationseinheiten, die dem "Hauptamt" untergeordnet werden sollen, also "Bürgerbüro", "Personalwesen" und "Organistion/Informationstechnik".

aufgaben

Dieser Container innerhalb der organisation "Organistion/Informationstechnik" enthält folgende 2 Leistungen, die wir der Organisationseinheit "Organistion/Informationstechnik" zuordnen wollen.

ID der Aufgabe Aufgabe

3455 Behördennetz (Gemeinde)

3471 Datenschutzbeauftragter (Gemeinde)

Beachten Sie, dass diese beiden Leistungen vor dem Import bereits der Organisationseinheit "Hauptamt" zugeordnet sind.

Page 175: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  175 von 187

<soapenv:Envelope xmlns:mes="http://lfstad.bayern.de/baybw/schemas/cmsintegration/messages" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:typ="http://lfstad.bayern.de/baybw/schemas/cmsintegration/types"> <soapenv:Body> <mes:CmsIntegrationRequest> <mes:organisation> <typ:adressen> <typ:adresse> ... <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId> </typ:adresse> </typ:adressen> <typ:bezeichnung>Hauptamt</typ:bezeichnung> ... <typ:providerId>ORGANISATION_PROVIDER_ID_0</typ:providerId> <typ:organisationen> <typ:organisation> <typ:adressen> <typ:adresse> ... <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId> </typ:adresse> </typ:adressen> <typ:bezeichnung>Bürgerbüro</typ:bezeichnung> ... <typ:providerId>ORGANISATION_PROVIDER_ID_10</typ:providerId> </typ:organisation>  <typ:organisation> <typ:adressen> <typ:adresse> ... <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId> </typ:adresse> </typ:adressen> <typ:bezeichnung>Personalwesen</typ:bezeichnung> ... <typ:providerId>ORGANISATION_PROVIDER_ID_11</typ:providerId> </typ:organisation>  <typ:organisation> <typ:adressen> <typ:adresse> ... <typ:providerId>ADRESSE_PROVIDER_ID_0</typ:providerId> </typ:adresse> </typ:adressen> <typ:bezeichnung>Organisation/Informationstechnik</typ:bezeichnung> ... <typ:providerId>ORGANISATION_PROVIDER_ID_12</typ:providerId>  <typ:aufgaben> <typ:aufgabe> <typ:id>3455</typ:id> </typ:aufgabe>

Page 176: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  176 von 187

<typ:aufgabe> <typ:id>3471</typ:id> </typ:aufgabe> </typ:aufgaben>  </typ:organisation>  </typ:organisationen> </mes:organisation> <mes:wsRequestContext> <typ:dienststellenSchluessel>6741603</typ:dienststellenSchluessel> <typ:organisationsBezeichnung>Hauptamt</typ:organisationsBezeichnung> <typ:responseViaWebService>false</typ:responseViaWebService> <typ:responseViaEMail>true</typ:responseViaEMail> <typ:responseEMailAddresses> <typ:responseEMailAddress>[email protected]</typ:responseEMailAddress> </typ:responseEMailAddresses> <typ:requestTransactionId>TRANSACTION_1</typ:requestTransactionId> </mes:wsRequestContext></mes:CmsIntegrationRequest>  </soapenv:Body></soapenv:Envelope>

Sie können den vollständigen Beispiel-Request auch zur Bearbeitung in einem Editor ihrer Wahl herunterladen.

Welche Daten werden durch diesen Request im BayernPortal geändert?Da die Organisationseinheit "Hauptamt" als Einhängepunkt gewählt wurde, befasst sich der Import nur mit Daten "unterhalb" vom Hauptamt. Die Organisationsdaten und die Adresse des Hauptamts bleiben also (abgesehen von Kurzbeschreibung und Langbeschreibung) unverändert. Auch die Leistungszuordnungen des Hauptamts werden nicht angetastet. Dasselbe würde auch für Mitarbeiter/Ansprechpartner, Logos und regionale Ergänzungen zu Leistungen des Hauptamts gelten, falls vorhanden.

Nach dem Import finden wir im Organigramm unterhalb vom "Hauptamt" die 3 neuen Organisationseinheiten, die sich alle das gleiche Gebäude / die gleiche Adresse teilen. Im Redaktionssystem sieht ein Benutzer etwa folgendes Bild:

Page 177: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  177 von 187

Abbildung: Hauptamt und nachgeordnete Organisationseinheiten nach Import im Redaktionssystem

Auch bei den Leistungszuordnungen hat sich etwas geändert. Die Organisationseinheit "Organisation/Informationstechnik" hat 2 zugewiesene Leistungen. Diese beiden Leistungen sind auch weiterhin dem Hauptamt zugewiesen, da der Import am Einhängepunkt keine Veränderungen vornimmt.Im Redaktionssystem ergibt sich für einen Benutzer folgendes Bild, wenn er die Leistungszuordnungen für das "Hauptamt" anzeigen lässt:

Abbildung: Leistungszuordnungen von Hauptamt und nachgeordneten Organisationseinheiten nach Import im Redaktionssystem

3.8 Validierungsfehler

3.8.1 Validierungsfehler in der synchronen Phase

Einhängepunkt

• Die Organisationsbezeichnung "..." ist im Teilbaum der Dienststelle nicht vorhanden.

Diese Fehlermeldung erhalten Sie, wenn Sie im Request eine ungültige Organisationseinheit als Einhängepunkt angeben. Der Einhängepunkt kann innerhalb des Request im Element CmsIntegrationRequest/wsRequestContext/

Page 178: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  178 von 187

organisationsBezeichnung genannt werden. Sie brauchen ihn aber nur anzugeben, wenn Sie ausnahmsweise bei einem Folgeimport nur einen Teilbaum der Dienststelle hochladen wollen.

Als Einhängepunkt dürfen Sie nur die Bezeichnung einer Organisationseinheit angeben, von der sie wissen, dass sie bereits im BayernPortal im Organisationsbaum der Dienststelle gespeichert ist. Achten Sie bei der Bezeichnung der Organisationseinheit bitte auch auch korrekte Groß- und Kleinschreibung!

Zur Fehleranalyse sehen Sie bitte im Redaktionssystem (produktiv) bzw. Redaktionssystem (Integrationstest) nach.

• Die Organisationsbezeichnung "..." ist im Teilbaum der Dienststelle nicht eindeutig.

Diese Fehlermeldung erhalten Sie, wenn Sie im Request eine Organisationseinheit als Einhängepunkt angeben, die es zwar im BayernPortal gibt, die jedoch im Organisationsbaum der Dienststelle mehr als einmal vorhanden ist.Wenn auch unüblich, ist es im BayernPortal zulässig, dass Organisationseinheiten einer Dienststelle die gleiche Bezeichnung haben, wenn sie im Organisationsbaum unterhalb von verschiedenen Knoten hängen (d.h. keine Geschwister sind).

Sollten Sie einen derartigen Fall haben, sehen Sie bitte zur Fehleranalyse im Redaktionssystem (produktiv) bzw. Redaktionssystem (Integrationstest) nach.

Wenn die Organsationseinheit im Organisationsbaum der Dienststelle tatsächlich mehr als einmal mit exakt gleicher Bezeichnung vorhanden ist, können Sie diese nicht als Einhängepunkt verwenden.

3.8.2 Validierungsfehler in der asynchronen Phase

Organisationseinheiten

• Organisationseinheit mit der ProviderId "...": Bezeichnung "..." dieser Organisationseinheit ist auf ihrer Hierarchiestufe nicht eindeutig.

• Organisationsbezeichnung "..." ist bereits im BayernPortal vorhanden. Ein Einfügen dieser Organisationseinheit würde daher ein Duplikat erzeugen.

Diese Fehlermeldungen erhalten Sie, wenn Sie im Request die Organisationseinheit mit der Bezeichnung "..." mehr als einmal auf der gleichen Ebene im Organisationsbaum importieren.

Bitte prüfen Sie, ob es sich um einen Fehler im Webservice-Client handelt, bzw. vermeiden Sie es, "Geschwister"-Organisationseinheiten exakt gleich zu benennen!

• Organisation mit der ProviderId "...": Keine Bezeichnung angegeben.

Diese Fehlermeldung erhalten Sie, wenn Sie im Request bei einer Organisationseinheit die Bezeichnung nicht angegeben (Element CmsIntegrationRequest/organisation/organisationen/organisation/organisationsBezeichnung).

Bitte liefern Sie für jede Organisationseinheit eine Bezeichnung!

• Die ProviderId für die Organisation mit Bezeichnung "..." ist nicht angegeben.

Diese Fehlermeldung erhalten Sie, wenn Sie im Request bei einer Organisationseinheit die ProviderId nicht angeben (Element CmsIntegrationRequest/organisation/organisationen/organisation/providerId).

Bitte liefern Sie für jede Organisationseinheit eine ProviderId!

Page 179: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  179 von 187

• Die ProviderId "..." für Organisation mit der Bezeichnung "..." ist nicht eindeutig.

Diese Fehlermeldung erhalten Sie, wenn im Request die gleiche ProviderId für mehr als eine Organisationseinheit verwendet wird (Element CmsIntegrationRequest/organisation/organisationen/organisation/providerId).

AdresseBitte liefern Sie für jede Organisationseinheit eine unterschiedliche ProviderId!

• Adresse mit der ProviderId "...": Keine Bezeichnung angegeben.

Diese Fehlermeldung erhalten Sie, wenn im Request bei einer Adresse die ProviderId nicht angegeben ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/providerId).

Bitte liefern Sie für jede Adresse eine ProviderId!

• Adresse mit der ProviderId "...": Keine Straße bei der Hausanschrift angegeben.

Diese Fehlermeldung erhalten Sie, wenn im Request bei einer Adresse die Straße der Hausanschrift nicht angegeben ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/hausAnschriftStrasse).

Bitte liefern Sie für jede Adresse die Straße der Hausanschrift!

• Adresse mit der ProviderId "...": Kein Ort bei der Hausanschrift angegeben.

Diese Fehlermeldung erhalten Sie, wenn im Request bei einer Adresse der Ort der Hausanschrift nicht angegeben ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/hausAnschriftOrt).

Bitte liefern Sie für jede Adresse den Ort der Hausanschrift!

• Adresse mit der ProviderId "...": Keine PLZ bei der Hausanschrift angegeben.

Diese Fehlermeldung erhalten Sie, wenn im Request bei einer Adresse die PLZ der Hausanschrift nicht angegeben ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/hausAnschriftPlz).

Bitte liefern Sie für jede Adresse die PLZ der Hausanschrift!

• Adresse mit der ProviderId "...": Telefonnummer "..." ist ungültig.

Diese Fehlermeldung erhalten Sie, wenn im Request bei einer Adresse die PLZ der Hausanschrift nicht angegeben ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/telefon).

Bitte sorgen Sie dafür, dass die Telefonnummer nur die Zeichen [0123456789/- ] enthält!

• Adresse mit der ProviderId "...": Faxnummer "..." ist ungültig.

Diese Fehlermeldung erhalten Sie, wenn im Request bei einer Adresse die PLZ der Hausanschrift nicht angegeben ist (Element CmsIntegrationRequest/organisation/adressen/adresse/fax oder Element CmsIntegrationRequest/organisationen/organisation/adressen/adresse/fax).

Bitte sorgen Sie dafür, dass die Faxnummer nur die Zeichen [0123456789/- ] enthält!

Page 180: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  180 von 187

Logos

• Logo mit der Id "...": Kein Titel angegeben.

Diese Fehlermeldung erhalten Sie, wenn im Request bei einem Logo der Titel leer ist (Element CmsIntegrationRequest/logos/logo/titel).

Bitte geben Sie für jedes Logo einen Titel an!

• Logo mit der Id "...": Kein Alternativtext angegeben.

Diese Fehlermeldung erhalten Sie, wenn im Request bei einem Logo der Alternativtext leer ist (Element CmsIntegrationRequest/logos/logo/alternativText).

Bitte geben Sie für jedes Logo einen Alternativtext an!

• Logo mit der Id "...": Keine Binärdaten zum Bild angegeben.

Diese Fehlermeldung erhalten Sie, wenn im Request bei einem Logo die Binärdaten leer sind (Element CmsIntegrationRequest/logos/logo/bild).

Bitte übermitteln Sie für jedes Logo die Binärdaten des Bildes!

Mitarbeiter / Ansprechpartner

• Mitarbeiter mit der ProviderId "...": Kein Nachname angegeben.

Diese Fehlermeldung erhalten Sie, wenn im Request bei einem Mitarbeiter/Ansprechpartner der Nachname leer ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/mitarbeiter//mitarbeiter/nachname).

Bitte übermitteln Sie für jeden Mitarbeiter/Ansprechpartner den Nachnamen!

• Mitarbeiter mit der ProviderId "...": Telefonnummer "..." ist ungültig.

Diese Fehlermeldung erhalten Sie, wenn im Request eine Telefonnummer mit ungültigen Zeichen angegeben ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/mitarbeiter//mitarbeiter/telefon).

Bitte sorgen Sie dafür, dass die Telefonnummer nur die Zeichen [0123456789/- ] enthält!

• Mitarbeiter mit der ProviderId "...": Faxnummer "..." ist ungültig.

Diese Fehlermeldung erhalten Sie, wenn im Request eine Faxnummer mit ungültigen Zeichen angegeben ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/mitarbeiter//mitarbeiter/fax).

Bitte sorgen Sie dafür, dass die Faxnummer nur die Zeichen [0123456789/- ] enthält!

• Mitarbeiter mit der ProviderId "...": Mobiltelefonnummer "..." ist ungültig.

Diese Fehlermeldung erhalten Sie, wenn im Request eine Mobiltelefonnummer mit ungültigen Zeichen angegeben ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/mitarbeiter//mitarbeiter/mobilTelefon).

Bitte sorgen Sie dafür, dass die Mobiltelefonnummer nur die Zeichen [0123456789/- ] enthält!

Page 181: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  181 von 187

Aufgabenzuordungen / Leistungszuordnungen

• Leistung: Id nicht angegeben oder Id = 0.

Diese Fehlermeldung erhalten Sie, wenn im Request eine Leistung mit der Id 0 zugeordnet ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/aufgaben//aufgabe/id). Bitte sorgen Sie dafür, dass alle Leistungen eine Id > 0 haben!

• Eine Leistung mit Id <id-der-leistung> ist im BayernPortal nicht vorhanden. Sie kann daher auch nicht von der Organisationseinheit <bezeichnung-der-organisationseinheit> wahrgenommen werden (siehe Hinweis Nr. 1!)

Diese Fehlermeldung erhalten Sie, wenn im Request eine Leistungs-Id angegeben wird, die es im BayernPortal gar nicht gibt (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/aufgaben//aufgabe/id).

• Für die Leistung mit der Id <id-der-leistung> (<bezeichnung-der-leistung>) ist die Dienststelle <bezeichnung-der-dienststelle> nicht zuständig. Sie kann daher auch nicht von der untergeordneten Organisationseinheit <bezeichnung-der-organisationseinheit> wahrgenommen werden (siehe Hinweis Nr. 1!).

Diese Fehlermeldung erhalten Sie, wenn im Request eine Leistung einer Organisationseinheit zugeordnet ist, für die die Dienststelle nicht zuständig ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/aufgaben//aufgabe). Bitte sorgen Sie dafür, dass Sie bei den Organisationseinheiten nur solche Leistungen zuordnen, für die Ihre Dienststelle laut BayernPortal zuständig ist. Die Ids dieser Leistungen können Sie mit dem Webservice Abrufen der Leistungen, die einer Dienststelle zugeordnet sind abrufen.

Der Hinweis mit der Nr. 1 wird in der Antwort-E-Mail oder im Protokoll des Rückruf-Webservice angezeigt und lautet, wie folgt:

1) Eventuelle, der Leistung zugewiesene regionale Ergänzungen mit Rechtsvorschriften, Links, Unterlagen, Formularen und Onlineverfahren können daher ebenfalls nicht berücksichtigt werden. Da für die o.g. Leistungen eine andere Behörde/Stelle zuständig ist, möchten wir Sie bitten, die Zuordnungen in Ihrer Datenbank zu löschen. Falls Sie der Meinung sind, dass Ihre Dienststelle für die o.g. Leistungen zuständig ist, wenden Sie sich bitte an die Redaktion für Verwaltungsinformationen.

Regionale Ergänzungen

• Regionale Ergänzung: Keine Bezeichnung angegeben.

Diese Fehlermeldung erhalten Sie, wenn im Request eine regionale Ergänzung zu finden ist, deren Bezeichnung leer ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/aufgaben/aufgabe/regionaleErgaenzung/bezeichnung).

Bitte sorgen Sie dafür, dass die Bezeichnung der regionalen Ergänzung angegeben wird!

• Formular zur regionalen Ergänzung: Keine Kurzbeschreibung angegeben.

Diese Fehlermeldung erhalten Sie, wenn im Request eine regionale Ergänzung mit einem Formular zu finden ist, dessen Kurzbeschreibung leer ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/aufgaben/aufgabe/regionaleErgaenzung/formulare//formular//kurz).

Page 182: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  182 von 187

Bitte sorgen Sie dafür, dass die Kurzbeschreibung des Formulars angegeben wird!

• Formular zur regionalen Ergänzung: Keine URL angegeben.

Diese Fehlermeldung erhalten Sie, wenn im Request eine regionale Ergänzung mit einem Formular zu finden ist, dessen URL leer ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/aufgaben/aufgabe/regionaleErgaenzung/formulare/formular/url).

Bitte sorgen Sie dafür, dass die URL des Formulars angegeben wird!

• Formular zur regionalen Ergänzung: URL "..." ist nicht erreichbar.

Diese Fehlermeldung erhalten Sie, wenn im Request eine regionale Ergänzung mit einem Formular zu finden ist, dessen URL ungültig ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/aufgaben/aufgabe/regionaleErgaenzung/formulare/formular/url).

Bitte prüfen Sie die URL und liefern Sie gegebenenfalls eine korrigierte URL!

• Link zur regionalen Ergänzung: Keine Kurzbeschreibung angegeben.

Diese Fehlermeldung erhalten Sie, wenn im Request eine regionale Ergänzung mit einem Link zu finden ist, dessen Kurzbeschreibung leer ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/aufgaben/aufgabe/regionaleErgaenzung/links//link//kurz).

Bitte sorgen Sie dafür, dass die Kurzbeschreibung des Links angegeben wird!

• Link zur regionalen Ergänzung: Keine URL angegeben.

Diese Fehlermeldung erhalten Sie, wenn im Request eine regionale Ergänzung mit einem Link zu finden ist, dessen URL leer ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/aufgaben/aufgabe/regionaleErgaenzung/link/link/url).

Bitte sorgen Sie dafür, dass die URL des Links angegeben wird!

• Link zur regionalen Ergänzung: URL "..." ist nicht erreichbar.

Diese Fehlermeldung erhalten Sie, wenn im Request eine regionale Ergänzung mit einem Link zu finden ist, dessen URL ungültig ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/aufgaben/aufgabe/regionaleErgaenzung/links/link/url).

Bitte prüfen Sie die URL und liefern Sie gegebenenfalls eine korrigierte URL!

• Onlineverfahren zur regionalen Ergänzung: Keine Kurzbeschreibung angegeben.

Diese Fehlermeldung erhalten Sie, wenn im Request eine regionale Ergänzung mit einem Onlineverfahren zu finden ist, dessen Kurzbeschreibung leer ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/aufgaben/aufgabe/regionaleErgaenzung/onlineVerfahren//onlineService//kurz).

Bitte sorgen Sie dafür, dass die Kurzbeschreibung des Onlineverfahrens angegeben wird!

• Onlineverfahren zur regionalen Ergänzung: Keine URL angegeben.

Diese Fehlermeldung erhalten Sie, wenn im Request eine regionale Ergänzung mit einem Onlineverfahren zu finden ist, dessen URL leer ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/aufgaben/aufgabe/regionaleErgaenzung/onlineVerfahren/onlineService/url).

Bitte sorgen Sie dafür, dass die URL des Onlineverfahrens angegeben wird!

Page 183: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  183 von 187

• Onlineverfahren zur regionalen Ergänzung: URL "..." ist nicht erreichbar.

Diese Fehlermeldung erhalten Sie, wenn im Request eine regionale Ergänzung mit einem Onlineverfahren zu finden ist, dessen URL ungültig ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/aufgaben/aufgabe/regionaleErgaenzung/onlineVerfahren/onlineService/url).

Bitte prüfen Sie die URL und liefern Sie gegebenenfalls eine korrigierte URL!

• Rechtsvorschrift zur regionalen Ergänzung: Keine Kurzbeschreibung angegeben.

Diese Fehlermeldung erhalten Sie, wenn im Request eine regionale Ergänzung mit einem Onlineverfahren zu finden ist, dessen Kurzbeschreibung leer ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/aufgaben/aufgabe/regionaleErgaenzung/rechtsvorschriften//rechtsvorschrift//kurz).

Bitte sorgen Sie dafür, dass die Kurzbeschreibung der Rechtsvorschrift angegeben wird!

• Rechtsvorschrift zur regionalen Ergänzung: URL "..." ist nicht erreichbar.

Diese Fehlermeldung erhalten Sie, wenn im Request eine regionale Ergänzung mit einem Onlineverfahren zu finden ist, dessen URL ungültig ist (Element CmsIntegrationRequest/organisation/organisationen/organisation/adressen/adresse/aufgaben/aufgabe/regionaleErgaenzung/rechtsvorschriften/rechtsvorschrift/url).

Bitte prüfen Sie die URL und liefern Sie gegebenenfalls eine korrigierte URL!

3.9 Workflow des Import-Web-Service

3.9.1 KurzbeschreibungDer Import verläuft in folgenden Schritten

Synchrone Verarbeitung (sollte im Sekundenbereich abgeschlossen sein):

• Client sendet Request• Authentifizierung über den Soap-Header (WS-Security, UsernameToken)• XSD-Schema-Validierung• Autorisierung über den Einstiegspunkt (Element CmsIntegrationRequest / wsRequestContext / dienststellenSchluessel)

• Validierung des Einhängepunkts (Element CmsIntegrationRequest / wsRequestContext / organisationsBezeichnung)

• Server speichert den Request in der XML-Form in Zwischentabelle• Server sendet Response

Response im Erfolgsfall

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"> <SOAP-ENV:Header/> <SOAP-ENV:Body> <ns2:CmsIntegrationResponse xmlns:ns2="http://lfstad.bayern.de/baybw/schemas/cmsintegration/messages"> <ns2:outcome>OK</ns2:outcome> <ns2:message>OK</ns2:message> </ns2:CmsIntegrationResponse> </SOAP-ENV:Body></SOAP-ENV:Envelope>

Page 184: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  184 von 187

Asynchrone Verarbeitung:

• Zeitplan-gesteuerter Job sucht nach neuen Requests• Deserialisierung des Request und fachliche Validierung (z.B. Pflichtfelder, Formate bei URL, E-Mail,

Telefonnummer und Faxnummer)• Report der Validierungsfehler erstellen• Ergebnis der Validierung (Report) in Zwischentabelle speichern• Daten in den Fachtabellen speichern, falls keine Validierungsfehler vorhanden• Zeitplan-gesteuerter Job sucht nach validierten Requests• Prüfung der Mindestwartezeit seit dem letzten erfolgreichen Import (7 Tage)• Erstellung einer Antwort für den Client

Page 185: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  185 von 187

E-Mail im Erfolgsfall

Von: [email protected]: IhreEmailAdresseBetreff: BayernPortal; ImportDatum: Di 20.03.2018 15:30  Sehr geehrte Damen und Herren, Sie erhalten diese automatisch generierte Nachricht, weil der Server des BayernPortal eine Anfrage zum Importieren von Daten erhalten hat und der Anfrage Ihre Zugangskennung zugeordnet ist. Die Daten wurden erfolgreich importiert. Verarbeitungsprotokoll--------------------- Benutzer: "0308106-003" Transaktionsidentifikationsnummer: "TRANSACTION_1" Eingang der Nachricht: "20.03.2018 15:33:50"Beginn der Verarbeitung: "20.03.2018 15:33:50"Start der Validierung: "20.03.2018 15:33:50" Ende der Validierung: "20.03.2018 15:33:50"Ergebnis der Validierung: "gültig"Meldung aus Validierung: "Validierung erfolgreich"Start des Imports: "20.03.2018 15:34:00"Ende des Imports: "20.03.2018 15:34:01"Ergebnis des Imports: "importiert"Meldung aus Import: Import erfolgreich  Diese Nachricht wurde automatisch erstellt.Bei Fragen wenden Sie sich bitte an die Zentrale Redaktion für Verwaltungsinformationen in Bayern beim Bayerisches Staatsministerium der Finanzen und für Heimat (mailto:[email protected]).  Mit freundlichen Grüßen Bayerisches Staatsministerium der Finanzen und für HeimatZentrale Redaktion des Redaktionssystems für Verwaltungsinformationen in BayernOdeonsplatz 4, 80539 MünchenTelefon: +49 (0)89 2306-2267E-Mail: mailto:[email protected]: https://www.bayvis-redaktionssystem.bayern.deDienstleistungsportal Bayern: http://www.dienstleistungsportal.bayern.deBayernPortal: http://www.freistaat.bayern

Page 186: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  186 von 187

Webservice Rückruf-Request im Erfolgsfall

<soapenv:Envelope xmlns:ns3="http://lfstad.bayern.de/baybw/schemas/cmsintegration/messages" xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns2="http://lfstad.bayern.de/baybw/schemas/cmsintegration/types">  <soapenv:Body> <ns3:BaybwToCmsIntegrationRequest> <ns3:importJournal> <ns2:user>0308106-003</ns2:user> <ns2:requestTransactionId>TRANSACTION_1</ns2:requestTransactionId> <ns2:neuStartZeitpunkt>2011-04-07T17:53:10+02:00</ns2:neuStartZeitpunkt> <ns2:neuStopZeitpunkt>2011-04-07T17:53:10+02:00</ns2:neuStopZeitpunkt> <ns2:validierungStartZeitpunkt>2011-04-07T17:53:10+02:00</ns2:validierungStartZeitpunkt> <ns2:validierungStopZeitpunkt>2011-04-07T17:53:10+02:00</ns2:validierungStopZeitpunkt> <ns2:valide>true</ns2:valide> <ns2:validierungMeldung>Validierung erfolgreich</ns2:validierungMeldung> <ns2:importStartZeitpunkt>2011-04-07T17:53:20+02:00</ns2:importStartZeitpunkt> <ns2:importStopZeitpunkt>2011-04-07T17:53:24+02:00</ns2:importStopZeitpunkt> <ns2:importErfolg>true</ns2:importErfolg> <ns2:importMeldung>Import erfolgreich</ns2:importMeldung> </ns3:importJournal> </ns3:BaybwToCmsIntegrationRequest> </soapenv:Body> </soapenv:Envelope

• Zeitplan-gesteuerter Job sucht nach beantworteten Requests• Request wird gelöscht

Mindestwartezeit seit dem letzten erfolgreichen ImportUm das System nicht mit zu häufigen Importvorgängen zu belasten, wurde mit Version 3.3. des Behördenwegweiser eine Mindestwartezeit von 7 Tagen eingeführt. Wenn eine Benutzerkennung eine Importanfrage innerhalb dieser Wartezeit nochmals sendet, dann durchläuft diese Anfrage nur die Validierungsphase vollständig. Die Importphase wird ohne weitere Bearbeitung übergangen. Folgende Antwort wird als E-Mail gesendet:

Page 187: Web-Service Dokumentation - baybw-services.bayern.de · Authentifizierung bei den SOAP-Web-Services erfolgt nach der WS-Security-Spezifikaton, bei den XML-Web-Services über HTTP-Basic-Authentification

BayernPortal Web-Service Dokumentation

Web-Services für den Datenimport in das BayernPortal Seite  187 von 187

E-Mail im Erfolgsfall, wenn Mindestwartezeit nicht eingehalten

Von: [email protected]: IhreEmailAdresseBetreff: BayernPortal; ImportDatum: 06.03.2012 17:16:00 Guten Tag! Dies ist eine automatisch generierte Nachricht.Sie erhalten diese, weil unser Server von Ihnen eine Anfrage zum Importierenvon Daten in den Behördenwegweiser erhalten hat.Bei dieser Anfrage waren Sie als Adressat der Antwort eingetragen. Die Anfrage wurde erfolgreich verarbeitet. Verarbeitungsprotokoll--------------------- Benutzer: "0308106-003"Transaktionsidentifikationsnummer: "TRANSACTION_1"Eingang der Nachricht: "06.03.2013 17:15:10"Beginn der Verarbeitung: "06.03.2013 17:15:10"Start der Validierung: "06.03.2013 17:15:10" Ende der Validierung: "06.03.2013 17:15:10"Ergebnis der Validierung: "gültig"Meldung aus Validierung: "Validierung erfolgreich"Start des Imports: "06.03.2013 17:15:20"Ende des Imports: "06.03.2013 17:15:20"Ergebnis des Imports: "nicht importiert wegen Mindestwartezeit von 7 Tagen seit dem letzten erfolgreichen Import"Meldung aus Import: Import wird ignoriert Mit freundlichen Grüßen Bayerisches Staatsministerium der Finanzen und für HeimatZentrale Redaktion des Redaktionssystems für Verwaltungsinformationen in BayernOdeonsplatz 4, 80539 MünchenTelefon: +49 (0)89 2306-2267E-Mail: mailto:[email protected]: https://www.bayvis-redaktionssystem.bayern.deDienstleistungsportal Bayern: http://www.dienstleistungsportal.bayern.deBayernPortal: http://www.freistaat.bayern