Webservices zum Abruf von Daten aus dem BayernPortal (Export-Webservices)
Behörden können drei Webservices nutzen, um Daten aus dem Redaktionssystem für Verwaltungsinformationen in Bayern (https://www.bayvis-redaktionssystem.bayern.de) abzurufen um sie in den eigenen Internetauftritt zu integrieren. Die Integration erfordert eine Programmierung auf der Seite der Behörde.
Die Webservices liefern Informationen zu Leistungen, Lebenslagen, Behörden, Organisationseinheiten und Ansprechpartnern, die im Redaktionssystem gepflegt werden.
Für die Nutzung der Export-Webservices ist grundsätzlich eine Datenpflege über das Redaktionssystem oder eine Datenlieferung über die Import-Schnittstelle erforderlich. Die Behörde muss mindestens Organisations- und Kommunikationsdaten pflegen. Bei Nutzung der Webservices sind die Nutzungsbedingungen (PDF) zu beachten.
Als Austauschformat wird XML (Extensible Markup Language) in der Version 1.0 verwendet. Ein Aufruf der Webservices ist bis einschließlich der Version 2 dieser Webservices nur über eine SOAP-Abfrage möglich.
Allgemeine Webservices Version 3
Ab der Version 3 werden die Export-Webservices auf zwei unterschiedlichen Zugriffswegen angeboten, nämlich als
- REST API - Version 3 (mit HTTP-Basic-Authentication)
- SOAP Schnittstelle - Version 3 (mit WS-Security UsernameToken-Header)
Es stehen verschiedene Endpunkte/Ressourcen zur Verfügung. Sie können z. B. folgende Daten abrufen:
- Abrufen der Kontaktdaten der eigenen Behörde und ihrer Außenstellen
- Abrufen der Kontaktdaten von allen oder bestimmten Organisationseinheiten der eigenen Behörde
- Abrufen der Kontaktdaten von allen oder bestimmten Gebäuden der eigenen Behörde
- Abrufen der Kontaktdaten von allen oder bestimmten Ansprechpartnern der eigenen Behörde oder der Ansprechpartner in einem Gebäude der eigenen Behörde
- Abrufen aller Leistungen, die im BayernPortal veröffentlicht sind (nur ID, Bezeichnung, URL, zugeordnete Lebenslage und Synonyme)
- Abrufen einer bestimmten Leistung (nur Bezeichnung, URL, zugeordnete Lebenslage und Synonyme)
- Abrufen der Leistungen, die der eigenen Behörde oder einer Organisationseinheit zugeordnet sind (nur ID, Bezeichnung, URL, zugeordnete Lebenslage und Synonyme)
- Abrufen der Leistungen, die der eigenen Behörde oder einer Organisationseinheit der eigenen Behörde zugeordnet sind (nur ID, Bezeichnung, URL, zugeordnete Lebenslage und Synonyme)
- Abrufen der Leistungen, die einem Ansprechpartner zugeordnet sind (nur ID, Bezeichnung, URL, zugeordnete Lebenslage und Synonyme)
- Abrufen aller Leistungsbeschreibungen, die im BayernPortal veröffentlicht sind (mit regionalen Ergänzungen)
- Abrufen der Leistungsbeschreibungen, die der eigenen Behörde oder einer Organisationseinheit zugeordnet sind (mit regionalen Ergänzungen und Daten der zuständigen Stelle(n))
- Abrufen einer bestimmten Leistungsbeschreibung (mit regionalen Ergänzungen und Daten der zuständigen Stelle(n))
- Abrufen der Formularen und Leistungen, die einer Behörde oder Organisationseinheit zugeordnet sind
- Abrufen aller Lebenslagen oder einer bestimmten Lebenslage
- Abrufen von Lebenslagen, die Leistungen zugeordnet sind
- nicht möglich: Abrufen der Kontaktdaten von Dienststellen, Organisationseinheiten oder Ansprechpartnern anderer Behörden sowie das Abrufen von Leistungsbeschreibungen mit den Kontaktdaten von Organisationseinheiten und Ansprechpartnern anderer Behörden
Allgemeine Webservices - Versionen 1 und 2
Die Webservice "Lebenslagen allgemein" und "Behörden, Gebäude und Ansprechpartner" gibt es derzeit noch in der Version 1. Sie werden voraussichtlich noch bis Ende 2018 angeboten.
Für den Webservice "Leistungen allgemein" gibt es derzeit noch eine Version 1 und eine Version 2 . Die Version 1 wird nur noch bis Ende 2016 angeboten. Die Version 2 wird voraussichtlich noch bis Ende 2018 angeboten.
Was hat sich in Version 2 des Webservice "Leistungen allgemein" gegenüber der Version 1 geändert? Bei der Anzahl und Bedeutung der Schnittstellenmethoden gibt es keine Änderungen. Dagegen sind die Antwortdokumente vom Datenmodell teilweise verändert:
- Das Element gueltigBis wird bei Leistungsbeschreibungen und regionalen Ergänzungen nicht mehr ausgeliefert.
- Wenn die Gültigkeitszeit von Leistungsbeschreibungen oder regionalen Ergänzungen abgelaufen ist oder das Element "status" den Wert "working" hat, dann wird die Kurzbeschreibung mit dem Inhalt "Diese Leistungsbeschreibung wird aktuell überarbeitet." ausgeliefert. Die meisten anderen Elemente (z. B. langbeschreibung, voraussetzungen etc.) fehlen in diesem Fall.
- Das Element "verantwortlicheBehoerde" enthält wie bisher die Bezeichnung der redaktionell verantwortlichen Behörde. Bei zentralen Leistungsbeschreibungen wird aber noch folgender Hinweis hinzugefügt: "(siehe: <a href="https://www.bayernportal.de/dokumente/leistung/...">BayernPortal</a>)". Die angegebene URL zeigt auf die (eventuell lokalisierte) Leistungsbeschreibung im BayernPortal. Dieses Element enthält also im Gegensatz zur vorherigen Version HTML-Markup.
- Das Datenmodell in "GetSingleLeistungsbeschreibungResponse" wurde so überarbeitet, dass bei den Zuständigkeiten unter bestimmten Bedingungen auch die Referenz-Ids für Behörden, Gebäude und Ansprechpartner ausgeliefert werden. Der Client kann diese Referenz-Ids nutzen, um weitere Detailanfragen über den Webservice "Behörden, Gebäude und Ansprechpartner allgemein" zu stellen.